cgGetStringStateAssignmentValue

Langue: en

Version: 47068 (openSuse - 09/10/07)

Section: 3 (Bibliothèques de fonctions)

Sommaire

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

cgGetStringStateAssignmentValues 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

the cgGetStateAssignmentState manpage, the cgGetStateType manpage, the cgGetFloatStateAssignmentValues manpage, the cgGetIntStateAssignmentValues manpage, the cgGetBoolStateAssignmentValue manpage, the cgGetProgramStateAssignmentValue manpage, the cgGetSamplerStateAssignmentValue manpage, the cgGetTextureStateAssignmentValue manpage