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

RenderTexture.depthStencilFormat

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

Switch to Manual
public Experimental.Rendering.GraphicsFormat depthStencilFormat;

Description

The format of the depth/stencil buffer.

The returned format is the actual format that is used when RenderTexture.Create is called. This format can be different than the depth/stencil format that was set on the RenderTexture if that format is not supported on the current platform or graphics API. RenderTexture will automatically try to use a compatible format with more bits. If the format is not supported and when no compatible format is found on this platform then the original format will be returned. This fallback to a compatible format can be disabled on a RenderTexture asset in the inspector.

Additional resources: RenderTexture.depth, RenderTextureDescriptor.depthStencilFormat, GraphicsFormatUtility.GetDepthStencilFormat, GraphicsFormat.