NAME

cgCreateArraySamplerState - create a new array-typed sampler state definition

SYNOPSIS

  #include <Cg/cg.h>

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

PARAMETERS

ctx

Specifies the context to define the sampler state in.

name

Specifies the name of the new sampler state.

type

Specifies the type of the new sampler state.

nelems

Specifies the number of elements in the array.

DESCRIPTION

cgCreateArraySamplerState adds a new array-typed sampler state definition to the context. When an effect file is added to the context, all state in sampler_state blocks in must have been defined ahead of time via a call to cgCreateSamplerState or cgCreateArraySamplerState.

Applications will typically call cgSetStateCallbacks shortly after creating a new state with cgCreateArraySamplerState.

RETURN VALUES

cgCreateArraySamplerState 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

cgCreateSamplerState, cgGetStateName, cgGetStateType, cgIsState, cgSetStateCallbacks, and cgGLRegisterStates.