Name

cgGetNumDependentAnnotationParameters - get the number of effect parameters on which an annotation depends

Synopsis

#include <Cg/cg.h>

int cgGetNumDependentAnnotationParameters( CGannotation ann );

Parameters

ann

The annotation handle.

Return Values

Returns the number of parameters on which ann depends.

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. cgGetNumDependentAnnotationParameters returns the total number of such parameters. cgGetDependentAnnotationParameter can then be used to iterate over these 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

Errors

CG_INVALID_ANNOTATION_HANDLE_ERROR is generated if ann is not a valid annotation.

History

cgGetNumDependentAnnotationParameters was introduced in Cg 1.4.

See Also

cgGetDependentAnnotationParameter, cgGetNumDependentStateAssignmentParameters