Name

cgGetStringStateAssignmentValue - get a string-valued state assignment's values

Synopsis

#include <Cg/cg.h>

const char * cgGetStringStateAssignmentValue( CGstateassignment sa );

Parameters

sa
The state assignment.

Return Values

Returns a pointer to a string.

Returns NULL if an error occurs.

Description

cgGetStringStateAssignmentValue allows the application to retrieve the value(s) of a string 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_STATE_ASSIGNMENT_TYPE_MISMATCH_ERROR is generated if sa is not a state assignment of a string type.

History

cgGetStringStateAssignmentValue was introduced in Cg 1.4.

See Also

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