PFND3D11DDI_RECYCLECOMMANDLIST callback function (d3d10umddi.h)

Article
04/01/2021

The RecycleCommandList function recycles a command list.

Syntax

PFND3D11DDI_RECYCLECOMMANDLIST Pfnd3d11ddiRecyclecommandlist;

void Pfnd3d11ddiRecyclecommandlist(
  D3D10DDI_HDEVICE unnamedParam1,
  D3D11DDI_HCOMMANDLIST unnamedParam2
)
{...}

Parameters

unnamedParam1

hDevice [in]

A handle to the display device (graphics context).

unnamedParam2

hCommandList [in]

An immediate-context handle to the driver's private data for the command list to recycle.

Return value

None

Remarks

The driver can use the pfnSetErrorCb callback function to set an error code.

The driver is only required to implement RecycleCommandList if the driver supports the D3D11DDICAPS_COMMANDLISTS_BUILD_2 threading-capability bit. The driver can return D3D11DDICAPS_COMMANDLISTS_BUILD_2 in the Caps member of the D3D11DDI_THREADING_CAPS structure from a call to the driver's GetCaps(D3D10_2) function.

For more information about RecycleCommandList, see Optimization for Small Command Lists.

The driver should not encounter any error, except for D3DDDIERR_DEVICEREMOVED. Therefore, if the driver passes any error, except for D3DDDIERR_DEVICEREMOVED, in a call to the pfnSetErrorCb function, the Direct3D runtime determines that the error is critical. Even if the device is removed, the driver is not required to return D3DDDIERR_DEVICEREMOVED. However, if device removal interferes with the operation of RecycleCommandList (which typically should not happen), the driver can return D3DDDIERR_DEVICEREMOVED.

Requirements

Requirement	Value
Minimum supported client	RecycleCommandList is supported beginning with the Windows 7 operating system.
Target Platform	Desktop
Header	d3d10umddi.h (include D3d10umddi.h)