NAME

cgGetNamedParameterAnnotation - get a parameter annotation by name

SYNOPSIS

  #include <Cg/cg.h>

  CGannotation cgGetNamedParameterAnnotation( CGparameter param,
                                              const char * name );

PARAMETERS

param

The parameter from which to retrieve the annotation.

name

The name of the annotation to retrieve.

RETURN VALUES

Returns the named annotation. If the parameter has no annotation corresponding to name, NULL is returned.

DESCRIPTION

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

EXAMPLES

The following example code illustrates the use of cgGetNamedParameterAnnotation:

  /* fetch annotation "Apple" from CGparameter param */
  CGannotation ann = cgGetNamedParameterAnnotation( param, "Apple" );
  while( ann )
  {
     /* do something with ann */
     ann = cgGetNextAnnotation( ann );
  }

ERRORS

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

HISTORY

cgGetNamedParameterAnnotation was introduced in Cg 1.4.

SEE ALSO

cgGetFirstParameterAnnotation, cgGetNextParameterAnnotation, cgGetAnnotationName