D3D12_DEPTH_STENCIL_VIEW_DESC

Describes the subresources of a texture that are accessible from a depth-stencil view.

Syntax

typedef struct D3D12_DEPTH_STENCIL_VIEW_DESC
{
    DXGI_FORMAT Format;
    D3D12_DSV_DIMENSION ViewDimension;
    D3D12_DSV_FLAGS Flags;
    D3D12_TEX1D_DSV Texture1D;
    D3D12_TEX1D_ARRAY_DSV Texture1DArray;
    D3D12_TEX2D_DSV Texture2D;
    D3D12_TEX2D_ARRAY_DSV Texture2DArray;
    D3D12_TEX2DMS_DSV Texture2DMS;
    D3D12_TEX2DMS_ARRAY_DSV Texture2DMSArray;
} D3D12_DEPTH_STENCIL_VIEW_DESC

Members

Format
Type: DXGI_FORMAT A DXGI_FORMAT-typed value that specifies the viewing format. For allowable formats, see Remarks. ViewDimension
Type: D3D12_DSV_DIMENSION A D3D12_DSV_DIMENSION-typed value that specifies how the depth-stencil resource will be accessed. This member also determines which _DSV to use in the following union. Flags
Type: D3D12_DSV_FLAGS A combination of D3D12_DSV_FLAGS enumeration constants that are combined by using a bitwise OR operation. The resulting value specifies whether the texture is read only. Pass 0 to specify that it isn’t read only; otherwise, pass one or more of the members of the D3D12_DSV_FLAGS enumerated type. Texture1D
Type: D3D12_TEX1D_DSV A D3D12_TEX1D_DSV structure that specifies a 1D texture subresource. Texture1DArray
Type: D3D12_TEX1D_ARRAY_DSV A D3D12_TEX1D_ARRAY_DSV structure that specifies an array of 1D texture subresources. Texture2D
Type: D3D12_TEX2D_DSV A D3D12_TEX2D_DSV structure that specifies a 2D texture subresource. Texture2DArray
Type: D3D12_TEX2D_ARRAY_DSV A D3D12_TEX2D_ARRAY_DSV structure that specifies an array of 2D texture subresources. Texture2DMS
Type: D3D12_TEX2DMS_DSV A D3D12_TEX2DMS_DSV structure that specifies a multisampled 2D texture. Texture2DMSArray
Type: D3D12_TEX2DMS_ARRAY_DSV A D3D12_TEX2DMS_ARRAY_DSV structure that specifies an array of multisampled 2D textures.

Remarks

These are valid formats for a depth-stencil view:

DXGI_FORMAT_D16_UNORM
DXGI_FORMAT_D24_UNORM_S8_UINT
DXGI_FORMAT_D32_FLOAT
DXGI_FORMAT_D32_FLOAT_S8X24_UINT
DXGI_FORMAT_UNKNOWN

A depth-stencil view can’t use a typeless format. If the format chosen is DXGI_FORMAT_UNKNOWN, the format of the parent resource is used. Pass a depth-stencil-view description into ID3D12Device::CreateDepthStencilView to create a depth-stencil view.

Requirements

Header: d3d12_xs.h or d3d12_x.h
Library: d3d12_xs.lib or d3d12_x.lib
Supported Platforms: XBOX Series consoles and XBOX One family

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Syntax

Members

Remarks

Requirements

See Also

​Syntax

​Members

​Remarks

​Requirements

​See Also

Syntax

Members

Remarks

Requirements

See Also