Version: 2023.2
LanguageEnglish
  • C#

DepthState

struct in UnityEngine.Rendering

/

Implemented in:UnityEngine.CoreModule

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

Values for the depth state.

Use this with RenderStateBlock and ScriptableRenderContext.DrawRenderers to override the GPU's render state.

Corresponds to the ZTest and ZWrite commands in ShaderLab.

Additional resources: RenderStateBlock, [[ScriptableRenderContext.DrawRenderers], ShaderLab command: ZTest, ShaderLab command: ZWrite.

Static Properties

defaultValueDefault values for the depth state.

Properties

compareFunctionHow should depth testing be performed.
writeEnabledControls whether pixels from this object are written to the depth buffer.

Constructors

DepthStateCreates a new depth state with the given values.