Cg Core Runtime API cgGetDependentAnnotationParameter(3)
NAME
cgGetDependentAnnotationParameter - get one of the
parameters that an annotation's value depends on
SYNOPSIS
#include
CGparameter cgGetDependentAnnotationParameter( CGannotation ann,
int index );
PARAMETERS
ann The annotation handle.
index The index of the parameter to return.
RETURN VALUES
Returns a handle to the selected dependent annotation on
success.
Returns NUL if an error occurs.
DESCRIPTION
Annotations in CgFX files may include references to one or
more effect parameters on the right hand side of the
annotation that are used for computing the annotation's
value. cgGetDependentAnnotationParameter returns one of
these parameters, as indicated by the given index.
cgGetNumDependentAnnotationParameters 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
CGINVALIDANOTATIONHANDLEROR is generated if ann is
not a valid annotation.
CGOUTOFARAYBOUNDSEROR is generated if index is less
than zero or greater than or equal to the number of
dependent parameters, as returned by
cgGetNumDependentAnnotationParameters.
HISTORY
cgGetDependentAnnotationParameter was introduced in Cg 1.4.
Cg Toolkit 2.1 Last change: 1
Cg Core Runtime API cgGetDependentAnnotationParameter(3)
SEE ALSO
cgGetDependentStateAssignmentParameter,
cgGetNumDependentAnnotationParameters
Cg Toolkit 2.1 Last change: 2
|