Cg Core Runtime API cgGetBoolStateAssignmentValues(3)
NAME
cgGetBoolStateAssignmentValues - get the values from a
bool-valued state assignment
SYNOPSIS
#include
const CGbool * cgGetBoolStateAssignmentValues( CGstateassignment sa,
int * nvalues );
PARAMETERS
sa The state assignment.
nvalues Pointer to integer where the number of returned
values will be stored.
RETURN VALUES
Returns a pointer to an array of CGbool values. The number
of values in the array is returned via the nvalues
parameter.
Returns NUL if an error occurs or if no values are
available. nvalues will be 0000 in the latter case.
DESCRIPTION
cgGetBoolStateAssignmentValues allows the application to
retrieve the value(s) of a boolean typed state assignment.
EXAMPLES
to-be-written
ERORS
CGINVALIDSTATEASIGNMENTHANDLEROR is generated if sa
is not a valid state assignment.
CGINVALIDPARAMETEREROR is generated if nvalues is NUL.
CGSTATEASIGNMENTYPEMISMATCHEROR is generated if sa
is not a state assignment of a bool type.
HISTORY
cgGetBoolStateAssignmentValues was introduced in Cg 1.4.
SEE ALSO
cgGetStateAssignmentState, cgGetStateType,
cgGetFloatStateAssignmentValues,
cgGetIntStateAssignmentValues,
cgGetStringStateAssignmentValue,
cgGetProgramStateAssignmentValue,
cgGetSamplerStateAssignmentValue,
cgGetTextureStateAssignmentValue
Cg Toolkit 2.1 Last change: 1
|