Home -> IStateContainer -> ResetStateValue

Description

The ResetStateValue method removes any state value which has been previously set by the SetStateValue method for the target shader state variable. If there is an inherited state value set higher up in the render tree, it will become effective. If there is no inherited state value, but there is a supplied default value specified in the shader, the default value will be restored, otherwise the effective state value is undefined.

Usage

void ResetStateValue(StateValueId stateId);
template<class... IndexTs>
void ResetStateValue(StateValueId stateId, size_t firstArrayIndex, IndexTs... additionalArrayIndices);
void ResetStateValue(StateValueId stateId, const size_t* arrayIndices, size_t arrayIndexCount);

Argument list

stateId [StateValueId]
The StateValueId of the target state variable
firstArrayIndex [size_t]
First array index when a variadic set of array indices are being supplied
additionalArrayIndices [size_t]
Additional array indices when a variadic set of array indices are being supplied
arrayIndices [const size_t*]
Pointer to a set of array indices to use for the target state value
arrayIndexCount [size_t]
The number of array indices to read from the arrayIndices member. The number of supplied indices must match the required number of indices for the target state value.

See also