NAME

cgGetStateName - get a state's name

SYNOPSIS

  #include <Cg/cg.h>

  const char * cgGetStateName( CGstate state );

PARAMETERS

state

Specifies the state.

DESCRIPTION

cgGetStateName allows the application to retrieve the name of a state defined in a Cg context. This name can be used later to retrieve the state from the context using cgGetNamedState.

RETURN VALUES

Returns the null-terminated name string for the state.

Returns null if state is invalid.

ERRORS

CG_INVALID_STATE_HANDLE_ERROR is generated if state does not refer to a valid state.

SEE ALSO

the "cgGetNamedState" document, the "cgGetFirstState" document, and the "cgGetNextState" document,