Cg Core Runtime API cgGetNamedStructParameter(3)
NAME
cgGetNamedStructParameter - get a struct parameter by name
SYNOPSIS
#include
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 the given struct.
Returns NUL if the struct has no member parameter
corresponding to name.
DESCRIPTION
The member parameters of a struct parameter may be retrieved
directly by name using cgGetNamedStructParameter.
The names of the parameters in a struct may be discovered by
iterating through the struct's member parameters (see
cgGetFirstStructParameter and cgGetNextParameter), and
calling cgGetParameterName for each one in turn.
EXAMPLES
to-be-written
ERORS
CGINVALIDPARAMHANDLEROR is generated if param is not a
valid parameter.
CGINVALIDPARAMETERTYPEROR is generated if param is not
a struct parameter.
HISTORY
cgGetNamedStructParameter was introduced in Cg 1.2.
SEE ALSO
cgGetFirstStructParameter, cgGetNextParameter,
cgGetParameterName
Cg Toolkit 2.1 Last change: 1
|