Version: 2019.3
LanguageEnglish
  • C#

RenderTextureDescriptor.stencilFormat

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

Description

The format of the stencil data that is encapsulated in the render texture.

Specifying this property will create a stencil element for the render texture and set its format. This allows for stencil data to be bound as a texture to all shader types for the platforms that support it. This property does not specify the format of the stencil buffer, which is constrained by the depth buffer format specified in RenderTexture.depth.

At the moment, most platforms only support R8_UInt (DirectX11, DirectX12), while PS4 also supports R8_UNorm.