Name

cgCreatePassAnnotation - create an annotation in a pass

Synopsis

#include <Cg/cg.h>

CGannotation cgCreatePassAnnotation( CGpass pass,
                                     const char * name,
                                     CGtype type );

Parameters

pass

The pass to which the new annotation will be added.

name

The name of the new annotation.

type

The type of the new annotation.

Return Values

Returns the new CGannotation handle on success.

Returns NULL if an error occurs.

Description

cgCreatePassAnnotation adds a new annotation to a pass.

Examples

/* create a float annotation named "Apple" for CGpass pass */
CGannotation ann = cgCreatePassAnnotation( pass, "Apple", CG_FLOAT );

Errors

CG_INVALID_PASS_HANDLE_ERROR is generated if pass is not a valid pass.

CG_DUPLICATE_NAME_ERROR is generated if name is already used by an annotation for this pass.

CG_INVALID_ENUMERANT_ERROR is generated if type is not CG_INT, CG_FLOAT, CG_BOOL, or CG_STRING.

History

cgCreatePassAnnotation was introduced in Cg 1.5.

See Also

cgGetNamedPassAnnotation, cgGetFirstPassAnnotation, cgGetNextAnnotation