NAME

cgGetAnnotationName - get an annotation's name

SYNOPSIS

  #include <Cg/cg.h>

  const char * cgGetAnnotationName( CGannotation ann );

PARAMETERS

ann

Specifies the annotation.

DESCRIPTION

cgGetAnnotationName allows the application to retrieve the name of a annotation. This name can be used later to retrieve the annotation using cgGetNamedPassAnnotation, cgGetNamedParameterAnnotation, cgGetNamedPTechniqueAnnotation, or cgGetNamedProgramAnnotation.

RETURN VALUES

Returns the null-terminated name string for the annotation.

Returns null if ann is invalid.

ERRORS

CG_INVALID_ANNOTATION_HANDLE_ERROR is generated if prog does not refer to a valid annotation.

SEE ALSO

cgGetNamedPassAnnotation, cgGetNamedParameterAnnotation, cgGetNamedTechniqueAnnotation, and cgGetNamedProgramAnnotation