Core/RootSignature.h

   1 //
   2 // Copyright (c) Microsoft. All rights reserved.
   3 // This code is licensed under the MIT License (MIT).
   4 // THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF
   5 // ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY
   6 // IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR
   7 // PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.
   8 //
   9 // Developed by Minigraph
  10 //
  11 // Author:  James Stanard
  12 //
  13
  14 #pragma once
  15
  16 #include "pch.h"
  17
  18 class DescriptorCache;
  19
  20 class RootParameter
  21 {
  22     friend class RootSignature;
  23 public:
  24
  25     RootParameter() : m_RootParam({})
  26     {
  27         m_RootParam.ParameterType = (D3D12_ROOT_PARAMETER_TYPE)0xFFFFFFFF;
  28     }
  29
  30     ~RootParameter()
  31     {
  32         Clear();
  33     }
  34
  35     void Clear()
  36     {
  37         if (m_RootParam.ParameterType == D3D12_ROOT_PARAMETER_TYPE_DESCRIPTOR_TABLE)
  38             delete [] m_RootParam.DescriptorTable.pDescriptorRanges;
  39
  40         m_RootParam.ParameterType = (D3D12_ROOT_PARAMETER_TYPE)0xFFFFFFFF;
  41     }
  42
  43     void InitAsConstants( UINT Register, UINT NumDwords, D3D12_SHADER_VISIBILITY Visibility = D3D12_SHADER_VISIBILITY_ALL )
  44     {
  45         m_RootParam.ParameterType = D3D12_ROOT_PARAMETER_TYPE_32BIT_CONSTANTS;
  46         m_RootParam.ShaderVisibility = Visibility;
  47         m_RootParam.Constants.Num32BitValues = NumDwords;
  48         m_RootParam.Constants.ShaderRegister = Register;
  49         m_RootParam.Constants.RegisterSpace = 0;
  50     }
  51
  52     void InitAsConstantBuffer( UINT Register, D3D12_SHADER_VISIBILITY Visibility = D3D12_SHADER_VISIBILITY_ALL )
  53     {
  54         m_RootParam.ParameterType = D3D12_ROOT_PARAMETER_TYPE_CBV;
  55         m_RootParam.ShaderVisibility = Visibility;
  56         m_RootParam.Descriptor.ShaderRegister = Register;
  57         m_RootParam.Descriptor.RegisterSpace = 0;
  58     }
  59
  60     void InitAsBufferSRV( UINT Register, D3D12_SHADER_VISIBILITY Visibility = D3D12_SHADER_VISIBILITY_ALL )
  61     {
  62         m_RootParam.ParameterType = D3D12_ROOT_PARAMETER_TYPE_SRV;
  63         m_RootParam.ShaderVisibility = Visibility;
  64         m_RootParam.Descriptor.ShaderRegister = Register;
  65         m_RootParam.Descriptor.RegisterSpace = 0;
  66     }
  67
  68     void InitAsBufferUAV( UINT Register, D3D12_SHADER_VISIBILITY Visibility = D3D12_SHADER_VISIBILITY_ALL )
  69     {
  70         m_RootParam.ParameterType = D3D12_ROOT_PARAMETER_TYPE_UAV;
  71         m_RootParam.ShaderVisibility = Visibility;
  72         m_RootParam.Descriptor.ShaderRegister = Register;
  73         m_RootParam.Descriptor.RegisterSpace = 0;
  74     }
  75
  76     void InitAsDescriptorRange( D3D12_DESCRIPTOR_RANGE_TYPE Type, UINT Register, UINT Count, D3D12_SHADER_VISIBILITY Visibility = D3D12_SHADER_VISIBILITY_ALL )
  77     {
  78         InitAsDescriptorTable(1, Visibility);
  79         SetTableRange(0, Type, Register, Count);
  80     }
  81
  82     void InitAsDescriptorTable( UINT RangeCount, D3D12_SHADER_VISIBILITY Visibility = D3D12_SHADER_VISIBILITY_ALL )
  83     {
  84         m_RootParam.ParameterType = D3D12_ROOT_PARAMETER_TYPE_DESCRIPTOR_TABLE;
  85         m_RootParam.ShaderVisibility = Visibility;
  86         m_RootParam.DescriptorTable.NumDescriptorRanges = RangeCount;
  87         m_RootParam.DescriptorTable.pDescriptorRanges = new D3D12_DESCRIPTOR_RANGE[RangeCount];
  88     }
  89
  90     void SetTableRange( UINT RangeIndex, D3D12_DESCRIPTOR_RANGE_TYPE Type, UINT Register, UINT Count, UINT Space = 0 )
  91     {
  92         D3D12_DESCRIPTOR_RANGE* range = const_cast<D3D12_DESCRIPTOR_RANGE*>(m_RootParam.DescriptorTable.pDescriptorRanges + RangeIndex);
  93         range->RangeType = Type;
  94         range->NumDescriptors = Count;
  95         range->BaseShaderRegister = Register;
  96         range->RegisterSpace = Space;
  97         range->OffsetInDescriptorsFromTableStart = D3D12_DESCRIPTOR_RANGE_OFFSET_APPEND;
  98     }
  99
 100     const D3D12_ROOT_PARAMETER& operator() ( void ) const { return m_RootParam; }
 101
 102
 103 protected:
 104
 105     D3D12_ROOT_PARAMETER m_RootParam;
 106 };
 107
 108 // Maximum 64 DWORDS divied up amongst all root parameters.
 109 // Root constants = 1 DWORD * NumConstants
 110 // Root descriptor (CBV, SRV, or UAV) = 2 DWORDs each
 111 // Descriptor table pointer = 1 DWORD
 112 // Static samplers = 0 DWORDS (compiled into shader)
 113 class RootSignature
 114 {
 115     friend class DynamicDescriptorHeap;
 116
 117 public:
 118
 119     RootSignature( UINT NumRootParams = 0, UINT NumStaticSamplers = 0 ) : m_Finalized(FALSE), m_NumParameters(NumRootParams)
 120     {
 121         Reset(NumRootParams, NumStaticSamplers);
 122     }
 123
 124     ~RootSignature()
 125     {
 126     }
 127
 128     static void DestroyAll(void);
 129
 130     void Reset( UINT NumRootParams, UINT NumStaticSamplers = 0 )
 131     {
 132         if (NumRootParams > 0)
 133             m_ParamArray.reset(new RootParameter[NumRootParams]);
 134         else
 135             m_ParamArray = nullptr;
 136         m_NumParameters = NumRootParams;
 137
 138         if (NumStaticSamplers > 0)
 139             m_SamplerArray.reset(new D3D12_STATIC_SAMPLER_DESC[NumStaticSamplers]);
 140         else
 141             m_SamplerArray = nullptr;
 142         m_NumSamplers = NumStaticSamplers;
 143         m_NumInitializedStaticSamplers = 0;
 144     }
 145
 146     RootParameter& operator[] ( size_t EntryIndex )
 147     {
 148         ASSERT(EntryIndex < m_NumParameters);
 149         return m_ParamArray.get()[EntryIndex];
 150     }
 151
 152     const RootParameter& operator[] ( size_t EntryIndex ) const
 153     {
 154         ASSERT(EntryIndex < m_NumParameters);
 155         return m_ParamArray.get()[EntryIndex];
 156     }
 157
 158     void InitStaticSampler( UINT Register, const D3D12_SAMPLER_DESC& NonStaticSamplerDesc,
 159         D3D12_SHADER_VISIBILITY Visibility = D3D12_SHADER_VISIBILITY_ALL );
 160
 161     void Finalize(const std::wstring& name, D3D12_ROOT_SIGNATURE_FLAGS Flags = D3D12_ROOT_SIGNATURE_FLAG_NONE);
 162
 163     ID3D12RootSignature* GetSignature() const { return m_Signature; }
 164
 165 protected:
 166
 167     BOOL m_Finalized;
 168     UINT m_NumParameters;
 169     UINT m_NumSamplers;
 170     UINT m_NumInitializedStaticSamplers;
 171     uint32_t m_DescriptorTableBitMap;           // One bit is set for root parameters that are non-sampler descriptor tables
 172     uint32_t m_SamplerTableBitMap;                      // One bit is set for root parameters that are sampler descriptor tables
 173     uint32_t m_DescriptorTableSize[16];         // Non-sampler descriptor tables need to know their descriptor count
 174     std::unique_ptr<RootParameter[]> m_ParamArray;
 175     std::unique_ptr<D3D12_STATIC_SAMPLER_DESC[]> m_SamplerArray;
 176     ID3D12RootSignature* m_Signature;
 177 };