シェーダを使った画面クリア

まず初めにDirect3D11(以下、DX11と省略)とはなにか？と聞かれたら、私はGPUを扱うためのAPIですと答えます。

GPUについてはご存知でしょうか？ GPUとは並列処理に特化したプロセッサです。 登場した当初は画像処理目的にのみに使われていましたが、 近年ではCPUをはるかに超える演算能力に着目して、 物理演算や画像認識、Deep Learningなど幅広い用途でも使われるようになっています。(それらをまとめてGPGPUと呼ばれています。)

なので、DX11を使用する際はCPUとGPUの2つのプロセッサが存在していることを認識して、 今、どちらを触っているかをしっかり把握してプログラミングしていかなければなりません。

と書くと難しく感じられますが、 実際には、シェーダ(英訳:Shader)というGPU上で実行される言語を使用しますのでそこまで注意を払う必要はなく、 CPUはDX11のAPIを、GPUはシェーダを使ってコーディングしていく形になります。

DX11ではHLSLと呼ばれるシェーダ言語を使います。 HLSLもc言語の文法をベースにしていますので、すぐに慣れることでしょう。 ただ、様々なお約束を覚える必要はありますが。

概要

まず初めに画面全体をGPUを使って単色で塗りつぶす単純なプログラムを作ることを題材に、 DX11を使う上で最も重要なシェーダとその使い方について説明していきます。
今パートに対応しているサンプルプロジェクトはPart01_ClearScreenになります。

1.シェーダの作成

//ClearScreen.hlsl
RWTexture2D<float4> screen : register(u0);
[numthreads(1, 1, 1)]
void main( uint2 DTid : SV_DispatchThreadID )
{
  screen[DTid] = float4(1, 1, 0, 1);
}
  

今回のサンプルではコンピュートシェーダ(英訳:Compute Shader)を使用して画面を単色で塗りつぶしています。

一口にシェーダといってもいくつかの種類があり、 大きく分けてグラフィックスパイプライン用のシェーダとGPGPU用のシェーダがあります。 (グラフィックスパイプラインについては後のパートで説明します。)

コンピュートシェーダはGPGPU目的でGPUを動作させるためのシェーダになり、Direct3D11から登場しました。 コンピュートシェーダは現在のハイエンドゲームの制作において欠かすことのできないシェーダであり、シェーダの中でコーディングする制限が一番少ないものになります。

話をソースコードに戻しまして、 ClearScreen.hlslの以下の部分で画面を塗りつぶしています。

//ClearScreen.hlsl main関数内
screen[DTid] = float4(1, 1, 0, 1);
  

screenが画面を表すリソース(英訳:Resource)になり、サンプルでは全画面を黄色を表す"float4(1, 1, 0, 1)"で塗りつぶしています。 シェーダ上では基本的に色を光の3原色である赤緑青とアルファ(不透明度)の4色で表現しており、0～1の範囲で調節します。 データの並びはfloat4(赤, 緑, 青, アルファ)となっています。

screenはRWTexture2D<float4>オブジェクトになります。 RWTexture2Dは読み書き可能[補足]な2次元テクスチャで、 C++のテンプレートみたいに"<...>"で要素の型を指定しています。 サンプルではfloat4を指定しているので、screenはシェーダ内でfloat4型を読み書きできる2次元テクスチャとなります。 2次元テクスチャの詳細はあとのパートで詳しく説明しますが、C++でいうところの2次元配列のようなもので、実際screenの各要素には配列のようにアクセスできます。

例えば、screenの(100, 200)にアクセスしたい場合は、

uint2 pos;
pos.x = 100;
pos.y = 200;
screen[pos] = ...;
    

さて、ここまで当たり前のようにfloat4やuint2といった型を使っていましたが、どのようなものか想像できるでしょうか？ float4はfloatを4つもつ型で、uint2はuintを2つもつ型になります。 float3だとfloatを3つ、uint4だとuintを4つもち、型名そのままの意味になります。 当然、float型とuint型も単体であり、ほかにはint型とbool型も同じように使えます。

これらの型は一見すると配列のように見えますが、各要素へのアクセスは配列とは異なり、 float4やuint4だとx,y,z,wかr,b,g,aを使ってアクセスします。 float2やuint2だとx,yかr,bとなり、 配列での0番目がx(r)に、1番目がy(b)に、2番目がz(b)、3番目がw(a)となっています。 xyzwとrgba</span>はそれぞれ同じ場所をさしています。c++言語でいうところの共用体みたいなものです。

また、以下のようにすると、xとyに１が入り、

float4 a;
a.xy = 1;
    

a.wyx = 2;
    

またこのような書き方も可能です。

float3 a = {1, 2, 3};
float4 b = float4(a, 4);//bはfloat4(1, 2, 3, 4)になる。
  

より詳しい説明は以下のドキュメントを参照してください。ここでは触れていない行列を表す変数についても説明されています。
ドキュメント： 成分ごとの演算(日本語) Per-Component Math Operations(英語)

ここまで、シェーダ内の画面を塗りつぶす部分について説明しました。 次はそのシェーダを実行する手順について見ていきます。 ClearScreen.hlslのいくつか部分には触れていませんが、それらはCPU側で使ったり、指定したりするものなので 関連する所が出てきましたら合わせて説明していきます。

2.シェーダの実行

シェーダを実行するコードは以下になります。

//Scene::onRender()の一部
//実行するシェーダをGPUに設定する
this->mpImmediateContext->CSSetShader(this->mpCSClearScreen.Get(), nullptr, 0);
//シェーダのscreenとして扱うリソースを設定する。
std::array<ID3D11UnorderedAccessView*, 1> ppUAVs = { {
  this->mpScreenUAV.Get()
} };
std::array<UINT, 1> initCounts = { { 0u, } };
this->mpImmediateContext->CSSetUnorderedAccessViews(
  0,
  static_cast<UINT>(ppUAVs.size()),
  ppUAVs.data(),
  initCounts.data());
//ClearScreen.hlslの実行
this->mpImmediateContext->Dispatch(this->mWidth, this->mHeight, 1);
  

実行命令

DX11を使ったコードは長くなりがちですが、行っていることは難しくありません。
上のコードの

//Scene::onRender()の一部
this->mpImmediateContext->Dispatch(this->mWidth, this->mHeight, 1);
    

Dispatch関数の引数は、ClearScreen.hlslのDTid引数の値とmain関数の呼び出し回数に影響を与えます。
ドキュメント ID3D11DeviceContext::Dispatch(日本語) ID3D11DeviceContext::Dispatch(英語)

// ClearScreen.hlslの一部
void main( uint2 DTid : SV_DispatchThreadID ) {
  // ... Dispatch関数の引数は、DTidの値とmain関数の呼び出し回数に影響を与える。
}
    

Dispatch(2,2,1)にすると、ClearScreen.hlslのmain関数が2x2x1=4回呼び出され、 DTidにはそれぞれuint2(0, 0), uint2(0, 1), uint2(1, 0), uint2(1, 1)の値がそれぞれ渡されます。

Dispatch(100, 200, 1)にすると、main関数は100x200x1=20000回呼び出され、 DTidには
uint2(0, 0)～uint2(99, 0)
uint2(0, 1)～uint2(99, 1)
...
uint2(0, 199)～uint2(99, 199)
の値がそれぞれ渡されます。

今回は画面を塗りつぶすので、画面の横幅と縦幅を指定しています。 なので、サンプルの画面サイズはデフォルトでは1280x720から、main関数は1280x720x1=921600回呼び出され、 各々のDTidはuint2(0, 0)～uint2(1279, 719)の値が渡されます。

実のところ、ClearScreen.hlslのnumthreads属性もDTidの値に影響があります。

//　ClearScreen.hlslの一部
[numthreads(1,1,1)]
void main( uint2 DTid : SV_DispatchThreadID ) {
　// ...
    

ここまでシェーダの実行の仕方について見てきました。コンピュートシェーダではDispatch関数を使うことでシェーダを実行します。 C++の関数呼び出しと比べるとかなり特殊な性質をもっていますが、これはGPUの大量のスレッドを同時に実行可能という特徴を生かすためこうなってます。 サンプルではClearScreen.hlslにはmain関数とは別にclearByOneThread関数というfor文を使ったC++で画面クリアをする場合と同じコードになるよう書いたものも用意していますので、一度目を通してみてください。 このシェーダとClearScreen.hlslは同じことをしていますが、処理速度はGPUの性質を生かしているClearScreen.hlslの方が速くなります。

//ClearScreen.hlslのclearByOneThread関数を簡略したもの。
[numthreads(1, 1, 1)]
void clearByOneThread(uint2 DTid : SV_DispatchThreadID)
{
  //screenのサイズを取得している
  uint2 size;
  screen.GetDimensions(size.x, size.y);
  //全ピクセルクリアー
  for (uint y = 0; y < size.y; ++y) {
    for (uint x = 0; x < size.x; ++x) {
      screen[uint2(x, y)] = float4(0.3f, 1, 0.3f, 1);
    }
  }
}
    

さて、単にDispatch関数だけを呼び出すだけではGPUから見ると実行するには情報不足です。 次は上のコードの残りの部分である、GPUがどのシェーダをどのようなリソースを使って実行するかその設定方法を説明していきます。

実行させるのに必要な設定

シェーダの実行の仕方がわかりましたので、次はGPUがどのシェーダをどのようなリソースを使って実行するかその設定方法を説明していきます。

GPUが実行するシェーダの設定は次のコードで行います。

//Scene::onRender()の一部
this->mpImmediateContext->CSSetShader(this->mpCSClearScreen.Get(), nullptr, 0);
    

CSSetShader関数はコンピュートシェーダの設定を行う関数で、 第一引数にコンピュートシェーダを表すID3D11ComputeShaderを渡します。 ID3D11ComputeShaderの生成は次の項目で説明します。 残りの引数は動的シェーダリンク(英訳:Dynamic Shader Linkage)というシェーダでオブジェクト指向言語でのインターフェイスとクラスを扱うときに使いますが、 Direct3D12では廃止になるようなので無視します。

次に使用するリソースの設定は以下のCSSetUnorderedAccessViews関数で行ってます。

//Scene::onRender()の一部
//シェーダのscreenとして扱うリソースを設定する。
std::array<ID3D11UnorderedAccessView*, 1> ppUAVs = { {
  this->mpScreenUAV.Get()
} };
std::array<UINT, 1> initCounts = { { 0u, } };
this->mpImmediateContext->CSSetUnorderedAccessViews(
  0,
  static_cast<UINT>(ppUAVs.size()),
  ppUAVs.data(),
  initCounts.data());
    

リソースにはいくつか種類があり、

• 定数バッファ (英訳:ConstantBuffer)
• シェーダリソースビュー (英訳:ShaderResourceView)
• サンプラステート (英訳:SamplerState)
• アンオーダードアクセスビュー (英訳:UnorderedAccessView, 以後、UAVと省略)

今回のサンプルでは画面を塗りつぶすことを目的としているので、 リソースの中で唯一書き込みが可能なUAVを使用しています。

話をサンプルに戻しまして、CSSetUnorderedAccessViews関数の引数について見ていきます。
ドキュメント： ID3D11DeviceContext::CSSetUnorderedAccessViews(日本語) ID3D11DeviceContext::CSSetUnorderedAccessViews(英語)

第4引数は今回は意味を持たないので、省略します。

シェーダの実行の仕方については以上になります。 最後に、シェーダのコンパイルの方法について見ていきましょう。

3.シェーダのコンパイル

シェーダを実行するためには一度コンパイルする必要があります。 コンパイルは実行時とオフラインの両方可能です。

実行時のコンパイル

//Scene::onInit()の一部
//実行中にシェーダをコンパイルし、ID3D11ComputeShaderを作成する
  std::array<D3D_SHADER_MACRO, 2> macros = { {
    {"DEFINE_MACRO", "float4(0, 1, 1, 1)"},
    {nullptr, nullptr},
  } };
  UINT compileFlag = 0;
  compileFlag |= D3DCOMPILE_DEBUG | D3DCOMPILE_SKIP_OPTIMIZATION;
  const char* entryPoint = "main";
  const char* shaderTarget = "cs_5_0";
  Microsoft::WRL::ComPtr<ID3DBlob> pShaderBlob, pErrorMsg;
  //シェーダのコンパイル
  hr = D3DCompileFromFile(
    L"ClearScreen.hlsl",
    macros.data(),
    nullptr,
    entryPoint,
    shaderTarget,
    compileFlag,
    0,
    pShaderBlob.GetAddressOf(),
    pErrorMsg.GetAddressOf());
  //ID3D11ComputeShaderの作成
  hr = this->mpDevice->CreateComputeShader(
    pShaderBlob->GetBufferPointer(),
    pShaderBlob->GetBufferSize(),
    nullptr,
    &this->mpCSClearScreenWithConstantBuffer);
  

上のコードのD3DCompileFromFile関数でシェーダのコンパイルを行っています。 引数がたくさんありますが、必ず必要となるものは以下のものになります。
ドキュメント： D3DCompileFromFile(英語)

さてまだ説明していないD3DCompileFromFile関数の引数がありますが、先にGPUにシェーダを設定するときに使用したCSSetShader関数に渡すID3D11ComputeShaderの作り方を見ていきます。 といっても簡単で、ID3D11Deviceとコンパイルしたシェーダバイナリを用意するだけでできます。

//Scene::onInit()の一部
hr = this->mpDevice->CreateComputeShader(
  pShaderBlob->GetBufferPointer(),
  pShaderBlob->GetBufferSize(),
  nullptr,
  &this->mpCSClearScreenWithConstantBuffer);
  

ID3D11Device::CreateComputeShader関数には単純にコンパイルされたシェーダと作成したいID3D11ComputeShaderを渡すだけです。 第3引数のnullptrは動的シェーダリンクに関係するものなので無視します。

実行時のシェーダのコンパイルで最低限必要となる引数とGPUに設定する際に使うID3D11ComputeShaderの生成方法についてはこれで以上になります。 この後はD3DCompileFromFileの残りの引数について説明していきます。

D3DCompileFromFile関数については以上になります。 この関数に似たものとしてD3DCompile関数がありますがそちらはシェーダを表す文字列からコンパイルする関数になります。 コンパイルエラーが起きたときの識別用の文字列を指定する以外は引数は同じになります。
ドキュメント:
D3DCompile(日本語) D3DCompile(英語)

オフラインでのコンパイル

HLSLはMicrosoftが用意しているfxc.exeで事前にコンパイルすることが可能です。 fxc.exeの場所は"Program Files (x86)\Windows Kits\10\bin\"以下のフォルダーにあります。 VisualStudioの開発者用コマンドプロンプトを使用すれば環境変数などの設定をしなくとも使用できますし、 サンプルプロジェクトにsetupFXCPath.batを用意しているので、コマンドプロンプトからそれを起動していただければ使えるようになります。

fxc.exe自体はD3DCompileFromFile関数と同じように使え、#includeキーワードにも対応しています。 コンパイルフラグはオプションで指定しますが、他のコマンドとは異なり"-"ではなく"/"を前につけて指定します。(Windows的にはこちらがデフォルト？) ヘルプを見てもらえれば使い方はわかりますが、ヘルプの見方は"fxc /?"または"fxc /help"になっていますので、混乱しないよう注意してください。

@rem 例
fxc /T cs_5_0 /Fo binary.cso ClearScreen.hlsl
    

ちなみにサンプルのClearScreen.hlslはプロジェクトのビルド時にコンパイルを行うようプロパティから設定しています。 その際、出力されるファイルはClearScreen.csoと拡張子がデフォルトで".cso"になりますので、この機能を使うときは覚えておいてください。

まとめ

かなり長くなりましたが、DX11でのシェーダの使い方の説明は以上になります。

今回の内容を踏まえたシェーダを実行したいときの流れは

補足

// 例
float value[4] = {1, 0.7f, 1, 1};//左から赤、緑、青、アルファ
this->mpImmediateContext->ClearUnorderedAccessViewFloat(this->mpScreenUAV.Get(), value);
    

// Scene::analysisの一部
Microsoft::WRL::ComPtr<ID3D11ShaderReflection> pReflector = NULL;
HRESULT hr = D3DReflect(pBinary, binarySize, IID_ID3D11ShaderReflection, (void**)pReflector.GetAddressOf());
if( FAILED(hr) ) {
  throw std::runtimer_error("ID3D11ShaderReflectionの作成に失敗");
}
D3D11_SHADER_DESC desc;
pReflector->GetDesc(&desc);
for( auto i = 0u; i < desc.BoundResources; ++i ) {
  D3D11_SHADER_INPUT_BIND_DESC bindDesc;
  pReflector->GetResourceBindingDesc(i, &bindDesc);
  /// .. リソースについて知りたい情報を調べていく
}