DirectX11--深刻理解Effects十一、使用着色器反射機制(Shader Reflection)實現一個複雜Effects框架

前言

若是以前你是跟隨本教程系列學習的話,應該可以初步瞭解Effects11(現FX11)的實現機制,而且能夠編寫一個簡易的特效管理框架,可是隨着特效種類的增多,要管理的着色器、資源等也隨之變多。若是寫了一套由多個HLSL着色器組成特效,就仍須要在C++端編寫與HLSL相對應的特效框架,這樣寫起來依然是十分繁雜。之前學習龍書的DirectX11時,裏面使用的正是Effects11框架,不得不認可用它實現C++跟HLSL的交互的確方便了許多,可是時過境遷,微軟將會逐漸拋棄fx_5_0,且目前FX11也已經列爲Archived,再也不更新。都說若是要實現一個3D引擎的話,必需要有一個屬於本身的特效管理框架。html

本文假定讀者已經讀過至少前13章的內容,或者有較爲豐富的DirectX 11開發經歷。git

學習目標:github

  1. 熟悉着色器反射機制
  2. 實現一個複雜Effects框架,瞭解該框架的使用

DirectX11 With Windows SDK完整目錄windows

Github項目源碼api

歡迎加入QQ羣: 727623616 能夠一塊兒探討DX11,以及有什麼問題也能夠在這裏彙報。數組

先從Effects11(FX11)談起

DirectX的特效是包含管線狀態和着色器的集合,而Effects框架則正是用於管理這些特效的一套API。若是使用Effects11(FX11)框架的話,那麼在HLSL中除了自己的語法外,還支持Effects特有的語法,這些語法大部分通過解析後會轉化爲在C++中使用Direct3D的API。緩存

知己知彼,才能百戰不殆。要想寫好一個特效管理框架,首先要把Effects框架與C++的關係給分析透徹。下面的內容也會引用FX11的少許源碼來佐證。框架

Pass、Technique十一、Group

Pass:一個Pass由一組須要用到的着色器和一些渲染狀態組成。一般狀況下,咱們至少須要一個頂點着色器和一個像素着色器。若是是要進行流輸出,則至少須要一個頂點着色器和一個幾何着色器。而通用計算則須要的是計算着色器。除此以外,它在HLSL還支持一些額外的函數,用以改變一些渲染狀態。函數

Technique11:一個Technique由一個或多個Pass組成,用於建立一個渲染技術。有時候爲了實現一種特效,須要歷經多個Pass的處理才能實現,咱們稱之爲多通道渲染。好比實現OIT(順序無關透明度),第一趟Pass須要完成透明像素的收集,第二趟Pass則是將收集好的像素按深度排序,並將透明混合的結果渲染到目標。佈局

Group:一個Group由一個或多個Technique組成。

下面展現了一份比較隨性的fx5.0代碼的部分(注意:下面的代碼不屬於HLSL的語法!)

// 存在部分省略

GeometryShader pGSComp = CompileShader(gs_5_0, gsBase());
GeometryShader pGSwSO = ConstructGSWithSO(pGSComp, "0:Position.xy; 1:Position.zw; 2:Color.xy", 
                                                   "3:Texcoord.xyzw; 3:$SKIP.x;", NULL, NULL, 1);

// 此處省略着色器函數...

technique11 T0
{
    pass P0
    {
        SetVertexShader(CompileShader(vs_5_0, VS()));
        SetGeometryShader(NULL);
        SetPixelShader(CompileShader(ps_5_0, PS(true, false, true)));

        SetRasterizerState(g_NoCulling);
        SetDepthStencilState(NULL, 0);
        SetBlendState(EnableAlphaBlending, (float4)0, 0xFFFFFFFF);
    }
    
    Pass P1
    {
        SetVertexShader(CompileShader(vs_5_0, VS()));
        SetGeometryShader(pGSwSO);
        SetPixelShader(NULL);
    }
}

這裏面的函數調用大部分實際上都是在C++完成的,所以在Direct3D API中能夠找到對應的原型:

SetVertexShader()	// 等價於ID3D11DeviceContext::VSSetShader
SetGeometryShader()	// 等價於ID3D11DeviceContext::GSSetShader
SetPixelShader()	// 等價於ID3D11DeviceContext::PSSetShader

SetRasterizerState()	// 等價於ID3D11DeviceContext::RSSetState
SetDepthStencilState()	// 等價於ID3D11DeviceContext::OMSetDepthStencilState
SetBlendState()			// 等價於ID3D11DeviceContext::OMSetBlendState

ConstructGSWithSO()		// 等價於ID3D11Device::CreateGeometryShaderWithStreamOutput

而像VertexShaderPixelShader這些僅存在於fx5.0的語法,在C++中對應的是ID3D11VertexShaderID3D11PixelShader等等。

至於CompileShader,咱們能夠猜想內部使用的是相似D3DCompile這樣的函數,只不過這份源碼確定是須要通過特殊處理才能變成原生的HLSL代碼。

在C++端,編譯fx5.0可使用D3DCompileD3DCompileFromFile,而後再使用D3DX11CreateEffectFromMemory建立出Effects。只不過會收到這樣的警告:

X4717: Effects deprecated for D3DCompiler_47

渲染狀態、採樣器狀態

在fx5.0中可以建立出SamplerStateRasterizerStateBlendStateDepthStencilState,而且還能預先設置好內部的各項參數,就像下面這樣(注意:下面的代碼不屬於HLSL的語法!)

SamplerState g_SamAnisotropic
{
	Filter = ANISOTROPIC;
	MaxAnisotropy = 4;

	AddressU = WRAP;
	AddressV = WRAP;
	AddressW = WRAP;
};

RasterizerState g_NoCulling
{
    FillMode = Solid;
    CullMode = None;
    FrontCounterClockwise = false;
}

實際上,採樣器的狀態和渲染狀態都是在C++中完成的,上面的代碼翻譯成C++則變成相似這樣:

// g_SamAnisotropic
CD3D11_SAMPLER_DESC sampDesc(CD3D11_DEFAULT());
sampDesc.Filter = D3D11_FILTER_ANISOTROPIC;
sampDesc.MaxAnisotropy = 4;
sampDesc.AddressU = D3D11_TEXTURE_ADDRESS_WRAP;
sampDesc.AddressV = D3D11_TEXTURE_ADDRESS_WRAP;
sampDesc.AddressW = D3D11_TEXTURE_ADDRESS_WRAP;
device->CreateSamplerState(&sampDesc, SSAnistropicWrap.GetAddressOf());

// g_NoCulling
CD3D11_RASTERIZER_DESC rasterizerDesc(CD3D11_DEFAULT());
rasterizerDesc.FillMode = D3D11_FILL_SOLID;
rasterizerDesc.CullMode = D3D11_CULL_NONE;
rasterizerDesc.FrontCounterClockwise = false;
device->CreateRasterizerState(&rasterizerDesc, RSNoCull.GetAddressOf()));

常量緩衝區

之前在用fx5.0寫常量緩衝區的時候是這樣的:

cbuffer cbPerFrame
{
	DirectionalLight gDirLights[3];
	float3 gEyePosW;

	float  gFogStart;
	float  gFogRange;
	float4 gFogColor;
};

cbuffer cbPerObject
{
	float4x4 gWorld;
	float4x4 gWorldInvTranspose;
	float4x4 gWorldViewProj;
	float4x4 gTexTransform;
	Material gMaterial;
};

在你聲明瞭cbuffer後,Effects11(FX11)會在C++端建立出對應的常量緩衝區:

D3D11_BUFFER_DESC cbd;
ZeroMemory(&cbd, sizeof(cbd));
cbd.Usage = D3D11_USAGE_DYNAMIC;	// FX11內部使用的是D3D11_USAGE_DYNAMIC
cbd.BindFlags = D3D11_BIND_CONSTANT_BUFFER;
cbd.CPUAccessFlags = D3D11_CPU_ACCESS_WRITE;	// FX11內部是0
cbd.ByteWidth = byteWidth;
return device->CreateBuffer(&cbd, nullptr, cBuffer.GetAddressOf());

隱藏指定寄存器槽的問題

已知常量緩衝區有16個寄存器槽,那麼,怎麼肯定cbuffer當前使用的是哪一個槽呢?

  1. 有經過register(b#)指定寄存器槽位的cbuffer優先佔用
  2. 除去那些顯式指定槽位的cbuffer,若是cbuffer裏面的成員有被當前着色器使用過,將會根據聲明順序按空餘槽位從小到大的順序佔用

根據上面的例子,cbPerFrame將使用slot(b0),而cbPerObject將使用slot(b1)。

如今讓咱們省略全部的花括號,觀察下面的代碼,根據下面兩種狀況,問那三個未指定寄存器槽的cbuffer分別佔用了哪一個slot?

  1. 頂點着色器使用過第一、三、四、5個cbuffer裏面的變量
  2. 像素着色器使用過第二、三、四、6個cbuffer裏面的變量
cbuffer CBChangesEveryInstanceDrawing : register(b0) { ... }
cbuffer CBChangesEveryObjectDrawing { ... }
cbuffer CBChangesEveryFrame { ... }
cbuffer CBDrawingStates { ... }
cbuffer CBChangesOnResize : register(b2) { ... }
cbuffer CBChangesRarely : register(b3) { ... }

答案以下:

  1. CBChangesEveryFrame佔用了slot(b1),CBDrawingStates佔用了slot(b4)
  2. CBChangesEveryObjectDrawing佔用了slot(b1),CBChangesEveryFrame佔用了slot(b4),CBDrawingStates佔用了slot(b5)

不只是寄存器槽cb#,其他的如t#、u#、s#等也是同樣的道理。

只要當前資源沒有標定寄存器槽,而且沒有被着色器使用過,編譯後它們不會佔用寄存器槽。

常量緩衝區的更新

在Effects11的C++端建立了常量緩衝區的同時,還會建立一份與cbuffer等大的內存副本,這麼作是爲了減小常量緩衝區的更新次數(即CPU→GPU的寫入)。而且每一個副本還要設置一個髒標記,即只有在數據發生變化的時候纔會進行實際的提交。

在Effects11中,更新常量初值的方式以下:

m_pFX->GetVariableByName("gWorld")->AsMatrix()->SetMatrix((float*)&M);

這裏實際上就是更新所屬常量緩衝區的內存副本中gWorld所屬的內存區域,而後將髒標記設置爲true

全部的更新結束後,經過調用ID3DX11EffectPass::Apply來執行實際的常量緩衝區更新:

m_pTech->GetPassByIndex(p)->Apply(0, m_pd3dImmediateContext);

在完成更新後,Apply便會將常量緩衝區綁定到渲染管線上,例如執行下面的語句:

m_pd3dImmediateContext->VSSetConstantBuffers(0, 1, &pCB->pD3DObject);

不只是常量緩衝區,Apply操做還會綁定着色器、着色器資源(SRV)、可讀寫資源(UAV)、採樣器、各類渲染狀態等。

翻看FX11的源碼,咱們能夠找到更新常量緩衝區的地方。該函數會在Apply後調用:

inline void CheckAndUpdateCB_FX(ID3D11DeviceContext *pContext, SConstantBuffer *pCB)
{
    if (pCB->IsDirty && !pCB->IsNonUpdatable)
    {
        // CB out of date; rebuild it
        pContext->UpdateSubresource(pCB->pD3DObject, 0, nullptr, pCB->pBackingStore, pCB->Size, pCB->Size);
        pCB->IsDirty = false;
    }
}

固然,若是cbuffer用的是DYNAMIC更新,則須要改成Map與UnMap的更新方式。

默認常量緩衝區(Default Constant Buffer)

若是一個變量沒有staticconst修飾符,那麼編譯器將會認爲它是屬於名爲$Globals的默認常量緩衝區的一員。相似的,着色器入口點的uniform形參將會被認爲是屬於另外一個名爲$Params的默認常量緩衝區。

考慮下面一段代碼:

uniform bool g_FogEnable;	// 屬於$Gbloals

cbuffer CB0 : register(b0) { ... }
cbuffer CB1 : register(b1) { ... }
cbuffer CB2 { ... }

float4 PS(
    PIN pin, 
	uniform int numLights /* 屬於$Params */
) : SV_Target
{
    ...
}

對於常量緩衝區槽位的安排,最終會按以下順序安排:

  1. 有指定寄存器槽位的cbuffer優先佔用
  2. 其次是$Globals佔用空餘槽位中值最小的那個
  3. 緊接着$Params佔用空餘槽位中最小的那個
  4. 剩餘有被該着色器使用的cbuffer按空餘槽位從小到大的順序佔用

所以,編譯器會這樣解釋:

cbuffer CB0 : register(b0) { ... }
cbuffer CB1 : register(b1) { ... }
cbuffer $Globals : register(b2) { bool g_FogEnable; }
cbuffer $Params : register(b3) { int numLights; }
cbuffer CB2 : register(b4) { ... }

固然,直接聲明$GlobalsGlobals是不可能編譯經過的。

這就能解釋的通,爲何咱們在編譯HLSL代碼時,b#的最大值只能到13(即咱們只能指定14個自定義的常量緩衝區),但在頭文件d3d11.h卻又說有16個寄存器槽位了。由於剩餘的兩個槽位要讓位於$Globals$Params這兩個默認常量緩衝區。

着色器反射

編譯好的着色器二進制數據中蘊含着豐富的信息,咱們能夠經過着色器反射機制來獲取本身所須要的東西,而後構建一個屬於本身的Effects類。

D3DReflect函數--獲取着色器反射對象

在調用該函數以前須要使用D3DCompileD3DCompileFromFile產生編譯好的着色器二進制對象ID3DBlob

HRESULT D3DReflect(
	LPCVOID pSrcData,		// [In]編譯好的着色器二進制信息
	SIZE_T  SrcDataSize,	// [In]編譯好的着色器二進制信息字節數
	REFIID  pInterface,		// [In]COM組件的GUID
	void    **ppReflector	// [Out]輸出的着色器反射藉口
);

其中pInterface__uuidof(ID3D11ShaderReflection)時,返回的是ID3D11ShaderReflection接口對象;而pInterface__uuidof(ID3D12ShaderReflection)時,返回的是ID3D12ShaderReflection接口對象。

ID3D11ShaderReflection提供了大量的方法給咱們獲取信息,其中咱們比較感興趣的主要信息有:

  1. 着色器自己的信息
  2. 常量緩衝區的信息
  3. 採樣器、資源的信息

D3D11_SHADER_DESC結構體--着色器自己的信息

經過方法ID3D11ShaderReflection::GetDesc,咱們能夠獲取到D3D11_SHADER_DESC對象。這裏麪包含了大量的基礎信息:

typedef struct _D3D11_SHADER_DESC {
  UINT                             Version;						// 着色器版本、類型信息
  LPCSTR                           Creator;						// 是誰建立的着色器
  UINT                             Flags;						// 着色器編譯/分析標籤
  UINT                             ConstantBuffers;				// 實際使用到常量緩衝區數目
  UINT                             BoundResources;				// 實際用到綁定的資源數目
  UINT                             InputParameters;				// 輸入參數數目(4x4矩陣爲4個向量形參)
  UINT                             OutputParameters;			// 輸出參數數目
  UINT                             InstructionCount;			// 指令數
  UINT                             TempRegisterCount;			// 實際使用到的臨時寄存器數目
  UINT                             TempArrayCount;				// 實際用到的臨時數組數目
  UINT                             DefCount;					// 常量定義數目
  UINT                             DclCount;					// 聲明數目(輸入+輸出)
  UINT                             TextureNormalInstructions;	// 未分類的紋理指令數目
  UINT                             TextureLoadInstructions;		// 紋理讀取指令數目
  UINT                             TextureCompInstructions;		// 紋理比較指令數目
  UINT                             TextureBiasInstructions;		// 紋理偏移指令數目
  UINT                             TextureGradientInstructions;	// 紋理梯度指令數目
  UINT                             FloatInstructionCount;		// 實際用到的浮點數指令數目
  UINT                             IntInstructionCount;			// 實際用到的有符號整數指令數目
  UINT                             UintInstructionCount;		// 實際用到的無符號整數指令數目
  UINT                             StaticFlowControlCount;		// 實際用到的靜態流控制指令數目
  UINT                             DynamicFlowControlCount;		// 實際用到的動態流控制指令數目
  UINT                             MacroInstructionCount;		// 實際用到的宏指令數目
  UINT                             ArrayInstructionCount;		// 實際用到的數組指令數目
  UINT                             CutInstructionCount;			// 實際用到的cut指令數目
  UINT                             EmitInstructionCount;		// 實際用到的emit指令數目
  D3D_PRIMITIVE_TOPOLOGY           GSOutputTopology;			// 幾何着色器的輸出圖元
  UINT                             GSMaxOutputVertexCount;		// 幾何着色器的最大頂點輸出數目
  D3D_PRIMITIVE                    InputPrimitive;				// 輸入裝配階段的圖元
  UINT                             PatchConstantParameters;		// 待填坑...
  UINT                             cGSInstanceCount;			// 幾何着色器的實例數目
  UINT                             cControlPoints;				// 域着色器和外殼着色器的控制點數目
  D3D_TESSELLATOR_OUTPUT_PRIMITIVE HSOutputPrimitive;			// 鑲嵌器輸出的圖元類型
  D3D_TESSELLATOR_PARTITIONING     HSPartitioning;				// 待填坑...
  D3D_TESSELLATOR_DOMAIN           TessellatorDomain;			// 待填坑...
  UINT                             cBarrierInstructions;		// 計算着色器內存屏障指令數目
  UINT                             cInterlockedInstructions;	// 計算着色器原子操做指令數目
  UINT                             cTextureStoreInstructions;	// 計算着色器紋理寫入次數
} D3D11_SHADER_DESC;

其中,成員Version不只包含了着色器版本,還包含着色器類型。下面的枚舉值定義了着色器的類型,並經過宏D3D11_SHVER_GET_TYPE來獲取:

typedef enum D3D11_SHADER_VERSION_TYPE
{
    D3D11_SHVER_PIXEL_SHADER    = 0,
    D3D11_SHVER_VERTEX_SHADER   = 1,
    D3D11_SHVER_GEOMETRY_SHADER = 2,
    
    // D3D11 Shaders
    D3D11_SHVER_HULL_SHADER     = 3,
    D3D11_SHVER_DOMAIN_SHADER   = 4,
    D3D11_SHVER_COMPUTE_SHADER  = 5,

    D3D11_SHVER_RESERVED0       = 0xFFF0,
} D3D11_SHADER_VERSION_TYPE;

#define D3D11_SHVER_GET_TYPE(_Version) \
    (((_Version) >> 16) & 0xffff)

即:

auto shaderType = static_cast<D3D11_SHADER_VERSION_TYPE>(D3D11_SHVER_GET_TYPE(sd.Version));

D3D11_SHADER_INPUT_BIND_DESC結構體--描述着色器資源如何綁定到着色器輸入

爲了獲取着色器程序內聲明的一切給着色器使用的對象,從這個結構體入手是一種十分不錯的選擇。咱們將使用ID3D11ShaderReflection::GetResourceBindingDesc方法,和枚舉顯示適配器那樣從索引0開始枚舉同樣的作法,只要當前的索引值獲取失敗,說明已經獲取完全部的輸入對象:

for (UINT i = 0;; ++i)
{
	D3D11_SHADER_INPUT_BIND_DESC sibDesc;
	hr = pShaderReflection->GetResourceBindingDesc(i, &sibDesc);
	// 讀取完變量後會失敗,但這並非失敗的調用
	if (FAILED(hr))
		break;
    
    // 根據sibDesc繼續分析...
}

注意:那些在着色器代碼中從未被當前着色器使用過的資源將不會被枚舉出來,而且在着色器調試和着色器反射的時候看不到它們,而反彙編中也許可以看到該變量被標記爲unused。

如今先來看該結構體的成員:

typedef struct _D3D11_SHADER_INPUT_BIND_DESC {
	LPCSTR                   Name;			// 着色器資源名
	D3D_SHADER_INPUT_TYPE    Type;			// 資源類型
	UINT                     BindPoint;		// 指定的輸入槽起始位置
	UINT                     BindCount;		// 對於數組而言,佔用了多少個槽
	UINT                     uFlags;		// D3D_SHADER_INPUT_FLAGS枚舉複合
	D3D_RESOURCE_RETURN_TYPE ReturnType;	// 
	D3D_SRV_DIMENSION        Dimension;		// 着色器資源類型
	UINT                     NumSamples;	// 若爲紋理,則爲MSAA採樣數,不然爲0xFFFFFFFF
} D3D11_SHADER_INPUT_BIND_DESC;

其中成員Name幫助咱們使用着色器反射按名獲取資源,而成員Type幫助咱們肯定資源類型。這兩個成員一旦肯定下來,對咱們開展更詳細的着色器反射和實現本身的特效框架提供了巨大的幫助。具體枚舉以下:

typedef enum _D3D_SHADER_INPUT_TYPE {
  D3D_SIT_CBUFFER,
  D3D_SIT_TBUFFER,
  D3D_SIT_TEXTURE,
  D3D_SIT_SAMPLER,
  D3D_SIT_UAV_RWTYPED,
  D3D_SIT_STRUCTURED,
  D3D_SIT_UAV_RWSTRUCTURED,
  D3D_SIT_BYTEADDRESS,
  D3D_SIT_UAV_RWBYTEADDRESS,
  D3D_SIT_UAV_APPEND_STRUCTURED,
  D3D_SIT_UAV_CONSUME_STRUCTURED,
  D3D_SIT_UAV_RWSTRUCTURED_WITH_COUNTER,
  // ...
} D3D_SHADER_INPUT_TYPE;

根據上述枚舉能夠分爲常量緩衝區、採樣器、着色器資源、可讀寫資源四大類。對於採樣器、着色器資源和可讀寫資源咱們只須要知道它設置在哪一個slot便可,但對於常量緩衝區,咱們還須要知道其內部的成員和位於哪一段內存區域。

D3D11_SHADER_BUFFER_DESC結構體--描述一個着色器的常量緩衝區

在經過上面提到的枚舉值斷定出來是常量緩衝區後,咱們就能夠經過ID3D11ShaderReflection::GetConstantBufferByName迅速拿下常量緩衝區的反射,而後再獲取D3D11_SHADER_BUFFER_DESC的信息:

ID3D11ShaderReflectionConstantBuffer* pSRCBuffer = pShaderReflection->GetConstantBufferByName(sibDesc.Name);
// 獲取cbuffer內的變量信息並創建映射
D3D11_SHADER_BUFFER_DESC cbDesc{};
hr = pSRCBuffer->GetDesc(&cbDesc);
if (FAILED(hr))
	return hr;

注意:ID3D11ShaderReflectionConstantBuffer並非COM組件,所以不能用ComPtr存放。

該結構體定義以下:

typedef struct _D3D11_SHADER_BUFFER_DESC {
	LPCSTR           Name;		// 常量緩衝區名稱
	D3D_CBUFFER_TYPE Type;		// D3D_CBUFFER_TYPE枚舉值
	UINT             Variables;	// 內部變量數目
	UINT             Size;		// 緩衝區字節數
	UINT             uFlags;	// D3D_SHADER_CBUFFER_FLAGS枚舉複合
} D3D11_SHADER_BUFFER_DESC;

根據成員Variables,咱們就能夠肯定查詢變量的次數。

D3D11_SHADER_VARIABLE_DESC結構體--描述一個着色器的變量

雖然有點想吐槽,常量緩衝區裏面存的是變量這個說法,但仍是得這樣來看待:常量緩衝區內的數據是能夠改變的,可是在着色器運行的時候,cbuffer內的任何變量就不能夠被修改了。所以對C++來講,它是可變量,但對着色器來講,它是常量。

好了不扯那麼多,如今咱們用這樣一個循環,經過ID3D11ShaderReflectionVariable::GetVariableByIndex來逐一枚舉着色器變量的反射,而後獲取D3D11_SHADER_VARIABLE_DESC的信息:

// 記錄內部變量
for (UINT j = 0; j < cbDesc.Variables; ++j)
{
    ID3D11ShaderReflectionVariable* pSRVar = pSRCBuffer->GetVariableByIndex(j);
    D3D11_SHADER_VARIABLE_DESC svDesc;
    hr = pSRVar->GetDesc(&svDesc);
    if (FAILED(hr))
        return hr;
    // ...
}

ID3D11ShaderReflectionVariable不是COM組件,所以無需管釋放。

那麼D3D11_SHADER_VARIABLE_DESC的定義以下:

typedef struct _D3D11_SHADER_VARIABLE_DESC {
	LPCSTR Name;			// 變量名
	UINT   StartOffset;		// 起始偏移
	UINT   Size;			// 大小
	UINT   uFlags;			// D3D_SHADER_VARIABLE_FLAGS枚舉複合
	LPVOID DefaultValue;	// 用於初始化變量的默認值
	UINT   StartTexture;	// 從變量開始到紋理開始的偏移量[看不懂]
	UINT   TextureSize;		// 紋理字節大小
	UINT   StartSampler;	// 從變量開始到採樣器開始的偏移量[看不懂]
	UINT   SamplerSize;		// 採樣器字節大小
} D3D11_SHADER_VARIABLE_DESC;

其中前三個參數是咱們須要的,由此咱們就能夠構建出根據變量名來設置值和獲取值的一套方案。

講到這裏其實已經知足了咱們構建一個最小特效管理類的需求。但你若是想要得到更詳細的變量信息,則能夠繼續往下讀,這裏只會粗略講述。

D3D11_SHADER_TYPE_DESC結構體--描述着色器變量類型

如今咱們已經得到了一個着色器變量的反射,那麼能夠經過ID3D11ShaderReflectionVariable::GetType獲取着色器變量類型的反射,而後獲取D3D11_SHADER_TYPE_DESC的信息:

ID3D11ShaderReflectionType* pSRType = pSRVar->GetType();
D3D11_SHADER_TYPE_DESC stDesc;
hr = pSRType->GetDesc(&stDesc);
if (FAILED(hr))
	return hr;

D3D11_SHADER_TYPE_DESC的定義以下:

typedef struct _D3D11_SHADER_TYPE_DESC {
	D3D_SHADER_VARIABLE_CLASS Class;		// 說明它是標量、矢量、矩陣、對象,仍是類型
	D3D_SHADER_VARIABLE_TYPE  Type;			// 說明它是BOOL、INT、FLOAT,仍是別的類型
	UINT                      Rows;			// 矩陣行數
	UINT                      Columns;		// 矩陣列數
	UINT                      Elements;		// 數組元素數目
	UINT                      Members;		// 結構體成員數目
	UINT                      Offset;		// 在結構體中的偏移,若是不是結構體則爲0
	LPCSTR                    Name;			// 着色器變量類型名,若是變量未被使用則爲NULL
} D3D11_SHADER_TYPE_DESC;

若是它是個結構體,就還能經過ID3D11ShaderReflectionType::GetMemberTypeByIndex方法繼續獲取子類別。。。

實現一個複雜Effects框架須要考慮到的問題

在設計一個Effects框架時,你須要考慮這些問題:

  1. 是使用常規HLSL代碼,而後經過着色器反射來實現;仍是像Effects11那樣,混雜着自定義語法,本身作代碼分析
  2. 若是是前者,那HLSL代碼有什麼施加約束(如常量緩衝區、全局變量的約束)
  3. 你的Effects容許塞入一個着色器,仍是六種着色器各一個,又仍是任意數目的着色器
  4. 你但願你的框架能提供多麼複雜的功能(取決於你想獲取多麼詳細的着色器反射信息),以及 緩存哪些信息
  5. 常量緩衝區使用DYNAMIC更新仍是DEFAULT更新
  6. 你如何定義一個Effect Pass(是否每一個Effect Pass都須要提供獨立的形參存儲空間),它可以管理哪些資源

由於不一樣的引擎對此需求可能有所不一樣,這取決於你怎麼去設計。

EffectHelper類的使用

目前本人實現了一個功能儘量簡化,但可以知足基本需求的EffectHelper類。它的功能和限制以下:

  1. 支持原生HLSL代碼
  2. 容許塞入任意數目的着色器,但要求這些着色器在常量緩衝區和全局變量的定義上沒有衝突。一種明智的作法是把全部用到的常量緩衝區、採樣器、着色器資源、可讀寫資源、全局變量都放在同一個頭文件,而後每一個着色器文件都包含這個頭文件來使用;又或者是把全部着色器都寫到同一個文件上
  3. 該框架容許按名添加着色器,以及按名添加通道,在建立通道時按名指定使用哪些着色器
  4. 和Effects11同樣,經過名稱來獲取HLSL常量緩衝區的變量,而後設置和獲取值
  5. 每一個通道須要單獨設置着色器形參(按名獲取),而且能夠獨立設置光柵化狀態、混合狀態、深度/模板狀態,不設置則使用默認狀態。經過Apply應用當前通道。不支持Technique和Group這種形式
  6. 類內部全局設置和緩存採樣器狀態、着色器資源、可讀寫資源

本文並不打算寫實現細節,整個框架源碼在1500行之內,你能夠觀察內部實現原理。如今主要介紹如何使用。

EffectHelper::AddShader方法--添加着色器

在C++端,首先編譯着色器代碼,獲得編譯好的着色器二進制信息,而後經過EffectHelper::AddShader添加着色器:

m_pEffectHelper = std::make_unique<EffectHelper>();

ComPtr<ID3DBlob> blob;

// 建立頂點着色器(3D)
HR(CreateShaderFromFile(L"HLSL\\Basic_VS_3D.cso", L"HLSL\\Basic_VS_3D.hlsl", "VS_3D", "vs_5_0", blob.ReleaseAndGetAddressOf()));
HR(m_pEffectHelper->AddShader("Basic_VS_3D", m_pd3dDevice.Get(), blob.Get()));
// 建立頂點佈局(3D)
HR(m_pd3dDevice->CreateInputLayout(VertexPosNormalTex::inputLayout, ARRAYSIZE(VertexPosNormalTex::inputLayout),
                                   blob->GetBufferPointer(), blob->GetBufferSize(), m_pVertexLayout3D.GetAddressOf()));

// 建立像素着色器(3D)
HR(CreateShaderFromFile(L"HLSL\\Basic_PS_3D.cso", L"HLSL\\Basic_PS_3D.hlsl", "PS_3D", "ps_5_0", blob.ReleaseAndGetAddressOf()));
HR(m_pEffectHelper->AddShader("Basic_PS_3D", m_pd3dDevice.Get(), blob.Get()));

EffectHelper::AddEffectPass方法--添加渲染通道

在建立好着色器後,咱們就能夠添加渲染通道。首先要填充通道信息,結構體EffectPassDesc定義以下:

// 渲染通道描述
// 經過指定添加着色器時提供的名字來設置着色器
struct EffectPassDesc
{
	LPCSTR nameVS = nullptr;
	LPCSTR nameDS = nullptr;
	LPCSTR nameHS = nullptr;
	LPCSTR nameGS = nullptr;
	LPCSTR namePS = nullptr;
	LPCSTR nameCS = nullptr;
};

若是不須要使用某一着色器階段,則需指定爲nullptr。經過設置AddShader使用的名稱來指定使用哪一個着色器,而後就能夠建立通道了:

// 添加渲染通道
EffectPassDesc epDesc;
epDesc.nameVS = "Basic_VS_3D";
epDesc.namePS = "Basic_PS_3D";
HR(m_pEffectHelper->AddEffectPass("Basic_3D", m_pd3dDevice.Get(), &epDesc));

設置採樣器狀態、着色器資源、可讀寫資源

EffectHelper提供了按名設置和按槽設置兩種方式:

class EffectHelper
{
  public:
    // ...
    
	// 按槽設置採樣器狀態
	void SetSamplerStateBySlot(UINT slot, ID3D11SamplerState* samplerState);
	// 按名設置採樣器狀態(若存在同槽多名稱則只能使用按槽設置)
	void SetSamplerStateByName(LPCSTR name, ID3D11SamplerState* samplerState);
	
	// 按槽設置着色器資源
	void SetShaderResourceBySlot(UINT slot, ID3D11ShaderResourceView* srv);
	// 按名設置着色器資源(若存在同槽多名稱則只能使用按槽設置)
	void SetShaderResourceByName(LPCSTR name, ID3D11ShaderResourceView* srv);

	// 按槽設置可讀寫資源
	void SetUnorderedAccessBySlot(UINT slot, ID3D11UnorderedAccessView* uav, UINT* pUAVInitialCount);
	// 按名設置可讀寫資源(若存在同槽多名稱則只能使用按槽設置)
	void SetUnorderedAccessByName(LPCSTR name, ID3D11UnorderedAccessView* uav, UINT* pUAVInitialCount);
    
    // ...
};

經過IEffectConstantBufferVariable設置常量緩衝區變量

EffectHelper經過HLSL定義的常量緩衝區內變量的名稱來獲取可用於讀寫的接口:

std::shared_ptr<IEffectConstantBufferVariable> pWorld = m_pEffectHelper->GetConstantBufferVariable("g_World");

接口類IEffectConstantBufferVariable定義以下:

// 常量緩衝區的變量
// 非COM組件
struct IEffectConstantBufferVariable
{
	// 設置無符號整數,也能夠爲bool設置
	virtual void SetUInt(UINT val) = 0;
	// 設置有符號整數
	virtual void SetSInt(INT val) = 0;
	// 設置浮點數
	virtual void SetFloat(FLOAT val) = 0;

	// 設置無符號整數向量,容許設置1個到4個份量
	// 着色器變量類型爲bool也可使用
	// 根據要設置的份量數來讀取data的前幾個份量
	virtual void SetUIntVector(UINT numComponents, const UINT data[4]) = 0;

	// 設置有符號整數向量,容許設置1個到4個份量
	// 根據要設置的份量數來讀取data的前幾個份量
	virtual void SetSIntVector(UINT numComponents, const INT data[4]) = 0;

	// 設置浮點數向量,容許設置1個到4個份量
	// 根據要設置的份量數來讀取data的前幾個份量
	virtual void SetFloatVector(UINT numComponents, const FLOAT data[4]) = 0;

	// 設置無符號整數矩陣,容許行列數在1-4
	// 要求傳入數據沒有填充,例如3x3矩陣能夠直接傳入UINT[3][3]類型
	virtual void SetUIntMatrix(UINT rows, UINT cols, const UINT* noPadData) = 0;

	// 設置有符號整數矩陣,容許行列數在1-4
	// 要求傳入數據沒有填充,例如3x3矩陣能夠直接傳入INT[3][3]類型
	virtual void SetSIntMatrix(UINT rows, UINT cols, const INT* noPadData) = 0;

	// 設置浮點數矩陣,容許行列數在1-4
	// 要求傳入數據沒有填充,例如3x3矩陣能夠直接傳入FLOAT[3][3]類型
	virtual void SetFloatMatrix(UINT rows, UINT cols, const FLOAT* noPadData) = 0;

	// 設置其他類型,容許指定設置範圍
	virtual void SetRaw(const void* data, UINT byteOffset = 0, UINT byteCount = 0xFFFFFFFF) = 0;

	// 獲取最近一次設置的值,容許指定讀取範圍
	virtual HRESULT GetRaw(void* pOutput, UINT byteOffset = 0, UINT byteCount = 0xFFFFFFFF) = 0;
};

前面的矩陣能夠這樣設置:

XMMATRIX Eye = XMMatrixIdentity();
pWorld->SetFloatMatrix(4, 4, (const FLOAT*)&Eye);

要注意這樣的設置並非當即生效到着色器內的。

IEffectPass接口類

在完成各類資源綁定後,就能夠來到渲染通道這邊了。IEffectPass定義以下:

// 渲染通道
// 非COM組件
struct IEffectPass
{
	// 設置光柵化狀態
	virtual void SetRasterizerState(ID3D11RasterizerState* pRS) = 0;
	// 設置混合狀態
	virtual void SetBlendState(ID3D11BlendState* pBS, const FLOAT blendFactor[4], UINT sampleMask) = 0;
	// 設置深度混合狀態
	virtual void SetDepthStencilState(ID3D11DepthStencilState* pDSS, UINT stencilValue) = 0;
	// 獲取頂點着色器的uniform形參用於設置值
	virtual std::shared_ptr<IEffectConstantBufferVariable> VSGetParamByName(LPCSTR paramName) = 0;
	// 獲取域着色器的uniform形參用於設置值
	virtual std::shared_ptr<IEffectConstantBufferVariable> DSGetParamByName(LPCSTR paramName) = 0;
	// 獲取外殼着色器的uniform形參用於設置值
	virtual std::shared_ptr<IEffectConstantBufferVariable> HSGetParamByName(LPCSTR paramName) = 0;
	// 獲取幾何着色器的uniform形參用於設置值
	virtual std::shared_ptr<IEffectConstantBufferVariable> GSGetParamByName(LPCSTR paramName) = 0;
	// 獲取像素着色器的uniform形參用於設置值
	virtual std::shared_ptr<IEffectConstantBufferVariable> PSGetParamByName(LPCSTR paramName) = 0;
	// 獲取計算着色器的uniform形參用於設置值
	virtual std::shared_ptr<IEffectConstantBufferVariable> CSGetParamByName(LPCSTR paramName) = 0;
	// 應用着色器、常量緩衝區(包括函數形參)、採樣器、着色器資源和可讀寫資源到渲染管線
	virtual void Apply(ID3D11DeviceContext* deviceContext) = 0;
};

可見每一個渲染通道有本身獨立的三個渲染狀態,並存儲着着色器uniform形參的信息容許用戶設置。

最後繪製前,咱們要應用當前的渲染通道:

m_pCurrEffectPass->Apply(m_pd3dImmediateContext.Get());

補充說明

該特效管理框架將會從第31章日後的項目開始使用。但這裏給出項目09用於添加和替換的一些源代碼以嚐鮮。目前並不會有較大的改動,若是使用過程當中遇到什麼問題,能夠在這裏評論反饋。

EffectHelper_Project_09.zip

DirectX11 With Windows SDK完整目錄

Github項目源碼

歡迎加入QQ羣: 727623616 能夠一塊兒探討DX11,以及有什麼問題也能夠在這裏彙報。

相關文章
相關標籤/搜索