NAME

cgGetStringAnnotationValue - get an string-valued annotation's value

SYNOPSIS

  #include <Cg/cg.h>

  const char * cgGetStringAnnotationValue( CGannotation ann );

PARAMETERS

ann

The annotation.

RETURN VALUES

Returns a pointer to a string.

If no value is available, NULL will be returned.

DESCRIPTION

cgStringAnnotationValue allows the application to retrieve the value of a string typed annotation.

EXAMPLES

to-be-written

ERRORS

CG_INVALID_ANNOTATION_HANDLE_ERROR is generated if the handle ann is invalid.

HISTORY

cgGetStringAnnotationValue was introduced in Cg 1.4.

SEE ALSO

cgGetAnnotationType, cgGetFloatAnnotationValues, cgGetStringAnnotationValues, cgGetBooleanAnnotationValues