NAME

cgGetParameterVariability - get a program parameter's variability

SYNOPSIS

  #include <Cg/cg.h>

  CGenum cgGetParameterVariability( CGparameter param );

PARAMETERS

param

Specifies the program parameter.

DESCRIPTION

cgGetParameterVariability allows the application to retrieve the variablilty of a parameter in a Cg program. This variablity is necessary for the application to be able to supply the program's inputs and use the program's outputs.

cgGetParameterVariability will return one of the following variabilities:

CG_VARYING

A varying parameter is one whose value changes with each invocation of the program.

CG_UNIFORM

A uniform parameter is one whose value does not chance with each invocation of a program, but whose value can change between groups of program invocations.

CG_CONSTANT

A constant parameter never changes for the life of a compiled program. Modifying a constant parameter requires program recompilation.

CG_MIXED

A structure parameter that contains parameters that differ in variability.

RETURN VALUES

Returns the variability of param. Returns CG_ERROR if an error occurs.

ERRORS

CG_INVALID_PARAM_HANDLE_ERROR is generated if the handle param is invalid.

SEE ALSO

the "cgGetNamedParameter" document, the "cgGetNextParameter" document, the "cgGetParameterName" document, the "cgGetParameterType" document, the "cgGetParameterDirection" document, the "cgGetParameterBinding" document, the "cgGetParameterDirectionalBinding" document, the "cgIsArray" document, the "cgSetParameterVariablity" document, the "cgSetParameterDirection" document, the "cgSetParameterBinding" document, the "cgSetParameterDirectionalBinding" document