NAME

cgGetNamedProgramAnnotation - get a program annotation by name

SYNOPSIS

  #include <Cg/cg.h>

  CGannotation cgGetNamedProgramAnnotation( CGprogram prog, const char * name );

PARAMETERS

prog

Specifies the program to retrieve the annotation from.

name

Specifies the name of the annotation to retrieve.

DESCRIPTION

The annotations associated with a program can be retrieved directly by name using the cgGetNamedProgramAnnotation function. The names of a program's annotations can be discovered by iterating through the annotations (see cgGetFirstProgramAnnotation and cgGetNextAnnotation), calling cgGetAnnotationName for each one in turn.

RETURN VALUES

Returns the named annotation. If the program has no annotation corresponding to name, NULL is returned.

ERRORS

CG_INVALID_PROGRAM_HANDLE_ERROR is generated if prog does not refer to a valid program.

SEE ALSO

cgGetFirstProgramAnnotation, cgGetNextProgramAnnotation, cgGetAnnotationName