NAME

cgGetFirstStateAssignment - get the first state assignment in a pass

SYNOPSIS

  #include <Cg/cg.h>

  CGstateassignment cgGetFirstStateAssignment( CGpass pass );

PARAMETERS

pass

Specifies the pass to retrieve the first state assignment from.

DESCRIPTION

cgGetFirstStateAssignment is used to begin iteration over all of the state assignment contained within a pass. See the "cgGetNextStateAssignment" document for more information.

RETURN VALUES

cgGetFirstStateAssignment returns a the first CGstateassignment object in pass. If pass cointains no programs, NULL is returned.

ERRORS

CG_INVALID_PASS_HANDLE_ERROR is generated if pass does not refer to a valid pass.

SEE ALSO

the "cgGetNextStateAssignment" document, and the "cgIsStateAssignment" document