NAME

cgGetFirstSamplerState - get the first sampler state definition in a context

SYNOPSIS

  #include <Cg/cg.h>

  CGstate cgGetFirstSamplerState( CGcontext ctx );

PARAMETERS

ctx

Specifies the context to retrieve the first sampler state definition from.

DESCRIPTION

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

RETURN VALUES

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

ERRORS

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

SEE ALSO

the "cgGetNextSamplerState" document, the "cgGetNamedSamplerState" document, and the "cgIsSamplerState" document