cgGetBoolStateAssignmentValues
Keywords: cgGetBoolStateAssignmentValues, NVIDIA, NVIDIA Cg Toolkit, Cg Toolkit, Shader, Shader Programming, GPU Shader Programming, GPU Program

> ## Name

> cgGetBoolStateAssignmentValues - get the values from a bool-valued state assignment

> ## 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 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 NULL if an error occurs or if no values are available. nvalues will be 0 in the latter case.

> ## 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 sa is not a valid state assignment.

> CG_INVALID_PARAMETER_ERROR is generated if nvalues is NULL.

> CG_STATE_ASSIGNMENT_TYPE_MISMATCH_ERROR 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