NAME

cgGetNamedStructParameter - get a struct parameter by name

SYNOPSIS

  #include <Cg/cg.h>

  CGparameter cgGetNamedStructParameter( CGparameter param,
                                         const char * name );

PARAMETERS

param

The struct parameter from which to retrieve the member parameter.

name

The name of the member parameter to retrieve.

RETURN VALUES

Returns the member parameter from of the given struct. If the struct has no member parameter corresponding to name, a NULL is returned ( cgIsParameter returns CG_FALSE for invalid parameters).

DESCRIPTION

The member parameters of a struct parameter my be retrieved directly by name using the cgGetNamedStructParameter function.

The names of the parameters in a struct may be discovered by iterating through the struct's member parameters (see cgGetFirstStructParameter), and calling cgGetParameterName for each one in turn.

EXAMPLES

to-be-written

ERRORS

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

CG_INVALID_PARAMETER_ERROR is generated if name is NULL.

HISTORY

cgGetNamedParameter was introduced in Cg 1.2.

SEE ALSO

cgGetFirstStructParameter, cgGetNextParameter, cgIsParameter, cgGetParameterName