NAME

cgGetFirstState - get the first state definition in a context

SYNOPSIS

  #include <Cg/cg.h>

  CGstate cgGetFirstState( CGcontext ctx );

PARAMETERS

ctx

Specifies the context to retrieve the first state definition from.

DESCRIPTION

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

RETURN VALUES

cgGetFirstState 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 "cgGetNextState" document, the "cgGetNamedState" document, and the "cgIsState" document