Edit

ID3D12GraphicsCommandList4::DispatchRays method (d3d12.h)

  • Article

Launch the threads of a ray generation shader.

Syntax

void DispatchRays(
  [in] const D3D12_DISPATCH_RAYS_DESC *pDesc
);

Parameters

[in] pDesc

A description of the ray dispatch

Return value

None

Remarks

This method can be called from graphics or compute command lists and bundles.

A raytracing pipeline state must be set on the command list. Otherwise, the behavior of this call is undefined.

There are 3 dimensions passed in to set the grid size: width/height/depth. These dimensions are constrained such that width * height * depth <= 2^30. Exceeding this produces undefined behavior. If any grid dimension is 0, no threads are launched.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1809 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Target Platform Windows
Header d3d12.h
Library D3D12.lib
DLL D3D12.dll

See also

ID3D12GraphicsCommandList4