NAME

cgGetNamedPassAnnotation - get a pass annotation by name

SYNOPSIS

  #include <Cg/cg.h>

  CGannotation cgGetNamedPassAnnotation( CGpass pass, const char * name );

PARAMETERS

pass

Specifies the pass to retrieve the annotation from.

name

Specifies the name of the annotation to retrieve.

DESCRIPTION

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

RETURN VALUES

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

ERRORS

CG_INVALID_PASS_HANDLE_ERROR is generated if pass does not refer to a valid pass.

SEE ALSO

the "cgGetFirstPassAnnotation" document, the "cgGetNextPassAnnotation" document, the "cgGetAnnotationName" document