ID3D12GraphicsCommandList::ClearUnorderedAccessViewFloat method

Sets all the elements in a unordered access view to the specified float values.

Syntax

void ClearUnorderedAccessViewFloat(
  [in]       D3D12_GPU_DESCRIPTOR_HANDLE ViewGPUHandleInCurrentHeap,
  [in]       D3D12_CPU_DESCRIPTOR_HANDLE ViewCPUHandle,
  [in]       ID3D12Resource              *pResource,
  [in] const FLOAT                       Values[4],
  [in]       UINT                        NumRects,
  [in] const D3D12_RECT                  *pRects
);

Parameters

ViewGPUHandleInCurrentHeap [in]

Type: D3D12_GPU_DESCRIPTOR_HANDLE

Describes the GPU descriptor handle that represents the start of the heap for the unordered-access view to clear.

ViewCPUHandle [in]

Type: D3D12_CPU_DESCRIPTOR_HANDLE

Describes the CPU descriptor handle that represents the start of the heap for the render target to clear.

pResource [in]

Type: ID3D12Resource*

A pointer to the ID3D12Resource interface that represents the unordered-access-view resource to clear.

Values [in]

Type: const FLOAT[4]

A 4-component array that containing the values to fill the unordered-access-view resource with.

NumRects [in]

Type: UINT

The number of rectangles in the array that the pRects parameter specifies.

pRects [in]

Type: const D3D12_RECT*

An array of D3D12_RECT structures for the rectangles in the resource view to clear. If NULL, ClearUnorderedAccessViewFloat clears the entire resource view.

Return value

This method does not return a value.

Remarks

Runtime validation

For floating-point inputs, the runtime will set denormalized values to 0 (while preserving NANs).

Validation failure will result in the call to Close returning E_INVALIDARG.

Debug layer

The debug layer will issue errors if the input values are outside of a normalized range.

The debug layer will issue an error if the subresources referenced by the view are not in the appropriate state. For ClearUnorderedAccessViewFloat, the state must be D3D12_RESOURCE_STATE_UNORDERED_ACCESS.

Requirements

See also

ID3D12GraphicsCommandList