PIX API を使用すると、PIX UI を使用せずに、GPU キャプチャの取得、タイミング キャプチャを開く、レンダリング パフォーマンスの分析など、PIX の機能をプログラムで制御できます。 API は COM ベースです。 PixApi.hを含め、 PixApi.libに対してリンクし、 IPixFactory に根ざした一連の COM インターフェイスを介して作業します。
このセクションでは、C++ API サーフェスについて説明します。 参照ページは PIX API ヘッダーから生成されるため、配送 API を追跡します。
前提条件
PIX API は PIX インストーラーに付属しています。 取得するには、Windows 10 以降のマシンに PIX をインストールします。 残りの前提条件は、使用する言語によって異なります。必要なのは選択した言語のツールチェーンのみです。
-
C++ - MSVC (
cl.exeまたはclang-cl)。 API は COM ベースです。コンシューマーには、PixApi.hとPixApi.libに対するリンクが含まれます。 ヘッダーでは__uuidofと MSVC C++ ABI を使用するため、Microsoft C++ 拡張機能が必要です。これはcl.exeとclang-clで既定で有効になっています。 -
D3D12 ヘッダー - Windows SDK
10.0.26100以降、または DirectX Agility SDK。 - C# - .NET 10 以降。 C# プロジェクションは CsWin32 で生成されます。
- Python - pythonnet パッケージを使用した Python 3.9 以降。
PIX インストールを検索する
PIX は通常、プレビュー ビルド用に %ProgramFiles%\Microsoft PIX\<version>\ または Microsoft PIX Preview\<version>\ にインストールされます。 インストール ディレクトリには、次の PIX API コンポーネントが含まれています。
| パス | 目次 |
|---|---|
include\ |
C++ ヘッダー ファイル (PixApi.h およびインターフェイス ヘッダー) |
lib\ |
ライブラリのインポート (PixApi.lib) |
| (root をインストール) | ランタイム DLL (pixapi.dll) とそのネイティブ依存関係 |
プロジェクトを設定する
C++ プロジェクトで PIX API を使用するには:
- PIX インストール
include\ディレクトリをプロジェクトの追加イン クルード ディレクトリに追加します。 -
lib\ディレクトリからリンカーの追加依存関係にPixApi.libを追加します。 このライブラリは、 PixCreateFactory エントリ ポイントを提供します。 - インストール ルートからの
pixapi.dllが実行時に検出可能であることを確認します。 最も簡単な方法は、PIX のインストール ディレクトリをPATHに追加するか、実行可能ファイルの横にpixapi.dllコピーすることです。
作業の開始
PIX API ではファクトリ パターンが使用されます。 すべての対話は、IPixFactory インターフェイスを返す PixCreateFactory で始まります。
ComPtr<IPixFactory> factory;
HRESULT hr = PixCreateFactory(IID_PPV_ARGS(factory.GetAddressOf()));
工場出荷時から、キャプチャを開き、デバイスに接続し、PIX API の残りの部分にアクセスできます。
// Open an existing GPU capture.
ComPtr<IPixGpuCaptureDocument> gpuDoc;
hr = factory->OpenGpuCaptureDocument(
L"C:\\path\\to\\capture.wpix",
IID_PPV_ARGS(gpuDoc.GetAddressOf()));
// Or connect to a device for live capture and timing.
PIX_CONNECTION_DESC_LOCAL local = {};
PIX_CONNECTION_DESC desc = {};
desc.Type = PIX_CONNECTION_TYPE_LOCAL;
desc.pLocal = &local;
ComPtr<IPixConnectionDocument> connection;
hr = factory->OpenConnectionDocument(
&desc, nullptr,
IID_PPV_ARGS(connection.GetAddressOf()));
主要なインターフェイス
| インターフェイス | 用途 |
|---|---|
| IPixFactory | 接続とトークンをキャプチャして開くエントリ ポイント。 |
| IPixConnectionDocument | ライブ キャプチャとタイミングのためのデバイス接続を管理します。 |
| IPixGpuCaptureDocument | GPU キャプチャ ファイル (.wpix) を開いて検査します。 |
| IPixGpuCaptureAnalysis | タイミング、リソース、カウンターの GPU キャプチャ分析を実行します。 |
| IPixTimingCaptureDocument | 検査とシンボル解決のためにタイミング キャプチャ ファイルを開きます。 |
| IPixGpuCaptureDrPix | GPU キャプチャで Dr. PIX 自動実験を実行します。 |
インターフェイス、構造体、列挙型、関数の完全な一覧については、このセクションのリファレンス ページを参照してください。
C# と Python のサポート
PIX API には、 CsWin32 プロジェクションとして生成される C# バインディングも付属しており、Python から .NET 相互運用レイヤーを介して使用できます。 3 つの言語すべてで動作する例については、サンプル リポジトリを参照してください。