ホーム › Graphics.Direct3D.Fxc › D3DCompile2

D3DCompile2

関数

拡張オプション付きでシェーダーをコンパイルする。

シグネチャ

// D3DCOMPILER_47.dll
#include <windows.h>

HRESULT D3DCompile2(
    const void* pSrcData,
    UINT_PTR SrcDataSize,
    LPCSTR pSourceName,   // optional
    const D3D_SHADER_MACRO* pDefines,   // optional
    ID3DInclude* pInclude,   // optional
    LPCSTR pEntrypoint,
    LPCSTR pTarget,
    DWORD Flags1,
    DWORD Flags2,
    DWORD SecondaryDataFlags,
    const void* pSecondaryData,   // optional
    UINT_PTR SecondaryDataSize,
    ID3DBlob** ppCode,
    ID3DBlob** ppErrorMsgs   // optional
);

パラメーター

名前型方向説明

pSrcData void* in 未コンパイルのシェーダーデータ (ASCII の HLSL コード) へのポインター。

SrcDataSize UINT_PTR in pSrcData が指すメモリブロックのサイズ (バイト単位)。

pSourceName LPCSTR inoptional エラーメッセージ内でソースデータを識別するために使用する名前を格納した、null で終わる定数文字列への省略可能なポインター。使用しない場合は NULL を設定します。

pDefines D3D_SHADER_MACRO* inoptional シェーダーマクロを定義する D3D_SHADER_MACRO 構造体の省略可能な配列。各マクロ定義には、名前と null で終わる定義が含まれます。使用しない場合は NULL を設定します。配列の最後の構造体は終端として機能し、すべてのメンバーを NULL に設定する必要があります。

pInclude

ID3DInclude*

inoptional

コンパイラーがインクルードファイルを処理するために使用する ID3DInclude インターフェイスへのポインター。このパラメーターに NULL を設定し、かつシェーダーに #include が含まれている場合は、コンパイルエラーが発生します。既定のインクルードハンドラーへのポインターである D3D_COMPILE_STANDARD_FILE_INCLUDE マクロを渡すこともできます。この既定のインクルードハンドラーは、現在のディレクトリからの相対パスにあるファイルと、最初のソースファイルのディレクトリからの相対パスにあるファイルをインクルードします。D3D_COMPILE_STANDARD_FILE_INCLUDE を使用する場合は、pSourceName パラメーターにソースファイル名を指定する必要があります。コンパイラーは pSourceName から最初の相対ディレクトリを導出します。

#define D3D_COMPILE_STANDARD_FILE_INCLUDE ((ID3DInclude*)(UINT_PTR)1)

pEntrypoint LPCSTR in シェーダーの実行が開始されるシェーダーエントリポイント関数の名前を格納した、null で終わる定数文字列へのポインター。エフェクトをコンパイルする場合、D3DCompile2 は pEntrypoint を無視します。呼び出される関数が使用しないポインターパラメーターには NULL を設定するのが良いプログラミング作法であるため、pEntrypoint には NULL を設定することをお勧めします。

pTarget LPCSTR in コンパイルの対象となるシェーダーターゲット、またはシェーダー機能のセットを指定する、null で終わる定数文字列へのポインター。シェーダーターゲットには、シェーダーモデル (シェーダーモデル 2、シェーダーモデル 3、シェーダーモデル 4、シェーダーモデル 5 など) を指定できます。ターゲットには、エフェクトの種類 (fx_4_1 など) を指定することもできます。各種プロファイルがサポートするターゲットについては、「Specifying Compiler Targets」を参照してください。

Flags1 DWORD in ビットごとの OR 演算で組み合わせたシェーダーの D3D compile constants の組み合わせ。結果の値は、コンパイラーが HLSL コードをどのようにコンパイルするかを指定します。

Flags2 DWORD in ビットごとの OR 演算で組み合わせたエフェクトの D3D compile effect constants の組み合わせ。結果の値は、コンパイラーがエフェクトをどのようにコンパイルするかを指定します。エフェクトファイルではなくシェーダーをコンパイルする場合、D3DCompile2 は Flags2 を無視します。呼び出される関数が使用しないポインター以外のパラメーターには 0 を設定するのが良いプログラミング作法であるため、Flags2 には 0 を設定することをお勧めします。

SecondaryDataFlags

DWORD

ビットごとの OR 演算で組み合わせた、次のフラグの組み合わせ。結果の値は、コンパイラーが HLSL コードをどのようにコンパイルするかを指定します。

フラグ	説明
D3DCOMPILE_SECDATA_MERGE_UAV_SLOTS (0x01)	pSecondaryData パラメーターが指す二次データ内のアンオーダードアクセスビュー (UAV) スロットをマージします。
D3DCOMPILE_SECDATA_PRESERVE_TEMPLATE_SLOTS (0x02)	pSecondaryData パラメーターが指す二次データ内のテンプレートスロットを保持します。
D3DCOMPILE_SECDATA_REQUIRE_TEMPLATE_MATCH (0x04)	コンパイラーが HLSL コードをコンパイルする際に、pSecondaryData パラメーターが指す二次データ内のテンプレートが一致することを必須にします。

pSecondaryData が NULL の場合は 0 を設定します。

pSecondaryData void* inoptional 二次データへのポインター。二次データを渡さない場合は NULL を設定します。この二次データは、2 つのシェーダー間で UAV スロットを揃えるために使用します。たとえば、シェーダー A に UAV があり、それらが何らかのスロットにバインドされているとします。A と同じ名前の UAV が B でも A と同じスロットにマップされるようにシェーダー B をコンパイルするには、A のバイトコードを二次データとして D3DCompile2 に渡します。

SecondaryDataSize UINT_PTR in pSecondaryData が指すメモリブロックのサイズ (バイト単位)。pSecondaryData が NULL の場合は 0 を設定します。

ppCode ID3DBlob** out コンパイル済みコードへのアクセスに使用できる ID3DBlob インターフェイスへのポインターを受け取る変数へのポインター。

ppErrorMsgs ID3DBlob** outoptional コンパイラーのエラーメッセージへのアクセスに使用できる ID3DBlob インターフェイスへのポインターを受け取る変数へのポインター。エラーがない場合は NULL になります。

戻り値の型: HRESULT

公式ドキュメント

Microsoft High Level Shader Language (HLSL) のコードを、指定したターゲット向けのバイトコードにコンパイルします。(D3DCompile2)

戻り値

型: HRESULT

Direct3D 11 のリターンコードのいずれかを返します。

解説(Remarks)

D3DCompile2 と D3DCompile の違いは、D3DCompile2 にはバイトコードの生成方法の一部を制御するために使用できる省略可能なパラメーター (SecondaryDataFlags、pSecondaryData、SecondaryDataSize) がある点です。詳細については、これらのパラメーターの説明を参照してください。それ以外の点では、D3DCompile2 と D3DCompile とで生成されるバイトコードの効率に違いはありません。

UWP 向けのシェーダーのコンパイル

シェーダーをオフラインでコンパイルするには、エフェクトコンパイラーツールを使用する方法をお勧めします。すべてのシェーダーを事前にコンパイルできない場合は、コストの高いシェーダーや、起動時およびパフォーマンスに最も影響するパスで必要となるシェーダーをコンパイルし、残りは実行時にコンパイルすることを検討してください。UWP アプリケーションで、読み込んだシェーダーや生成したシェーダーを、ユーザーインターフェイススレッドをブロックせずにコンパイルするには、次のような手順を使用できます。

Visual Studio 2015 以降で UWP アプリを開発する場合、新しい項目「shader.hlsl」を追加します。
- Visual Studio のソリューションフォルダービューで shaders.hlsl 項目を選択し、右クリックしてプロパティを開きます。
- コンテンツ項目がはいに設定されていることを確認します。
- 項目の種類がテキストに設定されていることを確認します。
- XAML にボタンを追加して適切な名前を付け (この例では「TheButton」)、Click ハンドラーを追加します。
次に、.cpp ファイルに次のインクルードを追加します。
```
#include <ppltasks.h>
#include <d3dcompiler.h>
#include <Robuffer.h>
```
次のコードを使用して D3DCompile2 を呼び出します。ここではエラーチェックや処理を行っていない点に注意してください。また、このコードは I/O とコンパイルの両方をバックグラウンドで実行できることを示しており、これによって UI の応答性が保たれます。

void App1::DirectXPage::TheButton_Click(Platform::Object^ sender, Windows::UI::Xaml::RoutedEventArgs^ e)
{
  std::shared_ptr<Microsoft::WRL::ComPtr<ID3DBlob>> blobRef = std::make_shared<Microsoft::WRL::ComPtr<ID3DBlob>>();

  // ファイルを読み込んでコンパイルする。
  auto fileOp = Windows::ApplicationModel::Package::Current->InstalledLocation->GetFileAsync(L"shader.hlsl");
  create_task(fileOp).then([this](Windows::Storage::StorageFile^ file) -> IAsyncOperation<Windows::Storage::Streams::IBuffer^>^
  {
    // ファイル I/O はバックグラウンドスレッドで行う (use_arbitrary)。
    return Windows::Storage::FileIO::ReadBufferAsync(file);
  }, task_continuation_context::use_arbitrary())
    .then([this, blobRef](Windows::Storage::Streams::IBuffer^ buffer)
  {
    // コンパイルはバックグラウンドスレッドで行う (use_arbitrary)。

    // Object^ にキャストし、さらにその基になる IInspectable インターフェイスにキャストする。
    Microsoft::WRL::ComPtr<IInspectable> insp(reinterpret_cast<IInspectable*>(buffer));

    // IBufferByteAccess インターフェイスをクエリする。
    Microsoft::WRL::ComPtr<Windows::Storage::Streams::IBufferByteAccess> bufferByteAccess;
    insp.As(&bufferByteAccess);

    // バッファーのデータを取得する。
    byte *pBytes = nullptr;
    bufferByteAccess->Buffer(&pBytes);

    Microsoft::WRL::ComPtr<ID3DBlob> blob;
    Microsoft::WRL::ComPtr<ID3DBlob> errMsgs;
    D3DCompile2(pBytes, buffer->Length, "shader.hlsl", nullptr, nullptr, "main", "ps_5_0", 0, 0, 0, nullptr, 0, blob.GetAddressOf(), errMsgs.GetAddressOf());
    *blobRef = blob;
  }, task_continuation_context::use_arbitrary())
    .then([this, blobRef]()
  {
    // UI を更新する / フォアグラウンドスレッドでシェーダーを使用する。
    wchar_t message[40];
    swprintf_s(message, L"blob is %u bytes long", (unsigned)(*blobRef)->GetBufferSize());
    this->TheButton->Content = ref new Platform::String(message);
  }, task_continuation_context::use_current());
}

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// D3DCOMPILER_47.dll
#include <windows.h>

HRESULT D3DCompile2(
    const void* pSrcData,
    UINT_PTR SrcDataSize,
    LPCSTR pSourceName,   // optional
    const D3D_SHADER_MACRO* pDefines,   // optional
    ID3DInclude* pInclude,   // optional
    LPCSTR pEntrypoint,
    LPCSTR pTarget,
    DWORD Flags1,
    DWORD Flags2,
    DWORD SecondaryDataFlags,
    const void* pSecondaryData,   // optional
    UINT_PTR SecondaryDataSize,
    ID3DBlob** ppCode,
    ID3DBlob** ppErrorMsgs   // optional
);

[DllImport("D3DCOMPILER_47.dll", ExactSpelling = true)]
static extern int D3DCompile2(
    IntPtr pSrcData,   // void*
    UIntPtr SrcDataSize,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string pSourceName,   // LPCSTR optional
    IntPtr pDefines,   // D3D_SHADER_MACRO* optional
    IntPtr pInclude,   // ID3DInclude* optional
    [MarshalAs(UnmanagedType.LPStr)] string pEntrypoint,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pTarget,   // LPCSTR
    uint Flags1,   // DWORD
    uint Flags2,   // DWORD
    uint SecondaryDataFlags,   // DWORD
    IntPtr pSecondaryData,   // void* optional
    UIntPtr SecondaryDataSize,   // UINT_PTR
    IntPtr ppCode,   // ID3DBlob** out
    IntPtr ppErrorMsgs   // ID3DBlob** optional, out
);

<DllImport("D3DCOMPILER_47.dll", ExactSpelling:=True)>
Public Shared Function D3DCompile2(
    pSrcData As IntPtr,   ' void*
    SrcDataSize As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPStr)> pSourceName As String,   ' LPCSTR optional
    pDefines As IntPtr,   ' D3D_SHADER_MACRO* optional
    pInclude As IntPtr,   ' ID3DInclude* optional
    <MarshalAs(UnmanagedType.LPStr)> pEntrypoint As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pTarget As String,   ' LPCSTR
    Flags1 As UInteger,   ' DWORD
    Flags2 As UInteger,   ' DWORD
    SecondaryDataFlags As UInteger,   ' DWORD
    pSecondaryData As IntPtr,   ' void* optional
    SecondaryDataSize As UIntPtr,   ' UINT_PTR
    ppCode As IntPtr,   ' ID3DBlob** out
    ppErrorMsgs As IntPtr   ' ID3DBlob** optional, out
) As Integer
End Function

' pSrcData : void*
' SrcDataSize : UINT_PTR
' pSourceName : LPCSTR optional
' pDefines : D3D_SHADER_MACRO* optional
' pInclude : ID3DInclude* optional
' pEntrypoint : LPCSTR
' pTarget : LPCSTR
' Flags1 : DWORD
' Flags2 : DWORD
' SecondaryDataFlags : DWORD
' pSecondaryData : void* optional
' SecondaryDataSize : UINT_PTR
' ppCode : ID3DBlob** out
' ppErrorMsgs : ID3DBlob** optional, out
Declare PtrSafe Function D3DCompile2 Lib "d3dcompiler_47" ( _
    ByVal pSrcData As LongPtr, _
    ByVal SrcDataSize As LongPtr, _
    ByVal pSourceName As String, _
    ByVal pDefines As LongPtr, _
    ByVal pInclude As LongPtr, _
    ByVal pEntrypoint As String, _
    ByVal pTarget As String, _
    ByVal Flags1 As Long, _
    ByVal Flags2 As Long, _
    ByVal SecondaryDataFlags As Long, _
    ByVal pSecondaryData As LongPtr, _
    ByVal SecondaryDataSize As LongPtr, _
    ByVal ppCode As LongPtr, _
    ByVal ppErrorMsgs As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

D3DCompile2 = ctypes.windll.d3dcompiler_47.D3DCompile2
D3DCompile2.restype = ctypes.c_int
D3DCompile2.argtypes = [
    ctypes.POINTER(None),  # pSrcData : void*
    ctypes.c_size_t,  # SrcDataSize : UINT_PTR
    wintypes.LPCSTR,  # pSourceName : LPCSTR optional
    ctypes.c_void_p,  # pDefines : D3D_SHADER_MACRO* optional
    ctypes.c_void_p,  # pInclude : ID3DInclude* optional
    wintypes.LPCSTR,  # pEntrypoint : LPCSTR
    wintypes.LPCSTR,  # pTarget : LPCSTR
    wintypes.DWORD,  # Flags1 : DWORD
    wintypes.DWORD,  # Flags2 : DWORD
    wintypes.DWORD,  # SecondaryDataFlags : DWORD
    ctypes.POINTER(None),  # pSecondaryData : void* optional
    ctypes.c_size_t,  # SecondaryDataSize : UINT_PTR
    ctypes.c_void_p,  # ppCode : ID3DBlob** out
    ctypes.c_void_p,  # ppErrorMsgs : ID3DBlob** optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('D3DCOMPILER_47.dll')
D3DCompile2 = Fiddle::Function.new(
  lib['D3DCompile2'],
  [
    Fiddle::TYPE_VOIDP,  # pSrcData : void*
    Fiddle::TYPE_UINTPTR_T,  # SrcDataSize : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pSourceName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pDefines : D3D_SHADER_MACRO* optional
    Fiddle::TYPE_VOIDP,  # pInclude : ID3DInclude* optional
    Fiddle::TYPE_VOIDP,  # pEntrypoint : LPCSTR
    Fiddle::TYPE_VOIDP,  # pTarget : LPCSTR
    -Fiddle::TYPE_INT,  # Flags1 : DWORD
    -Fiddle::TYPE_INT,  # Flags2 : DWORD
    -Fiddle::TYPE_INT,  # SecondaryDataFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pSecondaryData : void* optional
    Fiddle::TYPE_UINTPTR_T,  # SecondaryDataSize : UINT_PTR
    Fiddle::TYPE_VOIDP,  # ppCode : ID3DBlob** out
    Fiddle::TYPE_VOIDP,  # ppErrorMsgs : ID3DBlob** optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "d3dcompiler_47")]
extern "system" {
    fn D3DCompile2(
        pSrcData: *const (),  // void*
        SrcDataSize: usize,  // UINT_PTR
        pSourceName: *const u8,  // LPCSTR optional
        pDefines: *const D3D_SHADER_MACRO,  // D3D_SHADER_MACRO* optional
        pInclude: *mut core::ffi::c_void,  // ID3DInclude* optional
        pEntrypoint: *const u8,  // LPCSTR
        pTarget: *const u8,  // LPCSTR
        Flags1: u32,  // DWORD
        Flags2: u32,  // DWORD
        SecondaryDataFlags: u32,  // DWORD
        pSecondaryData: *const (),  // void* optional
        SecondaryDataSize: usize,  // UINT_PTR
        ppCode: *mut *mut core::ffi::c_void,  // ID3DBlob** out
        ppErrorMsgs: *mut *mut core::ffi::c_void  // ID3DBlob** optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("D3DCOMPILER_47.dll")]
public static extern int D3DCompile2(IntPtr pSrcData, UIntPtr SrcDataSize, [MarshalAs(UnmanagedType.LPStr)] string pSourceName, IntPtr pDefines, IntPtr pInclude, [MarshalAs(UnmanagedType.LPStr)] string pEntrypoint, [MarshalAs(UnmanagedType.LPStr)] string pTarget, uint Flags1, uint Flags2, uint SecondaryDataFlags, IntPtr pSecondaryData, UIntPtr SecondaryDataSize, IntPtr ppCode, IntPtr ppErrorMsgs);
"@
$api = Add-Type -MemberDefinition $sig -Name 'D3DCOMPILER_47_D3DCompile2' -Namespace Win32 -PassThru
# $api::D3DCompile2(pSrcData, SrcDataSize, pSourceName, pDefines, pInclude, pEntrypoint, pTarget, Flags1, Flags2, SecondaryDataFlags, pSecondaryData, SecondaryDataSize, ppCode, ppErrorMsgs)

#uselib "D3DCOMPILER_47.dll"
#func global D3DCompile2 "D3DCompile2" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; D3DCompile2 pSrcData, SrcDataSize, pSourceName, varptr(pDefines), pInclude, pEntrypoint, pTarget, Flags1, Flags2, SecondaryDataFlags, pSecondaryData, SecondaryDataSize, ppCode, ppErrorMsgs   ; 戻り値は stat
; pSrcData : void* -> "sptr"
; SrcDataSize : UINT_PTR -> "sptr"
; pSourceName : LPCSTR optional -> "sptr"
; pDefines : D3D_SHADER_MACRO* optional -> "sptr"
; pInclude : ID3DInclude* optional -> "sptr"
; pEntrypoint : LPCSTR -> "sptr"
; pTarget : LPCSTR -> "sptr"
; Flags1 : DWORD -> "sptr"
; Flags2 : DWORD -> "sptr"
; SecondaryDataFlags : DWORD -> "sptr"
; pSecondaryData : void* optional -> "sptr"
; SecondaryDataSize : UINT_PTR -> "sptr"
; ppCode : ID3DBlob** out -> "sptr"
; ppErrorMsgs : ID3DBlob** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "D3DCOMPILER_47.dll"
#cfunc global D3DCompile2 "D3DCompile2" sptr, sptr, str, var, sptr, str, str, int, int, int, sptr, sptr, sptr, sptr
; res = D3DCompile2(pSrcData, SrcDataSize, pSourceName, pDefines, pInclude, pEntrypoint, pTarget, Flags1, Flags2, SecondaryDataFlags, pSecondaryData, SecondaryDataSize, ppCode, ppErrorMsgs)
; pSrcData : void* -> "sptr"
; SrcDataSize : UINT_PTR -> "sptr"
; pSourceName : LPCSTR optional -> "str"
; pDefines : D3D_SHADER_MACRO* optional -> "var"
; pInclude : ID3DInclude* optional -> "sptr"
; pEntrypoint : LPCSTR -> "str"
; pTarget : LPCSTR -> "str"
; Flags1 : DWORD -> "int"
; Flags2 : DWORD -> "int"
; SecondaryDataFlags : DWORD -> "int"
; pSecondaryData : void* optional -> "sptr"
; SecondaryDataSize : UINT_PTR -> "sptr"
; ppCode : ID3DBlob** out -> "sptr"
; ppErrorMsgs : ID3DBlob** optional, out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "D3DCOMPILER_47.dll"
#cfunc global D3DCompile2 "D3DCompile2" sptr, sptr, str, sptr, sptr, str, str, int, int, int, sptr, sptr, sptr, sptr
; res = D3DCompile2(pSrcData, SrcDataSize, pSourceName, varptr(pDefines), pInclude, pEntrypoint, pTarget, Flags1, Flags2, SecondaryDataFlags, pSecondaryData, SecondaryDataSize, ppCode, ppErrorMsgs)
; pSrcData : void* -> "sptr"
; SrcDataSize : UINT_PTR -> "sptr"
; pSourceName : LPCSTR optional -> "str"
; pDefines : D3D_SHADER_MACRO* optional -> "sptr"
; pInclude : ID3DInclude* optional -> "sptr"
; pEntrypoint : LPCSTR -> "str"
; pTarget : LPCSTR -> "str"
; Flags1 : DWORD -> "int"
; Flags2 : DWORD -> "int"
; SecondaryDataFlags : DWORD -> "int"
; pSecondaryData : void* optional -> "sptr"
; SecondaryDataSize : UINT_PTR -> "sptr"
; ppCode : ID3DBlob** out -> "sptr"
; ppErrorMsgs : ID3DBlob** optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。