NAME

cgGetNumDependentAnnotationParameters - returns the number of effect parameters an annotation depends on.

SYNOPSIS

  #include <Cg/cg.h>

  int cgGetNumDependentAnnotationParameters(CGannotation ann);

PARAMETERS

ann

Specifies the annotation handle.

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 state assignment's value. cgGetNumDependentAnnotationParameters returns the total number of such parameters. the "cgGetDependentAnnotationParameter" document can then be used to iterate over the parameters individually.

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.

ERRORS

CG_INVALID_ANNOTATION_HANDLE_ERROR is generated if ann does not refer to a valid annotation.

SEE ALSO

the "cgGetDependentAnnotationParameter" document, the "cgGetFirstAnnotation" document, the "cgGetNamedAnnotation" document, the "cgGetNumDependentStateAssignmentParameters" document