NAME

cgGetFirstParameterAnnotation - get the first annotation of a parameter

SYNOPSIS

  #include <Cg/cg.h>

  CGannotation cgGetFirstParameterAnnotation( CGparameter param );

PARAMETERS

param

Specifies the parameter to retrieve the annotation from.

DESCRIPTION

The annotations associated with a parameter can be retrieved using the cgGetFirstParameterAnnotation function. The remainder of the parameter'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 parameter has no annotations, NULL is returned.

ERRORS

CG_INVALID_PARAMETER_HANDLE_ERROR is generated if param does not refer to a valid parameter.

SEE ALSO

cgGetNamedParameterAnnotation, cgGetNextAnnotation