NAME

cgGetParameterEffect - get a parameter's parent program

SYNOPSIS

  #include <Cg/cg.h>

  CGeffect cgGetParameterEffect( CGparameter prog );

PARAMETERS

param

Specifies the parameter.

DESCRIPTION

cgGetParameterEffect allows the application to retrieve a handle to the effect a given parameter belongs to.

RETURN VALUES

Returns a CGeffect handle to the parent effect. In the event of an error or if the parameter is not a child of an effect, NULL is returned.

ERRORS

CG_INVALID_PROGRAM_HANDLE_ERROR is generated if prog does not refer to a valid program.

HISTORY

This function was introduced with Cg 1.5.

SEE ALSO

cgCreateEffect, cgGetParameterProgram, cgCreateContext