NAME

cgGetNextAnnotation - iterate through annotations

SYNOPSIS

  #include <Cg/cg.h>

  CGannotation cgGetNextAnnotation( CGannotation ann );

PARAMETERS

ann

The current annotation.

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.

DESCRIPTION

The annotations associated with a parameter, pass, technique, or program can be iterated over by using the cgGetNextAnnotation function.

EXAMPLES

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.

ERRORS

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

HISTORY

cgGetNextAnnotation was introduced in Cg 1.4.

SEE ALSO

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