Shaderc VkRunner (GPU Shader Sandbox)

🚀 VkRunner 使用ドキュメント

VkRunner は、shader テストスクリプトを実行するためのツールです。GLSL または SPIR - V を使用して shader をコンパイルし実行し、結果を PPM 画像として出力することができます。さらに、C ライブラリインターフェースも提供しており、他のテストセットに簡単に統合することができます。

🚀 クイックスタート

VkRunner を使用することで、shader のテストを簡単に行うことができます。以下に基本的な使い方を説明します。

✨ 主な機能

• shader テストスクリプトの実行が可能で、GLSL または SPIR - V をサポート。
• 結果を PPM 画像として出力できる。
• C ライブラリインターフェースを提供し、他のテストセットへの統合が容易。

📚 ドキュメント

🔍 スクリプト構造

🌐 環境設定

• デバイス選択: --device - id DEVID オプションを使用して、Vulkan デバイスを指定します。
• ログ出力: -i IMG オプションを使用して、最終的なレンダリング結果を PPM 画像として保存します。
• デバッグ情報: -d オプションを使用すると、SPIR - V の逆アセンブル情報を表示します。

📜 スクリプト内容

🎨 シェーダー設定

• 頂点シェーダー: vertexShader 指令を使用して、GLSL または SPIR - V ファイルを指定します。
• フラグメントシェーダー: fragmentShader 指令を使用して、GLSL または SPIR - V ファイルを指定します。
• コンピュートシェーダー: computeShader 指令を使用して、GLSL または SPIR - V ファイルを指定します。

📦 定数バッファ設定

• ubo 設定: ubo N subdata TYPE VALUE を使用して、UBO に初期値を割り当てます。

⚙️ シェーダー事前処理

• GLSL コンパイル: glslangValidator と spirv - as ツールを使用して、GLSL を SPIR - V に変換します。
• SPIR - V 事前コンパイル: スクリプトに直接 SPIR - V バイナリデータを含めることで、コンパイラの依存関係を回避できます。

🎉 グラフィックレンダリング

• 描画コマンド: draw arrays または draw indexed 指令を使用して、グラフィックをレンダリングします。
• 頂点データ: [vertex data] と [indices] 部分を使用して、頂点とインデックスバッファを定義します。

💻 使用例

基本的な使用法

サンプルスクリプト：basic.shader_test

[vertex data]
# 三角形の頂点座標を定義
0.0 0.0 1.0  # 最初の頂点 (x, y, z)
0.5 0.0 1.0  # 2番目の頂点
0.25 0.5 1.0 # 3番目の頂点

[vertex data]
# 2番目の三角形の頂点座標を定義
-0.5 0.0 1.0
-0.75 0.5 1.0
-0.25 0.5 1.0

[index]
# インデックスバッファを使用して2つの三角形を描画
0 1 2  # 最初の三角形を描画
3 4 5  # 2番目の三角形を描画

[test commands]
draw arrays triangleStrip

サンプルスクリプト：compute.shader_test

[ubo]
# 簡単な UBO 構造体を定義
struct Buf {
    data vec4;
};

buf Buf ubodata = (Buf){vec4(1.0, 0.0, 0.0, 1.0)};

[test commands]
computeShader compute.comp  # コンピュートシェーダーファイルを指定

高度な使用法

事前コンパイルツール

ツールの説明

• precompile - script.py: shader スクリプトをバイナリファイルに事前コンパイルし、実行を高速化し、依存関係を減らします。
• コマンドラインオプション:
  • -o OUTPUT_DIR: 出力ディレクトリを指定します。
  • -g GLSLANG_PATH: glslangValidator のパスを指定します。
  • -s SPIRV_AS_PATH: spirv - as のパスを指定します。

使用例

# すべてのサンプルを compiled - examples ディレクトリに事前コンパイル
./precompile-script.py -o compiled-examples examples/*.shader_test

# 事前コンパイルされたテストケースを実行
./src/vkrunner compiled-examples/*.