Cg Core Runtime API                   cgGetNamedPassAnnotation(3)



NAME
     cgGetNamedPassAnnotation - get a pass annotation by name

SYNOPSIS
       #include 

       CGannotation cgGetNamedPassAnnotation( CGpass pass,
                                              const char * name );


PARAMETERS
     pass    The pass from which to retrieve the annotation.

     name    The name of the annotation to retrieve.

RETURN VALUES
     Returns the named annotation.

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

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

EXAMPLES
       /* fetch annotation "Apple" from CGpass pass */
       CGannotation ann = cgGetNamedPassAnnotation( pass, "Apple" );


ERORS
     CGINVALIDPASHANDLEROR is generated if pass is not a
     valid pass.

HISTORY
     cgGetNamedPassAnnotation was introduced in Cg 1.4.

SEE ALSO
     cgGetFirstPassAnnotation, cgGetNextAnnotation,
     cgGetAnnotationName











Cg Toolkit 2.1            Last change:                          1