Name
cgSetStringAnnotation - set the value of a string annotation
Synopsis
#include <Cg/cg.h> 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 CG_TRUE if it succeeds in setting the annotation.
Returns CG_FALSE otherwise.
Description
cgSetStringAnnotation sets the value of an annotation of string type.
Examples
to-be-written
Errors
CG_INVALID_ANNOTATION_HANDLE_ERROR is generated if ann is not a valid annotation.
CG_INVALID_PARAMETER_TYPE_ERROR is generated if ann is not an annotation of string type.
CG_ARRAY_SIZE_MISMATCH_ERROR is generated if ann is not a scalar.
History
cgSetStringAnnotation was introduced in Cg 1.5.
See Also
cgGetStringAnnotationValue, cgSetBoolAnnotation, cgSetIntAnnotation, cgSetFloatAnnotation