Edit

Share via

D3D12DDI_CLEAR_VALUES structure (d3d12umddi.h)

  • Article

The D3D12DDI_CLEAR_VALUES structure contains values used to optimize clear operations for a particular resource.

Syntax

typedef struct D3D12DDI_CLEAR_VALUES {
  DXGI_FORMAT Format;
  union {
    FLOAT                         Color[4];
    D3D12DDI_DEPTH_STENCIL_VALUES DepthStencil;
  };
} D3D12DDI_CLEAR_VALUES;

Members

Format

Specifies one member of the DXGI_FORMAT enumeration.

The format of the commonly cleared color follows the same validation rules as a view/descriptor creation. In general, the format of the clear color can be any format in the same type-less group that the resource format belongs to.

This Format must match the format of the view used during the clear operation. It indicates whether the Color or the DepthStencil member is valid and how to convert the values for usage with the resource.

Color[4]

The color value that the driver should clear.

DepthStencil

Pointer to a D3D12DDI_DEPTH_STENCIL_VALUES structure that contains the depth and stencil buffer the driver should clear.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1809
Header d3d12umddi.h