Cg Core Runtime API                      cgSetStringAnnotation(3)



NAME
     cgSetStringAnnotation - set the value of a string annotation

SYNOPSIS
       #include 

       CGbool cgSetStringAnnotation( CGannotation ann,
                                     const char * value );


PARAMETERS
     ann     The annotation that will be set.

     value   The value to which ann will be set.

RETURN VALUES
     Returns CGTRUE if it succeeds in setting the annotation.

     Returns CGFALSE otherwise.

DESCRIPTION
     cgSetStringAnnotation sets the value of an annotation of
     string type.

EXAMPLES
     to-be-written

ERORS
     CGINVALIDANOTATIONHANDLEROR is generated if ann is
     not a valid annotation.

     CGINVALIDPARAMETERTYPEROR is generated if ann is not
     an annotation of string type.

     CGARAYSIZEMISMATCHEROR is generated if ann is not a
     scalar.

HISTORY
     cgSetStringAnnotation was introduced in Cg 1.5.

SEE ALSO
     cgGetStringAnnotationValue, cgSetBoolAnnotation,
     cgSetIntAnnotation, cgSetFloatAnnotation












Cg Toolkit 2.1            Last change:                          1