NAME

cgGetFirstPassAnnotation - get the first annotation of a pass

SYNOPSIS

  #include <Cg/cg.h>

  CGannotation cgGetFirstPassAnnotation( CGpass pass );

PARAMETERS

pass

Specifies the pass to retrieve the annotation from.

DESCRIPTION

The annotations associated with a pass can be retrieved using the cgGetFirstPassAnnotation function. The remainder of the pass's annotations can be discovered by iterating through the parameters, calling cgGetNextAnnotation to get to the next one.

RETURN VALUES

Returns the first annotation. If the pass has no annotations, NULL is returned.

ERRORS

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

SEE ALSO

cgGetNamedPassAnnotation, cgGetNextAnnotation