Name

cgGetNamedPassAnnotation - get a pass annotation by name

Synopsis

#include <Cg/cg.h>

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

Parameters

pass

The pass from which to retrieve the annotation.

name

The name of the annotation to retrieve.

Return Values

Returns the named annotation.

Returns NULL if the pass has no annotation corresponding to name.

Description

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

Examples

/* fetch annotation "Apple" from CGpass pass */
CGannotation ann = cgGetNamedPassAnnotation( pass, "Apple" );

Errors

CG_INVALID_PASS_HANDLE_ERROR is generated if pass is not a valid pass.

History

cgGetNamedPassAnnotation was introduced in Cg 1.4.

See Also

cgGetFirstPassAnnotation, cgGetNextAnnotation, cgGetAnnotationName