Cg Core Runtime API                cgGetNamedProgramAnnotation(3)



NAME
     cgGetNamedProgramAnnotation - get a program annotation by
     name

SYNOPSIS
       #include 

       CGannotation cgGetNamedProgramAnnotation( CGprogram program,
                                                 const char * name );


PARAMETERS
     program The program from which to retrieve the annotation.

     name    The name of the annotation to retrieve.

RETURN VALUES
     Returns the named annotation.

     Returns NUL if the program has no annotation corresponding
     to name.

DESCRIPTION
     The annotations associated with a program can be retrieved
     directly by name using cgGetNamedProgramAnnotation.  The
     names of a program's annotations can be discovered by
     iterating through the annotations (see
     cgGetFirstProgramAnnotation and cgGetNextAnnotation),
     calling cgGetAnnotationName for each one in turn.

EXAMPLES
       /* fetch annotation "Apple" from CGprogram program */
       CGannotation ann = cgGetNamedProgramAnnotation( program, "Apple" );


ERORS
     CGINVALIDPROGRAMHANDLEROR is generated if program is
     not a valid program handle.

HISTORY
     cgGetNamedProgramAnnotation was introduced in Cg 1.4.

SEE ALSO
     cgGetFirstProgramAnnotation, cgGetNextAnnotation,
     cgGetAnnotationName










Cg Toolkit 2.1            Last change:                          1