Name

cgGetFirstTechniqueAnnotation - get the first annotation of a technique

Synopsis

#include <Cg/cg.h>

CGannotation cgGetFirstTechniqueAnnotation( CGtechnique tech );

Parameters

tech

The technique from which to retrieve the annotation.

Return Values

Returns the first annotation in the given technique.

Returns NULL if the technique has no annotations or an error occurs.

Description

The annotations associated with a technique can be retrieved using cgGetFirstTechniqueAnnotation. The remainder of the technique's annotations can be discovered by iterating through the parameters, calling cgGetNextAnnotation to get to the next one.

Examples

CGannotation ann = cgGetFirstTechniqueAnnotation( technique );
while( ann )
{
  /* do something with ann */
  ann = cgGetNextAnnotation( ann );
}

Errors

CG_INVALID_TECHNIQUE_HANDLE_ERROR is generated if tech is not a valid technique.

History

cgGetFirstTechniqueAnnotation was introduced in Cg 1.4.

See Also

cgGetNamedTechniqueAnnotation, cgGetNextAnnotation