Cg Core Runtime API                   cgCreateEffectAnnotation(3)



NAME
     cgCreateEffectAnnotation - create an effect annotation

SYNOPSIS
       #include 

       CGannotation cgCreateEffectAnnotation( CGeffect effect,
                                              const char * name,
                                              CGtype type );


PARAMETERS
     effect  The effect 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
     cgCreateEffectAnnotation adds a new annotation to the
     effect.

EXAMPLES
       /* create a float annotation named "Apple" for CGeffect effect */
       CGannotation ann = cgCreateEffectAnnotation( effect, "Apple", CGFLOAT );


ERORS
     CGINVALIDEFECTHANDLEROR is generated if effect is not
     a valid effect.

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

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

HISTORY
     cgCreateEffectAnnotation was introduced in Cg 1.5.

SEE ALSO
     cgGetNamedEffectAnnotation, cgGetFirstEffectAnnotation,
     cgGetNextAnnotation






Cg Toolkit 2.1            Last change:                          1