NAME
cgGetFirstParameterAnnotation - get the first annotation of a parameter
SYNOPSIS
#include <Cg/cg.h> CGannotation cgGetFirstParameterAnnotation( CGparameter param );PARAMETERS
- param
The parameter from which to retrieve the annotation.
RETURN VALUES
Returns the first annotation. If the parameter has no annotations, NULL is returned.
DESCRIPTION
The annotations associated with a parameter can be retrieved using the cgGetFirstParameterAnnotation function. The remainder of the parameter'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 CGparameter param:
CGannotation ann = cgGetFirstParameterAnnotation( param ); while( ann ) { /* do something with ann */ ann = cgGetNextAnnotation( ann ); }ERRORS
CG_INVALID_PARAMETER_HANDLE_ERROR is generated if param does not refer to a valid parameter.
HISTORY
cgGetFirstParameterAnnotation was introduced in Cg 1.4.
SEE ALSO