Edit

Share via

ID3D11DeviceContext::ClearRenderTargetView method (d3d11.h)

  • Article

Set all the elements in a render target to one value.

Syntax

void ClearRenderTargetView(
  [in] ID3D11RenderTargetView *pRenderTargetView,
  [in] const FLOAT [4]        ColorRGBA
);

Parameters

[in] pRenderTargetView

Type: ID3D11RenderTargetView*

Pointer to the render target.

[in] ColorRGBA

Type: const FLOAT[4]

A 4-component array that represents the color to fill the render target with.

Return value

None

Remarks

Applications that wish to clear a render target to a specific integer value bit pattern should render a screen-aligned quad instead of using this method. The reason for this is because this method accepts as input a floating point value, which may not have the same bit pattern as the original integer.

Differences between Direct3D 9 and Direct3D 11/10:

Unlike Direct3D 9, the full extent of the resource view is always cleared. Viewport and scissor settings are not applied.
 

When using D3D_FEATURE_LEVEL_9_x, ClearRenderTargetView only clears the first array slice in the render target view. This can impact (for example) cube map rendering scenarios. Applications should create a render target view for each face or array slice, then clear each view individually.

Requirements

Requirement Value
Target Platform Windows
Header d3d11.h
Library D3D11.lib

See also

ID3D11DeviceContext