Cg Core Runtime API                     cgCreatePassAnnotation(3)



NAME
     cgCreatePassAnnotation - create an annotation in a pass

SYNOPSIS
       #include 

       CGannotation cgCreatePassAnnotation( CGpass pass,
                                            const char * name,
                                            CGtype type );


PARAMETERS
     pass    The pass to which the new annotation will be added.

     name    The name of the new annotation.

     type    The type of the new annotation.

RETURN VALUES
     Returns the new CGannotation handle on success.

     Returns NUL if an error occurs.

DESCRIPTION
     cgCreatePassAnnotation adds a new annotation to a pass.

EXAMPLES
       /* create a float annotation named "Apple" for CGpass pass */
       CGannotation ann = cgCreatePassAnnotation( pass, "Apple", CGFLOAT );


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

     CGDUPLICATENAMEROR is generated if name is already used
     by an annotation for this pass.

     CGINVALIDENUMERANTEROR is generated if type is not
     CGINT, CGFLOAT, CGBOL, or CGSTRING.

HISTORY
     cgCreatePassAnnotation was introduced in Cg 1.5.

SEE ALSO
     cgGetNamedPassAnnotation, cgGetFirstPassAnnotation,
     cgGetNextAnnotation








Cg Toolkit 2.1            Last change:                          1