ID3D12DebugCommandList1::SetDebugParameter method (d3d12sdklayers.h)

  • Article

Modifies optional Debug Layer settings of a command list.

Syntax

HRESULT SetDebugParameter(
       D3D12_DEBUG_COMMAND_LIST_PARAMETER_TYPE Type,
  [in] const void                              *pData,
       UINT                                    DataSize
);

Parameters

Type

Type: D3D12_DEBUG_COMMAND_LIST_PARAMETER_TYPE

Specifies a D3D12_DEBUG_COMMAND_LIST_PARAMETER_TYPE value that indicates which debug parameter data to set.

[in] pData

Type: const void*

Pointer to debug parameter data to set. The interpretation of this data depends on the D3D12_DEBUG_COMMAND_LIST_PARAMETER_TYPE given in the Type parameter.

DataSize

Type: UINT

Specifies the size in bytes of the debug parameter pData.

Return value

Type: HRESULT

This method returns one of the Direct3D 12 Return Codes.

Remarks

Certain debug behaviors of D3D12 Debug Layer can be modified by setting debug parameters. These can be used to toggle extra validation or expose experimental debug features.

ID3D12DebugCommandList1::SetDebugParameter only impacts debug settings for the associated command list. For device-wide debug parameters see the ID3D12DebugDevice1::SetDebugParameter method.

Resetting a command list restores the debug parameters to the default values. This is because a command list reset is treated as equivalent to creating a new command list.

Requirements

Requirement Value
Target Platform Windows
Header d3d12sdklayers.h

See also

GetDebugParameter

ID3D12DebugCommandList1