Version: 2022.2
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

GraphicsFormatUtility.GetDepthStencilFormat

Leave feedback
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 static Experimental.Rendering.GraphicsFormat GetDepthStencilFormat(int minimumDepthBits, int minimumStencilBits);

Parameters

minimumDepthBits Minimum number of bits that the format should have for the depth component.
minimumStencilBits Minimum number of bits that the format should have for the stencil component.

Returns

GraphicsFormat A GraphicFormat that has a depth and/or stencil component.

Description

Returns a supported depth stencil format that has 'minimumDepthBits' of bits or higher per pixel for the depth component if a compatible format exists on the current platform. If 'minimumStencilBits' is higher than 0, and a compatible format exists on the current platform, Unity returns a depth stencil format with 8 bits per pixel for the stencil component.

The minimum depth bits are rounded up to 16, 24 or 32 bits. If the minimum stencil bits are zero then the returned format will not contain a stencil component.

Returns 'GraphicsFormat.None' if no formats are supported on the current platform that have the minimum amount of bits for the components.

See Also: RenderTexture.depthStencilFormat, RenderTextureDescriptor.depthStencilFormat.

Copyright © 2023 Unity Technologies
优美缔软件（上海）有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961