NAME

cgGetFirstState - get the first state definition in a context

SYNOPSIS

  #include <Cg/cg.h>

  CGstate cgGetFirstState( CGcontext context );

PARAMETERS

context

The context from which to retrieve the first state definition.

RETURN VALUES

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

DESCRIPTION

cgGetFirstState is used to begin iteration over all of the state definitions contained within a context. See cgGetNextState 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

cgGetFirstState was introduced in Cg 1.4.

SEE ALSO

cgGetNextState, cgGetNamedState, cgIsState