NAME

cgGetBoolStateAssignmentValues - get a bool-valued state assignment's values

SYNOPSIS

  #include <Cg/cg.h>

  const CGbool * cgGetBoolStateAssignmentValues( CGstateassignment sa,
                                                 int * nvalues );

PARAMETERS

sa

The state assignment.

nvalues

Pointer to integer where the number of values returned 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.

If no values are available, NULL will be returned and nvalues will be 0.

DESCRIPTION

cgGetBoolStateAssignmentValues allows the application to retrieve the value(s) of a boolean typed state assignment.

EXAMPLES

to-be-written

ERRORS

CG_INVALID_STATE_ASSIGNMENT_HANDLE_ERROR is generated if the handle sa is invalid.

CG_INVALID_PARAMETER_ERROR is generated if nvalues is NULL.

CG_INVALID_PARAMETER_TYPE_ERROR is generated if the state assignment is not bool-typed.

HISTORY

cgGetBoolStateAssignmentValues was introduced in Cg 1.4.

SEE ALSO

cgGetStateAssignmentState, cgGetStateType, cgGetFloatStateAssignmentValues, cgGetIntStateAssignmentValues, cgGetStringStateAssignmentValue, cgGetProgramStateAssignmentValue, cgGetSamplerStateAssignmentValue, cgGetTextureStateAssignmentValue