NAME
cgGetStateAssignmentIndex - get the array index of a state assignment for array-valued state
SYNOPSIS
#include <Cg/cg.h> int cgGetStateAssignmentIndex( CGstateassignment sa );PARAMETERS
- sa
The state assignment.
RETURN VALUES
Returns an integer index value. If the CGstate for this state assignment is not an array type, zero is returned.
DESCRIPTION
cgGetStateAssignmentIndex returns the array index of a state assignment if the state it is based on is an array type. For example, if there is a "LightPosition" state defined as an array of eight float3 values, then given an effect file with the state assignment:
pass { LightPosition[3] = float3(10,0,0); }Then when cgGetStateAssignmentIndex is passed a handle to this state assignment, it will return the value three.
EXAMPLES
to-be-written
ERRORS
CG_INVALID_STATE_ASSIGNMENT_HANDLE_ERROR is generated if the handle sa is invalid.
HISTORY
cgGetStateAssignmentIndex was introduced in Cg 1.4.
SEE ALSO