シェーダーオブジェクトの移植

[アーティクル]
07/13/2023

重要な API

OpenGL ES 2.0 から簡単なレンダラーを移植する場合、最初の手順では、Direct3D 11 の対応する頂点シェーダーオブジェクトとフラグメントシェーダーオブジェクトを設定し、コンパイル後にメインプログラムがシェーダーオブジェクトと通信できるようにします。

注意

新しい Direct3D プロジェクトを作成しましたか? 作成していない場合は、「テンプレートからの DirectX ゲームプロジェクトの作成」の指示に従ってください。このチュートリアルでは、画面に描画するために DXGI リソースと Direct3D リソースを作成していることを前提としています。これらのリソースは、テンプレートで提供されます。

OpenGL ES 2.0 と同じように、Direct3D のコンパイル済みシェーダーは描画コンテキストに関連付ける必要があります。ただし、Direct3D にはもともとシェーダープログラムオブジェクトという概念がありません。そのため、代わりに、シェーダーを ID3D11DeviceContext に直接割り当てる必要があります。この手順では、OpenGL ES 2.0 のシェーダーオブジェクトを作成してバインドするプロセスに従い、Direct3D で対応する API の動作を実現します。

手順

手順 1: シェーダーのコンパイル

この簡単な OpenGL ES 2.0 のサンプルでは、シェーダーをテキストファイルとして保存し、実行時コンパイルのために文字列データとして読み込みます。

OpenGL ES 2.0: シェーダーのコンパイル

GLuint __cdecl CompileShader (GLenum shaderType, const char *shaderSrcStr)
// shaderType can be GL_VERTEX_SHADER or GL_FRAGMENT_SHADER. Returns 0 if compilation fails.
{
  GLuint shaderHandle;
  GLint compiledShaderHandle;
   
  // Create an empty shader object.
  shaderHandle = glCreateShader(shaderType);

  if (shaderHandle == 0)
  return 0;

  // Load the GLSL shader source as a string value. You could obtain it from
  // from reading a text file or hardcoded.
  glShaderSource(shaderHandle, 1, &shaderSrcStr, NULL);
   
  // Compile the shader.
  glCompileShader(shaderHandle);

  // Check the compile status
  glGetShaderiv(shaderHandle, GL_COMPILE_STATUS, &compiledShaderHandle);

  if (!compiledShaderHandle) // error in compilation occurred
  {
    // Handle any errors here.
              
    glDeleteShader(shaderHandle);
    return 0;
  }

  return shaderHandle;

}

Direct3D では、シェーダーは実行時にコンパイルされず、常に、プログラムの他の部分をコンパイルしたときに、CSO ファイルにコンパイルされます。 Microsoft Visual Studio でアプリをコンパイルすると、HLSL ファイルは、アプリで読み込む必要がある CSO (.cso) ファイルにコンパイルされます。アプリをパッケージ化するときは、これらの CSO ファイルを必ず含めてください。

注次の例では、auto キーワードとラムダ構文を使って、シェーダーの読み込みとコンパイルを非同期的に実行します。 ReadDataAsync() はテンプレートに実装されているメソッドで、CSO ファイルをバイトデータの配列 (fileData) として読み取ります。

Direct3D 11: シェーダーのコンパイル

auto loadVSTask = DX::ReadDataAsync(m_projectDir + "SimpleVertexShader.cso");
auto loadPSTask = DX::ReadDataAsync(m_projectDir + "SimplePixelShader.cso");

auto createVSTask = loadVSTask.then([this](Platform::Array<byte>^ fileData) {

m_d3dDevice->CreateVertexShader(
  fileData->Data,
  fileData->Length,
  nullptr,
  &m_vertexShader);

auto createPSTask = loadPSTask.then([this](Platform::Array<byte>^ fileData) {
  m_d3dDevice->CreatePixelShader(
    fileData->Data,
    fileData->Length,
    nullptr,
    &m_pixelShader;
};

手順 2: 頂点シェーダーとフラグメント (ピクセル) シェーダーの作成と読み込み

OpenGL ES 2.0 にはシェーダー "プログラム" という概念があります。この概念は、CPU で実行されるメインプログラムと GPU で実行されるシェーダーの間のインターフェイスとして機能します。シェーダーはコンパイルされ (またはコンパイル済みのソースから読み込まれ)、プログラムに関連付けられることで、GPU で実行できるようになります。

OpenGL ES 2.0: シェーダープログラムへの頂点シェーダーとフラグメントシェーダーの読み込み

GLuint __cdecl LoadShaderProgram (const char *vertShaderSrcStr, const char *fragShaderSrcStr)
{
  GLuint programObject, vertexShaderHandle, fragmentShaderHandle;
  GLint linkStatusCode;

  // Load the vertex shader and compile it to an internal executable format.
  vertexShaderHandle = CompileShader(GL_VERTEX_SHADER, vertShaderSrcStr);
  if (vertexShaderHandle == 0)
  {
    glDeleteShader(vertexShaderHandle);
    return 0;
  }

   // Load the fragment/pixel shader and compile it to an internal executable format.
  fragmentShaderHandle = CompileShader(GL_FRAGMENT_SHADER, fragShaderSrcStr);
  if (fragmentShaderHandle == 0)
  {
    glDeleteShader(fragmentShaderHandle);
    return 0;
  }

  // Create the program object proper.
  programObject = glCreateProgram();
   
  if (programObject == 0)    return 0;

  // Attach the compiled shaders
  glAttachShader(programObject, vertexShaderHandle);
  glAttachShader(programObject, fragmentShaderHandle);

  // Compile the shaders into binary executables in memory and link them to the program object..
  glLinkProgram(programObject);

  // Check the project object link status and determine if the program is available.
  glGetProgramiv(programObject, GL_LINK_STATUS, &linkStatusCode);

  if (!linkStatusCode) // if link status <> 0
  {
    // Linking failed; delete the program object and return a failure code (0).

    glDeleteProgram (programObject);
    return 0;
  }

  // Deallocate the unused shader resources. The actual executables are part of the program object.
  glDeleteShader(vertexShaderHandle);
  glDeleteShader(fragmentShaderHandle);

  return programObject;
}

// ...

glUseProgram(renderer->programObject);

Direct3D には、シェーダープログラムオブジェクトという概念がありません。そのため、シェーダーは、ID3D11Device インターフェイスでいずれかのシェーダー作成メソッド (ID3D11Device::CreateVertexShader や ID3D11Device::CreatePixelShader など) が呼び出されたときに作成されます。現在の描画コンテキストのシェーダーを設定するには、シェーダー設定メソッド (頂点シェーダーの ID3D11DeviceContext::VSSetShader やフラグメントシェーダーの ID3D11DeviceContext::PSSetShader など) を使って、シェーダーを対応する ID3D11DeviceContext に渡します。

Direct3D 11: グラフィックスデバイスの描画コンテキストのシェーダーの設定

m_d3dContext->VSSetShader(
  m_vertexShader.Get(),
  nullptr,
  0);

m_d3dContext->PSSetShader(
  m_pixelShader.Get(),
  nullptr,
  0);

手順 3: シェーダーに渡すデータの定義

OpenGL ES 2.0 の例では、シェーダーパイプラインに対して宣言する次の uniform が 1 つあります。

u_mvpMatrix: 立方体のモデル座標を受け取り、それをスキャン変換のために 2D プロジェクション座標に変換する最終的なモデルビュープロジェクション変換マトリックスを表す浮動小数点値の 4x4 配列。

さらに、頂点データ用の次の attribute 値が 2 つあります。

a_position: 頂点のモデル座標の 4 つの浮動小数点値で構成されたベクトル。
a_color: 頂点に関連付けられている RGBA カラー値の 4 つの浮動小数点値で構成されたベクトル。

OpenGL ES 2.0: GLSL での uniform と attribute の定義

uniform mat4 u_mvpMatrix;
attribute vec4 a_position;
attribute vec4 a_color;

この場合は、対応するメインプログラムの変数をレンダラーオブジェクトのフィールドとして定義します (「簡単な OpenGL ES 2.0 レンダラーを Direct3D 11 に移植する方法」の見出しをご覧ください)。定義したら、メインプログラムでシェーダーパイプラインにこれらの値を渡すメモリ内の場所を指定する必要があります。これは、通常、描画呼び出しの直前に行います。

OpenGL ES 2.0: uniform データと attribute データの場所のマーキング


// Inform the shader of the attribute locations
loc = glGetAttribLocation(renderer->programObject, "a_position");
glVertexAttribPointer(loc, 3, GL_FLOAT, GL_FALSE, 
    sizeof(Vertex), 0);
glEnableVertexAttribArray(loc);

loc = glGetAttribLocation(renderer->programObject, "a_color");
glVertexAttribPointer(loc, 4, GL_FLOAT, GL_FALSE, 
    sizeof(Vertex), (GLvoid*) (sizeof(float) * 3));
glEnableVertexAttribArray(loc);


// Inform the shader program of the uniform location
renderer->mvpLoc = glGetUniformLocation(renderer->programObject, "u_mvpMatrix");

Direct3D には、同じ意味での "attribute" と "uniform" の概念がありません (または、少なくともこの構文を共有しません)。その代わり、Direct3D サブリソースとして表される定数バッファーがあります。これは、メインプログラムとシェーダープログラムの間で共有されるリソースです。頂点の位置や色など、これらのサブリソースの一部は HLSL セマンティクスと呼ばれます。 OpenGL ES 2.0 の概念に関連する定数バッファーと HLSL セマンティクスについて詳しくは、「OpenGL ES 2.0 のバッファー、uniform、頂点 attribute と Direct3D の比較」を参照してください。

このプロセスを Direct3D に移行する場合は、uniform を Direct3D の定数バッファー (cbuffer) に変換し、register HLSL セマンティクスを使って、検索のために cbuffer をレジスタに割り当てます。 2 つの頂点 attribute はシェーダーパイプラインステージの入力要素として処理され、シェーダーに通知する HLSL セマンティクス (POSITION と COLOR0) が割り当てられます。ピクセルシェーダーは、GPU によって生成されたシステム値であることを示す SV_ プレフィックスが付いている SV_POSITION を受け取ります (この場合は、スキャン変換時に生成されたピクセルの位置です)。VertexShaderInput と PixelShaderInput は定数バッファーとして宣言しません。これは、VertexShaderInput は頂点バッファーを定義するために使い (「頂点バッファーと頂点データの移植」をご覧ください)、PixelShaderInput のデータはパイプラインの前のステージ (この場合は頂点シェーダー) の結果として生成されるためです。

Direct3D: HLSL での定数バッファーと頂点データの定義

cbuffer ModelViewProjectionConstantBuffer : register(b0)
{
  matrix mvp;
};

// Per-vertex data used as input to the vertex shader.
struct VertexShaderInput
{
  float4 pos : POSITION;
  float4 color : COLOR0;
};

// Per-vertex color data passed through the pixel shader.
struct PixelShaderInput
{
  float4 pos : SV_POSITION;
  float3 color : COLOR0;
};

定数バッファーへの移植と HLSL セマンティクスの利用について詳しくは、「OpenGL ES 2.0 のバッファー、uniform、頂点 attribute と Direct3D の比較」をご覧ください。

定数バッファーまたは頂点バッファーを使ってシェーダーパイプラインに渡されるデータのレイアウトの構造体を次に示します。

Direct3D 11: 定数バッファーと頂点バッファーのレイアウトの宣言

// Constant buffer used to send MVP matrices to the vertex shader.
struct ModelViewProjectionConstantBuffer
{
  DirectX::XMFLOAT4X4 modelViewProjection;
};

// Used to send per-vertex data to the vertex shader.
struct VertexPositionColor
{
  DirectX::XMFLOAT4 pos;
  DirectX::XMFLOAT4 color;
};

定数バッファー要素には DirectXMath XM* 型を使っています。これにより、シェーダーパイプラインに送信する際に、コンテンツのパッキングとアラインメントが適切に行われます。 Windows プラットフォームの標準の浮動小数点型と配列を使う場合は、手動でパッキングとアラインメントを実行する必要があります。

定数バッファーをバインドするために、レイアウトの記述を CD3D11_BUFFER_DESC 構造体として作成し、ID3DDevice::CreateBuffer に渡します。次に、レンダリングメソッドで、定数バッファーを ID3D11DeviceContext::UpdateSubresource に渡してから、描画します。

Direct3D 11: 定数バッファーのバインド

CD3D11_BUFFER_DESC constantBufferDesc(sizeof(ModelViewProjectionConstantBuffer), D3D11_BIND_CONSTANT_BUFFER);

m_d3dDevice->CreateBuffer(
  &constantBufferDesc,
  nullptr,
  &m_constantBuffer);

// ...

// Only update shader resources that have changed since the last frame.
m_d3dContext->UpdateSubresource(
  m_constantBuffer.Get(),
  0,
  NULL,
  &m_constantBufferData,
  0,
  0);

同じように頂点バッファーを作成して更新します。これについては、次の手順の「頂点バッファーと頂点データの移植」で説明します。