PFND3D11DDI_DESTROYCOMMANDLIST callback function

The DestroyCommandList function destroys a command list.

Syntax

PFND3D11DDI_DESTROYCOMMANDLIST Pfnd3d11ddiDestroycommandlist;

void Pfnd3d11ddiDestroycommandlist(
  D3D10DDI_HDEVICE Arg1,
  D3D11DDI_HCOMMANDLIST Arg2
)
{...}

Parameters

Arg1

hDevice [in]

A handle to the display device (graphics context).

Arg2

hCommandList [in]

A handle to the driver's private data for the command list to destroy. The Microsoft Direct3D runtime frees the memory region that it previously allocated for the command list. Therefore, the driver can no longer access this memory region.

Return Value

None

The driver can use the pfnSetErrorCb callback function to set an error code. For more information about setting error codes, see the following Remarks section.

Remarks

The driver is only required to implement DestroyCommandList if the driver supports the D3D11DDICAPS_COMMANDLISTS_BUILD_2 capability that can be returned in the D3D11DDI_THREADING_CAPS structure from a call to the GetCaps(D3D10_2) function.

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 DestroyCommandList (which typically should not happen), the driver can return D3DDDIERR_DEVICEREMOVED.

The driver can implement a DestroyCommandList function that contains a switch statement to process the destruction of command lists and the lightweight destruction of command lists. That is, the driver can implement one DestroyCommandList, and can set the pfnRecycleDestroyCommandList member of the D3D11DDI_DEVICEFUNCS structure to point to DestroyCommandList along with the pfnRecycleDestroyCommandList member of D3D11DDI_DEVICEFUNCS to point to DestroyCommandList. However, to improve performance, the driver can implement separate DestroyCommandList and RecycleDestroyCommandList functions.

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

Requirements

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

See Also

CreateCommandList

D3D11DDI_DEVICEFUNCS

D3D11DDI_THREADING_CAPS

GetCaps(D3D10_2)

pfnSetErrorCb