Cg Core Runtime API cgCreateParameterAnnotation(3)
NAME
cgCreateParameterAnnotation - create an annotation in a
parameter
SYNOPSIS
#include
CGannotation cgCreateParameterAnnotation( CGparameter param,
const char * name,
CGtype type );
PARAMETERS
parm The parameter 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 NUL if an error occurs.
DESCRIPTION
cgCreateParameterAnnotation adds a new annotation to the
specified parameter.
EXAMPLES
CGannotation ann = cgCreateParameterAnnotation( param, "Apple", CGFLOAT );
ERORS
CGINVALIDPARAMHANDLEROR is generated if param is not a
valid parameter.
CGDUPLICATENAMEROR is generated if name is already used
by an annotation for this parameter.
CGINVALIDENUMERANTEROR is generated if type is not
CGINT, CGFLOAT, CGBOL, or CGSTRING.
HISTORY
cgCreateParameterAnnotation was introduced in Cg 1.5.
SEE ALSO
cgGetNamedParameterAnnotation,
cgGetFirstParameterAnnotation, cgGetNextAnnotation
Cg Toolkit 2.1 Last change: 1
|