NAME

cgCreateArrayState - create a new array-typed state definition

SYNOPSIS

  #include <Cg/cg.h>

  CGstate cgCreateArrayState(CGcontext cgfx, const char *name, CGtype type, int nelems);

PARAMETERS

ctx

Specifies the context to define the state in.

name

Specifies the name of the new state.

type

Specifies the type of the new state.

nelems

Specifies the number of elements in the array.

DESCRIPTION

cgCreateArrayState adds a new array-typed state definition to the context. When a CgFX file is later added to the context, all state assignments in passes in the file must have been defined ahead of time via a call to the "cgCreateState" document or cgCreateArrayState.

Applications will typically call the "cgSetStateCallbacks" document shortly after creating a new state with cgCreateState.

RETURN VALUES

cgCreateArrayState returns a handle to the newly created CGstate. If there is an error, NULL is returned.

ERRORS

CG_INVALID_CONTEXT_HANDLE_ERROR is generated if ctx does not refer to a valid context.

CG_INVALID_PARAMETER_ERROR is generated if name is NULL or not a valid identifier, as well as if type is not a simple scalar, vector, or matrix-type, or if nelems is not a positive number.

SEE ALSO

the "cgCreateArrayState" document, the "cgGetStateName" document, the "cgGetStateType" document, the "cgIsState" document, the "cgSetStateCallbacks" document, and the "cgGLRegisterStates" document.