CreateRootSignature

Creates a root signature layout.

Syntax

HRESULT CreateRootSignature(
    UINT nodeMask,
    const void  pBlobWithRootSignature,
    SIZE_T blobLengthInBytes,
    const IID & riid,
    void  ppvRootSignature
)

Parameters

nodeMask [in]
Type: UINT For single GPU operation, set this to zero. If there are multiple GPU nodes, set bits to identify the nodes (the device’s physical adapters) to which the root signature is to apply. Each bit in the mask corresponds to a single node. Refer to Multi-adapter systems. pBlobWithRootSignature [in]
Type: const void * A pointer to the source data for the serialized signature. blobLengthInBytes [in]
Type: SIZE_T The size, in bytes, of the block of memory that pBlobWithRootSignature points to. riid
Type: const IID & The globally unique identifier (GUID) for the root signature interface. See Remarks. An input parameter. ppvRootSignature [out]
Type: void ** A pointer to a memory block that receives a pointer to the root signature.

Return value

Type: HRESULT Returns S_OK if successful; otherwise, returns one of the Direct3D 12 Return Codes. This method returns E_INVALIDARG if the blob that pBlobWithRootSignature points to is invalid.

Remarks

If an application procedurally generates a D3D12_ROOT_SIGNATURE_DESC data structure, it must pass a pointer to this D3D12_ROOT_SIGNATURE_DESC in a call to D3D12SerializeRootSignature to make the serialized form. The application then passes the serialized form to pBlobWithRootSignature in a call to ID3D12Device::CreateRootSignature. The REFIID, or GUID, of the interface to the root signature layout can be obtained by using the __uuidof() macro. For example, __uuidof(ID3D12RootSignature) will get the GUID of the interface to a root signature.

Examples

The D3D12HelloTriangle sample uses ID3D12Device::CreateRootSignature as follows: Create an empty root signature.

CD3DX12_ROOT_SIGNATURE_DESC rootSignatureDesc;
rootSignatureDesc.Init(0, nullptr, 0, nullptr, D3D12_ROOT_SIGNATURE_FLAG_ALLOW_INPUT_ASSEMBLER_INPUT_LAYOUT);

ComPtr<ID3DBlob> signature;
ComPtr<ID3DBlob> error;
ThrowIfFailed(D3D12SerializeRootSignature(&rootSignatureDesc, D3D_ROOT_SIGNATURE_VERSION_1, &signature, &error));
ThrowIfFailed(m_device->CreateRootSignature(0, signature->GetBufferPointer(), signature->GetBufferSize(), IID_PPV_ARGS(&m_rootSignature)));

Requirements

Header: d3d12_xs.h or d3d12_x.h
Library: d3d12_xs.lib or d3d12_x.lib
Supported Platforms: XBOX Series consoles and XBOX One family

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Syntax

Parameters

Return value

Remarks

Examples

Requirements

See Also

​Syntax

​Parameters

​Return value

​Remarks

​Examples

​Requirements

​See Also

Syntax

Parameters

Return value

Remarks

Examples

Requirements

See Also