NAME

cgGetFirstSamplerState - get the first sampler state definition in a context

SYNOPSIS

  #include <Cg/cg.h>

  CGstate cgGetFirstSamplerState( CGcontext context );

PARAMETERS

context

The context from which to retrieve the first sampler state definition.

RETURN VALUES

cgGetFirstSamplerState returns a the first CGstate object in context. If context contains no programs, NULL is returned.

DESCRIPTION

cgGetFirstSamplerState is used to begin iteration over all of the sampler state definitions contained within a context. See cgGetNextSamplerState for more information.

EXAMPLES

to-be-written

ERRORS

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

HISTORY

cgGetFirstSamplerState was introduced in Cg 1.4.

SEE ALSO

cgGetNextSamplerState, cgGetNamedSamplerState, cgIsSamplerState