NAME
cgGetFirstPassAnnotation - get the first annotation of a pass
SYNOPSIS
#include <Cg/cg.h> CGannotation cgGetFirstPassAnnotation( CGpass pass );PARAMETERS
- pass
The pass from which to retrieve the annotation.
RETURN VALUES
Returns the first annotation. If the pass has no annotations, NULL is returned.
DESCRIPTION
The annotations associated with a pass can be retrieved using the cgGetFirstPassAnnotation function. The remainder of the pass's annotations can be discovered by iterating through the parameters, calling cgGetNextAnnotation to get to the next one.
EXAMPLES
The following example code illustrates this on CGpass pass:
CGannotation ann = cgGetFirstPassAnnotation( pass ); while( ann ) { /* do something with ann */ ann = cgGetNextAnnotation( ann ); }ERRORS
CG_INVALID_PASS_HANDLE_ERROR is generated if pass does not refer to a valid pass.
HISTORY
cgGetFirstPassAnnotation was introduced in Cg 1.4.
SEE ALSO