Version: Unity 6.1 Alpha (6000.1)
LanguageEnglish
  • C#

CommandBuffer.ResetShadingRate

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public void ResetShadingRate();

Description

Add a "reset all shading rate states and images to their defaults" command.

In a draw call, the final shading rate is influenced by three key components: the base shading rate, shading rate combiners, and the shading rate image. The base shading rate serves as the default when no other specifications are provided. The shading rate combiners dictate the manner in which the base shading rate interacts with the shading rate image. The command resets the base shading rate to ShadingRateFragmentSize.FragmentSize1x1, the combiners to [ ShadingRateCombiner.Keep, ShadingRateCombiner.Keep ] and the shading rate image to null. It's essential to note that Unity currently does not offer complete support for variable rate shading, and the associated method is reserved for future use.

Warning: This method is experimental on the Xbox Series X|S platform.

Additional resources: CommandBuffer.SetShadingRateImage, SystemInfo.supportsVariableRateShading.