NAME

cgGetFirstStateAssignment - get the first state assignment in a pass

SYNOPSIS

  #include <Cg/cg.h>

  CGstateassignment cgGetFirstStateAssignment( CGpass pass );

PARAMETERS

pass

The pass from which to retrieve the first state assignment.

RETURN VALUES

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

DESCRIPTION

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

EXAMPLES

to-be-written

ERRORS

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

HISTORY

cgGetFirstStateAssignment was introduced in Cg 1.4.

SEE ALSO

cgGetNextStateAssignment, cgIsStateAssignment