cgGetNumDependentStateAssignmentParameters

Langue: en

Version: 47007 (openSuse - 09/10/07)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

cgGetNumDependentStateAssignmentParameters - get the number of effect parameters on which a state assignment depends

SYNOPSIS


  #include <Cg/cg.h>







  int cgGetNumDependentStateAssignmentParameters( CGstateassignment sa );

PARAMETERS


sa
The state assignment handle.

RETURN VALUES

Returns the number of parameters on which sa depends.

DESCRIPTION

State assignments in CgFX passes may include references to one or more effect parameters on the right hand side of the state assignment that are used for computing the state assignment's value. cgGetNumDependentStateAssignmentParameters returns the total number of such parameters. the cgGetDependentStateAssignmentParameter manpage can then be used to iterate over these parameters.

This information can be useful for applications that wish to cache the values of state assignments for customized state mangement so that they can determine which state assignments may change as the result of changing a parameter's value.

EXAMPLES

to-be-written

ERRORS

CG_INVALID_STATE_ASSIGNMENT_HANDLE_ERROR is generated if sa is not a valid state assignment.

HISTORY

cgGetNumDependentStateAssignmentParameters was introduced in Cg 1.4.

SEE ALSO

the cgGetDependentStateAssignmentParameter manpage, the cgGetFirstStateAssignment manpage, the cgGetNamedStateAssignment manpage, the cgGetNumDependentAnnotationParameters manpage