OMSetRenderTargets

Sets CPU descriptor handles for the render targets and depth stencil.

Syntax

void OMSetRenderTargets(
    UINT NumRenderTargetDescriptors,
    const D3D12_CPU_DESCRIPTOR_HANDLE  pRenderTargetDescriptors,
    BOOL RTsSingleHandleToDescriptorRange,
    const D3D12_CPU_DESCRIPTOR_HANDLE  pDepthStencilDescriptor
)

Parameters

NumRenderTargetDescriptors [in]
Type: UINT The number of entries in the pRenderTargetDescriptors array (ranges between 0 and D3D12_SIMULTANEOUS_RENDER_TARGET_COUNT). If this parameter is nonzero, the number of entries in the array to which pRenderTargetDescriptors points must equal the number in this parameter. pRenderTargetDescriptors [in, optional]
Type: const D3D12_CPU_DESCRIPTOR_HANDLE * Specifies an array of D3D12_CPU_DESCRIPTOR_HANDLE structures that describe the CPU descriptor handles that represents the start of the heap of render target descriptors. If this parameter is NULL and NumRenderTargetDescriptors is 0, no render targets are bound. RTsSingleHandleToDescriptorRange [in]
Type: BOOL True means the handle passed in is the pointer to a contiguous range of NumRenderTargetDescriptors descriptors. This case is useful if the set of descriptors to bind already happens to be contiguous in memory (so all that’s needed is a handle to the first one). For example, if NumRenderTargetDescriptors is 3 then the memory layout is taken as follows:

In this case the driver dereferences the handle and then increments the memory being pointed to. False means that the handle is the first of an array of NumRenderTargetDescriptors handles. The false case allows an application to bind a set of descriptors from different locations at once. Again assuming that NumRenderTargetDescriptors is 3, the memory layout is taken as follows:

Memory layout with parameter set to false

In this case the driver dereferences three handles that are expected to be adjacent to each other in memory. pDepthStencilDescriptor [in, optional]
Type: const D3D12_CPU_DESCRIPTOR_HANDLE * A pointer to a D3D12_CPU_DESCRIPTOR_HANDLE structure that describes the CPU descriptor handle that represents the start of the heap that holds the depth stencil descriptor. If this parameter is NULL, no depth stencil descriptor is bound.

Return value

Type: void None.

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

Parameters

Return value

Requirements

See Also

​Syntax

​Parameters

​Return value

​Requirements

​See Also

Syntax

Parameters

Return value

Requirements

See Also