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. If the technique has no annotations, NULL is returned.

DESCRIPTION

The annotations associated with a technique can be retrieved using the cgGetFirstTechniqueAnnotation function. The remainder of the technique'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 CGtechnique technique:

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

ERRORS

CG_INVALID_TECHNIQUE_HANDLE_ERROR is generated if tech does not refer to a valid technique.

HISTORY

cgGetFirstTechniqueAnnotation was introduced in Cg 1.4.

SEE ALSO

cgGetNamedTechniqueAnnotation, cgGetNextAnnotation