NAME

cgGetFirstProgramAnnotation - get the first annotation of a program

SYNOPSIS

  #include <Cg/cg.h>

  CGannotation cgGetFirstProgramAnnotation( CGprogram program );

PARAMETERS

program

The program from which to retrieve the annotation.

RETURN VALUES

Returns the first annotation. If the program has no annotations, NULL is returned.

DESCRIPTION

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

  CGannotation ann = cgGetFirstProgramAnnotation( program );
  while( ann )
  {
     /* do something with ann */
     ann = cgGetNextAnnotation( ann );
  }

ERRORS

CG_INVALID_PROGRAM_HANDLE_ERROR is generated if program does not refer to a valid program.

HISTORY

cgGetFirstProgramAnnotation was introduced in Cg 1.4.

SEE ALSO

cgGetNamedProgramAnnotation, cgGetNextAnnotation