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

RenderTextureFormat.Depth

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

A depth render texture format.

Depth format is used to render high precision "depth" value into a render texture. Which format is actually used depends on platform support and on the number of depth bits you request through the constructor.

You can also set an exact depth-stencil format with RenderTexture.depthStencilFormat or a RenderTexture constructor that takes GraphicsFormat. Use SystemInfo.IsFormatSupported to check your platform supports this.

When writing shaders that use or render into a depth texture, care must be taken to ensure that they work both on OpenGL and on Direct3D, see depth textures documentation.

Note that not all graphics cards support depth textures. Use SystemInfo.SupportsRenderTextureFormat to check for support.

Additional resources: RenderTexture class, SystemInfo.SupportsRenderTextureFormat.