Name

cgGetNamedSamplerState - get a sampler state by name

Synopsis

#include <Cg/cg.h>

CGstate cgGetNamedSamplerState( CGcontext context,
                                const char * name );

Parameters

context

The context from which to retrieve the named sampler state.

name

The name of the state to retrieve.

Return Values

Returns the named sampler state.

Returns NULL if context is invalid or if context has no sampler states corresponding to name.

Description

The sampler states associated with a context, as specified with a sampler_state block in an effect file, can be retrieved directly by name using cgGetNamedSamplerState.

Examples

to-be-written

Errors

CG_INVALID_CONTEXT_HANDLE_ERROR is generated if context is not a valid context.

CG_INVALID_PARAMETER_ERROR is generated if name is NULL.

History

cgGetNamedSamplerState was introduced in Cg 1.4.

See Also

cgCreateArraySamplerState, cgCreateSamplerState, cgGetFirstSamplerState, cgSetSamplerState