NAME

cgGetNextAnnotation - iterate through annotations

SYNOPSIS

  #include <Cg/cg.h>

  CGannotation cgGetNextAnnotation( CGannotation ann );

PARAMETERS

ann

Specifies the current annotation.

DESCRIPTION

The annotations associated with a parameter, pass, technique, or program can be iterated over by using the cgGetNextAnnotation function. The following example code illustrates one way to do this:

  CGannotation ann = cgGetFirstParameterAnnotation( param );
  while( ann )
  {
   /* do something with ann */
   ann = cgGetNextAnnotation( ann );
  }

Note that no specific order of traversal is defined by this mechanism. The only guarantee is that each annotation will be visited exactly once.

RETURN VALUES

cgGetNextAnnotation returns the next annotation in the sequence of annotations associated with the annotated object. Returns 0 when prog is the last annotation.

ERRORS

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

SEE ALSO

cgGetFirstParameterAnnotation, cgGetFirstPassAnnotation, cgGetFirstTechniqueAnnotation, cgGetFirstProgramAnnotation, cgGetNamedParameterAnnotation, cgGetNamedPassAnnotation, cgGetNamedTechniqueAnnotation, cgGetNamedProgramAnnotation, and cgIsAnnotation