Edit

ID3D12Object::SetName method (d3d12.h)

  • Article

Associates a name with the device object. This name is for use in debug diagnostics and tools.

Syntax

HRESULT SetName(
  [in] LPCWSTR Name
);

Parameters

[in] Name

Type: LPCWSTR

A NULL-terminated UNICODE string that contains the name to associate with the device object.

Return value

Type: HRESULT

This method returns one of the Direct3D 12 Return Codes.

Remarks

This method takes UNICODE names.

Note that this is simply a convenience wrapper around ID3D12Object::SetPrivateData with WKPDID_D3DDebugObjectNameW. Therefore names which are set with SetName can be retrieved with ID3D12Object::GetPrivateData with the same GUID. Additionally, D3D12 supports narrow strings for names, using the WKPDID_D3DDebugObjectName GUID directly instead.

Requirements

Requirement Value
Target Platform Windows
Header d3d12.h
Library D3D12.lib
DLL D3D12.dll

See also

Direct3D 12 Programming Environment Setup

ID3D12Object