NAME

cgCreateSamplerState - create a new sampler state definition

SYNOPSIS

  #include <Cg/cg.h>

  CGstate cgCreateSamplerState(CGcontext cgfx, const char *name, CGtype type);

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.

DESCRIPTION

cgCreateSamplerState adds a new 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 the "cgCreateArraySamplerState" document.

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

RETURN VALUES

cgCreateSamplerState 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. (Array-typed state should be created with the "cgCreateArrayState" document.)

SEE ALSO

the "cgCreateArraySamplerState" document, the "cgGetStateName" document, the "cgGetStateType" document, the "cgIsState" document, and the "cgGLRegisterStates" document.