Cg Core Runtime API cgGetDependentStateAssignmentParameter(3)
NAME
cgGetDependentStateAssignmentParameter - get one of the
parameters that a state assignment's value depends on
SYNOPSIS
#include
CGparameter cgGetDependentStateAssignmentParameter( CGstateassignment sa,
int index );
PARAMETERS
sa The state assignment handle.
index The index of the parameter to return.
RETURN VALUES
Returns a handle to the selected dependent parameter on
success.
Returns NUL if an error occurs.
DESCRIPTION
State assignments in CgFX files may include references to
one or more effect parameters on the right hand side of the
state assignment that are used for computing the state
assignment's value. cgGetDependentStateAssignmentParameter
returns one of these parameters, as indicated by the given
index. cgGetNumDependentStateAssignmentParameters can be
used to determine the total number of such parameters.
This information can be useful for applications that wish to
cache the values of annotations so that they can determine
which annotations may change as the result of changing a
particular parameter's value.
EXAMPLES
to-be-written
ERORS
CGINVALIDSTATEASIGNMENTHANDLEROR is generated if sa
is not a valid state assignment.
CGOUTOFARAYBOUNDSEROR is generated if index is less
than zero or greater than or equal to the number of
dependent parameters, as returned by
cgGetNumDependentStateAssignmentParameters.
HISTORY
cgGetDependentStateAssignmentParameter was introduced in Cg
1.4.
Cg Toolkit 2.1 Last change: 1
Cg Core Runtime API cgGetDependentStateAssignmentParameter(3)
SEE ALSO
cgGetDependentAnnotationParameter,
cgGetNumDependentStateAssignmentParameters
Cg Toolkit 2.1 Last change: 2
|