1. はじめに
このセクションは規定ではありません。
グラフィックス処理ユニット(GPU)は、パーソナルコンピュータにおいて豊かなレンダリングや計算アプリケーションを可能にする重要な役割を担っています。 WebGPUは、Web上でGPUハードウェアの機能を公開するAPIです。 このAPIは、(2014年以降の)ネイティブGPU APIに効率良くマッピングできるよう、ゼロから設計されています。 WebGPUはWebGLとは関係なく、OpenGL ESを明示的にターゲットとしていません。
WebGPUは物理的なGPUハードウェアをGPUAdapterとして扱います。
アダプターへの接続は
GPUDeviceを介し、リソースの管理やデバイスのGPUQueueによるコマンド実行を行います。
GPUDeviceは、処理ユニットへ高速アクセス可能な独自メモリを持つ場合があります。
GPUBufferや
GPUTextureは、GPUメモリに裏付けられた物理リソースです。
GPUCommandBufferや
GPURenderBundleは、ユーザーが記録したコマンドのコンテナです。
GPUShaderModuleはシェーダーコードを格納します。他のリソース、例えばGPUSamplerや
GPUBindGroupは、GPUが
物理リソースを利用する方法を構成します。
GPUはGPUCommandBufferでエンコードされたコマンドを実行し、データをパイプライン(固定機能とプログラム可能ステージの混在)へ流します。プログラム可能ステージは
シェーダー(GPU上で動作する専用プログラム)を実行します。
パイプラインのほとんどの状態は
GPURenderPipelineや
GPUComputePipelineオブジェクトで定義されます。それ以外の状態は、コマンド
beginRenderPass()や
setBlendConstant()などでエンコード時に設定されます。
2. 悪意ある利用への考慮事項
このセクションは規定ではありません。 このAPIをWebで公開することによるリスクについて説明します。
2.1. セキュリティの考慮事項
WebGPUのセキュリティ要件はWebの従来通りであり、変更できません。 一般的なアプローチは、すべてのコマンドをGPUに到達する前に厳格に検証し、ページが自身のデータだけ操作できるようにすることです。
2.1.1. CPUベースの未定義動作
WebGPU実装は、ユーザーによるワークロードをターゲットプラットフォーム固有のAPIコマンドに変換します。ネイティブAPIはコマンドの正しい使用方法を規定しており(例:vkCreateDescriptorSetLayout)、有効な利用規則を守らない場合の結果は保証されません。 これは「未定義動作」と呼ばれ、攻撃者が自身の所有しないメモリにアクセスしたり、ドライバに任意のコードを実行させたりすることに悪用される可能性があります。
安全でない利用を禁止するため、WebGPUの許容動作範囲は全ての入力に対して定義されています。
実装はユーザーからの全ての入力を検証し、有効なワークロードのみドライバへ到達させる必要があります。本書では全てのエラー条件とその取り扱いについて規定しています。
例えば、copyBufferToBuffer()の「source」と「destination」の両方で、交差する範囲の同一バッファを指定すると、
GPUCommandEncoderはエラーを生成し、他の操作は行われません。
エラー処理の詳細は§ 22 エラーとデバッグを参照してください。
2.1.2. GPUベースの未定義動作
WebGPUのシェーダーはGPUハードウェア内部の計算ユニットで実行されます。ネイティブAPIでは、一部のシェーダー命令がGPU上で未定義動作となる場合があります。
これに対応するため、WebGPUではシェーダー命令セットとその動作を厳密に定義しています。シェーダーがcreateShaderModule()に渡される際、
WebGPU実装はプラットフォーム固有シェーダーへの変換や最適化を行う前に、必ず検証を行います。
2.1.3. 未初期化データ
一般に、新しいメモリの割り当ては、システム上で他のアプリケーションが残したデータが露出する可能性があります。 これに対処するため、WebGPUは概念的にすべてのリソースをゼロ初期化しますが、実際には開発者が手動で内容を初期化する場合はこの手順を省略することもあります。 シェーダー内の変数や共有ワークグループメモリもこれに含まれます。
ワークグループメモリのクリア方法はプラットフォームにより異なります。 ネイティブAPIがクリア機能を提供しない場合、WebGPU実装は計算シェーダー内で全呼び出しを使ってクリアを行い、同期後に開発者のコード実行を続行します。
GPULoadOp
"load"を"clear"へ変更)が必要になる場合があります。
そのため、すべての実装は、このパフォーマンス低下の可能性について開発者コンソールで警告を推奨すべきですが、実際に低下がなくても警告を表示すべきです。
2.1.4. シェーダー内の範囲外アクセス
シェーダーは物理リソースへ直接(例:"uniform"
GPUBufferBinding)、またはテクスチャユニット(座標変換を扱う固定機能ハードウェアブロック)経由でアクセスできます。
WebGPU APIの検証では、シェーダーへの全入力が提供され、使用法・型が正しいことのみ保証できます。
テクスチャユニットが関与しない場合、データへのアクセスが範囲内であることはAPIレベルでは保証できません。
シェーダーがアプリケーション所有外のGPUメモリへアクセスするのを防ぐため、WebGPU実装はドライバの「堅牢なバッファアクセス」モードを有効化し、アクセスをバッファ範囲内に制限する場合があります。
または、手動で範囲外チェックを挿入するようにシェーダーコードを変換することもできます。この場合、範囲外チェックは配列インデックスへのアクセスにのみ適用されます。構造体の単純なフィールドアクセスについては、ホスト側のminBindingSize検証により不要です。
シェーダーが物理リソース範囲外のデータを読み込もうとした場合、実装は以下のいずれかを許容します:
-
リソース範囲内の他の場所の値を返す
-
値ベクトル "(0, 0, 0, X)"(Xは任意)を返す
-
描画またはディスパッチ呼び出しを部分的に破棄する
シェーダーが物理リソース範囲外へデータを書き込もうとした場合、実装は以下のいずれかを許容します:
-
リソース範囲内の他の場所へ値を書き込む
-
書き込み操作を破棄する
-
描画またはディスパッチ呼び出しを部分的に破棄する
2.1.5. 無効なデータ
CPUからGPUへ浮動小数点データをアップロードする場合や、GPU上で生成する場合、無限大やNaN(非数)など、正しい数値に対応しない2進表現になる場合があります。このときのGPUの動作は、IEEE-754標準に準拠したGPUハードウェア実装の精度に依存します。 WebGPUは、無効な浮動小数点数値の導入が算術計算結果のみに影響し、それ以外の副作用は生じないことを保証します。
2.1.6. ドライバのバグ
GPUドライバも他のソフトウェア同様、バグの影響を受けます。バグが発生した場合、攻撃者がドライバの誤動作を利用して特権外のデータへアクセスする可能性があります。 このリスク低減のため、WebGPUワーキンググループは、WebGL同様にWebGPU適合テストスイート(CTS)をGPUベンダーのドライバテスト工程に統合するよう協力します。 WebGPU実装では、既知のバグへの対応策を講じ、回避困難なバグがあるドライバではWebGPUの利用を無効化することが期待されます。
2.1.7. タイミング攻撃
2.1.7.1. コンテンツ・タイムラインのタイミング
WebGPUはJavaScriptに新しい状態(コンテンツタイムライン)を公開しません。これは、エージェントが
エージェントクラスタ内で共有するものです。
コンテンツタイムラインの状態(例:[[mapping]])は、
明示的なコンテンツタイムラインタスク(通常のJavaScript同様)時のみ変更されます。
2.1.7.2. デバイス/キュー・タイムラインのタイミング
書き込み可能なストレージバッファや他の呼び出し間通信は、キュータイムライン上で高精度タイマー構築に利用される場合があります。
オプション機能"timestamp-query"もGPU操作の高精度タイミングを提供します。セキュリティ・プライバシー対策として、タイミングクエリ値は低精度に揃えられます:詳細はcurrent queue timestampを参照。特に以下の点に注意してください:
-
デバイスタイムラインは通常、複数のオリジンで共有されるプロセスで動作するため、COOP/COEPによるクロスオリジン分離はデバイス/キュー・タイムラインのタイマー分離を提供しません。
-
キュータイムラインの作業はデバイスタイムラインから発行され、GPUハードウェア上で実行される際、CPUプロセスと同様の分離(Meltdown対策など)が保証されない場合があります。
-
GPUハードウェアは一般にSpectre型攻撃には脆弱ではありませんが、WebGPUがソフトウェア実装の場合、共有プロセス上で動作し、分離による対策ができません。
2.1.8. Row hammer攻撃
Row hammerはDRAMセルの状態漏洩を利用する攻撃手法です。GPUでも利用される可能性があります。 WebGPUは特別な対策を持たず、プラットフォームレベルの対策(メモリリフレッシュ間隔短縮など)に依存します。
2.1.9. サービス妨害(DoS)
WebGPUアプリケーションはGPUメモリや計算ユニットへアクセス可能です。WebGPU実装は、他のアプリケーションの応答性維持のため、利用可能なGPUメモリ量を制限する場合があります。 GPU処理時間については、アプリケーションが数秒以上GPUの応答を止めないよう「ウォッチドッグ」タイマーを設けることもできます。 これらの対策はWebGLでも用いられています。
2.1.10. ワークロード識別
WebGPUは同一マシン上で動作する他プログラム(Webページ)と共有される制約付きグローバルリソースへアクセスします。アプリケーションは、これら共有リソースの利用パターンから、他ページで実行中のワークロードを間接的に推測することが可能です。 これらの問題は、JavascriptでのシステムメモリやCPU実行スループットに関する問題と同様です。WebGPUは追加の対策を提供しません。
2.1.11. メモリリソース
WebGPUは、VRAMなどのマシングローバルメモリヒープからの失敗可能な割り当てを公開します。 これにより、あるヒープ種別の残りメモリ量を、割り当てを試みて失敗を監視することで推測できます。
GPUは内部的に1つ以上(通常は2つのみ)のメモリヒープを、全アプリケーションで共有しています。ヒープが枯渇するとWebGPUはリソース作成に失敗します。 これは観測可能であり、悪意あるアプリケーションが他アプリケーションのヒープ利用状況や割り当て量を推測できる場合があります。
2.1.12. 計算リソース
他サイトが同時にWebGPUを利用すると、処理完了までの時間増加を観測できる場合があります。例えば、サイトが継続的に計算ワークロードをキューへ送り、完了を監視することで、他の何かがGPU利用を開始したことを推測できます。
GPUには演算ユニット、テクスチャサンプリングユニット、アトミックユニット等、個別にテスト可能な多数の部品があります。悪意あるアプリケーションは、これらユニットの負荷状況を感知し、他アプリケーションのワークロードを推測しようとする場合があります。これはJavascriptのCPU実行状況と同様の現実です。
2.1.13. 機能の濫用
悪意あるサイトは、WebGPUが公開する機能を悪用し、ユーザーや体験の利益にならない計算(隠れた暗号通貨マイニング、パスワード解析、レインボーテーブル計算など)を実行する可能性があります。
API利用のこうした用途を防ぐことはできません。ブラウザーが正当なワークロードと悪用ワークロードを区別できないためです。これはWeb上の汎用計算機能(JavaScript、WebAssembly、WebGL)全般に共通する問題で、WebGPUは一部ワークロードの実装・実行を容易または効率化するだけです。
この種の濫用軽減策として、ブラウザーはバックグラウンドタブの操作をスロットリングしたり、リソース大量利用中のタブを警告したり、WebGPU利用可能なコンテキストを制限できます。
ユーザーエージェントは、特に悪意ある利用による高い電力消費に対し、ユーザーへの警告を経験的に発することができます。 そのような警告を実装する場合、JavaScript、WebAssembly、WebGLなどと同様にWebGPUも判断基準に含めるべきです。
2.2. プライバシーの考慮事項
WebGPUのプライバシー考慮事項はWebGLと似ています。GPU APIは複雑であり、開発者が効果的に利用するために、デバイスの機能の様々な側面を必要に応じて公開する必要があります。一般的な対策としては、識別につながる情報を正規化またはビニングし、可能な限り挙動を統一することが含まれます。
ユーザーエージェントは、32個を超える識別可能な構成やバケットを公開してはなりません。
2.2.1. 機器固有の機能と制限
WebGPUは、基盤となるGPUアーキテクチャやデバイス形状に関する多くの詳細を公開できます。 これには利用可能な物理アダプター、GPUやCPUリソースの多数の制限(最大テクスチャサイズなど)、および利用可能なオプションのハードウェア固有機能が含まれます。
ユーザーエージェントは、実際のハードウェア制限を公開する義務はなく、機器固有情報の公開度合いを完全に制御できます。フィンガープリント防止の一手として、すべてのターゲットプラットフォームを少数のビンにまとめる手法があります。全体として、ハードウェア制限の公開によるプライバシーへの影響はWebGLと同等です。
デフォルトの制限値も、ほとんどのアプリケーションがより高い制限を要求せずとも動作できるよう、意図的に十分高く設定されています。 APIの利用は要求された制限値に従い検証されるため、実際のハードウェア機能が偶然ユーザーに露出することはありません。
2.2.2. 機器固有のアーティファクト
WebGLと同様に、機器固有のラスタライズ/精度アーティファクトやパフォーマンス差が観測される場合があります。これにはラスタライズ範囲やパターン、シェーダーステージ間の補間精度、計算ユニットのスケジューリング、その他実行に関する要素が含まれます。
一般に、ラスタライズや精度のフィンガープリントはベンダーごとのほぼ全デバイスで一致します。パフォーマンス差は比較的扱い難いですが、信号としても低い傾向(JS実行性能と同様)です。
プライバシー重視のアプリケーションやユーザーエージェントは、こうしたアーティファクトを除去するためにソフトウェア実装を利用すべきです。
2.2.3. 機器固有のパフォーマンス
ユーザーを識別するもう一つの要素は、GPU上の特定操作の性能測定です。低精度タイミングでも、操作の繰り返し実行により、ユーザーのマシンが特定ワークロードに強いかどうかが判明します。 これはWebGLやJavascriptにも存在する一般的なベクトルですが、信号としては低く、完全な正規化は困難です。
WebGPUの計算パイプラインは、固定機能ハードウェアに妨げられないGPUアクセスを公開します。これによりユニークなデバイスフィンガープリントのリスクが高まります。ユーザーエージェントは論理的なGPU呼び出しと実際の計算ユニットを分離する等の対策でリスク低減が可能です。
2.2.4. ユーザーエージェントの状態
本仕様は、オリジンごとの追加ユーザーエージェント状態を定義していません。
ただし、ユーザーエージェントは高負荷なコンパイル結果(GPUShaderModule、
GPURenderPipeline、
GPUComputePipeline等)のコンパイルキャッシュを持つことが期待されます。
これらのキャッシュはWebGPUアプリケーションの初回訪問後の読み込み時間短縮に重要です。
仕様上は、これらのキャッシュは非常に高速なコンパイルと区別できませんが、アプリケーション側ではcreateComputePipelineAsync()の解決にかかる時間を容易に測定でき、オリジン間で情報漏洩する可能性があります(例:「ユーザーがこの特定のシェーダーでサイトへアクセスしたか」)。そのためユーザーエージェントはストレージ分割のベストプラクティスに従うべきです。
システムのGPUドライバも独自のシェーダーやパイプラインのコンパイルキャッシュを持つ場合があります。ユーザーエージェントは可能な限りこれらを無効化するか、パーティションごとのデータをシェーダーへ加えて、GPUドライバが別物とみなすようにすることもできます。
2.2.5. ドライバのバグ
セキュリティの考慮事項で述べた懸念に加え、ドライバのバグはユーザーの識別手段となる挙動差を生じる場合があります。セキュリティの考慮事項に記載の対策(GPUベンダーとの協調、既知問題へのワークアラウンド実装等)もここで適用されます。
2.2.6. アダプタ識別子
WebGLの過去の経験から、開発者がGPUの種類を特定可能であることが、堅牢なGPUベースコンテンツの作成・保守に正当な必要があることが示されています。例として、既知のドライババグがあるアダプタを特定して回避したり、特定ハードウェアで性能が期待通りでない機能を避けたりする場合などです。
しかしアダプタ識別子の公開はフィンガープリント情報の増加につながるため、識別精度の制限が望まれます。
堅牢なコンテンツとプライバシー保護のバランスを取るため、いくつかの対策が可能です。まず、ユーザーエージェントが既知のドライバ問題を特定し回避することで、開発者の負担を軽減できます(これはブラウザがGPU利用を始めて以来行われています)。
アダプタ識別子をデフォルトで公開する場合、可能な限り幅広く(ベンダーや一般的なアーキテクチャのみ)しつつ有用性を保つべきです。場合によっては、実際のアダプタの合理的な代理となる識別子を報告する場合もあります。
バグ報告など、アダプタの詳細情報が有用な場合は、ユーザーの同意を得て追加情報をページに公開することが可能です。
最後に、ユーザーエージェントは、強化プライバシーモードなど適切と判断した場合、アダプタ識別子を一切報告しない裁量を常に持ちます。
3. 基本事項
3.1. 規約
3.1.1. 構文上の省略形
本仕様では、以下の構文上の省略形を使用します:
.(ドット)構文。プログラミング言語で一般的です。-
「
Foo.Bar」は「値(またはインターフェース)FooのBarメンバー」を意味します。Fooが順序付きマップであり、BarがFooに存在しない場合はundefinedを返します。 ?.(オプショナルチェーン)構文。JavaScript由来です。-
「
Foo?.Bar」は「Fooがnullまたはundefined、またはBarがFooに存在しない場合はundefined、それ以外はFoo.Bar」を意味します。例として、
bufferがGPUBufferの場合、buffer?.\[[device]].\[[adapter]]は 「bufferがnullまたはundefinedならundefined、 それ以外はbufferの\[[device]]内部スロットの\[[adapter]]内部スロット」を指します。 ??(ヌリッシュ合体)構文。JavaScript由来です。-
「
x??y」は「xがnullまたはundefinedでないならx、そうでなければy」です。 - スロットバック属性
-
同名の内部スロットで裏付けられるWebIDL属性です。可変の場合と不可変の場合があります。
3.1.2. WebGPUオブジェクト
WebGPUオブジェクトは、WebGPUインターフェースと内部オブジェクトから構成されます。
WebGPUインターフェースは、WebGPUオブジェクトの公開インターフェースと状態を定義します。 作成されたコンテンツタイムライン上で利用でき、JavaScript公開WebIDLインターフェースです。
GPUObjectBaseを含むインターフェースはすべてWebGPUインターフェースです。
内部オブジェクトは、WebGPUオブジェクトの状態をデバイスタイムライン上で追跡します。 内部オブジェクトの可変状態の読み書きは、単一の順序付けられたデバイスタイムライン上でのみ実行されます。
以下の特別なプロパティ型がWebGPUオブジェクトに定義できます:
- 不変プロパティ
-
オブジェクト初期化時に設定される読み取り専用スロット。任意のタイムラインからアクセスできます。
注意: このスロットは不変なので、必要に応じて複数のタイムラインでコピーを持つことができます。 不変プロパティは、本仕様で複数コピーの記述を避けるためこう定義されています。
[[角括弧付き]]の場合は内部スロット。
角括弧なしの場合はスロットバック属性です。 - コンテンツタイムラインプロパティ
-
オブジェクト作成時のコンテンツタイムラインでのみアクセス可能なプロパティ。
[[角括弧付き]]の場合は内部スロット。
角括弧なしの場合はスロットバック属性です。 - デバイスタイムラインプロパティ
-
内部オブジェクトの状態を追跡し、作成されたデバイスタイムラインでのみアクセス可能なプロパティ。デバイスタイムラインプロパティは可変です。
デバイスタイムラインプロパティは
[[角括弧付き]]で内部スロットです。 - キュータイムラインプロパティ
-
内部オブジェクトの状態を追跡し、作成されたキュータイムラインでのみアクセス可能なプロパティ。キュータイムラインプロパティは可変です。
キュータイムラインプロパティは
[[角括弧付き]]で内部スロットです。
interface mixin GPUObjectBase {attribute USVString label ; };
GPUObjectBase
parent,
interface T, GPUObjectDescriptorBase
descriptor)
(TはGPUObjectBaseを拡張する)
場合、次のコンテンツタイムライン手順を実行する:
-
deviceをparent.
[[device]]とする。 -
objectをTの新しいインスタンスとする。
-
object.
[[device]]にdeviceを設定する。 -
objectを返す。
GPUObjectBase
には以下の不変プロパティがあります:
[[device]]型 device(readonly)-
このオブジェクトの内容への操作はassertで デバイスタイムライン上で動作し、デバイスが有効であることを検証します。
GPUObjectBase
には以下のコンテンツタイムラインプロパティがあります:
label型 USVString-
開発者が指定するラベル。実装定義の方法で利用されます。 ブラウザ、OS、その他ツールが、基盤となる内部オブジェクトを開発者へ識別するために使用可能です。 例:
GPUErrorメッセージ、コンソール警告、ブラウザデベロッパーツール、プラットフォームデバッグユーティリティなどで表示されます。注意:実装はラベルを使ってWebGPUオブジェクトの識別を強化したエラーメッセージを推奨します。ただし、これは唯一の識別方法である必要はありません。 実装は他の利用可能な情報も活用 すべき です。ラベルがない場合など、例えば:
-
GPUTextureの親ラベルをGPUTextureView表示時に利用 -
GPUCommandEncoderの親ラベルをGPURenderPassEncoderやGPUComputePassEncoder表示時に利用 -
GPUCommandEncoderのソースラベルをGPUCommandBuffer表示時に利用 -
GPURenderBundleEncoderのソースラベルをGPURenderBundle表示時に利用
注意:labelはGPUObjectBaseのプロパティです。 2つのGPUObjectBaseラッパーオブジェクトは、同じ基盤オブジェクトを参照していても、ラベル状態は完全に分離しています (例:getBindGroupLayout()で返された場合)。labelプロパティは、JavaScriptから設定された場合のみ変更されます。つまり、1つの基盤オブジェクトが複数ラベルと関連付けられる場合があります。 本仕様ではラベルがデバイスタイムラインに伝搬する方法は定義しません。 ラベルの利用方法は完全に実装定義です。エラーメッセージで最新ラベル、全ラベル、あるいはラベルなしを表示する場合があります。
一部ユーザーエージェントが基盤ネイティブAPIのデバッグ機能にラベルを渡す場合があるため、型は
USVStringです。 -
GPUObjectBase
には以下のデバイスタイムラインプロパティがあります:
[[valid]]型boolean(初期値true)-
trueの場合、内部オブジェクトが有効であることを示します。
[[device]]
などの親オブジェクトがガベージコレクションされるのを妨げるべきではありません。ただし、一部の実装では親オブジェクトへの強い参照を保持する必要があるため、これを保証することはできません。
その結果、開発者はWebGPUインターフェイスが、そのインターフェイスのすべての子オブジェクトもガベージコレクションされるまで存続し続ける可能性があり、一部のリソースが予想よりも長く割り当てられたままになることを想定すべきです。
割り当てられたリソースを予測可能に解放したい場合、ガベージコレクションに頼るよりも、WebGPUインターフェイス(例えば
GPUDevice.destroy()
や GPUBuffer.destroy()
の destroy メソッドを呼び出すことが推奨されます。
3.1.3. オブジェクト記述子
オブジェクト記述子は、オブジェクトの作成に必要な情報を保持します。
通常、create*メソッド(GPUDeviceのメソッド)を使って作成されます。
dictionary {GPUObjectDescriptorBase USVString label = ""; };
GPUObjectDescriptorBase
のメンバーは以下の通りです:
label、型 USVString、デフォルト値""-
GPUObjectBase.labelの初期値です。
3.2. 非同期性
3.2.1. 無効な内部オブジェクトと伝播する無効性
WebGPUのオブジェクト生成操作はPromiseを返しませんが、内部的には非同期処理です。返されるオブジェクトは内部オブジェクトを参照し、デバイスタイムライン上で操作されます。
例外やリジェクトで失敗するのではなく、多くのエラーは関連するデバイスタイムラインでGPUErrorを生成し、デバイスに通知します。
内部オブジェクトは有効か無効のいずれかです。 無効オブジェクトは後で有効になることはありませんが、 有効オブジェクトが無効化される場合もあります。
作成時にオブジェクトが無効になる場合があります。例えばオブジェクト記述子が有効なオブジェクトを表していない場合や、リソース割り当てに十分なメモリがない場合です。
また、他の無効なオブジェクトから生成した場合(例:無効なGPUTextureに対してcreateView()を呼ぶ場合)も発生します。
このケースは伝播する無効性と呼ばれます。
内部オブジェクトはほとんどの型で作成後に無効になりませんが、使用不能になる場合があります(例:所有デバイスが失われた、destroyedされた、バッファ状態が「destroyed」など)。
一部の型では、作成後に無効になる場合があります。特に、デバイス、アダプター、GPUCommandBuffer、
コマンド/パス/バンドルエンコーダです。
GPUObjectBase
objectがtargetObjectと併用可能(valid to use with)であるとは、以下のデバイスタイムライン条件をすべて満たす場合です:
-
object.
[[valid]]がtrueであること。 -
object.
[[device]].[[valid]]がtrueであること。 -
object.
[[device]]とtargetObject.[[device]]が等しいこと。
3.2.2. Promiseの順序付け
WebGPUのいくつかの操作はPromiseを返します。
WebGPUは、これらのPromiseの解決(resolveまたはreject)順序について、以下を除き保証しません:
-
ある
GPUQueueqに対し、 p1 = q.onSubmittedWorkDone()を先に呼び、 p2 = q.onSubmittedWorkDone()を後で呼んだ場合、p1はp2より先に解決されなければなりません。 -
ある
GPUQueueqと同じGPUDevice上のGPUBufferbに対し、 p1 = b.mapAsync()を先に呼び、 p2 = q.onSubmittedWorkDone()を後で呼んだ場合、p1はp2より先に解決されなければなりません。
アプリケーションは他のPromiseの解決順序に依存してはなりません。
3.3. 座標系
レンダリング操作では、以下の座標系を使用します:
-
正規化デバイス座標(NDC)は3次元座標で、次の範囲です:
-
-1.0 ≤ x ≤ 1.0
-
-1.0 ≤ y ≤ 1.0
-
0.0 ≤ z ≤ 1.0
-
左下隅は(-1.0, -1.0, z)です。
正規化デバイス座標。 注意:
z = 0またはz = 1がニア平面として扱われるかはアプリケーション依存です。上記図はz = 0をニア平面としていますが、実際の挙動はシェーダーで使う投影行列、depthClearValue、depthCompare関数等の組み合わせで決まります。 -
-
クリップ空間座標は4次元(x, y, z, w)です。
-
フレームバッファ座標は、フレームバッファ内のピクセルを指定します。
-
2次元座標です。
-
各ピクセルはx・y方向に1単位分広がります。
-
左上隅は(0.0, 0.0)です。
-
xは右方向へ増加します。
-
yは下方向へ増加します。
-
詳細は§ 17 レンダーパス、§ 23.2.5 ラスタライズを参照。
フレームバッファ座標。 -
-
ビューポート座標は、x・y方向でフレームバッファ座標、z方向で深度を持ちます。
-
通常は0.0 ≤ z ≤ 1.0ですが、
[[viewport]].minDepthやmaxDepthをsetViewport()で設定することで変更できます。
-
-
フラグメント座標はビューポート座標と一致します。
-
テクスチャ座標(2DではUV座標とも呼ばれる)は、テクスチャのサンプリングで使われ、
texture dimensionに応じた成分数を持ちます。-
0 ≤ u ≤ 1.0
-
0 ≤ v ≤ 1.0
-
0 ≤ w ≤ 1.0
-
(0.0, 0.0, 0.0)はテクスチャメモリアドレス順で最初のテクセルです。
-
(1.0, 1.0, 1.0)はテクスチャメモリアドレス順で最後のテクセルです。
2Dテクスチャ座標。 -
-
ウィンドウ座標または表示座標は、フレームバッファ座標と一致し、外部ディスプレイや類似のインターフェースとのやり取り時に使われます。
注意: WebGPUの座標系はDirectXのグラフィックスパイプラインの座標系に一致します。
3.4. プログラミングモデル
3.4.1. タイムライン
WebGPUの挙動は「タイムライン」で記述されます。 各操作(アルゴリズムとして定義)は、タイムライン上で実行されます。 タイムラインは、操作の順序と、どの状態がどの操作から参照できるかを明確に定義します。
注意: この「タイムライン」モデルは、ブラウザエンジンのマルチプロセスモデル(通常「コンテンツプロセス」と「GPUプロセス」)や、 多くの実装でGPU自体が独立した実行ユニットであることに由来する制約を記述します。 WebGPUの実装は、タイムラインで並列実行する必要はないため、複数プロセスやスレッドは必須ではありません。 (ただし、get a copy of the image contents of a contextのように、他タイムラインの完了を同期的に待つ場合は並行処理が必要です。)
- コンテンツタイムライン
-
Webスクリプトの実行に関連付けられます。 本仕様で記載されているすべてのメソッド呼び出しを含みます。
ある
GPUDevicedeviceの操作でコンテンツタイムラインへ手順を発行するには、 queue a global task for GPUDevicedeviceでその手順を発行します。 - デバイスタイムライン
-
ユーザーエージェントが発行するGPUデバイス操作に関連付けられます。 アダプター、デバイス、GPUリソースや状態オブジェクトの作成を含みます。これらは通常、GPUを制御するユーザーエージェント側から見ると同期的ですが、別プロセスで実行されることもあります。
- キュータイムライン
-
GPUの計算ユニット上での操作の実行に関連付けられます。実際の描画、コピー、計算ジョブなどGPU上で実行される処理を含みます。
- タイムライン非依存
-
上記いずれかのタイムラインに関連します。
不変プロパティimmutable propertiesや 呼び出し元から渡された引数のみを操作する場合、どのタイムラインにも手順を発行できます。
- 不変値例用語 定義
-
すべてのタイムラインで利用可能です。
- コンテンツタイムライン例用語 定義
-
コンテンツタイムラインのみで利用可能です。
- デバイスタイムライン例用語 定義
-
デバイスタイムラインのみで利用可能です。
- キュータイムライン例用語 定義
-
キュータイムラインのみで利用可能です。
不変値例用語の利用例。 コンテンツタイムライン例用語の利用例。
不変値例用語の利用例。 デバイスタイムライン例用語の利用例。
不変値例用語の利用例。 キュータイムライン例用語の利用例。
本仕様では、非同期操作は戻り値がコンテンツタイムライン以外のタイムラインで行われる処理に依存する場合に使われます。 APIではPromiseやイベントで表現されます。
GPUComputePassEncoder.dispatchWorkgroups():
-
ユーザーは
dispatchWorkgroupsコマンドをGPUComputePassEncoderのメソッドで呼び出し、コンテンツタイムライン上でエンコードされます。 -
ユーザーは
GPUQueue.submit()を呼び、GPUCommandBufferをユーザーエージェントに渡します。これはOSドライバによる低レベルのサブミットとしてデバイスタイムライン上で処理されます。 -
サブミットはGPUの呼び出しスケジューラによって実際の計算ユニットへ割り当てられ、キュータイムライン上で実行されます。
GPUDevice.createBuffer():
-
ユーザーは
GPUBufferDescriptorを記入し、GPUBufferを作成します。 これはコンテンツタイムライン上で行われます。 -
ユーザーエージェントはデバイスタイムライン上で低レベルのバッファを作成します。
GPUBuffer.mapAsync():
-
ユーザーは
GPUBufferのマップをコンテンツタイムライン上でリクエストし、Promiseが返されます。 -
ユーザーエージェントはバッファがGPUで現在使用中かどうかを確認し、使用終了後に再確認するリマインダーを設定します。
-
GPUがキュータイムライン上でバッファの使用を終えた後、ユーザーエージェントがメモリへのマッピングを行い、Promiseをresolveします。
3.4.2. メモリモデル
このセクションは規定ではありません。
アプリケーション初期化時にGPUDeviceを取得したら、
WebGPUプラットフォームは以下のレイヤーで構成されると記述できます:
-
本仕様を実装するユーザーエージェント。
-
このデバイス用の低レベルネイティブAPIドライバを持つオペレーティングシステム。
-
実際のCPUおよびGPUハードウェア。
WebGPUプラットフォームの各レイヤーは、 ユーザーエージェントが仕様実装時に考慮すべき異なるメモリ型を持つ場合があります:
-
スクリプト所有のメモリ(
ArrayBufferなど)は、通常GPUドライバからはアクセスできません。 -
ユーザーエージェントが、コンテンツ実行とGPUドライバ通信をそれぞれ別プロセスで行う場合、プロセス間共有メモリを用いてデータを転送します。
-
専用GPUは高速な独自メモリを持ち、統合GPUは通常システムメモリを共有します。
ほとんどの物理リソースは、 GPUによる計算やレンダリングに効率的なメモリ型で割り当てられます。 ユーザーがGPUに新しいデータを提供する必要がある場合、データがプロセス境界を越えてGPUドライバと通信するユーザーエージェント部分へ届き、 さらにドライバに見えるようにする必要があります(これはドライバ割り当てのステージングメモリへのコピーを伴う場合もあります)。 最後に、専用GPUメモリへ転送され、内部レイアウトがGPU操作に最適な形へ変換されることもあります。
これらすべての遷移は、ユーザーエージェントによるWebGPU実装で処理されます。
注:
この例は最悪の場合を説明していますが、実際には実装がプロセス境界を越える必要がなかったり、ドライバ管理のメモリを ArrayBuffer
を介してユーザーに直接公開できたりして、データのコピーを回避できる場合もあります。
3.4.3. リソースの使用法
物理リソースは、内部使用法としてGPUコマンドで利用できます。
- input
-
描画やディスパッチ呼び出しの入力データ用バッファ。内容は保持されます。 buffer
INDEX、 bufferVERTEX、 bufferINDIRECTで許可されます。 - constant
-
シェーダーから見て定数となるリソースバインディング。内容は保持されます。 buffer
UNIFORMまたは textureTEXTURE_BINDINGで許可されます。 - storage
-
読み書き可能なストレージリソースバインディング。 buffer
STORAGEまたは textureSTORAGE_BINDINGで許可されます。 - storage-read
-
読み取り専用ストレージリソースバインディング。内容は保持されます。 buffer
STORAGEまたは textureSTORAGE_BINDINGで許可されます。 - attachment
-
レンダーパスで読み書き出力アタッチメントや書き込み専用リゾルブターゲットとして使うテクスチャ。 texture
RENDER_ATTACHMENTで許可されます。 - attachment-read
-
レンダーパスで読み取り専用アタッチメントとして使うテクスチャ。内容は保持されます。 texture
RENDER_ATTACHMENTで許可されます。
サブリソースは、バッファ全体またはテクスチャのサブリソースです。
-
Uの各使用法がinput、constant、storage-read、attachment-readのいずれかである。
-
Uの各使用法がstorageである。
複数の書き込み可能な使用法も許可されます。 これは使用法範囲ストレージ例外です。
-
Uの各使用法がattachmentである。
複数の書き込み可能な使用法も許可されます。 これは使用法範囲アタッチメント例外です。
使用法が互換使用法リストにだけ組み合わされるよう強制することで、APIはメモリ操作のデータ競合発生タイミングを制限できます。 この性質により、WebGPU向けに書かれたアプリケーションが異なるプラットフォームでも修正なしで動作しやすくなります。
-
すべてのアスペクトを読み取り専用にした深度/ステンシルアタッチメント(
depthReadOnlyやstencilReadOnlyを指定)。 -
描画呼び出しでのテクスチャバインディング。
-
バッファやテクスチャは、ストレージとして、レンダーパス内の2つの異なるドローコールにバインドされる場合があります。
-
単一のバッファの不連続な範囲を、ストレージとして2つの異なるバインディングポイントにバインドすることができます。
重複する範囲は、単一のディスパッチ/ドローコールにバインドしてはなりません。これは「Encoder bind groups alias a writable resource」によってチェックされます。
同じスライスを2つの異なるアタッチメントに重複してバインド不可です。これはbeginRenderPass()で検証されます。
3.4.4. 同期
使用法範囲は、マップであり、サブリソースからlist<内部使用法>>への対応です。 各使用法範囲は、互いに同時実行可能な一連の操作範囲をカバーし、その範囲内ではサブリソースの使用法が一貫した互換使用法リストでなければなりません。
使用法範囲はエンコード時に構築・検証されます:
使用法範囲は以下の通り:
-
計算パスでは、各ディスパッチコマンド(
dispatchWorkgroups()やdispatchWorkgroupsIndirect()) が1つの使用法範囲です。サブリソースは、ディスパッチでアクセス可能性がある場合に使用されます。例:
-
現在の
GPUComputePipelineの[[layout]]でバインドグループから参照されるすべてのサブリソース -
ディスパッチ呼び出しで直接使われるバッファ(例:インダイレクトバッファ)
注意: 計算パスの状態設定コマンド(setBindGroup()など)は、 バインドしたリソース自体を使用法範囲に直接加えません。ディスパッチコマンド時に状態が参照されて検証されます。
-
-
1つのレンダーパスが1つの使用法範囲です。
サブリソースは、状態設定コマンドも含め、任意のコマンドで参照された場合に使用法範囲として扱われます(計算パスと異なり)。例:
-
setVertexBuffer()で設定されたバッファ -
setIndexBuffer()で設定されたバッファ -
setBindGroup()で設定されたバインドグループから参照されるすべてのサブリソース
-
描画呼び出しで直接使われるバッファ(例:インダイレクトバッファ)
-
注意: コピーコマンドは単独の操作であり、使用法範囲検証には使いません。自己競合防止のため独自検証を行います。
-
レンダーパスでは、パイプラインのシェーダーやレイアウトがこれらバインディングに依存しているか、バインドグループが別のset呼び出しで上書きされているかに関係なく、任意のsetBindGroup()呼び出しで使われるサブリソース。
-
描画呼び出しがこのバッファを利用するか、他のset呼び出しで上書きされているかに関係なく、任意の
setVertexBuffer()呼び出しで使われるバッファ。 -
描画呼び出しがこのバッファを利用するか、他のset呼び出しで上書きされているかに関係なく、任意の
setIndexBuffer()呼び出しで使われるバッファ。 -
GPURenderPassDescriptorのカラーアタッチメント、リゾルブアタッチメント、深度/ステンシルアタッチメントで使われるテクスチャサブリソース(beginRenderPass()で参照)、シェーダーがこれらアタッチメントに依存しているか否かに関係なく。 -
可視性0のバインドグループエントリで使われるリソース、および計算ステージのみ可視でレンダーパスで使われる(またはその逆)リソース。
3.5. コア内部オブジェクト
3.5.1. アダプター
アダプターは、システム上のWebGPU実装を識別します。 これは、ブラウザの基盤となるプラットフォーム上の計算/レンダリング機能のインスタンス、そしてその機能上に構築されたブラウザのWebGPU実装のインスタンスの両方を指します。
アダプターは GPUAdapter
で公開されます。
アダプターは基盤実装を一意に表しません。
requestAdapter()
を複数回呼ぶと、毎回異なるアダプターオブジェクトが返されます。
各アダプターオブジェクトは、1つのデバイスしか生成できません。
requestDevice()
に成功すると、アダプターの[[state]]
は"consumed"
に変化します。
さらに、アダプターオブジェクトはいつでも期限切れになる場合があります。
注意:
これにより、アプリケーションはデバイス生成時に最新のシステム状態を利用したアダプター選択を行えます。
また、初回初期化、アダプターの抜き差しによる再初期化、テスト用のGPUDevice.destroy()
呼び出しによる再初期化など、様々なシナリオで堅牢性が高まります。
アダプターは、広い互換性・予測可能な挙動・プライバシー向上などを目的に、著しい性能低下を伴う場合、フォールバックアダプターと見なされる場合があります。すべてのシステムでフォールバックアダプターが利用可能である必要はありません。
[[features]]型 ordered set<GPUFeatureName> (読み取り専用)-
このアダプター上でデバイス生成に利用可能な機能。
[[limits]]型 supported limits (読み取り専用)-
このアダプター上でデバイス生成に利用可能な最良の制限値。
各アダプター制限値は、supported limits内のデフォルト値と同等またはより良い値でなければなりません。
[[fallback]]型boolean(読み取り専用)-
trueの場合、このアダプターはフォールバックアダプターです。 [[xrCompatible]]型 boolean-
trueの場合、このアダプターはWebXRセッションとの互換性を持つようにリクエストされたことを示します。 [[default feature level]]、型は 機能レベル文字列、読み取り専用-
このアダプターから作成されたデバイスのデフォルトの機能レベルを示します。
アダプターには次のデバイスタイムラインプロパティがあります:
[[state]]初期値"valid"-
"valid"-
このアダプターはデバイス生成に利用可能です。
"consumed"-
このアダプターはすでにデバイス生成に利用されており、再利用できません。
"expired"-
このアダプターは他の理由で期限切れになっています。
GPUAdapter
adapterを期限切れにするには、以下のデバイスタイムライン手順を実行します:
-
adapter.
[[adapter]].[[state]]に"expired"を設定する。
3.5.2. デバイス
デバイスは、アダプターの論理的インスタンスであり、 これを通じて内部オブジェクトが生成されます。
デバイスは、そこから生成されたすべての内部オブジェクトの排他的な所有者です。
デバイスが無効(失われたまたは destroyed)になると、
それとその上で生成されたすべてのオブジェクト(直接:createTexture()、間接:createView()など)は、
暗黙的に利用不可となります。
[[adapter]]型 アダプター (読み取り専用)-
このデバイスが生成されたアダプターです。
[[features]]型 ordered set<GPUFeatureName> (読み取り専用)-
このデバイス上で利用できる機能(生成時に算出)。 基盤アダプターが他の機能をサポートしていても、追加機能は利用できません。
[[limits]]型 supported limits (読み取り専用)-
このデバイスで利用できる制限値(生成時に算出)。 基盤アダプターがより良い制限値をサポートしていても、追加利用はできません。
デバイスには以下のコンテンツタイムラインプロパティがあります:
[[content device]]型GPUDevice(読み取り専用)-
このデバイスに関連付けられたコンテンツタイムラインの
GPUDeviceインターフェース。
GPUDeviceDescriptor
descriptorで作成します:
-
features を、descriptor.
requiredFeaturesに含まれる値の集合とする。 -
もし features に
"texture-formats-tier2"が含まれているなら:-
追加
"texture-formats-tier1"を features に加える。
-
-
もし features に
"texture-formats-tier1"が含まれているなら:-
追加
"rg11b10ufloat-renderable"を features に加える。
-
-
adapter.
[[default feature level]]で定義されるデフォルトのGPUFeatureNameをすべて features に追加する。 -
limits を新しい supported limits オブジェクトとし、 デフォルト値は adapter.
[[default feature level]]で定義された値とする。 -
descriptor.
requiredLimitsの各 (key, value) ペアについて:-
もし value が
undefinedでなく、かつ value が limits[key] よりも優れているなら:-
limits[key] を value に設定する。
-
-
-
limits.
maxStorageBuffersPerShaderStageに max(limits.maxStorageBuffersPerShaderStage, limits.maxStorageBuffersInVertexStage, limits.maxStorageBuffersInFragmentStage) を設定する。 -
limits.
maxStorageTexturesPerShaderStageに max(limits.maxStorageTexturesPerShaderStage, limits.maxStorageTexturesInVertexStage, limits.maxStorageTexturesInFragmentStage) を設定する。 -
もし features が
"core-features-and-limits"を含む場合:-
limits.
maxStorageBuffersInVertexStageおよび limits.maxStorageBuffersInFragmentStageに limits.maxStorageBuffersPerShaderStageを設定する。 -
limits.
maxStorageTexturesInVertexStageおよび limits.maxStorageTexturesInFragmentStageに limits.maxStorageTexturesPerShaderStageを設定する。
-
-
device をdeviceオブジェクトとする。
-
device.
[[adapter]]に adapter を設定する。 -
device.
[[features]]に features を設定する。 -
device.
[[limits]]に limits を設定する。 -
device を返す。
ユーザーエージェントがデバイスへのアクセスを取り消す必要がある場合は、
lose the
device(device, "unknown")
をデバイスのデバイスタイムライン上で呼び出します。
この操作は、同タイムライン上でキューされている他の操作よりも先に実行される場合があります。
操作が失敗し、その副作用がデバイス上のオブジェクトの状態を可視的に変化させたり、内部実装/ドライバ状態を破損する可能性がある場合は、 その変更が可視化されるのを防ぐため、デバイスを失うべきです。
注意:
アプリケーションが(destroy()で)明示的に開始しないすべてのデバイス喪失については、
ユーザーエージェントはlostプロミスが処理されている場合でも、開発者向け警告を無条件で表示するべきです。
これらのシナリオは稀であるべきですが、WebGPU APIの多くがアプリケーションのランタイムフローを中断しないため(検証エラーなし、ほとんどのPromiseは通常通り解決)、シグナルは開発者にとって重要です。
-
無効化でdeviceを無効にする。
-
device.
[[content device]]のコンテンツタイムラインで以下の手順を発行する: -
deviceが失われた状態になるまで待機している未完了手順を完了する。
注意: 失われたデバイスからはエラーは生成されません。 詳細は§ 22 エラーとデバッグを参照。
-
デバイスタイムラインがeventの完了を通知された場合、または
その場合は、timeline上でstepsを発行する。
3.6. オプション機能
WebGPUのアダプターやデバイスは機能を持ちます。 これは、WebGPUの機能が実装ごとに異なることを示すもので、主にハードウェアやシステムソフトウェアの制約によるものです。 機能は機能(feature)または制限(limit)のいずれかです。
ユーザーエージェントは、32個を超える識別可能な構成やバケットを公開してはなりません。
アダプターの機能は§ 4.2.1 アダプター機能保証に準拠しなければなりません。
サポートされている機能だけがrequestDevice()で要求可能です。
サポートされていない機能を要求すると失敗します。
デバイスの機能は"新しいデバイス"で決定され、アダプターのデフォルト(機能なし・デフォルトのsupported
limits)から始まり、requestDevice()で要求された機能が加えられます。
これらの機能は、アダプターの機能に関係なく強制されます。
プライバシーの考慮事項については § 2.2.1 機器固有の機能と制限 を参照してください。
3.6.1. 機能
機能は、すべての実装でサポートされているわけではないWebGPUのオプション機能セットです。主にハードウェアやシステムソフトウェアの制約により左右されます。
すべての機能はオプションですが、アダプターはその可用性についてある程度の保証をします(§ 4.2.1 アダプター機能保証参照)。
デバイスは、生成時に決定された機能のみをサポートします(§ 3.6 オプション機能参照)。 API呼び出しは、これらの機能(アダプターの機能ではなく)に従って検証を行います。
-
既存のAPIサーフェスを新しい方法で利用すると、通常は検証エラーとなります。
-
複数種類のオプションAPIサーフェスがあります:
-
新しいメソッドやenum値を使うと常に
TypeErrorを投げます。 -
新しい辞書メンバーを型が正しい非デフォルト値で使うと、通常は検証エラーとなります。
-
新しいWGSLの
enableディレクティブを使うと、常にcreateShaderModule()で検証エラーとなります。
-
GPUFeatureName
feature は、ある 有効化されている
GPUObjectBase
object に対して、次の場合かつその場合に限り成り立つ:
object.[[device]].[[features]]
が feature を含む 場合。
各機能が有効にする機能内容の説明は機能一覧を参照してください。
注: サポートされている場合でも、機能を有効にすることが必ずしも望ましいとは限りません。有効化によってパフォーマンスへの影響が生じる可能性があるためです。 このため、またデバイスや実装間の移植性を高めるためにも、アプリケーションは実際に必要となる可能性のある機能のみをリクエストするべきです。
3.6.2. 制限
制限は、デバイス上でWebGPUを利用する際の数値的な制約です。
注: サポートされている場合でも、「より良い」リミットを設定することが必ずしも望ましいとは限りません。設定によってパフォーマンスに影響が出る可能性があるためです。 このため、またデバイスや実装間の移植性を高めるためにも、アプリケーションは実際に必要となる場合のみ、デフォルトより良いリミットをリクエストするべきです。
各制限にはデフォルト値と互換モードのデフォルト値があります。
アダプターは常にデフォルトまたはより良い制限値をサポートすることが保証されています(§ 4.2.1 アダプター機能保証参照)。
デバイスは生成時に決定された制限値のみをサポートします(§ 3.6 オプション機能参照)。 API呼び出しは、これらの制限値(アダプターの制限値ではなく)に従って検証されます。より良い/悪い値は利用できません。
任意の制限値について、ある値は他の値よりも優れている場合があります。 優れている制限値は常に検証を緩和し、より多くのプログラムが有効となります。各制限クラスごとに「優れている」の定義があります。
制限値ごとに異なる制限クラスがあります:
- maximum
-
このリミットは、APIに渡されるある値に最大値を強制します。
より大きい値の方が良いです。
- alignment
-
このリミットは、APIに渡されるある値に対し最小アライメントを強制します。 つまり、その値はリミットの倍数でなければなりません。
より小さい値の方が良いです。
2のべき乗でデフォルト以下の値のみ設定できます。 2のべき乗でない値は無効です。 より大きい2のべき乗値はデフォルトに丸められます。
supported limits オブジェクトはWebGPUで定義されたすべてのリミットに対応する値を持ちます:
| リミット名 | 型 | リミットクラス | デフォルト | 互換モードデフォルト |
|---|---|---|---|---|
maxTextureDimension1D
| GPUSize32
| 最大 | 8192 | 4096 |
dimension が size.width
の、texture
を "1d" として作成したときに許可される最大値。
| ||||
maxTextureDimension2D
| GPUSize32
| 最大 | 8192 | 4096 |
dimension が "2d" のテクスチャを作成したときの size.width および
size.height
の許容される最大値。
| ||||
maxTextureDimension3D
| GPUSize32
| 最大 | 2048 | |
dimension が "3d" のテクスチャを作成したときの size.width、
size.height
および size.depthOrArrayLayers
の許容される最大値。
| ||||
maxTextureArrayLayers
| GPUSize32
| 最大 | 256 | |
dimension が "2d" のテクスチャを作成したときの size.depthOrArrayLayers
の許容される最大値。
| ||||
maxBindGroups
| GPUSize32
| 最大 | 4 | |
GPUBindGroupLayouts
を bindGroupLayouts
に含めて GPUPipelineLayout
を作成する際に許可される最大数。
| ||||
maxBindGroupsPlusVertexBuffers
| GPUSize32
| 最大 | 24 | |
同時に使用される bind group と vertex buffer のスロット数の合計の最大値(最高インデックス未満の空スロットもカウントします)。
createRenderPipeline()
と 描画呼び出し 内で検証されます。
| ||||
maxBindingsPerBindGroup
| GPUSize32
| 最大 | 1000 | |
|
GPUBindGroupLayout を作成する際に利用可能なバインディングインデックスの数。 注意: この制限は標準的ですが任意です。
デフォルトの バインディングスロット制限を超える と、
1 つの bind group で 1000 個のバインディングを使用することは不可能ですが、これにより
| ||||
maxDynamicUniformBuffersPerPipelineLayout
| GPUSize32
| 最大 | 8 | |
| パイプラインレイアウト全体で動的オフセットを持つ uniform バッファである GPUBindGroupLayoutEntry の最大数。 詳細は バインディングスロット制限を超える を参照。 | ||||
maxDynamicStorageBuffersPerPipelineLayout
| GPUSize32
| 最大 | 4 | |
| パイプラインレイアウト全体で動的オフセットを持つ storage バッファである GPUBindGroupLayoutEntry の最大数。 詳細は バインディングスロット制限を超える を参照。 | ||||
maxSampledTexturesPerShaderStage
| GPUSize32
| 最大 | 16 | |
各 GPUShaderStage
の stage ごとに、パイプラインレイアウトでサンプルテクスチャである GPUBindGroupLayoutEntry の最大数。
詳細は バインディングスロット制限を超える を参照。
| ||||
maxSamplersPerShaderStage
| GPUSize32
| 最大 | 16 | |
各 GPUShaderStage
の stage ごとに、パイプラインレイアウトでサンプラーである GPUBindGroupLayoutEntry の最大数。
詳細は バインディングスロット制限を超える を参照。
| ||||
maxStorageBuffersPerShaderStage
| GPUSize32
| 最大 | 8 | |
各 GPUShaderStage
の stage ごとに、パイプラインレイアウトでストレージバッファである GPUBindGroupLayoutEntry の最大数。
詳細は バインディングスロット制限を超える を参照。
注意: この制限はすべてのステージに適用されます。
デバイス初期化 の際に、
| ||||
maxStorageBuffersInVertexStage
| GPUSize32
| 最大 | 8 | 0 |
| 頂点ステージにおいて、パイプラインレイアウトでストレージバッファである GPUBindGroupLayoutEntry の最大数。 詳細は バインディングスロット制限を超える を参照。 | ||||
maxStorageBuffersInFragmentStage
| GPUSize32
| 最大 | 8 | 4 |
| フラグメントステージにおいて、パイプラインレイアウトでストレージバッファである GPUBindGroupLayoutEntry の最大数。 詳細は バインディングスロット制限を超える を参照。 | ||||
maxStorageTexturesPerShaderStage
| GPUSize32
| 最大 | 4 | |
各 GPUShaderStage
の stage ごとに、パイプラインレイアウトでストレージテクスチャである GPUBindGroupLayoutEntry の最大数。
詳細は バインディングスロット制限を超える を参照。
注意: この制限はすべてのステージに適用されます。
デバイス初期化 の際に、
| ||||
maxStorageTexturesInVertexStage
| GPUSize32
| 最大 | 4 | 0 |
| 頂点ステージにおける、パイプラインレイアウトでストレージテクスチャである GPUBindGroupLayoutEntry の最大数。 詳細は バインディングスロット制限を超える を参照。 | ||||
maxStorageTexturesInFragmentStage
| GPUSize32
| 最大 | 4 | |
| フラグメントステージにおける、パイプラインレイアウトでストレージテクスチャである GPUBindGroupLayoutEntry の最大数。 詳細は バインディングスロット制限を超える を参照。 | ||||
maxUniformBuffersPerShaderStage
| GPUSize32
| 最大 | 12 | |
各 GPUShaderStage
の stage ごとに、パイプラインレイアウトで uniform バッファである GPUBindGroupLayoutEntry の最大数。
詳細は バインディングスロット制限を超える を参照。
| ||||
maxUniformBufferBindingSize
| GPUSize64
| 最大 | 65536 bytes | 16384 bytes |
GPUBufferBinding
の最大の size。
これは、GPUBindGroupLayoutEntry
の entry に対して、entry.buffer?.type
が "uniform"
の場合に適用されます。
| ||||
maxStorageBufferBindingSize
| GPUSize64
| 最大 | 134217728 bytes (128 MiB) | |
GPUBufferBinding
の最大の size。
これは、GPUBindGroupLayoutEntry
の entry に対して、entry.buffer?.type
が "storage"
または "read-only-storage"
の場合に適用されます。
| ||||
minUniformBufferOffsetAlignment
| GPUSize32
| アラインメント | 256 bytes | |
uniform バッファの GPUBufferBinding.offset
と、setBindGroup()
で与えられる動的オフセットに必要なアラインメント。
これは、GPUBindGroupLayoutEntry
の entry に対して、entry.buffer?.type
が "uniform"
の場合に適用されます。
| ||||
minStorageBufferOffsetAlignment
| GPUSize32
| アラインメント | 256 bytes | |
storage バッファの GPUBufferBinding.offset
と、setBindGroup()
で与えられる動的オフセットに必要なアラインメント。
これは、GPUBindGroupLayoutEntry
の entry に対して、entry.buffer?.type
が "storage"
または "read-only-storage"
の場合に適用されます。
| ||||
maxVertexBuffers
| GPUSize32
| 最大 | 8 | |
buffers
を含めて GPURenderPipeline
を作成する際に許可される最大数。
| ||||
maxBufferSize
| GPUSize64
| 最大 | 268435456 bytes (256 MiB) | |
size
を指定して GPUBuffer
を作成する際の最大サイズ。
| ||||
maxVertexAttributes
| GPUSize32
| 最大 | 16 | |
attributes
の総数の最大値(buffers
全体で)
を指定して GPURenderPipeline
を作成する際に適用されます。
| ||||
maxVertexBufferArrayStride
| GPUSize32
| 最大 | 2048 bytes | |
arrayStride
の許容される最大値(GPURenderPipeline を作成する際に適用)。
| ||||
maxInterStageShaderVariables
| GPUSize32
| 最大 | 16 | 15 |
| ステージ間通信(頂点出力やフラグメント入力など)の入力または出力変数の最大数。 | ||||
maxColorAttachments
| GPUSize32
| 最大 | 8 | 4 |
GPURenderPipelineDescriptor.fragment.targets、
GPURenderPassDescriptor.colorAttachments、
および GPURenderPassLayout.colorFormats
におけるカラーアタッチメントの最大数。
| ||||
maxColorAttachmentBytesPerSample
| GPUSize32
| 最大 | 32 | |
| レンダーパイプライン出力データの 1 サンプル(ピクセルまたはサブピクセル)を保持するのに必要な最大バイト数(すべてのカラーアタッチメント合計)。 | ||||
maxComputeWorkgroupStorageSize
| GPUSize32
| 最大 | 16384 bytes | |
| compute ステージの workgroup ストレージとして使用される最大バイト数(GPUShaderModule のエントリポイントに対して)。 | ||||
maxComputeInvocationsPerWorkgroup
| GPUSize32
| 最大 | 256 | 128 |
| compute ステージの GPUShaderModule エントリポイントに対する workgroup_size 次元の積の最大値。 | ||||
maxComputeWorkgroupSizeX
| GPUSize32
| 最大 | 256 | 128 |
| compute ステージの GPUShaderModule エントリポイントに対する workgroup_size の X 次元の最大値。 | ||||
maxComputeWorkgroupSizeY
| GPUSize32
| 最大 | 256 | 128 |
| compute ステージの GPUShaderModule エントリポイントに対する workgroup_size の Y 次元の最大値。 | ||||
maxComputeWorkgroupSizeZ
| GPUSize32
| 最大 | 64 | |
| compute ステージの GPUShaderModule エントリポイントに対する workgroup_size の Z 次元の最大値。 | ||||
maxComputeWorkgroupsPerDimension
| GPUSize32
| 最大 | 65535 | |
dispatchWorkgroups(workgroupCountX, workgroupCountY, workgroupCountZ)
の引数に対する許容される最大値。
| ||||
3.6.2.1. GPUSupportedLimits
GPUSupportedLimits
は、アダプターまたはデバイスのサポートされる制限値を公開します。
GPUAdapter.limits
および GPUDevice.limits
を参照してください。
[Exposed =(Window ,Worker ),SecureContext ]interface GPUSupportedLimits {readonly attribute unsigned long ;maxTextureDimension1D readonly attribute unsigned long ;maxTextureDimension2D readonly attribute unsigned long ;maxTextureDimension3D readonly attribute unsigned long ;maxTextureArrayLayers readonly attribute unsigned long ;maxBindGroups readonly attribute unsigned long ;maxBindGroupsPlusVertexBuffers readonly attribute unsigned long ;maxBindingsPerBindGroup readonly attribute unsigned long ;maxDynamicUniformBuffersPerPipelineLayout readonly attribute unsigned long ;maxDynamicStorageBuffersPerPipelineLayout readonly attribute unsigned long ;maxSampledTexturesPerShaderStage readonly attribute unsigned long ;maxSamplersPerShaderStage readonly attribute unsigned long ;maxStorageBuffersPerShaderStage readonly attribute unsigned long ;maxStorageBuffersInVertexStage readonly attribute unsigned long ;maxStorageBuffersInFragmentStage readonly attribute unsigned long ;maxStorageTexturesPerShaderStage readonly attribute unsigned long ;maxStorageTexturesInVertexStage readonly attribute unsigned long ;maxStorageTexturesInFragmentStage readonly attribute unsigned long ;maxUniformBuffersPerShaderStage readonly attribute unsigned long long ;maxUniformBufferBindingSize readonly attribute unsigned long long ;maxStorageBufferBindingSize readonly attribute unsigned long ;minUniformBufferOffsetAlignment readonly attribute unsigned long ;minStorageBufferOffsetAlignment readonly attribute unsigned long ;maxVertexBuffers readonly attribute unsigned long long ;maxBufferSize readonly attribute unsigned long ;maxVertexAttributes readonly attribute unsigned long ;maxVertexBufferArrayStride readonly attribute unsigned long ;maxInterStageShaderVariables readonly attribute unsigned long ;maxColorAttachments readonly attribute unsigned long ;maxColorAttachmentBytesPerSample readonly attribute unsigned long ;maxComputeWorkgroupStorageSize readonly attribute unsigned long ;maxComputeInvocationsPerWorkgroup readonly attribute unsigned long ;maxComputeWorkgroupSizeX readonly attribute unsigned long ;maxComputeWorkgroupSizeY readonly attribute unsigned long ;maxComputeWorkgroupSizeZ readonly attribute unsigned long ; };maxComputeWorkgroupsPerDimension
3.6.2.2. GPUSupportedFeatures
GPUSupportedFeatures
は setlike インターフェースです。その set entries は、
アダプターやデバイスによってサポートされている features の
GPUFeatureName
値です。
これは GPUFeatureName
列挙型にある文字列のみを含まなければなりません。
[Exposed =(Window ,Worker ),SecureContext ]interface GPUSupportedFeatures {readonly setlike <DOMString >; };
GPUSupportedFeatures
のset entries の型が DOMString
である理由は、ユーザーエージェントが仕様の今後の改訂で追加された正当な GPUFeatureName
を
認識できない場合でも優雅に扱えるようにするためです。もし set entries の
型が
GPUFeatureName
だった場合、次のコードは TypeError
をスローし、false を返すことはありません:
3.6.2.3. WGSLLanguageFeatures
WGSLLanguageFeatures
はnavigator.gpu.で利用可能なsetlikeインターフェースです。
そのset entriesは、実装がサポートするWGSL言語拡張の文字列名です
(アダプターやデバイスに関係なく判定されます)。
wgslLanguageFeatures
[Exposed =(Window ,Worker ),SecureContext ]interface WGSLLanguageFeatures {readonly setlike <DOMString >; };
3.6.2.4. GPUAdapterInfo
GPUAdapterInfo
はアダプターの識別情報を公開します。
GPUAdapterInfo
のメンバーは、特定値の設定が保証されません。値がない場合、その属性は空文字("")を返します。
どの値を公開するかはユーザーエージェントの裁量であり、端末によっては値が一切設定されないことも十分あり得ます。
したがって、アプリケーションはGPUAdapterInfo
の任意の値や値が未設定の場合も必ず扱えるようにする必要があります。
アダプターのGPUAdapterInfo
はGPUAdapter.info
およびGPUDevice.adapterInfoで公開されます。
この情報は不変です。
あるアダプターに対しては、各GPUAdapterInfo
属性はアクセスするたびに同じ値を返します。
注意:
GPUAdapterInfo
の属性は初回アクセス時点で不変ですが、実装は各属性の公開値を初回アクセスまで遅延決定しても構いません。
注意:
他のGPUAdapterインスタンス(同じ物理アダプターを表していても)でも、
GPUAdapterInfoの値が異なる場合があります。
ただし、特定のイベント(ページが追加の識別情報取得を許可された場合。現行標準では該当イベント定義なし)がない限り、値は同じにすべきです。
プライバシーの考慮事項については § 2.2.6 アダプター識別子 を参照してください。
[Exposed =(Window ,Worker ),SecureContext ]interface GPUAdapterInfo {readonly attribute DOMString vendor ;readonly attribute DOMString architecture ;readonly attribute DOMString device ;readonly attribute DOMString description ;readonly attribute unsigned long subgroupMinSize ;readonly attribute unsigned long subgroupMaxSize ;readonly attribute boolean isFallbackAdapter ; };
GPUAdapterInfo
には以下の属性があります:
vendor, 型 DOMString, 読み取り専用-
アダプターのベンダー名(利用可能な場合)。なければ空文字。
architecture, 型 DOMString, 読み取り専用-
アダプターが属するGPUファミリー・クラス名(利用可能な場合)。なければ空文字。
device, 型 DOMString, 読み取り専用-
アダプターのベンダー固有識別子(利用可能な場合)。なければ空文字。
注意: これはアダプター種別を表す値(例:PCIデバイスID)です。シリアル番号など特定機器一意の値ではありません。
description, 型 DOMString, 読み取り専用-
ドライバが報告するアダプターの人間可読説明(利用可能な場合)。なければ空文字。
注意:
descriptionには整形が一切施されないため、パースは推奨されません。既知のドライバ問題回避など、GPUAdapterInfoで動作変更する場合は、他フィールドを利用すべきです。 subgroupMinSize, 型 unsigned long, 読み取り専用-
"subgroups"機能がサポートされている場合、アダプターの最小サブグループサイズ。 subgroupMaxSize, 型 unsigned long, 読み取り専用-
"subgroups"機能がサポートされている場合、アダプターの最大サブグループサイズ。 isFallbackAdapter, 型 boolean, 読み取り専用-
アダプターがフォールバックアダプターかどうか。
-
adapterInfoを新しい
GPUAdapterInfoとする。 -
ベンダーが判明していれば、adapterInfo.
vendorにベンダー名(正規化識別文字列)を設定する。プライバシー保護のため、ユーザーエージェントは空文字または適当なベンダー名(正規化識別文字列)にしてもよい。 -
アーキテクチャが判明していれば、adapterInfo.
architectureにアダプターが属するファミリー・クラス名(正規化識別文字列)を設定する。プライバシー保護のため、空文字または適当なアーキテクチャ名(正規化識別文字列)でもよい。 -
デバイスが判明していれば、adapterInfo.
deviceにベンダー固有識別子(正規化識別文字列)を設定する。プライバシー保護のため、空文字または適当な識別子(正規化識別文字列)でもよい。 -
説明が判明していれば、adapterInfo.
descriptionにドライバ報告の説明文を設定。プライバシー保護のため、空文字または適当な説明でもよい。 -
"subgroups"がサポートされていれば、subgroupMinSizeに最小サブグループサイズを設定。なければ4とする。注意: プライバシー保護のため、ユーザーエージェントは一部機能をサポートしないか、区別不能でも利用可能な値(例:すべて4にする)を返す場合がある。
-
"subgroups"がサポートされていれば、subgroupMaxSizeに最大サブグループサイズを設定。なければ128とする。注意: プライバシー保護のため、ユーザーエージェントは一部機能をサポートしないか、区別不能でも利用可能な値(例:すべて128にする)を返す場合がある。
-
adapterInfo.
isFallbackAdapterをadapter.[[fallback]]で設定。 -
adapterInfoを返す。
3.7. 機能検出
このセクションは規範的ではありません。
この仕様を完全に実装するには、特に明記されている場合(§ 3.6 オプション機能など)を除き、規定されているすべてを実装する必要があります。
しかし、新しい「コア」追加は実装によって公開される前にこの仕様に追加されるため、多くの機能はアプリケーションによって機能検出できるように設計されています:
-
インターフェイスのサポートは
typeof InterfaceName !== 'undefined'で検出できます。 -
メソッドや属性のサポートは
'itemName' in InterfaceName.prototypeで検出できます。 -
新しい辞書メンバーが検出可能である必要がある場合、一般的に機能検出のための特定のメカニズムが文書化されています。例:
-
unclippedDepthのサポートはデバイス機能"depth-clip-control"の一部です。 -
キャンバスの
toneMappingサポートはgetConfiguration()を使って検出します。
-
3.8. 拡張文書
「拡張文書」とは、新しい機能を説明する追加文書であり、非規定でありWebGPU/WGSL仕様の一部ではありません。
これらは本仕様を基盤として構築される機能を記述し、多くの場合新しいAPI機能フラグやWGSLのenableディレクティブ、他のドラフトWeb標準との連携を含みます。
WebGPUの実装は拡張機能を公開してはなりません。公開すると仕様違反となります。 新しい機能はWebGPU標準(本ドキュメント)やWGSL仕様に統合されるまで、WebGPU標準の一部にはなりません。
3.9. オリジン制限
WebGPUは画像、動画、キャンバスに保存された画像データへのアクセスを許可します。 シェーダーによってGPUへアップロードされたテクスチャ内容を間接的に推測できるため、クロスドメインメディアの利用には制限があります。
WebGPUは、オリジンがクリーンでない画像ソースのアップロードを禁止します。
これは、WebGPUで描画されたキャンバスのorigin-cleanフラグがfalseになることは決してないことも意味します。
画像・動画要素のCORSリクエスト発行については以下を参照してください:
3.10. タスクソース
3.10.1. WebGPUタスクソース
WebGPUは新しいタスクソース「WebGPUタスクソース」を定義します。
これはuncapturederrorイベントおよびGPUDevice.lostに使用されます。
GPUDevice
deviceに対し、グローバルタスクをキューするには、
コンテンツタイムライン上で手順stepsを使って:
-
グローバルタスクをキューする(WebGPUタスクソースで、deviceを生成したグローバルオブジェクトとstepsを指定)。
3.10.2. 自動期限切れタスクソース
WebGPUは新しいタスクソース「自動期限切れタスクソース」を定義します。 これは特定オブジェクトの自動・タイマーによる期限切れ(破棄)に使用されます:
GPUDevice
deviceに対し、自動期限切れタスクをキューするには、
コンテンツタイムライン上で手順stepsを使って:
-
グローバルタスクをキューする(自動期限切れタスクソースで、deviceを生成したグローバルオブジェクトとstepsを指定)。
自動期限切れタスクソースからのタスクは高優先度で処理すべきです。特に、キューされたらユーザー定義(JavaScript)タスクより先に実行すべきです。
実装ノート: 高優先度の期限切れ「タスク」は、実際のタスクを実行する代わりに、イベントループ処理モデル内の固定ポイントに追加手順を挿入する形でも有効です。
3.11. 色空間とエンコーディング
WebGPUはカラーマネジメントを提供しません。WebGPU内部の値(テクスチャ要素など)はすべて生の数値であり、カラーマネージされた値ではありません。
WebGPUは、カラーマネージされた出力(GPUCanvasConfiguration)や入力
(copyExternalImageToTexture()やimportExternalTexture())と連携します。
したがって、WebGPU数値と外部色値との間で色変換が必要となります。
各インターフェースポイントごとに、WebGPU数値が解釈されるエンコーディング(色空間、伝達関数、アルファ事前乗算)がローカルに定義されます。
WebGPUは、PredefinedColorSpace
enumのすべての色空間を許可します。
各色空間はCSS定義に基づき拡張範囲を持ち、色空間外の値も表現可能です(色度・輝度両方)。
GPUTextureはカラーマネージメントされていません。これは
-srgb フォーマットも含まれますが、これらは
tagged されたsRGBカラースペース(
PredefinedColorSpace
やCSSカラースペース srgb、
srgb-linear のような)であるわけではありません。
しかし、-srgb テクスチャフォーマットにはガンマエンコード/デコードの特性があり、これは
"srgb"
や
"display-p3"
で使われているガンマエンコーディングとアルゴリズム的に近いものです。
たとえば、フラグメントシェーダーで「sRGB-linear」エンコード(物理的線形)のカラーバリューを -srgb
フォーマットテクスチャに出力すると、書き込み時に値がガンマエンコードされます。
その後、テクスチャ内の値は
"srgb"
タグ付き(知覚的にほぼ線形)のキャンバスで正しく使用できるようにエンコードされます。
同様に、これらの特性は
copyExternalImageToTexture()
を使うことで活用することも可能です。詳しくはその説明を参照してください。
ガマット外の事前乗算RGBA値とは、R/G/Bチャネル値がアルファ値を超えるものです。例:事前乗算sRGB
RGBA値[1.0, 0, 0, 0.5]は(非事前乗算)色[2, 0, 0]で50%アルファを表し、CSSではrgb(srgb 2 0 0 / 50%)。
sRGB色域外の色値同様、これは拡張色空間の定義済み点です(ただしアルファ0の場合は色がありません)。
ただし、この値を可視キャンバスへ出力する場合、結果は未定義です(GPUCanvasAlphaMode
"premultiplied"参照)。
3.11.1. 色空間変換
色は、上記で定義された方法に従い、ある色空間での表現を別の色空間の表現に変換することで変換されます。
元の値にRGBAチャンネルが4つ未満の場合、欠損している緑/青/アルファチャンネルは順に0, 0, 1として補われ、その後に色空間/エンコーディング変換やアルファプリマルチ化処理が行われます。変換後に宛先が4チャンネル未満を必要とする場合は、余分なチャンネルは無視されます。
注意:
グレースケール画像は一般的にその色空間内でRGB値(V, V, V)、またはRGBA値(V, V, V, A)として表現されます。
色は変換中に不可逆的にクランプされません:ある色空間から別の色空間へ変換する際、元の色値が宛先色空間のガマット範囲外の場合は、[0, 1]の範囲外の値になることがあります。例えばsRGBが宛先の場合、元がrgba16floatやDisplay-P3などの広色域だったり、プリマルチプライされてガマット外値を含んでいる場合に発生します。
同様に、元の値が高ビット深度(例:各成分16ビットのPNG)や拡張範囲(例:float16ストレージのcanvas)の場合でも、これらの色は色空間変換を通じて保持され、中間計算の精度も元データの精度以上となります。
3.11.2. 色空間変換省略
色空間・エンコーディング変換の元と先が同じならば、変換は不要です。一般に、変換の任意のステップが恒等関数(no-op)の場合、実装はパフォーマンスのため省略すべきです。
最適なパフォーマンスのため、アプリケーションは色空間やエンコーディング設定を工夫し、必要な変換数を最小化するべきです。
GPUCopyExternalImageSourceInfoの各種画像ソースに関して:
-
ImageBitmapの場合:-
事前乗算は
premultiplyAlphaで制御。 -
色空間は
colorSpaceConversionで制御。
-
-
2Dキャンバスの場合:
-
色空間は
colorSpaceコンテキスト生成属性で制御。
-
WebGLキャンバスの場合:
-
事前乗算は
premultipliedAlphaオプション(WebGLContextAttributes)で制御。 -
色空間は
WebGLRenderingContextBaseのdrawingBufferColorSpace状態で制御。
-
注意: これらの機能に依存する前に、各ブラウザの実装サポート状況を確認してください。
3.12. JavaScriptからWGSLへの数値変換
WebGPU APIのいくつかの部分(pipeline-overridable constants
や
レンダーパスのクリア値)は、WebIDL(double
や float)の数値を受け取り、
WGSL値(bool, i32, u32, f32, f16)へ変換します。
double
またはfloat)を
WGSL型Tへ変換するには、
(TypeErrorを投げる可能性あり)
以下のデバイスタイムライン手順を実行します:
注意: このTypeError
はデバイスタイムラインで生成され、JavaScriptには表出しません。
-
アサート:idlValueは有限値である(
unrestricted doubleやunrestricted floatではないため)。 -
vを、!によるidlValueの ECMAScript値への変換結果とする。
-
- もし T が
boolの場合 -
WGSL
bool値を返します。これは ! を使い v を IDL値型booleanに変換した結果に対応します。注: このアルゴリズムは ECMAScript の値を IDL
doubleやfloatに変換した後に呼ばれます。元の ECMAScript 値が数値でもブール値でもない[]や{}の場合、WGSLboolの結果は、元の値を IDLbooleanに直接変換した場合と異なることがあります。 - もし T が
i32の場合 -
WGSL
i32値を返します。これは?を使いvをIDL値型[EnforceRange]longに変換した結果に対応します。 - もし T が
u32の場合 -
WGSL
u32値を返します。これは?を使いvをIDL値型[EnforceRange]unsigned longに変換した結果に対応します。 - もし T が
f32の場合 - もし T が
f16の場合 -
-
f16(wgslF32)、すなわちWGSLf32値を!でf16に変換した結果(WGSL浮動小数点変換定義)を返す。
注: 値が
f32の範囲内なら、値がf16の範囲外でもエラーは発生しません。
- もし T が
GPUColor
colorをテクスチャフォーマットのテクセル値formatへ変換するには、
(TypeErrorを投げる可能性あり)
以下のデバイスタイムライン手順を実行します:
注意: このTypeError
はデバイスタイムラインで生成され、JavaScriptには表出しません。
-
formatの各コンポーネント(assert:すべて同じ型)は:
- 浮動小数点型または正規化型の場合
-
Tを
f32とする。 - 符号付き整数型の場合
-
Tを
i32とする。 - 符号なし整数型の場合
-
Tを
u32とする。
-
wgslColorをWGSL型
vec4<T>とし、各RGBAチャネル値はcolorの値を ?でWGSL型Tへ変換したもの。 -
wgslColorを§ 23.2.7 出力マージの変換規則でformatへ変換し、結果を返す。
注意: 整数型以外の場合、値の選択は実装定義となる。 正規化型の場合、値は型の範囲にクランプされる。
注意:
つまり、書き込まれる値はWGSLシェーダーがvec4(f32, i32,
u32)として出力した場合と同じになります。
4. 初期化
4.1. navigator.gpu
GPUオブジェクトは
Window
および WorkerGlobalScope
コンテキストで利用でき、Navigator
および WorkerNavigator
インターフェースを通じて navigator.gpu で公開されます。
interface mixin { [NavigatorGPU SameObject ,SecureContext ]readonly attribute GPU gpu ; };Navigator includes NavigatorGPU ;WorkerNavigator includes NavigatorGPU ;
NavigatorGPU
には以下の属性があります:
gpu, 型 GPU, 読み取り専用-
requestAdapter()などトップレベルエントリポイントを提供するグローバルシングルトン。
4.2. GPU
GPUはWebGPUへの入り口です。
[Exposed =(Window ,Worker ),SecureContext ]interface GPU {Promise <GPUAdapter ?>requestAdapter (optional GPURequestAdapterOptions options = {});GPUTextureFormat getPreferredCanvasFormat (); [SameObject ]readonly attribute WGSLLanguageFeatures wgslLanguageFeatures ; };
GPUは以下のメソッドを持ちます:
requestAdapter(options)-
ユーザーエージェントからアダプタを要求します。 ユーザーエージェントはアダプタを返すかどうかを選択し、返す場合は提供されたオプションに従って選択します。
呼び出し対象:GPUthis.引数:
GPU.requestAdapter(options) メソッドの引数。 パラメータ 型 Nullable Optional 説明 optionsGPURequestAdapterOptions✘ ✔ アダプタを選択するための基準。 戻り値:
Promise<GPUAdapter?>Content timeline の手順:
-
現在の Content timeline を contentTimeline とする。
-
promise を新しいプロミスとして作成する。
-
このオブジェクトの Device timeline 上で initialization steps を実行する。
-
promise を返す。
デバイスタイムライン 初期化手順:-
以下の全ての要件が 満たされていなければならない。
-
options.
featureLevelは feature level文字列でなければならない。
どれか一つでも満たされていなければ:
-
adapter を
nullとし、contentTimeline 上で resolution steps を実行し、終了する。
-
-
もし options.
featureLevelが "compatibility" なら:-
ユーザーエージェントがサポートすると選択した場合には options.
featureLevelを "compatibility" に設定し、そうでなければ "core" に設定する。注: これはアプリケーションから渡された JavaScript オブジェクト自体を修正するものではない。
-
-
adapter を次のいずれかに設定する:
-
アダプター オブジェクトを新規に生成し、§ 4.2.2 アダプター選択 の規則と optionsの条件に従い、§ 4.2.1 アダプター能力保証を守るものとし、 アダプターの能力はユーザーエージェントによる実装定義方法で決定される。
-
ユーザーエージェントがアダプターを返せない場合、または実装定義で返さないと選択した場合は
null。
adapter が返されたら、そのプロパティを定義に従って初期化する。
-
adapter.
[[limits]]および adapter.[[features]]をアダプターのサポートする能力に応じて設定する。 -
もし adapter がフォールバックアダプターの条件を満たすなら adapter.
[[fallback]]をtrueに設定し、そうでなければfalseに設定する。 -
adapter.
[[xrCompatible]]に options.xrCompatibleを設定する。 -
adapter.
[[default feature level]]に options.featureLevelを設定する。
-
-
contentTimeline 上で resolution steps を実行する。
コンテンツタイムライン 解決手順:-
もし adapter が
nullでなければ:-
promise を新しい
GPUAdapter(adapter をカプセル化したもの)で解決する。
それ以外の場合:
-
promise を
nullで解決する。
-
-
getPreferredCanvasFormat()-
このシステムで 8 ビット深度の標準ダイナミックレンジコンテンツを表示するのに最適な
GPUTextureFormatを返します。返される値は"rgba8unorm"または"bgra8unorm"のいずれかでなければなりません。返された値は
formatとしてconfigure()に渡すことができ、関連するキャンバスが内容を効率的に表示できるようにします。注: 画面に表示されないキャンバスはこのフォーマットの恩恵を受けるかどうかは環境によります。
呼び出し対象:GPUthis.戻り値:
GPUTextureFormatContent timeline の手順:
-
このシステムの WebGPU キャンバス表示に最適なフォーマットに応じて、
"rgba8unorm"または"bgra8unorm"のいずれかを返します。
-
GPUは以下の属性を持ちます:
wgslLanguageFeatures, 型 WGSLLanguageFeatures, 読み取り専用-
サポートされるWGSL言語拡張名。サポートされる言語拡張は自動的に有効化されます。
アダプターはいつでも
期限切れになる可能性があります。システム状態に変更が生じ、requestAdapter()
の結果に影響する場合、ユーザーエージェントはすべての既返却済み
アダプターを期限切れにすべきです。例:
-
物理アダプター追加/削除(抜き差し、ドライバ更新、ハング回復など)
-
システム電源設定変更(ノートPC抜き差し、電源設定変更など)
注意:
ユーザーエージェントは、システム状態変化がなくても(例:アダプター作成後数秒・数分後など)、アダプターを頻繁に期限切れにすることを選択できます。
これにより実際のシステム状態変化の隠蔽や、requestAdapter()
を再度呼び出す必要性の認識向上につながります。
この状況になっても標準的なデバイスロス回復処理で復旧可能です。
4.2.1. アダプター機能保証
GPUAdapter
がrequestAdapter()
で返された場合、以下の保証が必要です:
-
以下のいずれかが必ず真であること:
-
"texture-compression-bc"がサポートされている。 -
"texture-compression-etc2"と"texture-compression-astc"の両方がサポートされている。
-
-
"texture-compression-bc-sliced-3d"がサポートされている場合は、"texture-compression-bc"もサポートされていなければならない。 -
"texture-compression-astc-sliced-3d"がサポートされている場合は、"texture-compression-astc"もサポートされていなければならない。 -
すべてのアライメントクラス制限値は2の累乗でなければならない。
-
maxBindingsPerBindGroupは、(シェーダーステージごとの最大バインディング数 × パイプラインごとの最大シェーダーステージ数)以上でなければならない。ここで:-
シェーダーステージごとの最大バインディング数は (
maxSampledTexturesPerShaderStage+maxSamplersPerShaderStage+maxStorageBuffersPerShaderStage+maxStorageTexturesPerShaderStage+maxUniformBuffersPerShaderStage)。 -
パイプラインごとの最大シェーダーステージ数は
2。これはGPURenderPipelineが頂点・フラグメントシェーダー両方をサポートするためです。
注意:
maxBindingsPerBindGroupは本質的な制限値ではありません。 実装は他の制限値を下げるのではなく、この値を要件に合わせて引き上げるべきです。 -
-
maxBindGroupsはmaxBindGroupsPlusVertexBuffers以下でなければならない。 -
maxVertexBuffersはmaxBindGroupsPlusVertexBuffers以下でなければならない。 -
minUniformBufferOffsetAlignmentおよびminStorageBufferOffsetAlignmentは両方とも32バイト以上でなければならない。注意: 32バイトは
vec4<f64>のアライメントに相当します。WebGPU Shading Language § 14.4.1 アライメントとサイズ参照。 -
maxUniformBufferBindingSizeはmaxBufferSize以下でなければならない。 -
maxStorageBufferBindingSizeはmaxBufferSize以下でなければならない。 -
maxStorageBufferBindingSizeは4バイトの倍数でなければならない。 -
maxVertexBufferArrayStrideは4バイトの倍数でなければならない。 -
maxComputeWorkgroupSizeXはmaxComputeInvocationsPerWorkgroup以下でなければならない。 -
maxComputeWorkgroupSizeYはmaxComputeInvocationsPerWorkgroup以下でなければならない。 -
maxComputeWorkgroupSizeZはmaxComputeInvocationsPerWorkgroup以下でなければならない。 -
maxComputeInvocationsPerWorkgroupはmaxComputeWorkgroupSizeX×maxComputeWorkgroupSizeY×maxComputeWorkgroupSizeZ以下でなければならない。
4.2.2. アダプター選択
GPURequestAdapterOptions
は、ユーザーエージェントに対してアプリケーションに適した構成のヒントを与えます。
dictionary GPURequestAdapterOptions {DOMString featureLevel = "core";GPUPowerPreference powerPreference ;boolean forceFallbackAdapter =false ;boolean xrCompatible =false ; };
enum {GPUPowerPreference "low-power" ,"high-performance" , };
GPURequestAdapterOptions
には以下のメンバーがあります:
featureLevel、 型は DOMString、初期値は"core"-
特定の能力セット以上をサポートするアダプターを要求します。 これはこのアダプターから作成されるデバイスの
[[default feature level]]に影響します。 各レベルの能力は下記で定義されており、詳細手順はrequestAdapter()および「新しいデバイス」で定義されています。実装やシステムがリクエストされた feature level の全ての能力をサポートしていない場合、
requestAdapter()はnullを返します。注: 通常、アプリケーションはサポートする最も低い feature level で1回だけ
requestAdapter()を呼び、アダプターから追加能力を調べてオプションで利用し、 必要な場合それらをrequestDevice()で要求することを推奨します。許可される feature level 文字列 の値は次の通りです:
- "core"
-
次の能力セット:
注: この
[[default feature level]]を持つアダプターは慣例的に「Core-defaulting」と呼ばれることがあります。 - "compatibility"
-
次の能力セット:
-
互換モードデフォルト リミット。
-
機能はなし(
"core-features-and-limits"機能を除外)。
実装がより厳格な「互換モード」検証ルールを強制できない場合、
requestAdapter()はこのリクエストを無視し、 "core" へのリクエストとして扱います。注: この
[[default feature level]]を持つアダプターは慣例的に「Compatibility-defaulting」と呼ばれることがあります。 -
powerPreference、型は GPUPowerPreference-
システムで利用可能なアダプターの中からどのクラスのアダプターを選ぶべきか示すヒントをオプションで指定します。
このヒント値はどのアダプターが選ばれるかに影響する可能性がありますが、 アダプターが返されるかどうかには影響してはなりません。
注: このヒントの主な用途は、マルチGPUシステムにおいてどちらのGPUを使用するかに影響することです。 例えば、ノートPCでは省電力な統合GPUと高性能なディスクリートGPUを持つ場合があります。このヒントはまた、選択されたGPUの電力設定にも影響するかもしれません。
注: バッテリー状態やディスプレイの接続、外付けGPUの有無など、ハードウェア構成によっては、 同じ電力設定ヒントでも異なるアダプターが選択されることがあります。 典型的には、同じハード構成や状態、および
powerPreference指定であれば、 同じアダプターが選択されやすいです。次の値のいずれかでなければなりません:
undefined(または未指定)-
ユーザーエージェントへヒントを与えません。
"low-power"-
性能より省電力を優先するリクエストを示します。
注: 一般的に、描画性能がボトルネックにならない場合(例:1秒あたり1フレームしか描画しない、シンプルな幾何またはシェーダーのみ描画する、小さなHTMLキャンバスのみ使う等)にこの値の利用が推奨されます。 バッテリー持続時間を大きく伸ばす可能性があるため、許容できる場合はこの値を推奨します。
"high-performance"-
省電力より性能を優先するリクエストを示します。
注: この値を指定すると、生成したデバイスでユーザーエージェントが電力節約のため低消費電力アダプターへ切り替えるべく デバイスロストを強制する可能性が高くなります。 本当に必要と考える場合のみこの値を指定することを推奨します。特にポータブルデバイスではバッテリー寿命が大きく短くなる場合があります。
forceFallbackAdapter、 型は boolean、初期値はfalse-
trueに設定した場合、フォールバックアダプターのみが返される可能性があります。ユーザーエージェントがフォールバックアダプターをサポートしていない場合、requestAdapter()はnullで解決されます。注:
requestAdapter()はforceFallbackAdapterがfalseで他に適切なアダプターがない場合や ユーザーエージェントが返すことを選択した場合も、フォールバックアダプター を返す場合があります。アプリがフォールバックアダプターでの動作を拒否したい場合はinfo.isFallbackAdapter属性をrequestDevice()前に判定してください。 xrCompatible、型は boolean、初期値はfalse-
trueに設定した場合、WebXR セッションへ描画するのに最適なアダプターが選択されなければなりません。ユーザーエージェントやシステムがWebXR セッションをサポートしない場合、この値は無視されることがあります。注: アダプター要求時に
xrCompatibleをtrueにしない場合、そのアダプターから生成されたGPUDeviceは WebXR セッションへの描画に利用できません。
"high-performance"
GPUAdapter
を要求する例:
const gpuAdapter= await navigator. gpu. requestAdapter({ powerPreference: 'high-performance' });
4.3. GPUAdapter
GPUAdapter
はアダプターをカプセル化し、
その機能(featuresやlimits)を記述します。
GPUAdapter
を取得するには、requestAdapter()を使います。
[Exposed =(Window ,Worker ),SecureContext ]interface GPUAdapter { [SameObject ]readonly attribute GPUSupportedFeatures features ; [SameObject ]readonly attribute GPUSupportedLimits limits ; [SameObject ]readonly attribute GPUAdapterInfo info ;Promise <GPUDevice >requestDevice (optional GPUDeviceDescriptor descriptor = {}); };
GPUAdapter
には以下の不変プロパティがあります。
features, 型 GPUSupportedFeatures, 読み取り専用-
this.[[adapter]].[[features]]の値セット。 limits, 型 GPUSupportedLimits, 読み取り専用-
this.[[adapter]].[[limits]]の制限値。 info, 型 GPUAdapterInfo, 読み取り専用-
この
GPUAdapterの下層物理アダプター情報。同一
GPUAdapterに対してはGPUAdapterInfoの値は常に一定です。毎回同じオブジェクトが返されます。初回生成方法:
[[adapter]], 型 adapter, 読み取り専用-
この
GPUAdapterが参照するアダプター。
GPUAdapter
には以下のメソッドがあります:
requestDevice(descriptor)-
これは一度限りの操作です: デバイスが正常に返された場合、アダプターは
"consumed"になります。呼び出し対象:GPUAdapterthis。引数:
GPUAdapter.requestDevice(descriptor) メソッドの引数。 パラメーター 型 ヌル許容 省略可 説明 descriptorGPUDeviceDescriptor✘ ✔ 要求する GPUDeviceの説明。コンテンツタイムライン のステップ:
-
変数 contentTimeline を現在のコンテンツタイムラインにします。
-
変数 promise を新しい promiseにします。
-
変数 adapter を this.
[[adapter]]にします。 -
this のデバイスタイムラインに対して、initialization stepsを実行します。
-
promise を返します。
デバイスタイムライン の initialization steps:-
次のいずれかの要件が満たされない場合:
-
descriptor の集合にある値のセットのうち、descriptor.
requiredFeaturesは、adapter.[[features]]にあるものの部分集合でなければなりません。
その場合、次の手順をcontentTimeline上で実行して返します:
コンテンツタイムライン のステップ:注: これはブラウザがその機能名をまったく認識していない場合(
GPUFeatureNameの定義内)に生成されるエラーと同じです。 これにより、ブラウザが機能をサポートしていない場合の動作と、特定のアダプターがその機能をサポートしていない場合の動作が収束します。 -
-
以下の手順のすべての要件が満たされる必要があります。
-
adapter.
[[state]]は"consumed"であってはなりません。 -
descriptor.
requiredLimitsの各 [key, value] について、value がundefinedでない場合:-
key はサポートされているリミット のメンバー名でなければなりません。
-
value は adapter.
[[limits]][key] よりも良すぎてはなりません。
注: key が認識されない場合(たとえ value が
undefinedであっても)、ユーザーエージェントは開発者に見える警告を出すことを検討すべきです。 -
もしいずれかが満たされない場合は、次の手順をcontentTimeline上で実行して返します:
コンテンツタイムライン のステップ:-
Rejectしてpromiseを
OperationErrorで終了させます。
-
-
もし adapter.
[[state]]が"expired"であるか、ユーザーエージェントが要求を満たせない場合:-
変数 device を新しいデバイスにします。
-
デバイスを失わせる (Lose the device)(device,
"unknown"). -
Assert して adapter.
[[state]]が"expired"であることを確認します。注: これが発生した場合、ユーザーエージェントはほとんどまたはすべてのケースで開発者に見える警告を出すことを検討するべきです。アプリケーションは
requestAdapter()から始めて再初期化ロジックを実行するべきです。
それ以外の場合:
-
-
続きの手順をcontentTimeline上で実行します。
コンテンツタイムライン のステップ:-
変数 gpuDevice を新しい
GPUDeviceインスタンスにします。 -
gpuDevice.
[[device]]を device に設定します。 -
device.
[[content device]]を gpuDevice に設定します。 -
Resolve して promise を gpuDevice で解決します。
注: アダプターが要求を満たせなかったためにデバイスが既に失われている場合、device.
lostは promise が解決する前に既に解決されていることに注意してください。
-
GPUDeviceを要求する例:
const gpuAdapter= await navigator. gpu. requestAdapter(); const gpuDevice= await gpuAdapter. requestDevice();
4.3.1. GPUDeviceDescriptor
GPUDeviceDescriptor
はデバイス要求内容を記述します。
dictionary GPUDeviceDescriptor :GPUObjectDescriptorBase {sequence <GPUFeatureName >requiredFeatures = [];record <DOMString , (GPUSize64 or undefined )>requiredLimits = {};GPUQueueDescriptor defaultQueue = {}; };
GPUDeviceDescriptor
には以下のメンバーがあります:
requiredFeatures, 型 sequence<GPUFeatureName>、デフォルト[]-
デバイス要求で必要な機能を指定します。 アダプターがこれら機能を提供できない場合、要求は失敗します。
API呼び出しの検証では、指定した機能セットのみが利用可能であり、それ以外は利用不可です。
requiredLimits, 型record<DOMString, (GPUSize64 or undefined)>、デフォルト{}-
デバイス要求で必要な制限値を指定します。 アダプターがこれら制限値を提供できない場合、要求は失敗します。
値が
undefinedでない各キーはsupported limitsメンバー名でなければなりません。生成されたデバイスのAPI呼び出しは、そのデバイスの厳密な制限値に従って検証されます(アダプターの制限値ではない。§ 3.6.2 制限参照)。
defaultQueue, 型 GPUQueueDescriptor、デフォルト{}-
デフォルト
GPUQueueの記述内容。
"texture-compression-astc"機能付きGPUDeviceを要求する例:
const gpuAdapter= await navigator. gpu. requestAdapter(); const requiredFeatures= []; if ( gpuAdapter. features. has( 'texture-compression-astc' )) { requiredFeatures. push( 'texture-compression-astc' ) } const gpuDevice= await gpuAdapter. requestDevice({ requiredFeatures});
maxColorAttachmentBytesPerSample制限付きGPUDeviceを要求する例:
const gpuAdapter= await navigator. gpu. requestAdapter(); if ( gpuAdapter. limits. maxColorAttachmentBytesPerSample< 64 ) { // 希望の制限値が未サポートの場合、より高い制限値を必要としないコードパスへフォールバックするか、 // デバイスが最低要件を満たしていないことをユーザーに通知するなどの対応を取る。 } // max color attachments bytes per sampleのより高い制限値を要求。 const gpuDevice= await gpuAdapter. requestDevice({ requiredLimits: { maxColorAttachmentBytesPerSample: 64 }, });
4.3.1.1. GPUFeatureName
各GPUFeatureNameは、
利用可能であればWebGPUの追加利用を許可する機能セットを識別します。
enum GPUFeatureName {"core-features-and-limits" ,"depth-clip-control" ,"depth32float-stencil8" ,"texture-compression-bc" ,"texture-compression-bc-sliced-3d" ,"texture-compression-etc2" ,"texture-compression-astc" ,"texture-compression-astc-sliced-3d" ,"timestamp-query" ,"indirect-first-instance" ,"shader-f16" ,"rg11b10ufloat-renderable" ,"bgra8unorm-storage" ,"float32-filterable" ,"float32-blendable" ,"clip-distances" ,"dual-source-blending" ,"subgroups" ,"texture-formats-tier1" ,"texture-formats-tier2" ,"primitive-index" ,"texture-component-swizzle" , };
4.4. GPUDevice
GPUDevice
はデバイスをカプセル化し、その機能を公開します。
GPUDeviceは
WebGPUインターフェースを生成するトップレベルインターフェースです。
GPUDeviceを取得するには、requestDevice()を使用します。
[Exposed =(Window ,Worker ),SecureContext ]interface GPUDevice :EventTarget { [SameObject ]readonly attribute GPUSupportedFeatures features ; [SameObject ]readonly attribute GPUSupportedLimits limits ; [SameObject ]readonly attribute GPUAdapterInfo adapterInfo ; [SameObject ]readonly attribute GPUQueue queue ;undefined destroy ();GPUBuffer createBuffer (GPUBufferDescriptor descriptor );GPUTexture createTexture (GPUTextureDescriptor descriptor );GPUSampler createSampler (optional GPUSamplerDescriptor descriptor = {});GPUExternalTexture importExternalTexture (GPUExternalTextureDescriptor descriptor );GPUBindGroupLayout createBindGroupLayout (GPUBindGroupLayoutDescriptor descriptor );GPUPipelineLayout createPipelineLayout (GPUPipelineLayoutDescriptor descriptor );GPUBindGroup createBindGroup (GPUBindGroupDescriptor descriptor );GPUShaderModule createShaderModule (GPUShaderModuleDescriptor descriptor );GPUComputePipeline createComputePipeline (GPUComputePipelineDescriptor descriptor );GPURenderPipeline createRenderPipeline (GPURenderPipelineDescriptor descriptor );Promise <GPUComputePipeline >createComputePipelineAsync (GPUComputePipelineDescriptor descriptor );Promise <GPURenderPipeline >createRenderPipelineAsync (GPURenderPipelineDescriptor descriptor );GPUCommandEncoder createCommandEncoder (optional GPUCommandEncoderDescriptor descriptor = {});GPURenderBundleEncoder createRenderBundleEncoder (GPURenderBundleEncoderDescriptor descriptor );GPUQuerySet createQuerySet (GPUQuerySetDescriptor descriptor ); };GPUDevice includes GPUObjectBase ;
features, 型 GPUSupportedFeatures, 読み取り専用-
このデバイスがサポートする
GPUFeatureName値のセット([[device]].[[features]])。 limits, 型 GPUSupportedLimits, 読み取り専用-
このデバイスがサポートする制限値(
[[device]].[[limits]])。 queue, 型 GPUQueue, 読み取り専用-
このデバイスの主キュー
GPUQueue。 adapterInfo, 型 GPUAdapterInfo, 読み取り専用-
この
GPUDeviceを生成した物理アダプターの情報。同じ
GPUDeviceに対しては、GPUAdapterInfoの値は常に一定です。毎回同じオブジェクトが返されます。初回生成方法:
呼び出し元:GPUDevicethis.戻り値:
GPUAdapterInfoコンテンツタイムライン手順:
-
this.
[[device]].[[adapter]]に対して新しいアダプター情報を返す。
-
[[device]]
はGPUDeviceが参照するdeviceです。
GPUDeviceは以下のメソッドを持ちます:
destroy()-
デバイスを破棄し、以降の操作を禁止します。 未完了の非同期操作は失敗します。
注意: デバイスは何度破棄しても有効です。
-
Lose the device(this.
[[device]],"destroyed").
注意: このデバイスに対して以降の操作が一切キューされないため、実装は未完了の非同期操作やリソース割り当て(アンマップ直後のメモリ含む)を即座に中断・解放できます。
-
GPUDeviceの許可バッファ用途:
GPUDeviceの許可テクスチャ用途:
4.5. 例
GPUAdapter
およびGPUDevice要求のエラーハンドリング例:
let gpuDevice= null ; async function initializeWebGPU() { // ユーザーエージェントがWebGPUをサポートしているか確認 if ( ! ( 'gpu' in navigator)) { console. error( "ユーザーエージェントがWebGPUをサポートしていません。" ); return false ; } // アダプター要求 const gpuAdapter= await navigator. gpu. requestAdapter(); // 適切なアダプターが見つからない場合、requestAdapterはnullで解決されることがある if ( ! gpuAdapter) { console. error( 'WebGPUアダプターが見つかりません。' ); return false ; } // デバイス要求 // オプション辞書に無効な値が渡された場合、promiseはrejectされる。 // 必ずアダプターのfeaturesやlimitsを事前に確認してからrequestDevice()を呼ぶこと。 gpuDevice= await gpuAdapter. requestDevice(); // requestDeviceはnullを返さないが、何らかの理由で有効なデバイス要求が満たせない場合 // 既に失われたデバイスとしてresolveされることがあり得る。 // また、デバイスは作成後も様々な理由(ブラウザのリソース管理、ドライバ更新等)で // いつでも失われる可能性があるため、常にロストデバイスを適切に扱うこと。 gpuDevice. lost. then(( info) => { console. error( `WebGPUデバイスが失われました: ${ info. message} ` ); gpuDevice= null ; // デバイスロストの多くは一時的なものなので、アプリケーションは // 以前のデバイスが失われたら新規取得を試みるべき(意図的なdestroy理由以外)。 // 前のデバイスで作成したWebGPUリソース(バッファ、テクスチャ等)は // 新しいデバイスで再作成する必要がある。 if ( info. reason!= 'destroyed' ) { initializeWebGPU(); } }); onWebGPUInitialized(); return true ; } function onWebGPUInitialized() { // ここからWebGPUリソース作成処理を開始 } initializeWebGPU();
5. バッファ
5.1. GPUBuffer
GPUBuffer
はGPU操作で利用できるメモリブロックを表します。
データは線形レイアウトで格納されており、割り当て領域の各バイトは
GPUBufferの先頭からのオフセットで参照可能ですが、
操作ごとにアライメント制約があります。一部のGPUBufferは
マップ可能であり、対応するメモリブロックはArrayBuffer
(マッピング)経由でアクセスできます。
GPUBufferは
createBuffer()で作成します。
バッファはmappedAtCreationを指定可能です。
[Exposed =(Window ,Worker ),SecureContext ]interface GPUBuffer {readonly attribute GPUSize64Out size ;readonly attribute GPUFlagsConstant usage ;readonly attribute GPUBufferMapState mapState ;Promise <undefined >mapAsync (GPUMapModeFlags mode ,optional GPUSize64 offset = 0,optional GPUSize64 size );ArrayBuffer getMappedRange (optional GPUSize64 offset = 0,optional GPUSize64 size );undefined unmap ();undefined destroy (); };GPUBuffer includes GPUObjectBase ;enum GPUBufferMapState {"unmapped" ,"pending" ,"mapped" , };
size, 型 GPUSize64Out, 読み取り専用-
GPUBufferの割り当てサイズ(バイト単位)。 usage, 型 GPUFlagsConstant, 読み取り専用-
この
GPUBufferで許可されている用途。
GPUBufferは
以下のコンテンツタイムラインプロパティを持ちます:
mapState, 型 GPUBufferMapState, 読み取り専用-
バッファの現在の
GPUBufferMapState:"unmapped"-
バッファが
this.getMappedRange()で利用できるようにマップされていません。 "pending"-
バッファのマッピング要求が保留中です。
mapAsync()で検証失敗または成功する可能性があります。 "mapped"-
バッファがマップされており、
this.getMappedRange()が利用できます。
コンテンツタイムライン手順:-
this.
[[mapping]]がnullでなければ、"mapped"を返す。 -
this.
[[pending_map]]がnullでなければ、"pending"を返す。 -
"unmapped"を返す。
[[pending_map]], 型Promise<void> またはnull(初期値null)-
現在保留中の
Promise(mapAsync()呼び出し)を返します。保留中のマップは常に1つしかありません。既に要求中の場合、
mapAsync()は即座に拒否します。 [[mapping]], 型 active buffer mapping またはnull(初期値null)-
バッファが現在
getMappedRange()で利用可能な場合のみ設定されます。 それ以外の場合はnullです([[pending_map]]があっても)。active buffer mappingは以下のフィールドを持つ構造体です:
- data, 型 Data Block
-
この
GPUBufferのマッピングデータ。 このデータはArrayBufferビューを通じてアクセスされ、getMappedRange()で返され、viewsに格納されます。 - mode, 型
GPUMapModeFlags -
対応する
mapAsync()またはcreateBuffer()呼び出しで指定されたGPUMapModeFlags。 - range, 型 タプル [
unsigned long long,unsigned long long] -
マップされた
GPUBufferの範囲。 - views, 型 list<
ArrayBuffer> -
アプリケーションに
ArrayBufferとして返されたビュー。unmap()呼び出し時に切り離すため管理されます。
active buffer mappingを初期化するには、 mode modeとrange rangeで以下のコンテンツタイムライン手順を実行:-
sizeをrange[1] - range[0]とする。
-
dataを? CreateByteDataBlock(size)で作成。
注意:この操作はRangeErrorを投げることがあります。 一貫性・予測可能性のため:-
その時点で
new ArrayBuffer()が成功するサイズは、この割り当ても成功すべき。 -
その時点で
new ArrayBuffer()がRangeErrorを 決定的に投げるサイズは、この割り当ても同様にすべき。
-
-
以下を持つactive buffer mappingを返す:
GPUBufferは
以下のデバイスタイムラインプロパティを持ちます:
[[internal state]]-
バッファの現在の内部状態:
5.1.1. GPUBufferDescriptor
dictionary GPUBufferDescriptor :GPUObjectDescriptorBase {required GPUSize64 size ;required GPUBufferUsageFlags usage ;boolean mappedAtCreation =false ; };
GPUBufferDescriptor
には以下のメンバーがあります:
size, 型 GPUSize64-
バッファのサイズ(バイト単位)。
usage, 型 GPUBufferUsageFlags-
バッファで許可される用途。
mappedAtCreation, 型 boolean(デフォルトfalse)-
trueの場合、バッファは作成時にすでにマップされた状態となり、getMappedRange()が即座に呼び出し可能となります。mappedAtCreationをtrueにしても、usageにMAP_READやMAP_WRITEを含めなくても有効です。 これはバッファの初期データを設定するために利用できます。バッファ作成が最終的に失敗した場合でも、アンマップされるまではマップ範囲に書き込み/読み出しできるように見えることが保証されます。
5.1.2. バッファ用途
typedef [EnforceRange ]unsigned long ; [GPUBufferUsageFlags Exposed =(Window ,Worker ),SecureContext ]namespace {GPUBufferUsage const GPUFlagsConstant MAP_READ = 0x0001;const GPUFlagsConstant MAP_WRITE = 0x0002;const GPUFlagsConstant COPY_SRC = 0x0004;const GPUFlagsConstant COPY_DST = 0x0008;const GPUFlagsConstant INDEX = 0x0010;const GPUFlagsConstant VERTEX = 0x0020;const GPUFlagsConstant UNIFORM = 0x0040;const GPUFlagsConstant STORAGE = 0x0080;const GPUFlagsConstant INDIRECT = 0x0100;const GPUFlagsConstant QUERY_RESOLVE = 0x0200; };
GPUBufferUsage
フラグはGPUBufferが作成後にどのように利用できるかを決定します:
MAP_READ-
バッファは読み出し用にマップ可能です。(例:
mapAsync()でGPUMapMode.READを指定)COPY_DSTとだけ組み合わせ可能です。 MAP_WRITE-
バッファは書き込み用にマップ可能です。(例:
mapAsync()でGPUMapMode.WRITEを指定)COPY_SRCとだけ組み合わせ可能です。 COPY_SRC-
バッファはコピー操作のソースとして利用可能です。(例:copyBufferToBuffer()や
copyBufferToTexture()呼び出しのsource引数) COPY_DST-
バッファはコピーや書き込み操作の宛先として利用可能です。(例:copyBufferToBuffer()や
copyTextureToBuffer()呼び出しのdestination引数、あるいはwriteBuffer()ターゲット) INDEX-
バッファはインデックスバッファとして利用可能です。(例:
setIndexBuffer()への渡し) VERTEX-
バッファは頂点バッファとして利用可能です。(例:
setVertexBuffer()への渡し) UNIFORM-
バッファはユニフォームバッファとして利用可能です。(例:
GPUBufferBindingLayoutのバインドグループエントリでbuffer.typeが"uniform"の場合) STORAGE-
バッファはストレージバッファとして利用可能です。(例:
GPUBufferBindingLayoutのバインドグループエントリでbuffer.typeが"storage"または"read-only-storage"の場合) INDIRECT-
バッファは間接コマンド引数の保存に利用可能です。(例:
indirectBuffer引数としてdrawIndirect()やdispatchWorkgroupsIndirect()呼び出しで利用) QUERY_RESOLVE-
バッファはクエリ結果の取得に利用可能です。(例:
destination引数としてresolveQuerySet()呼び出しで使用)
5.1.3. バッファ作成
createBuffer(descriptor)-
GPUBufferを作成します。呼び出し元:GPUDevicethis.引数:
GPUDevice.createBuffer(descriptor)メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPUBufferDescriptor✘ ✘ 作成する GPUBufferの記述。戻り値:
GPUBufferコンテンツタイムライン手順:
-
bを!新しいWebGPUオブジェクトの作成(this,
GPUBuffer, descriptor)とする。 -
もしdescriptor.
mappedAtCreationがtrueなら:-
descriptor.
sizeが4の倍数でない場合、RangeErrorを投げる。 -
b.
[[mapping]]に ?active buffer mappingの初期化 (modeWRITE, range[0, descriptor.) を設定する。size]
-
-
initialization stepsをthisのデバイスタイムラインで発行する。
-
bを返す。
デバイスタイムライン initialization steps:-
以下の要件が満たされない場合、 検証エラー生成、無効化 b、return。
-
thisは失われていてはならない。
-
descriptor.
usageは0であってはならない。 -
descriptor.
sizeは this.[[device]].[[limits]].maxBufferSize以下でなければならない。
-
注意: バッファ作成が失敗し、descriptor.
mappedAtCreationがfalseの場合、mapAsync()呼び出しは拒否されるため、マッピング用に割り当てられたリソースは破棄または再利用される可能性があります。-
もしdescriptor.
mappedAtCreationがtrueなら:-
b.
[[internal state]]を"unavailable"に設定する。
それ以外:
-
b.
[[internal state]]を"available"に設定する。
-
-
bのデバイス割り当てを各バイト0で作成する。
-
const buffer= gpuDevice. createBuffer({ size: 128 , usage: GPUBufferUsage. UNIFORM| GPUBufferUsage. COPY_DST});
5.1.4. バッファ破棄
アプリケーションがGPUBufferを不要と判断した場合、destroy()を呼び出すことでガベージコレクション前にアクセスを失うことができます。バッファの破棄はマッピングも解除し、マッピング用に割り当てられたメモリも解放します。
注意: これにより、ユーザーエージェントは、そのバッファを使ったすべての操作が完了した時点でGPUメモリを回収できます。
GPUBufferは以下のメソッドを持ちます:
destroy()-
GPUBufferを破棄します。注意: バッファは何度破棄しても有効です。
呼び出し元:GPUBufferthis.戻り値:
undefinedコンテンツタイムライン手順:
-
this.
unmap()を呼び出す。 -
以降の手順をthis.
[[device]]のデバイスタイムラインで発行する。
デバイスタイムライン手順:-
this.
[[internal state]]を "destroyed"に設定する。
注意: このバッファを使った以降の操作は一切キューできなくなるため、実装はリソース割り当て(アンマップ直後のメモリも含む)を即座に解放可能です。
-
5.2. バッファのマッピング
アプリケーションはGPUBufferをマッピングするよう要求でき、これによりArrayBufferでGPUBufferの一部割り当て領域にアクセス可能となります。GPUBufferのマッピング要求はmapAsync()で非同期に行われ、ユーザーエージェントがGPUの利用完了を確認してからアプリケーションが内容にアクセスできるようにします。マップ中のGPUBufferはGPUで利用できず、unmap()でアンマップしないと、Queueタイムラインで作業登録できません。
一度GPUBufferがマップされると、アプリケーションはgetMappedRange()で範囲アクセスを同期的に要求できます。返されたArrayBufferはunmap()(直接またはGPUBuffer.destroy()やGPUDevice.destroy()経由)でのみdetach可能です。transferはできません。他の操作がそれを試みるとTypeErrorが投げられます。
typedef [EnforceRange ]unsigned long ; [GPUMapModeFlags Exposed =(Window ,Worker ),SecureContext ]namespace {GPUMapMode const GPUFlagsConstant READ = 0x0001;const GPUFlagsConstant WRITE = 0x0002; };
GPUMapMode
フラグはGPUBufferがmapAsync()でどのようにマップされるかを決定します:
READ-
このフラグは
MAP_READ用途で作成されたバッファにのみ有効です。バッファがマップされると、
getMappedRange()呼び出しはバッファの現行値を含むArrayBufferを返します。返されたArrayBufferの変更はunmap()呼び出し後に破棄されます。 WRITE-
このフラグは
MAP_WRITE用途で作成されたバッファにのみ有効です。バッファがマップされると、
getMappedRange()呼び出しはバッファの現行値を含むArrayBufferを返します。返されたArrayBufferの変更はGPUBufferにunmap()呼び出し後に保存されます。注意:
MAP_WRITE用途のバッファはCOPY_SRC用途のみと組み合わせ可能なため、書き込み用マッピングではGPUで生成された値は返されません。返されるArrayBufferはデフォルト初期化(ゼロ)または前回マッピング時にウェブページで書き込まれたデータのみを含みます。
GPUBufferは以下のメソッドを持ちます:
mapAsync(mode, offset, size)-
指定された範囲の
GPUBufferをマップし、Promiseが解決されるとGPUBufferの内容をgetMappedRange()でアクセスできるようになります。返された
Promiseの解決はマップが完了したことのみを示し、 現行標準タイムライン上で見える他の操作の完了は保証しません。 特に、他のPromise(onSubmittedWorkDone()や他のmapAsync())が解決されていることは意味しません。Promise(onSubmittedWorkDone())の解決は、 その呼び出し前に同じキューで排他的に使われたGPUBufferのmapAsync()が完了していることを意味します。呼び出し元:GPUBufferthis.引数:
GPUBuffer.mapAsync(mode, offset, size)メソッドの引数。 パラメータ 型 Nullable Optional 説明 modeGPUMapModeFlags✘ ✘ バッファを読み取り/書き込みどちらでマップするか。 offsetGPUSize64✘ ✔ マップ範囲の開始バイトオフセット。 sizeGPUSize64✘ ✔ マップする範囲のバイト数。 コンテンツタイムライン手順:
-
contentTimelineを現在のコンテンツタイムラインとする。
-
this.
mapStateが"unmapped"でない場合:-
this.
[[device]]のデバイスタイムラインでearly-reject stepsを発行する。
-
-
pを新しい
Promiseとする。 -
this.
[[pending_map]]にpを設定する。 -
this.
[[device]]のデバイスタイムラインでvalidation stepsを発行する。 -
pを返す。
デバイスタイムライン early-reject steps:-
Return。
デバイスタイムライン validation steps:-
sizeが
undefinedの場合:-
rangeSizeにmax(0, this.
size- offset)を設定。
それ以外の場合:
-
rangeSizeにsizeを設定。
-
-
以下の条件が満たされない場合:
-
thisは有効でなければならない。
-
deviceLostを
trueに設定。 -
contentTimelineでmap failure stepsを発行。
-
Return。
-
-
以下の条件が満たされない場合:
それ以外の場合:
-
deviceLostを
falseに設定。 -
contentTimelineでmap failure stepsを発行。
-
Return。
-
-
this.
[[internal state]]を"unavailable"に設定。注: バッファがマップされている間は、
unmap()まで内容は変更されません。 -
次のいずれかのイベントが発生した時点(先に発生した方、またはすでに発生していれば):
-
デバイスタイムラインが未特定のキュータイムラインの完了を認識:
-
現在キュー済みのthis利用操作の完了後
-
現在キュー済みの全操作の完了までに(thisの利用有無に関わらず)
-
-
this.
[[device]]が失われた場合。
その後、this.
[[device]]のデバイスタイムラインで後続の手順を発行する。 -
デバイスタイムライン手順:-
this.
[[device]]が失われた場合はdeviceLostをtrue、それ以外はfalseに設定。注: デバイス喪失は前ブロックとこの間でも起こり得ます。
-
deviceLostが
trueの場合:-
contentTimelineでmap failure stepsを発行。
それ以外の場合:
-
internalStateAtCompletionをthis.
[[internal state]]とする。注: この時点で
unmap()呼び出しでバッファが再び"available"になった場合、[[pending_map]]はpと異なるため、以下のマッピングは成功しません。 -
dataForMappedRegionにthisのoffsetからrangeSizeバイト分の内容を設定。
-
contentTimelineでmap success stepsを発行。
-
コンテンツタイムライン map success steps:-
this.
[[pending_map]]がpと異なる場合:注:
unmap()によりマップがキャンセルされています。-
Assert pは拒否されている。
-
Return。
-
-
Assert pはpendingである。
-
Assert internalStateAtCompletionは"unavailable"。
-
mappingをactive buffer mappingの初期化 (mode mode, range
[offset, offset + rangeSize])で生成する。この割り当てに失敗した場合:
-
this.
[[pending_map]]をnullにし、RangeErrorでpを拒否。 -
Return。
-
-
mapping.dataの内容をdataForMappedRegionに設定する。
-
this.
[[mapping]]にmappingを設定する。 -
this.
[[pending_map]]をnullにし、pをresolveする。
コンテンツタイムライン map failure steps:-
this.
[[pending_map]]がpと異なる場合:注:
unmap()によりマップがキャンセルされています。-
Assert pはすでに拒否されている。
-
Return。
-
-
Assert pはまだpendingである。
-
this.
[[pending_map]]をnullに設定する。 -
deviceLostがtrueの場合:
-
注:
unmap()でキャンセルされた場合も同じエラータイプです。
それ以外の場合:
-
-
getMappedRange(offset, size)-
指定したマップ範囲の
ArrayBufferを返します。内容はGPUBufferのものです。呼び出し元:GPUBufferthis.引数:
GPUBuffer.getMappedRange(offset, size)メソッドの引数。 パラメータ 型 Nullable Optional 説明 offsetGPUSize64✘ ✔ バッファ内容取得開始のバイトオフセット。 sizeGPUSize64✘ ✔ 返す ArrayBufferのバイトサイズ。戻り値:
ArrayBufferコンテンツタイムライン手順:
-
sizeが指定されていなければ:
-
rangeSizeをmax(0, this.
size- offset)とする。
指定されていればrangeSizeはsize。
-
-
以下の条件が満たされない場合、
OperationErrorを投げて終了:-
this.
[[mapping]]がnullでない。 -
offsetは8の倍数。
-
rangeSizeは4の倍数。
-
offset ≥ this.
[[mapping]].range[0]。 -
offset + rangeSize ≤ this.
[[mapping]].range[1]。 -
[offset, offset + rangeSize)がthis.
[[mapping]].viewsの他範囲と重複しない。
注:
GPUBufferがmappedAtCreationの場合、無効でも常にgetMappedRangeは有効です。現行標準タイムラインが無効性を認識できないためです。 -
-
dataをthis.
[[mapping]].dataとする。 -
viewを! ArrayBufferの生成(サイズrangeSize、ポインタはdataの(offset -
[[mapping]].range[0])バイト先を参照)とする。注: dataは
mapAsync()やcreateBuffer()ですでに割り当てられているため、ここでRangeErrorは投げられません。 -
view.
[[ArrayBufferDetachKey]]に"WebGPUBufferMapping"を設定する。注:
TypeErrorは、unmap()以外でDetachArrayBufferしようとした場合に投げられる。 -
viewをthis.
[[mapping]].viewsに追加する。 -
viewを返す。
注:
getMappedRange()でmapの状態確認なしに成功した場合、ユーザーエージェントは開発者向け警告を表示検討すべきです。mapAsync()の成功、mapStateが"mapped"、または後のonSubmittedWorkDone()成功を待つことで状態確認できる。 -
unmap()-
マップされた範囲のアンマップを行い、内容をGPUで再び利用可能にします。
呼び出し元:GPUBufferthis.戻り値:
undefinedコンテンツタイムライン手順:
-
this.
[[pending_map]]がnullでない場合:-
this.
[[pending_map]]をAbortErrorで拒否する。 -
this.
[[pending_map]]をnullに設定
-
-
this.
[[mapping]]がnullの場合:-
Return。
-
-
各
ArrayBufferabについて、this.[[mapping]].views内:-
DetachArrayBuffer(ab,"WebGPUBufferMapping")を実行
-
-
bufferUpdateを
nullとする。 -
this.
[[mapping]].modeがWRITEを含む場合:-
bufferUpdate = {
data: this.[[mapping]].data,offset: this.[[mapping]].range[0] }とする。
注:
WRITEモードでない場合、アンマップ時にアプリケーションによるローカル変更は破棄され、後のマッピング内容には影響しない。 -
-
this.
[[mapping]]をnullに設定 -
以降の手順をthis.
[[device]]のデバイスタイムラインで発行
デバイスタイムライン手順:-
以下の条件が満たされない場合はreturn:
-
thisはthis.
[[device]]で有効に利用可能である必要がある。
-
-
Assert this.
[[internal state]]は"unavailable"。 -
bufferUpdateが
nullでなければ:-
this.
[[device]].queueのキュータイムラインで以下発行:キュータイムライン手順:-
thisのbufferUpdate.
offsetからbufferUpdate.dataで内容更新
-
-
-
this.
[[internal state]]を"available"に設定
-
6. テクスチャとテクスチャビュー
6.1. GPUTexture
テクスチャは、1d・
2d・
3d
のデータ配列で構成され、各要素が複数の値を持つことで色などを表現できます。テクスチャは、作成時のGPUTextureUsage
に応じて様々な方法で読み書きが可能です。例えば、レンダー/コンピュートパイプラインのシェーダからサンプリング・読み書きでき、レンダーパスの出力として書き込むこともできます。
内部的には、テクスチャは線形アクセスではなく多次元アクセスに最適化されたGPUメモリレイアウトで格納されていることが多いです。
1つのテクスチャは、1つ以上のテクスチャサブリソースから構成されます。
各サブリソースはミップマップレベルで一意に識別され、
2dテクスチャの場合のみ、配列レイヤー
およびアスペクトでも識別されます。
テクスチャサブリソースはサブリソースであり、それぞれが1つの利用スコープ内で異なる内部用途に利用できます。
ミップマップレベル内の各サブリソースは、
1つ下のレベルのリソースと比べて各空間次元で約半分のサイズです
(論理ミップレベル別テクスチャ範囲参照)。
レベル0のサブリソースがテクスチャ本体の寸法となります。
より小さいレベルは通常、同じ画像の低解像度版の格納に用いられます。
GPUSamplerやWGSLは、
詳細度レベルの選択や補間を明示的または自動で行う仕組みを提供します。
"2d"
テクスチャは配列レイヤーの配列になる場合があります。
各レイヤー内のサブリソースは他レイヤーの同じリソースと同サイズです。
2d以外のテクスチャでは全てのサブリソースの配列レイヤーインデックスは0です。
各サブリソースはアスペクトを持ちます。
カラーテクスチャはcolorのみです。
深度・ステンシルフォーマットのテクスチャは複数アスペクト(depth・
stencil)を持つ場合があり、
depthStencilAttachmentや
"depth"バインディングなどで特殊な用途に使われます。
"3d"
テクスチャは複数のスライス(各z値ごとの2次元画像)を持ちます。
スライスはサブリソースとは異なります。
[Exposed =(Window ,Worker ),SecureContext ]interface GPUTexture {GPUTextureView createView (optional GPUTextureViewDescriptor descriptor = {});undefined destroy ();readonly attribute GPUIntegerCoordinateOut width ;readonly attribute GPUIntegerCoordinateOut height ;readonly attribute GPUIntegerCoordinateOut depthOrArrayLayers ;readonly attribute GPUIntegerCoordinateOut mipLevelCount ;readonly attribute GPUSize32Out sampleCount ;readonly attribute GPUTextureDimension dimension ;readonly attribute GPUTextureFormat format ;readonly attribute GPUFlagsConstant usage ;readonly attribute (GPUTextureViewDimension or undefined )textureBindingViewDimension ; };GPUTexture includes GPUObjectBase ;
GPUTexture
には以下の不変プロパティがあります:
width, 型 GPUIntegerCoordinateOut, 読み取り専用-
この
GPUTextureの幅。 height, 型 GPUIntegerCoordinateOut, 読み取り専用-
この
GPUTextureの高さ。 depthOrArrayLayers, 型 GPUIntegerCoordinateOut, 読み取り専用-
この
GPUTextureの深度またはレイヤー数。 mipLevelCount, 型 GPUIntegerCoordinateOut, 読み取り専用-
この
GPUTextureのミップレベル数。 sampleCount, 型 GPUSize32Out, 読み取り専用-
この
GPUTextureのサンプル数。 dimension, 型 GPUTextureDimension, 読み取り専用-
各
GPUTextureサブリソースごとのテクセルの次元。 format, 型 GPUTextureFormat, 読み取り専用-
この
GPUTextureのフォーマット。 usage, 型 GPUFlagsConstant, 読み取り専用-
この
GPUTextureで許可される用途。 [[viewFormats]], 型 sequence<GPUTextureFormat>-
この
GPUTextureに対してGPUTextureViewDescriptor.formatとして利用可能なGPUTextureFormatの集合。 textureBindingViewDimension, 型(GPUTextureViewDimension or undefined)、読み取り専用-
"core-features-and-limits"を持たないデバイスでは、 このテクスチャから作成されたビューは、そのdimensionとしてこれを持っていなければなりません。"core-features-and-limits"を持つデバイスでは、 これはundefinedであり、そのような制限はありません。
GPUTexture
には以下のデバイスタイムラインプロパティがあります:
[[destroyed]], 型boolean, 初期値false-
テクスチャが破棄された場合、いかなる操作にも利用できなくなり、基盤となるメモリも解放可能となります。
引数:
-
GPUExtent3DbaseSize -
GPUSize32mipLevel
戻り値: GPUExtent3DDict
デバイスタイムライン手順:
-
extentを新しい
GPUExtent3DDictオブジェクトとする。 -
extent.
depthOrArrayLayersに1を設定。 -
extentを返す。
論理ミップレベル別テクスチャ範囲とは、特定のミップレベルにおけるテクスチャのテクセル単位のサイズです。次の手順で算出されます:
引数:
-
GPUTextureDescriptordescriptor -
GPUSize32mipLevel
戻り値: GPUExtent3DDict
-
extentを新しい
GPUExtent3DDictオブジェクトとする。 -
descriptor.
dimensionが次の場合:"1d"-
-
extent.
heightに1を設定。 -
extent.
depthOrArrayLayersに1を設定。
"2d"-
-
extent.
heightにmax(1, descriptor.size.height ≫ mipLevel)を設定。 -
extent.
depthOrArrayLayersにdescriptor.size.depthOrArrayLayersを設定。
"3d"-
-
extent.
heightにmax(1, descriptor.size.height ≫ mipLevel)を設定。 -
extent.
depthOrArrayLayersにmax(1, descriptor.size.depthOrArrayLayers ≫ mipLevel)を設定。
-
extentを返す。
物理ミップレベル別テクスチャ範囲とは、特定のミップレベルにおけるテクスチャのテクセル単位のサイズ(テクセルブロックを完全に構成するための余分なパディングを含む)です。次の手順で算出されます:
引数:
-
GPUTextureDescriptordescriptor -
GPUSize32mipLevel
戻り値: GPUExtent3DDict
-
extentを新しい
GPUExtent3DDictオブジェクトとする。 -
logicalExtentに論理ミップレベル別テクスチャ範囲(descriptor, mipLevel)を設定。
-
descriptor.
dimensionが次の場合:"1d"-
-
extent.
widthにlogicalExtent.widthをdescriptorのテクセルブロック幅の倍数に切り上げて設定。 -
extent.
heightに1を設定。 -
extent.
depthOrArrayLayersに1を設定。
-
"2d"-
-
extent.
widthにlogicalExtent.widthをdescriptorのテクセルブロック幅の倍数に切り上げて設定。 -
extent.
heightにlogicalExtent.heightをdescriptorのテクセルブロック高さの倍数に切り上げて設定。 -
extent.
depthOrArrayLayersにlogicalExtent.depthOrArrayLayersを設定。
-
"3d"-
-
extent.
widthにlogicalExtent.widthをdescriptorのテクセルブロック幅の倍数に切り上げて設定。 -
extent.
heightにlogicalExtent.heightをdescriptorのテクセルブロック高さの倍数に切り上げて設定。 -
extent.
depthOrArrayLayersにlogicalExtent.depthOrArrayLayersを設定。
-
-
extentを返す。
6.1.1. GPUTextureDescriptor
dictionary GPUTextureDescriptor :GPUObjectDescriptorBase {required GPUExtent3D size ;GPUIntegerCoordinate mipLevelCount = 1;GPUSize32 sampleCount = 1;GPUTextureDimension dimension = "2d";required GPUTextureFormat format ;required GPUTextureUsageFlags usage ;sequence <GPUTextureFormat >viewFormats = [];GPUTextureViewDimension textureBindingViewDimension ; };
GPUTextureDescriptor
には以下のメンバーがあります:
size, 型 GPUExtent3D-
テクスチャの幅、高さ、および深さまたはレイヤー数。
mipLevelCount, 型 GPUIntegerCoordinate, 既定値1-
テクスチャが含むミップレベルの数。
sampleCount, 型 GPUSize32, 既定値1-
テクスチャのサンプル数。
sampleCount>1はマルチサンプルされたテクスチャを示します。 dimension, 型 GPUTextureDimension, 既定値"2d"-
テクスチャが一次元か、二次元レイヤーの配列か、三次元かを示します。
format, 型 GPUTextureFormat-
テクスチャのフォーマット。
usage, 型 GPUTextureUsageFlags-
テクスチャで許可される使用方法。
viewFormats, 型 sequence<GPUTextureFormat>, 既定値[]-
このテクスチャで
format値がcreateView()を呼び出す際に許可されるかを指定します(テクスチャ自身の実際のformatに加えて)。NOTE:このリストにフォーマットを追加するとパフォーマンスに大きな影響を与える可能性があるため、不必要にフォーマットを追加しないことが望ましい。実際のパフォーマンスへの影響はターゲットシステムに大きく依存するため、開発者はさまざまなシステムでテストして特定のアプリケーションへの影響を確認する必要があります。例えば、あるシステムでは任意のテクスチャの
formatまたはviewFormatsエントリに"rgba8unorm-srgb"が含まれている場合、それは"rgba8unorm"を含まないテクスチャよりも性能が劣ることがあります。他の形式やシステムでも類似の注意点が存在します。このリストのフォーマットは、テクスチャのフォーマットと texture view format compatible でなければなりません。
2つのGPUTextureFormatformat と viewFormat は、ある device において、 テクスチャビューのフォーマット互換 であるのは、次の場合である:-
format が viewFormat と等しい場合、または
-
format と viewFormat が
srgbフォーマット(-srgbサフィックスを持つかどうか)の違いのみの場合、 かつ device.[[features]]が "core-features-and-limits""core-features-and-limits"を含む場合。
-
textureBindingViewDimension, 型 GPUTextureViewDimension-
"core-features-and-limits"を持たないデバイスでは、このテクスチャから作成されたビューはdimensionとしてこれを持たなければなりません。 指定されなかった場合は、デフォルト値が選択されます。"core-features-and-limits"を持つデバイスでは、これは無視され、そのような制限はありません。
enum {GPUTextureDimension "1d" ,"2d" ,"3d" , };
"1d"-
一次元(幅のみ)のテクスチャ。
"1d"テクスチャはミップマップ不可・マルチサンプル不可・圧縮/深度/ステンシル不可・レンダーターゲット不可です。 "2d"-
幅・高さを持ち、レイヤーも持てるテクスチャ。
"3d"-
幅・高さ・深度を持つテクスチャ。
"3d"テクスチャはマルチサンプル不可・フォーマットは3d対応(プレーンカラーフォーマットや一部パック/圧縮フォーマット)のみ。
6.1.2. テクスチャ用途
typedef [EnforceRange ]unsigned long ; [GPUTextureUsageFlags Exposed =(Window ,Worker ),SecureContext ]namespace {GPUTextureUsage const GPUFlagsConstant COPY_SRC = 0x01;const GPUFlagsConstant COPY_DST = 0x02;const GPUFlagsConstant TEXTURE_BINDING = 0x04;const GPUFlagsConstant STORAGE_BINDING = 0x08;const GPUFlagsConstant RENDER_ATTACHMENT = 0x10; };
GPUTextureUsage
のフラグは、GPUTexture
の作成後の用途を決定します:
COPY_SRC-
コピー操作のソースとして利用可能(例:
source引数としてcopyTextureToTexture()やcopyTextureToBuffer())。 COPY_DST-
コピー・書き込み操作のデスティネーションとして利用可能(例:
destination引数としてcopyTextureToTexture()やcopyBufferToTexture()、writeTexture()のターゲット)。 TEXTURE_BINDING-
シェーダでサンプル用テクスチャとしてバインド可能(例:
GPUTextureBindingLayoutのバインドグループエントリ)。 STORAGE_BINDING-
シェーダでストレージテクスチャとしてバインド可能(例:
GPUStorageTextureBindingLayoutのバインドグループエントリ)。 RENDER_ATTACHMENT-
レンダーパスのカラー/深度・ステンシルアタッチメントとして利用可能(例:
GPURenderPassColorAttachment.viewやGPURenderPassDepthStencilAttachment.view)。
引数:
-
GPUTextureDimensiondimension -
GPUTextureDimensionsize
6.1.3. テクスチャの作成
createTexture(descriptor)-
GPUTextureを作成します。呼び出し元:GPUDevicethis.引数:
GPUDevice.createTexture(descriptor)メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPUTextureDescriptor✘ ✘ 作成する GPUTextureの説明。戻り値:
GPUTextureコンテンツタイムライン手順:
-
? GPUExtent3D の形状を検証する(descriptor.
size)。 -
? テクスチャフォーマットに必要な機能を検証する: descriptor.
formatと this.[[device]]を用いる。 -
? テクスチャフォーマットに必要な機能を検証する: descriptor.
viewFormatsの各要素と this.[[device]]を用いる。 -
変数 t に ! 新しい WebGPU オブジェクトを作成する(this,
GPUTexture, descriptor) を代入する。 -
t.
depthOrArrayLayersに descriptor.size.depthOrArrayLayers を設定する。 -
t.
mipLevelCountに descriptor.mipLevelCountを設定する。 -
t.
sampleCountに descriptor.sampleCountを設定する。 -
もし t.
[[device]].[[features]]が "core-features-and-limits""core-features-and-limits"を含まない場合:-
もし descriptor.
textureBindingViewDimensionが 指定されている場合:-
t.
textureBindingViewDimensionに descriptor.textureBindingViewDimensionを設定する。
それ以外の場合、descriptor.
dimensionが次のいずれかである場合:"1d"-
t.
textureBindingViewDimensionに"1d"を設定する。 "2d"-
配列レイヤー数 が 1 である場合:
-
t.
textureBindingViewDimensionに"2d"を設定する。
それ以外の場合:
-
t.
textureBindingViewDimensionに"2d-array"を設定する。
-
"3d"-
t.
textureBindingViewDimensionに"3d"を設定する。
-
-
-
デバイスタイムライン で this の 初期化手順 を実行する。
-
t を返す。
デバイスタイムライン initialization steps:-
以下の条件が満たされない場合検証エラーの生成、tの無効化、return。
-
GPUTextureDescriptorの検証(this, descriptor) が
trueを返す。
-
-
t.
[[viewFormats]]にdescriptor.viewFormatsを設定。 -
各ブロックがゼロのビット表現と等価な等価テクセル表現になるよう、tのデバイス割り当てを作成。
割り当てが副作用なしに失敗した場合、 メモリ不足エラー生成、tの無効化、return。
-
引数:
-
GPUDevicethis -
GPUTextureDescriptordescriptor
デバイスタイムライン手順:
-
limitsをthis.
[[limits]]とする。 -
以下すべて満たせば
true、そうでなければfalseを返す:-
thisが失われていないこと。
-
descriptor.
usageは0でないこと。 -
descriptor.
usageはthisの許可されたテクスチャ用途ビットのみを含むこと。 -
descriptor.
size.width, descriptor.size.height, descriptor.size.depthOrArrayLayersがゼロ超であること。 -
descriptor.
mipLevelCountがゼロ超であること。 -
descriptor.
sampleCountが1または4であること。 -
descriptor.
dimensionが:"1d"-
-
descriptor.
size.widthがlimits.maxTextureDimension1D以下。 -
descriptor.
size.depthOrArrayLayers が1。 -
descriptor.
sampleCountが1。 -
descriptor.
formatが圧縮フォーマットまたは深度・ステンシルフォーマットでない。
-
"2d"-
-
descriptor.
size.widthがlimits.maxTextureDimension2D以下。 -
descriptor.
size.heightがlimits.maxTextureDimension2D以下。 -
descriptor.
size.depthOrArrayLayers がlimits.maxTextureArrayLayers以下。
-
"3d"-
-
descriptor.
size.widthがlimits.maxTextureDimension3D以下。 -
descriptor.
size.heightがlimits.maxTextureDimension3D以下。 -
descriptor.
size.depthOrArrayLayers がlimits.maxTextureDimension3D以下。 -
descriptor.
sampleCountが1。 -
descriptor.
formatは § 26.1 テクスチャフォーマットの機能 に従い、"3d"テクスチャをサポートしていなければならない。
-
-
もし this.
[[features]]が "core-features-and-limits""core-features-and-limits"を含まない場合:-
もし descriptor.
textureBindingViewDimensionが"2d"の場合、 this.size.depthOrArrayLayers は 1 でなければならない。 -
もし descriptor.
textureBindingViewDimensionが"cube"の場合、 this.size.depthOrArrayLayers は 6 でなければならない。
Note: この検証はユーザーが textureBindingViewDimension を指定した場合のみ適用される。値が指定されなかった場合,テクスチャの textureBindingViewDimension は
createTexture()で説明されている通りに設定される。 そのアルゴリズムでは無効な値を生成できないため,上記の検証は不要である。 -
-
descriptor.
size.height は テクセルブロック高さ の倍数でなければならない。 -
もし descriptor.
sampleCount> 1 の場合:-
descriptor.
mipLevelCountは 1 でなければならない。 -
descriptor.
size.depthOrArrayLayers は 1 でなければならない。 -
descriptor.
usageはSTORAGE_BINDINGビットを含んではならない。 -
descriptor.
usageはRENDER_ATTACHMENTビットを含んでいなければならない。 -
descriptor.
formatは § 26.1 テクスチャフォーマットの機能 に従い,マルチサンプリングをサポートしていなければならない。
-
-
descriptor.
mipLevelCountは maximum mipLevel count(descriptor.dimension, descriptor.size) 以下でなければならない。 -
もし descriptor.
usageがRENDER_ATTACHMENTビットを含む場合:-
descriptor.
formatは レンダラブルフォーマット でなければならない。
-
-
もし descriptor.
usageがSTORAGE_BINDINGビットを含む場合:-
descriptor.
formatは § 26.1.1 プレーン色情報フォーマット の表で 少なくとも1つのアクセスモードに対してSTORAGE_BINDING機能を持つものでなければならない。
-
-
descriptor.
viewFormatsの各 viewFormat について, descriptor.formatと viewFormat はデバイス this 上で テクスチャビューのフォーマット互換性 を満たしていなければならない。NOTE:実装は,もし viewFormat が指定されたusageビットと互換性がない場合,その viewFormat は利用できなくなるため,開発者に警告を表示してもよい。
-
const texture= gpuDevice. createTexture({ size: { width: 16 , height: 16 }, format: 'rgba8unorm' , usage: GPUTextureUsage. TEXTURE_BINDING, });
6.1.4. テクスチャの破棄
アプリケーションがGPUTexture
を不要になった場合、
ガベージコレクション前にdestroy()を呼び出してアクセスを失わせることができます。
注: これにより、ユーザーエージェントはGPUTexture
に関連付けられたGPUメモリを
それまでに提出されたすべての操作が完了次第、回収できるようになります。
GPUTexture
には次のメソッドがあります:
destroy()-
GPUTextureを破棄します。デバイスタイムライン手順:-
this.
[[destroyed]]をtrueに設定する。
-
6.2. GPUTextureView
GPUTextureView
は、特定のGPUTextureが持つテクスチャサブリソースの部分集合へのビューです。
[Exposed =(Window ,Worker ),SecureContext ]interface GPUTextureView { };GPUTextureView includes GPUObjectBase ;
GPUTextureView
には以下の不変プロパティがあります:
[[texture]], readonly-
このビューが参照する
GPUTexture。 [[descriptor]], readonly-
このテクスチャビューを記述する
GPUTextureViewDescriptor。GPUTextureViewDescriptorのすべてのオプションフィールドが定義済みです。 [[renderExtent]], readonly-
レンダー可能ビューの場合、描画時の有効な
GPUExtent3DDict。注: この範囲は
baseMipLevelに依存します。
[[descriptor]]
descを用いて、
view.[[texture]]
のサブリソースのうち、各サブリソースsが以下を満たすものです:
-
sのミップマップレベルが desc.
baseMipLevel以上、 desc.baseMipLevel+ desc.mipLevelCount未満。 -
sの配列レイヤーが desc.
baseArrayLayer以上、 desc.baseArrayLayer+ desc.arrayLayerCount未満。
2つのGPUTextureView
オブジェクトは、そのサブリソース集合が交差する場合に限りテクスチャビュー・エイリアスとなります。
6.2.1. テクスチャビューの作成
dictionary :GPUTextureViewDescriptor GPUObjectDescriptorBase {GPUTextureFormat format ;GPUTextureViewDimension dimension ;GPUTextureUsageFlags usage = 0;GPUTextureAspect aspect = "all";GPUIntegerCoordinate baseMipLevel = 0;GPUIntegerCoordinate mipLevelCount ;GPUIntegerCoordinate baseArrayLayer = 0;GPUIntegerCoordinate arrayLayerCount ; // Requires "texture-component-swizzle" feature.DOMString swizzle = "rgba"; };
GPUTextureViewDescriptor
には以下のメンバーがあります:
format, 型 GPUTextureFormat-
テクスチャビューのフォーマット。テクスチャ自体の
formatか、 または作成時に指定したviewFormatsのいずれかでなければなりません。 dimension, 型 GPUTextureViewDimension-
テクスチャをどの次元でビューするか。
usage, 型 GPUTextureUsageFlags(デフォルト値0)-
テクスチャビューの許可用途。テクスチャの
usageフラグの部分集合でなければなりません。0の場合、テクスチャの全usageフラグをデフォルトとします。注: ビューの
formatがテクスチャの全usageに対応しない場合、デフォルトは失敗し、明示的にusageを指定する必要があります。 aspect, 型 GPUTextureAspect(デフォルト値"all")-
テクスチャビューからアクセス可能な
aspect。 baseMipLevel, 型 GPUIntegerCoordinate(デフォルト値0)-
テクスチャビューからアクセス可能な最初(最詳細)のミップマップレベル。
mipLevelCount, 型 GPUIntegerCoordinate-
baseMipLevelから始まるミップマップレベル数。 baseArrayLayer, 型 GPUIntegerCoordinate(デフォルト値0)-
テクスチャビューからアクセス可能な最初の配列レイヤーのインデックス。
arrayLayerCount, 型 GPUIntegerCoordinate-
baseArrayLayerから始まるアクセス可能な配列レイヤー数。 swizzle, 型は DOMString で、既定値は"rgba"-
長さ4の文字列で、各文字はそれぞれテクスチャビューの赤/緑/青/アルファの各チャンネルに対応する。
シェーダからアクセスされた場合、赤/緑/青/アルファ各チャンネルは、それぞれ
swizzle[0]、swizzle[1]、swizzle[2]、swizzle[3]に指定された成分に対応する値で置き換えられる:-
"r": テクスチャの赤チャンネルの値を使用する。 -
"g": テクスチャの緑チャンネルの値を使用する。 -
"b": テクスチャの青チャンネルの値を使用する。 -
"a": テクスチャのアルファチャンネルの値を使用する。 -
"0": 値を 0 に固定する。 -
"1": 値を 1 に固定する。
"texture-component-swizzle"機能が有効である必要がある。 -
enum {GPUTextureViewDimension "1d" ,"2d" ,"2d-array" ,"cube" ,"cube-array" ,"3d" , };
"1d"-
テクスチャを一次元画像としてビューします。
対応WGSL型:
-
texture_1d -
texture_storage_1d
-
"2d"-
テクスチャを単一の二次元画像としてビューします。
対応WGSL型:
-
texture_2d -
texture_storage_2d -
texture_multisampled_2d -
texture_depth_2d -
texture_depth_multisampled_2d
-
"2d-array"-
テクスチャビューを二次元画像の配列としてビューします。
対応WGSL型:
-
texture_2d_array -
texture_storage_2d_array -
texture_depth_2d_array
-
"cube"-
テクスチャをキューブマップとしてビューします。
ビューは6つの配列レイヤーを持ち、それぞれキューブの面(
[+X, -X, +Y, -Y, +Z, -Z])と以下の向きに対応します:キューブマップ面。+U/+V軸は個々の面のテクスチャ座標、すなわち各面のテクセルコピーメモリレイアウトを示します。 注: 内側からビューした場合、+Xが右、+Yが上、+Zが前の左手座標系になります。
サンプリングはキューブマップの面をまたいでシームレスに行われます。
対応WGSL型:
-
texture_cube -
texture_depth_cube
-
"cube-array"-
テクスチャは、n 個のキューブマップから成るパック配列として見なされます。 各キューブマップは6つの配列レイヤーを持ち、それぞれが1つの
"cube"ビューのように振る舞います。 合計で 6n の配列レイヤーとなります。対応するWGSL型:
-
texture_cube_array -
texture_depth_cube_array
-
"3d"-
テクスチャを三次元画像としてビューします。
対応WGSL型:
-
texture_3d -
texture_storage_3d
-
各GPUTextureAspect値はアスペクトの集合に対応します。
アスペクト集合は以下の各値ごとに定義されています。
enum GPUTextureAspect {"all" ,"stencil-only" ,"depth-only" , };
"all"-
テクスチャフォーマットの利用可能な全アスペクトがテクスチャビューからアクセス可能になります。カラーフォーマットの場合colorアスペクトが、複合深度ステンシルフォーマットの場合はdepthとstencil両方が、単一アスペクトの深度・ステンシルフォーマットはそのアスペクトのみアクセス可能です。
"stencil-only"-
深度・ステンシルフォーマットのstencilアスペクトのみがテクスチャビューからアクセス可能です。
"depth-only"-
深度・ステンシルフォーマットのdepthアスペクトのみがテクスチャビューからアクセス可能です。
createView(descriptor)-
GPUTextureViewを作成します。注意:デフォルトでは、createView()は、テクスチャ全体を表現できる次元を持つビューを作成します。たとえば、createView()を呼び出す際にdimensionを指定せず、かつ複数レイヤーの"2d"テクスチャの場合、"2d-array"のGPUTextureViewが作成されます(たとえarrayLayerCountに 1 を指定していても)。レイヤー数が開発時に不明なソースから作成されたテクスチャの場合、シェーダとの互換性を確保するために、
createView()の呼び出し時に明示的なdimensionを指定することが推奨されます。呼び出し対象:GPUTexturethis。引数:
GPUTexture.createView(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPUTextureViewDescriptor✘ ✔ 作成する GPUTextureViewの説明。戻り値: 型は
GPUTextureViewの view。Content timeline の手順:
-
? Validate texture format required features を descriptor.
formatおよび this.[[device]]で実行。 -
? Validate swizzle string を descriptor.
swizzleで実行。 -
view を ! create a new WebGPU object(this,
GPUTextureView, descriptor) に設定する。 -
Device timeline の this で initialization steps を実行。
-
view を返す。
Device timeline の initialization steps:-
descriptor を resolving GPUTextureViewDescriptor defaults の結果に設定(this, descriptor を使う)。
-
以下のいずれかの条件を満たさない場合 generate a validation error を発生させ、invalidate view を実行し、リターン。
-
this が valid to use with this.
[[device]]であること。 -
もし descriptor.
aspectが"all"の場合:-
descriptor.
formatが this.formatまたは this.[[viewFormats]]のいずれかと等しいこと。
それ以外の場合:
-
descriptor.
formatが resolving GPUTextureAspect( this.format, descriptor.aspect) に等しいこと。
-
-
descriptor.
swizzleが"rgba"でない場合、"texture-component-swizzle"が enabled for this.[[device]]であること。 -
もし descriptor.
usageにRENDER_ATTACHMENTビットが含まれる場合:-
descriptor.
formatが renderable format であること。
-
-
もし descriptor.
usageにSTORAGE_BINDINGビットが含まれる場合:-
descriptor.
formatが § 26.1.1 Plain color formats のテーブルでSTORAGE_BINDINGの capability がどれか1つでもあること。
-
-
descriptor.
mipLevelCountは > 0 であること。 -
descriptor.
baseMipLevel+ descriptor.mipLevelCountが this.mipLevelCount以下であること。 -
descriptor.
arrayLayerCountは > 0 であること。 -
descriptor.
baseArrayLayer+ descriptor.arrayLayerCountが array layer count of this 以下であること。 -
もし this.
sampleCount> 1 の場合、 descriptor.dimensionは"2d"であること。 -
もし descriptor.
dimensionが以下のいずれかの場合:"1d"-
-
descriptor.
arrayLayerCountは1であること。
"2d"-
-
descriptor.
arrayLayerCountは1であること。
"2d-array""cube"-
-
descriptor.
arrayLayerCountは6であること。
"cube-array"-
-
descriptor.
arrayLayerCountが6の倍数であること。
"3d"-
-
descriptor.
arrayLayerCountは1であること。
-
-
view を新たな
GPUTextureViewオブジェクトとして作成する。 -
view.
[[texture]]を this に設定する。 -
view.
[[descriptor]]を descriptor に設定する。 -
もし descriptor.
usageがRENDER_ATTACHMENTを含む場合:-
renderExtent を compute render extent([this.
width, this.height, this.depthOrArrayLayers], descriptor.baseMipLevel) で設定。 -
view.
[[renderExtent]]を renderExtent に設定する。
-
-
GPUTextureView
texture と GPUTextureViewDescriptor
descriptor に対して行うとき、次の device timeline の手順を実行します:
-
resolved を descriptor のコピーとして作成する。
-
もし resolved.
mipLevelCountが 提供されていない 場合、 resolved.mipLevelCountに texture.mipLevelCount− resolved.baseMipLevelを設定する。 -
もし resolved.
dimensionが 提供されていない かつ texture.dimensionが以下の場合: -
もし resolved.
arrayLayerCountが 提供されていない かつ resolved.dimensionが以下の場合:"1d","2d", または"3d"-
resolved.
arrayLayerCountに1を設定する。 "cube"-
resolved.
arrayLayerCountに6を設定する。 "2d-array"または"cube-array"-
resolved.
arrayLayerCountに array layer count of texture − resolved.baseArrayLayerを設定する。
-
もし resolved.
usageが0なら、 resolved.usageに texture.usageを設定する。 -
resolved を返す。
GPUTexture
texture に対して行うには、次の手順を実行します:
-
もし texture.
dimensionが以下の場合:"1d"または"3d"-
1を返す。 "2d"-
texture.
depthOrArrayLayersを返す。
DOMString
swizzle に対して行うには、
以下の content timeline
の手順を実行する:
-
swizzle が [ECMAScript] の正規表現
^[rgba01]{4}$に一致しない場合:-
TypeErrorを投げる。
-
6.3. テクスチャフォーマット
フォーマット名は、コンポーネントの順序、各コンポーネントのビット数、コンポーネントのデータ型を指定します。
-
r,g,b,a= 赤、緑、青、アルファ -
unorm= 符号なし正規化 -
snorm= 符号付き正規化 -
uint= 符号なし整数 -
sint= 符号付き整数 -
float= 浮動小数点
フォーマットに-srgbサフィックスが付いている場合、シェーダ内で色値の読み書き時にsRGB変換(ガンマ⇔リニア)が適用されます。圧縮テクスチャフォーマットはfeaturesによって提供されます。命名規則は本規約に従い、テクスチャ名をプレフィックスとして使用します(例:etc2-rgba8unorm)。
テクセルブロックは、画素ベースのGPUTextureFormatテクスチャでは単一のアドレス可能な要素、
ブロックベース圧縮GPUTextureFormatテクスチャでは単一の圧縮ブロックです。
テクセルブロック幅およびテクセルブロック高さは、1つのテクセルブロックの寸法を指定します。
-
画素ベースの
GPUTextureFormatの場合、 テクセルブロック幅・テクセルブロック高さは常に1です。 -
ブロックベース圧縮
GPUTextureFormatの場合、 テクセルブロック幅は1つのテクセルブロックの各行のテクセル数、 テクセルブロック高さは1つのテクセルブロックのテクセル行数です。全フォーマットの値は§ 26.1 テクスチャフォーマットの機能参照。
テクセルブロックコピーフットプリントは、あるGPUTextureFormatのアスペクトについて、
テクセルコピー時に1つのテクセルブロックが占有するバイト数です(該当する場合)。
注:
テクセルブロックメモリコストは、GPUTextureFormatの1つのテクセルブロックを格納するのに必要なバイト数です。全てのフォーマットで厳密には定義されていません。
この値は参考情報であり、規定値ではありません。
enum { // 8-bit formatsGPUTextureFormat ,"r8unorm" ,"r8snorm" ,"r8uint" , // 16-bit formats"r8sint" ,"r16unorm" ,"r16snorm" ,"r16uint" ,"r16sint" ,"r16float" ,"rg8unorm" ,"rg8snorm" ,"rg8uint" , // 32-bit formats"rg8sint" ,"r32uint" ,"r32sint" ,"r32float" ,"rg16unorm" ,"rg16snorm" ,"rg16uint" ,"rg16sint" ,"rg16float" ,"rgba8unorm" ,"rgba8unorm-srgb" ,"rgba8snorm" ,"rgba8uint" ,"rgba8sint" ,"bgra8unorm" , // Packed 32-bit formats"bgra8unorm-srgb" ,"rgb9e5ufloat" ,"rgb10a2uint" ,"rgb10a2unorm" , // 64-bit formats"rg11b10ufloat" ,"rg32uint" ,"rg32sint" ,"rg32float" ,"rgba16unorm" ,"rgba16snorm" ,"rgba16uint" ,"rgba16sint" , // 128-bit formats"rgba16float" ,"rgba32uint" ,"rgba32sint" , // Depth/stencil formats"rgba32float" ,"stencil8" ,"depth16unorm" ,"depth24plus" ,"depth24plus-stencil8" , // "depth32float-stencil8" feature"depth32float" , // BC compressed formats usable if "texture-compression-bc" is both // supported by the device/user agent and enabled in requestDevice."depth32float-stencil8" ,"bc1-rgba-unorm" ,"bc1-rgba-unorm-srgb" ,"bc2-rgba-unorm" ,"bc2-rgba-unorm-srgb" ,"bc3-rgba-unorm" ,"bc3-rgba-unorm-srgb" ,"bc4-r-unorm" ,"bc4-r-snorm" ,"bc5-rg-unorm" ,"bc5-rg-snorm" ,"bc6h-rgb-ufloat" ,"bc6h-rgb-float" ,"bc7-rgba-unorm" , // ETC2 compressed formats usable if "texture-compression-etc2" is both // supported by the device/user agent and enabled in requestDevice."bc7-rgba-unorm-srgb" ,"etc2-rgb8unorm" ,"etc2-rgb8unorm-srgb" ,"etc2-rgb8a1unorm" ,"etc2-rgb8a1unorm-srgb" ,"etc2-rgba8unorm" ,"etc2-rgba8unorm-srgb" ,"eac-r11unorm" ,"eac-r11snorm" ,"eac-rg11unorm" , // ASTC compressed formats usable if "texture-compression-astc" is both // supported by the device/user agent and enabled in requestDevice."eac-rg11snorm" ,"astc-4x4-unorm" ,"astc-4x4-unorm-srgb" ,"astc-5x4-unorm" ,"astc-5x4-unorm-srgb" ,"astc-5x5-unorm" ,"astc-5x5-unorm-srgb" ,"astc-6x5-unorm" ,"astc-6x5-unorm-srgb" ,"astc-6x6-unorm" ,"astc-6x6-unorm-srgb" ,"astc-8x5-unorm" ,"astc-8x5-unorm-srgb" ,"astc-8x6-unorm" ,"astc-8x6-unorm-srgb" ,"astc-8x8-unorm" ,"astc-8x8-unorm-srgb" ,"astc-10x5-unorm" ,"astc-10x5-unorm-srgb" ,"astc-10x6-unorm" ,"astc-10x6-unorm-srgb" ,"astc-10x8-unorm" ,"astc-10x8-unorm-srgb" ,"astc-10x10-unorm" ,"astc-10x10-unorm-srgb" ,"astc-12x10-unorm" ,"astc-12x10-unorm-srgb" ,"astc-12x12-unorm" , };"astc-12x12-unorm-srgb"
"depth24plus"
および"depth24plus-stencil8"
フォーマットのdepth成分は、24ビットdepth値または"depth32float"
値として実装される場合があります。
stencil8
フォーマットは実際の"stencil8"、または"depth24stencil8"(depthアスペクトは非表示・アクセス不可)として実装される場合があります。
-
24ビットdepthの場合、1ULPは1 / (224 − 1)で一定です。
-
depth32floatの場合、1ULPは最大1 / (224)で値によって異なります。
フォーマットがレンダー可能であるとは、カラー・レンダー可能フォーマットまたは深度・ステンシルフォーマットの場合です。
§ 26.1.1 プレーンカラーフォーマットでRENDER_ATTACHMENT
機能を持つものはカラー・レンダー可能フォーマットです。他はカラー・レンダー可能フォーマットではありません。
深度・ステンシルフォーマットはすべてレンダー可能です。
レンダー可能フォーマットは、レンダーパイプラインのブレンディングで使用可能な場合ブレンド可能にもなります。 § 26.1 テクスチャフォーマットの機能参照。
フォーマットがフィルタ可能であるとは、
GPUTextureSampleType
"float"
("unfilterable-float"のみでない)をサポートし、
"filtering"
GPUSamplerで利用可能な場合です。
§ 26.1 テクスチャフォーマットの機能参照。
引数:
-
GPUTextureFormatformat -
GPUTextureAspectaspect
戻り値: GPUTextureFormat
またはnull
-
aspectが:
"all"-
formatを返す。
"depth-only""stencil-only"-
formatがdepth-stencil-formatの場合: formatのアスペクト専用フォーマット(§ 26.1.2 深度ステンシルフォーマット)または aspectが存在しなければ
nullを返す。
-
nullを返す。
一部のテクスチャフォーマットの使用にはGPUDeviceでfeatureを有効化する必要があります。
新フォーマットは仕様に追加される場合があるため、enum値が実装で未知な場合もあります。
実装間の挙動を揃えるため、featureが有効でない場合にフォーマットを使おうとすると例外が投げられます(未対応フォーマット時と同じ挙動)。
§ 26.1 テクスチャフォーマットの機能で、どのGPUTextureFormatがfeature必須か確認できます。
GPUTextureFormat
format に対して論理 device device を用いて、以下の content timeline の手順を実行する:
-
formatがfeature必須で、device.
[[features]]がfeatureを含まない場合:-
TypeErrorを投げる。
-
6.4. GPUExternalTexture
GPUExternalTexture
は外部動画フレームをラップするサンプル可能な2Dテクスチャです。
不変のスナップショットであり、その内容はWebGPU内外(動画フレームの進行など)で変化しません。
GPUExternalTexture
は
externalTexture
バインドグループレイアウトエントリメンバーでバインド可能です。
このメンバーは複数のバインディングスロットを使用します(詳細はそちら参照)。
GPUExternalTexture
はインポート元のコピーなしで実装できる場合もありますが、
実装依存です。
基盤表現の所有権は排他または他オーナー(動画デコーダ等)との共有の場合もあり、アプリケーションからは不可視です。
外部テクスチャの基盤表現は(正確なサンプリング挙動以外)観測不可ですが、一般的には次が含まれます:
-
最大3個の2Dプレーン(例:RGBA、Y+UV、Y+U+V)
-
座標変換用メタデータ(クロップ・回転)
-
指定の出力色空間への変換メタデータ(行列、ガンマ、3D LUT)
実装内部の構成は時期・システム・UA・メディアソース・同一動画内フレーム間でも一貫しない場合があります。 多様な表現に対応するため、各外部テクスチャで以下を保守的にバインディングします:
-
最大3プレーン用サンプルテクスチャバインディング
-
3D LUT用サンプルテクスチャバインディング
-
3D LUT用サンプラーバインディング
-
メタデータ用ユニフォームバッファバインディング
[Exposed =(Window ,Worker ),SecureContext ]interface GPUExternalTexture { };GPUExternalTexture includes GPUObjectBase ;
GPUExternalTexture
には以下の不変プロパティがあります:
[[descriptor]], 型GPUExternalTextureDescriptor, 読み取り専用-
このテクスチャ作成時のディスクリプタ。
GPUExternalTexture
には以下の不変プロパティがあります:
[[expired]], 型boolean、初期値false-
オブジェクトが期限切れ(利用不可)かどうか。
注:
[[destroyed]]スロットと似ているが、こちらはtrueからfalseに戻る場合もある。
6.4.1. 外部テクスチャのインポート
外部テクスチャは外部動画オブジェクトからimportExternalTexture()
を用いて作成します。
HTMLVideoElement
から作成された外部テクスチャは、他のリソースのように手動やガベージコレクションではなく、インポート後にタスク内で自動的に期限切れ(破棄)となります。
外部テクスチャが期限切れになると、その[[expired]]
スロットがtrueに変わります。
VideoFrame
から作成された外部テクスチャは、元のVideoFrame
がclose(明示的にclose()呼び出し、または他の手段)された時のみ期限切れ(破棄)となります。
注:decode()
でも述べられている通り、著者はデコーダの停止を防ぐため、出力VideoFrame
にclose()
を推奨します。
インポート後のVideoFrame
がcloseされずに破棄された場合、インポート済みGPUExternalTexture
オブジェクトが生きている限り、VideoFrameも生き続けます。
両方とも破棄されるまでVideoFrameはガベージコレクトされません。
ガベージコレクションは予測できないため、これでもビデオデコーダが停止する可能性があります。
GPUExternalTexture
が期限切れになると、importExternalTexture()
を再度呼び出す必要があります。
ただし、ユーザーエージェントは期限切れを解除し、同じGPUExternalTexture
を返す場合があります(新しいものを生成しない)。これは、アプリケーションの実行が動画フレームレート(例:requestVideoFrameCallback()使用)と一致しない限り、一般的に起こります。
同じオブジェクトが再び返された場合、比較は等しくなり、以前のオブジェクトを参照しているGPUBindGroupやGPURenderBundleなどは引き続き使用可能です。
dictionary :GPUExternalTextureDescriptor GPUObjectDescriptorBase {required (HTMLVideoElement or VideoFrame )source ;PredefinedColorSpace colorSpace = "srgb"; };
GPUExternalTextureDescriptor
辞書には以下のメンバーがあります:
source, 型(HTMLVideoElement or VideoFrame)-
外部テクスチャをインポートする動画ソース。ソースサイズは外部ソース寸法表に従って決定されます。
colorSpace, 型 PredefinedColorSpace(デフォルト値"srgb")-
sourceの画像内容を読み込み時に変換する色空間。
importExternalTexture(descriptor)-
指定した画像ソースをラップした
GPUExternalTextureを作成します。呼び出し元:GPUDevicethis.引数:
GPUDevice.importExternalTexture(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPUExternalTextureDescriptor✘ ✘ 外部画像ソースオブジェクト(および作成オプション)を指定。 戻り値:
GPUExternalTexture現行標準タイムライン手順:
-
sourceをdescriptor.
sourceとする。 -
現在のsource画像内容が、同じdescriptor(
label除く)で以前に呼び出されたimportExternalTexture()と同じであり、UAが再利用を選択した場合:-
previousResultを以前返された
GPUExternalTextureとする。 -
previousResult.
[[expired]]をfalseにし、基盤リソースの所有権を更新する。 -
resultをpreviousResultとする。
注: これにより、アプリケーションが重複インポートを検出し、依存オブジェクト(
GPUBindGroupなど)を再生成せずに済みます。 実装は、1つのフレームが複数GPUExternalTextureでラップされるケースにも対応する必要があります(インポートメタデータcolorSpaceは同一フレームでも変更可能)。それ以外の場合:
-
sourceがorigin-cleanでない場合、
SecurityErrorを投げてreturn。 -
usabilityを? 画像引数の利用性の確認(source)とする。
-
usabilityが
goodでない場合: -
dataを、現在のsource画像内容をdescriptor.
colorSpaceへ非プリマルチアルファで変換した結果とする。この変換で[0, 1]範囲外の値になる場合があります。クランプが必要ならサンプリング後に行えます。
注: コピーのように記述されていますが、実際は読み取り専用の基盤データと変換用メタデータへの参照として実装可能です。
-
resultをdataをラップした新しい
GPUExternalTextureオブジェクトとする。
-
-
sourceが
HTMLVideoElementの場合、 自動期限切れタスクをキュー(device this、次の手順):-
result.
[[expired]]をtrueにし、基盤リソースの所有権を解放する。
注:
HTMLVideoElementはテクスチャをサンプリングする同じタスクでインポートすること(通常requestVideoFrameCallbackやrequestAnimationFrame()を使う)。 そうしないと、アプリケーションが使い終わる前にこれらの手順でテクスチャが破棄される可能性があります。 -
-
sourceが
VideoFrameの場合、 sourceがcloseされた時、次の手順を実行:-
result.
[[expired]]をtrueにする。
-
-
resultを返す。
-
const videoElement= document. createElement( 'video' ); // ... videoElementのセットアップ、ready待ち ... function frame() { requestAnimationFrame( frame); // 毎アニメーションフレームで必ず再インポート。importは期限切れの可能性が高い。 // ブラウザは過去フレームをキャッシュ・再利用する場合があり、その際 // 同じGPUExternalTextureオブジェクトを再び返すことがある。 // この場合、古いバインドグループも有効。 const externalTexture= gpuDevice. importExternalTexture({ source: videoElement}); // ... externalTextureで描画 ... } requestAnimationFrame( frame);
const videoElement= document. createElement( 'video' ); // ... videoElementのセットアップ ... function frame() { videoElement. requestVideoFrameCallback( frame); // フレーム進行が確実なため、毎回再インポート const externalTexture= gpuDevice. importExternalTexture({ source: videoElement}); // ... externalTextureで描画 ... } videoElement. requestVideoFrameCallback( frame);
6.5. 外部テクスチャバインディングのサンプリング
externalTexture
バインディングポイントは、GPUExternalTexture
オブジェクト(動画など動的画像ソース)をバインドできます。また、GPUTexture
やGPUTextureViewにも対応しています。
注:
GPUTexture
やGPUTextureView
をexternalTextureバインディングにバインドした場合、
RGBA単一プレーン・クロップ/回転/色変換なしのGPUExternalTexture
と同じ扱いになります。
外部テクスチャはWGSLではtexture_externalで表され、textureLoadやtextureSampleBaseClampToEdgeで読み取れます。
textureSampleBaseClampToEdgeに渡すsamplerは基盤テクスチャのサンプリングに使われます。
バインディングリソース型がGPUExternalTextureの場合、
結果はcolorSpaceで指定された色空間となります。
実装依存で、サンプラー(およびフィルタリング)が基底値から指定色空間への変換の前後どちらで適用されるかは異なります。
注: 内部表現がRGBAプレーンの場合、サンプリングは通常の2Dテクスチャと同様です。 複数プレーン(例:Y+UV)の場合、サンプラーは各基盤テクスチャを個別にサンプリングし、YUV→指定色空間変換前に適用されます。
7. サンプラー
7.1. GPUSampler
GPUSampler
はシェーダでテクスチャリソースデータを解釈するための変換・フィルタ情報を符号化します。
GPUSampler
はcreateSampler()
で作成されます。
[Exposed =(Window ,Worker ),SecureContext ]interface GPUSampler { };GPUSampler includes GPUObjectBase ;
GPUSampler
には以下の不変プロパティがあります:
[[descriptor]], 型GPUSamplerDescriptor、読み取り専用-
この
GPUSamplerの作成時に使用したGPUSamplerDescriptor。 [[isComparison]], 型boolean、読み取り専用-
この
GPUSamplerが比較サンプラーとして利用されるかどうか。 [[isFiltering]], 型boolean、読み取り専用-
この
GPUSamplerがテクスチャの複数サンプルを重み付けするかどうか。
7.1.1. GPUSamplerDescriptor
GPUSamplerDescriptor
はGPUSampler
の作成時オプションを指定します。
dictionary :GPUSamplerDescriptor GPUObjectDescriptorBase {GPUAddressMode addressModeU = "clamp-to-edge";GPUAddressMode addressModeV = "clamp-to-edge";GPUAddressMode addressModeW = "clamp-to-edge";GPUFilterMode magFilter = "nearest";GPUFilterMode minFilter = "nearest";GPUMipmapFilterMode mipmapFilter = "nearest";float lodMinClamp = 0;float lodMaxClamp = 32;GPUCompareFunction compare ; [Clamp ]unsigned short maxAnisotropy = 1; };
addressModeU, 型 GPUAddressMode(デフォルト値"clamp-to-edge")addressModeV, 型 GPUAddressMode(デフォルト値"clamp-to-edge")addressModeW, 型 GPUAddressMode(デフォルト値"clamp-to-edge")-
テクスチャの幅・高さ・深度座標それぞれの
アドレスモード指定。 magFilter, 型 GPUFilterMode(デフォルト値"nearest")-
サンプリング領域が1テクセル以下のときのサンプリング動作。
minFilter, 型 GPUFilterMode(デフォルト値"nearest")-
サンプリング領域が1テクセルより大きいときのサンプリング動作。
mipmapFilter, 型 GPUMipmapFilterMode(デフォルト値"nearest")-
ミップマップレベル間のサンプリング動作。
lodMinClamp, 型 float(デフォルト値0)lodMaxClamp, 型 float(デフォルト値32)-
テクスチャサンプリング時に内部的に使われる最小・最大レベルオブディテール。
compare, 型 GPUCompareFunction-
指定した場合、サンプラーは指定
GPUCompareFunctionで比較サンプラーになります。注: 比較サンプラーはフィルタリング使用可能ですが、結果は実装依存・通常のフィルタリングルールと異なる場合があります。
maxAnisotropy, 型 unsigned short(デフォルト値1)-
サンプラーで使われる最大異方性値クランプ指定。
maxAnisotropy> 1かつ実装が対応している場合、異方性フィルタリング有効。異方性フィルタリングは斜め視点テクスチャの画質向上。
maxAnisotropy値が高いほどフィルタリング時の最大異方性比。
レベルオブディテール(LOD)はテクスチャサンプリング時に選択されるミップレベルを示します。シェーダのtextureSampleLevel等で明示指定、またはテクスチャ座標の微分から暗黙決定されます。
注: 暗黙LOD計算例はScale Factor Operation, LOD Operation and Image Level Selection(Vulkan 1.3仕様)参照。
GPUAddressMode
はサンプリングテクセルがテクスチャ範囲外のときのサンプラー動作指定。
enum {GPUAddressMode "clamp-to-edge" ,"repeat" ,"mirror-repeat" , };
"clamp-to-edge"-
テクスチャ座標は0.0~1.0の範囲にクランプ。
"repeat"-
テクスチャ座標はテクスチャの反対側へラップ。
"mirror-repeat"-
テクスチャ座標は反対側へラップしつつ、座標の整数部が奇数のときテクスチャを反転。
GPUFilterMode
およびGPUMipmapFilterMode
はサンプリング領域が1テクセルちょうどでない場合のサンプラー動作指定。
注: 各種フィルターモードでどのテクセルがサンプルされるかの例はTexel Filtering(Vulkan 1.3仕様)参照。
enum {GPUFilterMode "nearest" ,"linear" , };enum {GPUMipmapFilterMode ,"nearest" , };"linear"
"nearest"-
テクスチャ座標に最も近いテクセルの値を返す。
"linear"-
各次元で2テクセル選び、その値を線形補間して返す。
GPUCompareFunction
は比較サンプラーの挙動指定。シェーダで比較サンプラー使用時、depth_refと取得テクセル値を比較し、その判定結果(合格1.0f/不合格0.0f)を生成。
比較後、テクスチャフィルタリング有効ならフィルタリングが行われ、判定結果同士が混合され[0, 1]範囲の値となる。フィルタリングは通常通り動作すべきだが、精度低下や混合なしの可能性もある。
enum {GPUCompareFunction "never" ,"less" ,"equal" ,"less-equal" ,"greater" ,"not-equal" ,"greater-equal" ,"always" , };
"never"-
比較判定は常に不合格。
"less"-
与えられた値がサンプル値より小さい場合に合格。
"equal"-
与えられた値がサンプル値と等しい場合に合格。
"less-equal"-
与えられた値がサンプル値以下の場合に合格。
"greater"-
与えられた値がサンプル値より大きい場合に合格。
"not-equal"-
与えられた値がサンプル値と異なる場合に合格。
"greater-equal"-
与えられた値がサンプル値以上の場合に合格。
"always"-
比較判定は常に合格。
7.1.2. サンプラーの作成
createSampler(descriptor)-
GPUSamplerを作成します。呼び出し元:GPUDevicethis.引数:
GPUDevice.createSampler(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPUSamplerDescriptor✘ ✔ 作成する GPUSamplerの説明。戻り値:
GPUSampler現行標準タイムライン手順:
-
sを! 新しいWebGPUオブジェクトの生成(this,
GPUSampler, descriptor)とする。 -
thisのデバイスタイムラインでinitialization stepsを発行。
-
sを返す。
デバイスタイムライン initialization steps:-
以下の条件が満たされない場合検証エラー生成、sの無効化、return。
-
thisが失われていないこと。
-
descriptor.
lodMinClamp≥ 0。 -
descriptor.
lodMaxClamp≥ descriptor.lodMinClamp。 -
descriptor.
maxAnisotropy≥ 1。注: 多くの実装は
maxAnisotropyを1~16の範囲でサポート。指定値はプラットフォーム最大値にクランプされます。 -
descriptor.
maxAnisotropy> 1の場合:-
descriptor.
magFilter, descriptor.minFilter, descriptor.mipmapFilterがすべて"linear"であること。
-
-
-
s.
[[descriptor]]にdescriptorを設定。 -
s.
[[isComparison]]を、s.[[descriptor]]のcompare属性がnullまたは未定義ならfalse、それ以外ならtrueに設定。 -
s.
[[isFiltering]]を、minFilter、magFilter、mipmapFilterのいずれも"linear"でなければfalse、いずれかが"linear"ならtrueに設定。
-
GPUSampler生成例:
const sampler= gpuDevice. createSampler({ addressModeU: 'repeat' , addressModeV: 'repeat' , magFilter: 'linear' , minFilter: 'linear' , mipmapFilter: 'linear' , });
8. リソースバインディング
8.1. GPUBindGroupLayout
GPUBindGroupLayout
は、GPUBindGroup
でバインドされたリソース群と、シェーダステージでのアクセス性とのインターフェースを定義します。
[Exposed =(Window ,Worker ),SecureContext ]interface GPUBindGroupLayout { };GPUBindGroupLayout includes GPUObjectBase ;
GPUBindGroupLayout
には以下の不変プロパティがあります:
[[descriptor]], 型GPUBindGroupLayoutDescriptor、読み取り専用
8.1.1. バインドグループレイアウトの作成
GPUBindGroupLayout
はGPUDevice.createBindGroupLayout()で作成します。
dictionary :GPUBindGroupLayoutDescriptor GPUObjectDescriptorBase {required sequence <GPUBindGroupLayoutEntry >entries ; };
GPUBindGroupLayoutDescriptor
辞書には以下のメンバーがあります:
entries, 型 sequence<GPUBindGroupLayoutEntry>-
バインドグループのシェーダリソースバインディングを記述するエントリのリスト。
GPUBindGroupLayoutEntry
は、GPUBindGroupLayoutに含める1つのシェーダリソースバインディングを記述します。
dictionary {GPUBindGroupLayoutEntry required GPUIndex32 binding ;required GPUShaderStageFlags visibility ;GPUBufferBindingLayout buffer ;GPUSamplerBindingLayout sampler ;GPUTextureBindingLayout texture ;GPUStorageTextureBindingLayout storageTexture ;GPUExternalTextureBindingLayout externalTexture ; };
GPUBindGroupLayoutEntry
辞書には以下のメンバーがあります:
binding, 型 GPUIndex32-
リソースバインディングを一意に識別するためのIDです。これは
GPUBindGroupLayout内のリソースに対応し、GPUBindGroupEntry.bindingや @binding 属性(GPUShaderModule内)と対応します。 visibility, 型 GPUShaderStageFlags-
GPUShaderStageのメンバーをビットセットで指定します。 各ビットがセットされていると、そのGPUBindGroupLayoutEntryのリソースが対応するシェーダーステージからアクセス可能であることを意味します。 buffer, 型 GPUBufferBindingLayoutsampler, 型 GPUSamplerBindingLayouttexture, 型 GPUTextureBindingLayoutstorageTexture, 型 GPUStorageTextureBindingLayoutexternalTexture, 型 GPUExternalTextureBindingLayout-
これらのメンバーのうちちょうど1つだけを設定し、バインディングタイプを示します。 メンバーの内容はその型固有のオプションを指定します。
対応するリソースが
createBindGroup()で設定される場合、このバインディングには対応するバインディングリソース型が必要です。
typedef [EnforceRange ]unsigned long ; [GPUShaderStageFlags Exposed =(Window ,Worker ),SecureContext ]namespace {GPUShaderStage const GPUFlagsConstant VERTEX = 0x1;const GPUFlagsConstant FRAGMENT = 0x2;const GPUFlagsConstant COMPUTE = 0x4; };
GPUShaderStage
には以下のフラグが含まれ、これにより該当GPUBindGroupEntry
がこのGPUBindGroupLayoutEntry
に対してどのシェーダーステージから可視かを示します:
VERTEX-
バインドグループエントリは頂点シェーダーからアクセス可能。
FRAGMENT-
バインドグループエントリはフラグメントシェーダーからアクセス可能。
COMPUTE-
バインドグループエントリは計算シェーダーからアクセス可能。
GPUBindGroupLayoutEntry
の
binding メンバー
は、どの
GPUBindGroupLayoutEntry
のメンバーが定義されているかによって決定されます:
buffer、
sampler、
texture、
storageTexture、
または
externalTexture
です。
いずれか一つのみが
GPUBindGroupLayoutEntry
ごとに定義できます。
各メンバーは対応する
GPUBindingResource
型を持ち、各
バインディングタイプ
は本表で示す
内部使用方法
と関連付けられています。
| バインディングメンバー | リソース型 | バインディング型 | バインディング用途 |
|---|---|---|---|
buffer
| GPUBufferBinding(または GPUBuffer
略記として)
| "uniform"
| constant |
"storage"
| storage | ||
"read-only-storage"
| storage-read | ||
sampler
| GPUSampler
| "filtering"
| constant |
"non-filtering"
| |||
"comparison"
| |||
texture
| GPUTextureView(または GPUTexture
略記として)
| "float"
| constant |
"unfilterable-float"
| |||
"depth"
| |||
"sint"
| |||
"uint"
| |||
storageTexture
| GPUTextureView(または GPUTexture
略記として)
| "write-only"
| storage |
"read-write"
| |||
"read-only"
| storage-read | ||
externalTexture
| GPUExternalTextureまたは GPUTextureView(または GPUTexture
略記として)
| constant |
GPUBindGroupLayoutEntry
値entriesが
バインディングスロット制限超過となるのは、supported
limitslimitsにおいて、制限値を超えてスロット数が使用された場合です。
各エントリは複数の制限に対して複数スロットを使用する場合があります。
デバイスタイムライン手順:
-
entries内の各entryについて、次の場合:
- entry.
buffer?.typeが"uniform"かつ entry.buffer?.hasDynamicOffsetがtrueの場合 -
maxDynamicUniformBuffersPerPipelineLayoutスロットを1個使用したとみなす。 - entry.
buffer?.typeが"storage"かつ entry.buffer?.hasDynamicOffsetがtrueの場合 -
maxDynamicStorageBuffersPerPipelineLayoutスロットを1個使用したとみなす。
- entry.
-
各シェーダーステージstage( «
VERTEX,FRAGMENT,COMPUTE»)について:-
entries 内の各 entry について、 entry.
visibilityが stage を含む場合、以下を行う:-
entry.
buffer?.typeが"uniform"の場合 -
1つの
maxUniformBuffersPerShaderStageスロットが使用されたとみなす。 -
entry.
buffer?.typeが"storage"または"read-only-storage"の場合 -
stage が次の場合:
-
VERTEX -
1つの
maxStorageBuffersInVertexStageスロットが使用されたとみなす。 -
FRAGMENT -
1つの
maxStorageBuffersInFragmentStageスロットが使用されたとみなす。 -
COMPUTE -
1つの
maxStorageBuffersPerShaderStageスロットが使用されたとみなす。
-
-
entry.
samplerが 提供されている 場合 -
1つの
maxSamplersPerShaderStageスロットが使用されたとみなす。 -
entry.
textureが 提供されている 場合 -
1つの
maxSampledTexturesPerShaderStageスロットが使用されたとみなす。 -
entry.
storageTextureが 提供されている 場合 -
stage が次の場合:
-
VERTEX -
1つの
maxStorageTexturesInVertexStageスロットが使用されたとみなす。 -
FRAGMENT -
1つの
maxStorageTexturesInFragmentStageスロットが使用されたとみなす。 -
COMPUTE -
1つの
maxStorageTexturesPerShaderStageスロットが使用されたとみなす。
-
-
entry.
externalTextureが 提供されている 場合 -
4つの
maxSampledTexturesPerShaderStageスロット、 1つのmaxSamplersPerShaderStageスロット、 および 1つのmaxUniformBuffersPerShaderStageスロットが使用されたとみなす。注: この挙動の説明は
GPUExternalTextureを参照してください。
-
entry.
-
enum {GPUBufferBindingType ,"uniform" ,"storage" , };"read-only-storage" dictionary {GPUBufferBindingLayout GPUBufferBindingType type = "uniform";boolean hasDynamicOffset =false ;GPUSize64 minBindingSize = 0; };
GPUBufferBindingLayout
辞書には以下のメンバーがあります:
type, 型 GPUBufferBindingType(デフォルト値"uniform")-
このバインディングにバインドされるバッファに要求される型を示します。
hasDynamicOffset, 型 boolean(デフォルト値false)-
このバインディングが動的オフセットを要求するかどうかを示します。
minBindingSize, 型 GPUSize64(デフォルト値0)-
このバインドポイントで使用されるバッファバインディングの最小
sizeを示します。バインディングは常にこのサイズに対して
createBindGroup()内で検証されます。この値が0でない場合、パイプライン作成時にさらに、変数の最小バッファバインディングサイズ以上であることが検証されます。
この値が0の場合、パイプライン作成時には無視され、代わりに描画/ディスパッチコマンドが
GPUBindGroup内の各バインディングが変数の最小バッファバインディングサイズを満たすか検証します。注: 実行時検証は、
sampleTypeやformatのような他の早期検証項目にも理論上可能ですが、現状ではパイプライン作成時のみ検証されます。 ただし実行時検証はコスト・複雑性の増加につながるため、最も利便性に影響するminBindingSizeにのみ導入されています。
enum {GPUSamplerBindingType ,"filtering" ,"non-filtering" , };"comparison" dictionary {GPUSamplerBindingLayout GPUSamplerBindingType type = "filtering"; };
GPUSamplerBindingLayout
辞書には以下のメンバーがあります:
type, 型 GPUSamplerBindingType(デフォルト値"filtering")-
このバインディングにバインドされるサンプラーに要求される型を示します。
enum {GPUTextureSampleType ,"float" ,"unfilterable-float" ,"depth" ,"sint" , };"uint" dictionary {GPUTextureBindingLayout GPUTextureSampleType sampleType = "float";GPUTextureViewDimension viewDimension = "2d";boolean multisampled =false ; };
GPUTextureBindingLayout
辞書には以下のメンバーがあります:
sampleType, 型 GPUTextureSampleType(デフォルト値"float")-
このバインディングにバインドされるテクスチャビューに要求される型を示します。
viewDimension, 型 GPUTextureViewDimension(デフォルト値"2d")-
このバインディングにバインドされるテクスチャビューに要求される
dimensionを示します。 multisampled, 型 boolean(デフォルト値false)-
このバインディングにバインドされるテクスチャビューがマルチサンプルである必要があるかどうかを示します。
enum {GPUStorageTextureAccess ,"write-only" ,"read-only" , };"read-write" dictionary {GPUStorageTextureBindingLayout GPUStorageTextureAccess access = "write-only";required GPUTextureFormat format ;GPUTextureViewDimension viewDimension = "2d"; };
GPUStorageTextureBindingLayout
辞書には以下のメンバーがあります:
access, 型 GPUStorageTextureAccess(デフォルト値"write-only")-
このバインディングのアクセスモード(読み取り・書き込み可能性)を示します。
format, 型 GPUTextureFormat-
このバインディングにバインドされるテクスチャビューの要求
format。 viewDimension, 型 GPUTextureViewDimension(デフォルト値"2d")-
このバインディングにバインドされるテクスチャビューに要求される
dimensionを示します。
dictionary { };GPUExternalTextureBindingLayout
GPUBindGroupLayout
オブジェクトは以下のデバイスタイムラインプロパティを持ちます:
[[entryMap]]、型は ordered map<GPUSize32,GPUBindGroupLayoutEntry>、 読み取り専用-
バインディングインデックスを
GPUBindGroupLayoutEntryに対応付けるマップです。 このGPUBindGroupLayoutが記述する内容を表します。 [[dynamicOffsetCount]]、型はGPUSize32、 読み取り専用-
この
GPUBindGroupLayoutに含まれる動的オフセットを持つバッファバインディングの数です。 [[exclusivePipeline]]、型はGPUPipelineBase? 、読み取り専用-
この
GPUBindGroupLayoutが デフォルトパイプラインレイアウト の一部として生成された場合、 その元となったパイプラインを示します。nullでない場合、このGPUBindGroupは 指定されたGPUPipelineBaseでのみ利用できます。
createBindGroupLayout(descriptor)-
GPUBindGroupLayoutを作成します。呼び出し元:GPUDevicethis。引数:
GPUDevice.createBindGroupLayout(descriptor) メソッドの引数 パラメータ 型 Nullable Optional 説明 descriptorGPUBindGroupLayoutDescriptor✘ ✘ 作成する GPUBindGroupLayoutの記述。戻り値:
GPUBindGroupLayoutContent timeline の手順:
-
各
GPUBindGroupLayoutEntryentry について descriptor.entries内で繰り返す:-
もし entry.
storageTextureが 設定済み であれば:-
? Validate texture format required features を entry.
storageTexture.formatおよび this.[[device]]で実行する。
-
-
-
layout を ! create a new WebGPU object(this,
GPUBindGroupLayout, descriptor) とする。 -
this の Device timeline で initialization steps を実施する。
-
layout を返す。
Device timeline の initialization steps:-
下記のいずれか条件が満たされない場合は generate a validation error を発生させ、 invalidate layout を実行しリターンする。
-
this が lost であってはならない。
-
limits を this.
[[device]].[[limits]]とする。 -
descriptor 内の各エントリの
bindingは一意でなければならない。 -
descriptor 内の各エントリの
bindingは limits.maxBindingsPerBindGroup未満でなければならない。 -
descriptor.
entriesが limits のバインディングスロット上限を超えてはならない。 -
各
GPUBindGroupLayoutEntryentry について descriptor.entries内で繰り返す:-
entry.
buffer、 entry.sampler、 entry.texture、 entry.storageTexture、 entry.externalTextureのうち、ちょうど1つのみが 設定済み でなければならない。 -
entry.
visibilityはGPUShaderStageで定義されたビットのみを含むこと。 -
もし entry.
visibilityにVERTEXが含まれている場合:-
もし entry.
bufferが 設定済み であれば、 entry.buffer.typeは"uniform"または"read-only-storage"でなければならない。 -
もし entry.
storageTextureが 設定済み であれば、 entry.storageTexture.accessは"read-only"でなければならない。
-
-
もし entry.
texture?.multisampledがtrueであれば:-
entry.
texture.viewDimensionは"2d"でなければならない。 -
entry.
texture.sampleTypeは"float"以外でなければならない。
-
-
もし entry.
storageTextureが 設定済み であれば:-
entry.
storageTexture.viewDimensionは"cube"または"cube-array"であってはならない。 -
entry.
storageTexture.formatは § 26.1.1 Plain color formats テーブルにより、指定した entry.storageTexture.accessでストレージ用途をサポートできるフォーマットでなければならない。
-
-
-
-
layout.
[[descriptor]]を descriptor に設定する。 -
layout.
[[dynamicOffsetCount]]を descriptor 内のbufferが 設定済み かつbuffer.hasDynamicOffsetがtrueであるエントリ数に設定する。 -
layout.
[[exclusivePipeline]]をnullに設定する。 -
各
GPUBindGroupLayoutEntryentry について descriptor.entries内で繰り返す:-
entry を layout.
[[entryMap]]に entry.bindingをキーとして挿入する。
-
-
8.1.2. 互換性
GPUBindGroupLayoutオブジェクトaとbは、以下すべての条件が満たされたときのみグループ同等とみなされます。
-
任意のバインディング番号bindingについて、次のいずれかを満たす:
-
a.
[[entryMap]]とb.[[entryMap]]の両方に存在しない。 -
a.
[[entryMap]][binding] == b.[[entryMap]][binding]
-
バインドグループレイアウトがグループ同等なら、すべての現行標準内容で相互に利用可能です。
8.2. GPUBindGroup
GPUBindGroupは、グループ内でまとめてバインドするリソース集合と、それらがシェーダーステージでどのように利用されるかを定義します。
[Exposed =(Window ,Worker ),SecureContext ]interface GPUBindGroup { };GPUBindGroup includes GPUObjectBase ;
GPUBindGroupは以下のデバイスタイムラインプロパティを持ちます:
[[layout]], 型GPUBindGroupLayout、読み取り専用-
この
GPUBindGroupに関連付けられているGPUBindGroupLayout。 [[entries]], 型 sequence<GPUBindGroupEntry>、読み取り専用-
この
GPUBindGroupが記述するGPUBindGroupEntryの集合。 [[usedResources]], 型 usage scope、読み取り専用-
このバインドグループが使用するバッファ・テクスチャサブリソースの集合。利用される内部用途フラグのリストも関連付けられます。
GPUBindGroup
bindGroup、list<GPUBufferDynamicOffset> dynamicOffsets を与えた場合)は次のように算出されます:
-
result を新しい set<(
GPUBindGroupLayoutEntry,GPUBufferBinding)> とする。 -
dynamicOffsetIndex を 0 にする。
-
bindGroup.
[[entries]]の各GPUBindGroupEntrybindGroupEntry について、 bindGroupEntry.bindingでソートし順に処理する:-
bindGroupLayoutEntry を bindGroup.
[[layout]].[[entryMap]][bindGroupEntry.binding] とする。 -
もし bindGroupLayoutEntry.
bufferが 設定されていなければ、次へ。 -
bound を get as buffer binding(bindGroupEntry.
resource) とする。 -
もし bindGroupLayoutEntry.
buffer.hasDynamicOffsetなら:-
bound.
offsetに dynamicOffsets[dynamicOffsetIndex] を加算する。 -
dynamicOffsetIndex を 1 増やす。
-
-
-
result を返す。
8.2.1. バインドグループの作成
GPUBindGroupはGPUDevice.createBindGroup()で作成します。
dictionary :GPUBindGroupDescriptor GPUObjectDescriptorBase {required GPUBindGroupLayout layout ;required sequence <GPUBindGroupEntry >entries ; };
GPUBindGroupDescriptor
辞書には以下のメンバーがあります:
layout, 型 GPUBindGroupLayout-
このバインドグループのエントリが準拠する
GPUBindGroupLayout。 entries, 型 sequence<GPUBindGroupEntry>-
layoutで記述される各バインディングに対し、シェーダーで公開するリソースを記述するエントリのリスト。
typedef (GPUSampler or GPUTexture or GPUTextureView or GPUBuffer or GPUBufferBinding or GPUExternalTexture );GPUBindingResource dictionary {GPUBindGroupEntry required GPUIndex32 binding ;required GPUBindingResource resource ; };
GPUBindGroupEntry
はGPUBindGroup内でバインドする1つのリソースを記述し、以下のメンバーを持ちます:
binding, 型 GPUIndex32-
この
GPUBindGroup内でリソースバインディングを一意に識別するID。GPUBindGroupLayoutEntry.bindingおよび、GPUShaderModuleの@binding属性に対応。 resource, 型 GPUBindingResource-
バインドするリソース。
GPUSampler、GPUTexture、GPUTextureView、GPUBuffer、GPUBufferBinding、 またはGPUExternalTexture。
GPUBindGroupEntry
は以下のデバイスタイムラインプロパティを持ちます:
[[prevalidatedSize]], 型boolean-
このバインディングエントリが作成時にバッファサイズ検証済みかどうか。
dictionary {GPUBufferBinding required GPUBuffer buffer ;GPUSize64 offset = 0;GPUSize64 size ; };
GPUBufferBinding
はバッファおよびオプションの範囲をリソースとしてバインドするために記述し、以下のメンバーを持ちます:
buffer, 型 GPUBuffer-
バインドする
GPUBuffer。 offset, 型 GPUSize64(デフォルト値0)-
bufferの先頭から、バッファバインディングでシェーダーに公開する範囲の先頭までのバイトオフセット。 size, 型 GPUSize64
createBindGroup(descriptor)-
GPUBindGroupを作成します。呼び出し元:GPUDevicethis.引数:
GPUDevice.createBindGroup(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPUBindGroupDescriptor✘ ✘ 作成する GPUBindGroupの説明。戻り値:
GPUBindGroup現行標準タイムライン手順:
-
bindGroupを! 新しいWebGPUオブジェクトの生成(this,
GPUBindGroup, descriptor)とする。 -
thisのデバイスタイムラインでinitialization stepsを発行。
-
bindGroupを返す。
デバイスタイムライン initialization steps:-
limitsをthis.
[[device]].[[limits]]とする。 -
以下の条件が満たされない場合検証エラー生成、bindGroupの無効化、return。
descriptor.
entries内の各GPUBindGroupEntrybindingDescriptorについて:-
resourceをbindingDescriptor.
resourceとする。 -
descriptor.
layout.entries内に bindingDescriptor.bindingと等しいGPUBindGroupLayoutEntrylayoutBindingが正確に1つ存在すること。 -
定義されたbinding memberが:
sampler-
-
resourceが
GPUSamplerである。 -
resourceがthisで有効利用可能であること。
-
"filtering"-
resource.
[[isComparison]]がfalse。 "non-filtering"-
resource.
[[isFiltering]]がfalseかつresource.[[isComparison]]がfalse。 "comparison"-
resource.
[[isComparison]]がtrue。
-
texture-
-
resource は
GPUTextureまたはGPUTextureViewのいずれかです。 -
resource は valid to use with this です。
-
textureView を get as texture view(resource) とします。
-
texture を textureView.
[[texture]]にします。 -
layoutBinding.
texture.viewDimensionが textureView のdimensionと等しいこと。 -
layoutBinding.
texture.sampleTypeが compatible であり、 textureView のformatと互換です。 -
textureView.
[[descriptor]].usageがTEXTURE_BINDINGを含むこと。 -
もし layoutBinding.
texture.multisampledがtrueなら texture のsampleCountは1より大きく、そうでなければ texture のsampleCountは1であること。 -
もし texture.
textureBindingViewDimensionがundefinedでない場合:-
Assert this.
[[device]].[[features]]が 含んでいない"core-features-and-limits"。 -
texture.
textureBindingViewDimensionが textureView.dimensionと等しいこと。
-
-
storageTexture-
-
resourceが
GPUTextureまたはGPUTextureViewである。 -
resourceがthisで有効利用可能であること。
-
storageTextureViewをget as texture view(resource)とする。
-
textureをstorageTextureView.
[[texture]]とする。 -
layoutBinding.
storageTexture.viewDimensionがstorageTextureViewのdimensionと等しい。 -
layoutBinding.
storageTexture.formatがstorageTextureView.[[descriptor]].formatと等しい。 -
storageTextureView.
[[descriptor]].usageがSTORAGE_BINDINGを含む。 -
storageTextureView.
[[descriptor]].mipLevelCountは1であること。 -
storageTextureView.
[[descriptor]].swizzleは"rgba"でなければならない。
-
buffer-
-
resourceが
GPUBufferまたはGPUBufferBindingである。 -
bufferBindingをget as buffer binding(resource)とする。
-
bufferBinding.
offsetと bufferBinding.sizeで指定されるバインド範囲がバッファ内にありサイズが0でないこと。 -
effective buffer binding size(bufferBinding) ≥ layoutBinding.
buffer.minBindingSize。 -
"uniform"-
-
effective buffer binding size(bufferBinding) ≤ limits.
maxUniformBufferBindingSize。 -
bufferBinding.
offsetがlimits.minUniformBufferOffsetAlignmentの倍数。
"storage"または"read-only-storage"-
-
effective buffer binding size(bufferBinding) ≤ limits.
maxStorageBufferBindingSize。 -
effective buffer binding size(bufferBinding)が4の倍数。
-
bufferBinding.
offsetがlimits.minStorageBufferOffsetAlignmentの倍数。
-
externalTexture-
-
resourceが
GPUExternalTexture、GPUTexture、 またはGPUTextureViewである。 -
resourceがthisで有効利用可能であること。
-
resourceが:
GPUTextureまたはGPUTextureView-
-
viewをget as texture view(resource)とする。
-
view.
[[descriptor]].usageがTEXTURE_BINDINGを含む。 -
view.
[[descriptor]].dimensionが"2d"であること。 -
view.
[[descriptor]].mipLevelCountが1であること。 -
view.
[[descriptor]].formatが"rgba8unorm"、"bgra8unorm"、 または"rgba16float"であること。 -
view.
[[texture]].sampleCountが1であること。
-
-
-
もし this.
[[device]].[[features]]が "core-features-and-limits""core-features-and-limits"を含まない場合:-
各
GPUBindGroupEntrybindGroupEntry について descriptor.entries内で繰り返す:-
もし bindGroupEntry.
resourceがGPUTextureViewの場合:-
textureView を bindGroupEntry.
resourceにする。 -
descriptor を textureView.
[[descriptor]]にする。 -
descriptor.
baseArrayLayerは0でなければならない。 -
descriptor.
arrayLayerCountは textureView.[[texture]].depthOrArrayLayersと等しくなければならない。
-
-
-
-
-
bindGroup.
[[layout]]を descriptor.layoutに設定する。 -
bindGroup.
[[entries]]を descriptor.entriesに設定する。 -
bindGroup.
[[usedResources]]を {} に設定する。 -
各
GPUBindGroupEntrybindingDescriptor について descriptor.entries内で繰り返す:-
internalUsage を layoutBinding の バインディング使用法 とする。
-
resource が参照する全ての サブリソースは
[[usedResources]]に internalUsage として追加される。 -
bindingDescriptor.
[[prevalidatedSize]]を以下に設定する。バインディングメンバーが layoutBinding でbufferであり、かつ layoutBinding.buffer.minBindingSizeが0の場合はfalse、それ以外はtrue。
-
-
引数:
-
GPUBindingResourceresource
戻り値: GPUTextureView
-
アサート resource は
GPUTextureまたはGPUTextureViewのいずれかである。 -
もし resource が次のいずれかの場合:
GPUTexture-
-
resource.
createView()を返す。
-
GPUTextureView-
-
resource を返す。
-
引数:
-
GPUBindingResourceresource
戻り値: GPUBufferBinding
-
アサート resource は
GPUBufferまたはGPUBufferBindingのいずれかである。 -
もし resource が次のいずれかの場合:
GPUBuffer-
-
bufferBinding を新しい
GPUBufferBindingとする。 -
bufferBinding.
bufferに resource を設定する。 -
bufferBinding を返す。
-
GPUBufferBinding-
-
resource を返す。
-
GPUBufferBinding
オブジェクト a / b は、次のすべてが成り立つ場合に バッファバインディングのエイリアス だとみなされます:
-
a.
offsetおよび a.sizeで形成される範囲が、 b.offsetおよび b.sizeで形成される範囲と重なっている。 なおsizeが 未指定 の場合、その範囲はバッファの末尾までとなる。
注: この判定を行う時、すでにダイナミックオフセットは範囲へ適用済みです。
8.3. GPUPipelineLayout
GPUPipelineLayout
は、setBindGroup()でコマンドエンコード中にセットされたすべてのGPUBindGroupのリソースと、
GPURenderCommandsMixin.setPipeline
またはGPUComputePassEncoder.setPipelineでセットされたパイプラインのシェーダーとの間のマッピングを定義します。
リソースの完全なバインディングアドレスは次の三つ組みとして定義できます:
-
リソースが可視となるシェーダーステージマスク
-
バインドグループインデックス
-
バインディング番号
アドレスの各要素はパイプラインのバインディング空間ともみなせます。1つのGPUBindGroup
(対応するGPUBindGroupLayout付き)は、固定のバインドグループインデックスに対する空間をカバーします。含まれるバインディングは、そのバインドグループインデックスでシェーダーが利用するリソースのスーパーセットである必要があります。
[Exposed =(Window ,Worker ),SecureContext ]interface GPUPipelineLayout { };GPUPipelineLayout includes GPUObjectBase ;
GPUPipelineLayout
は以下のデバイスタイムラインプロパティを持ちます:
[[bindGroupLayouts]], 型 list<GPUBindGroupLayout>、読み取り専用-
作成時に
GPUPipelineLayoutDescriptor.bindGroupLayoutsで指定されたGPUBindGroupLayoutオブジェクト群。
注: 同じGPUPipelineLayout
を複数のGPURenderPipeline
やGPUComputePipeline
パイプライン間で使用すると、これらのパイプライン間で切り替えが発生してもユーザーエージェントが内部でリソースを再バインドする必要がないことが保証されます。
GPUComputePipeline
オブジェクトXがGPUPipelineLayout.bindGroupLayouts
A, B, Cで作成されたとします。GPUComputePipeline
オブジェクトYはA, D, Cで作成されたとします。コマンドエンコードシーケンスが次の2つのディスパッチであると仮定します:
-
setBindGroup(0, ...)
-
setBindGroup(1, ...)
-
setBindGroup(2, ...)
-
setPipeline(X) -
setBindGroup(1, ...)
-
setPipeline(Y)
この場合、ユーザーエージェントは2回目のdispatchのためにグループスロット2を再バインドする必要があります。これは、GPUPipelineLayout.bindGroupLayouts
のインデックス2のGPUBindGroupLayoutや、
スロット2のGPUBindGroupが変化しなくても発生します。
注: GPUPipelineLayout
の推奨される利用方法は、最も一般的かつ変更頻度の低いバインドグループをレイアウトの「下部」、すなわちバインドグループスロット番号が0や1など低い位置に配置することです。描画呼び出し間で頻繁に変更する必要があるバインドグループほどインデックスを高くします。この一般的なガイドラインにより、ユーザーエージェントは描画呼び出し間の状態変更を最小化し、結果としてCPUオーバーヘッドも低減できます。
8.3.1. パイプラインレイアウトの作成
GPUPipelineLayout
はGPUDevice.createPipelineLayout()で作成されます。
dictionary :GPUPipelineLayoutDescriptor GPUObjectDescriptorBase {required sequence <GPUBindGroupLayout ?>bindGroupLayouts ; };
GPUPipelineLayoutDescriptor
辞書はパイプラインが用いるすべてのGPUBindGroupLayoutを定義し、次のメンバーを持ちます:
bindGroupLayouts, 型sequence<GPUBindGroupLayout?>-
パイプラインが利用するオプションの
GPUBindGroupLayoutのリスト。 各要素はGPUShaderModuleの@group属性に対応し、N番目の要素が@group(N)に対応します。
createPipelineLayout(descriptor)-
GPUPipelineLayoutを作成します。呼び出し元:GPUDevicethis。引数:
GPUDevice.createPipelineLayout(descriptor) メソッドの引数 パラメータ 型 Nullable Optional 説明 descriptorGPUPipelineLayoutDescriptor✘ ✘ 作成する GPUPipelineLayoutの説明。戻り値:
GPUPipelineLayoutContent timeline の手順:
-
pl に ! create a new WebGPU object(this,
GPUPipelineLayout, descriptor) を設定する。 -
this の Device timeline で initialization steps を実施する。
-
pl を返す。
Device timeline の initialization steps:-
limits を this.
[[device]].[[limits]]とする。 -
bindGroupLayouts を list(
nullのGPUBindGroupLayout閉じた サイズ = limits.maxBindGroupsのリスト)にする。 -
各 bindGroupLayout(インデックス i)を descriptor.
bindGroupLayoutsで繰り返す:-
もし bindGroupLayout が
nullでなく、かつ bindGroupLayout.[[descriptor]].entriesが 空でない場合:-
bindGroupLayouts[i] に bindGroupLayout を設定する。
-
-
-
allEntries を、bindGroupLayouts 内の
nullでない bgl の[[descriptor]].entriesをすべて連結した結果とする。 -
下記条件をいずれか満たさない場合は generate a validation error を発生させ、 invalidate pl を実行し、リターンする。
-
bindGroupLayouts 内の
nullでない各GPUBindGroupLayoutは valid to use with this であり、かつ[[exclusivePipeline]]がnullでなければならない。 -
descriptor.
bindGroupLayoutsの サイズ は limits.maxBindGroups以下であること。 -
allEntries が limits の バインディングスロット上限 を超えないこと。
-
-
pl.
[[bindGroupLayouts]]に bindGroupLayouts を設定する。
-
注意:
2つの GPUPipelineLayout
オブジェクトは、内部の [[bindGroupLayouts]]
シーケンスに含まれる
GPUBindGroupLayout
オブジェクトが
group-equivalent
である場合、いかなる用途でも等価とみなされます。
8.4. 例
GPUBindGroupLayoutを作成します。
そして、GPUBindGroupと
GPUPipelineLayout
を、このGPUBindGroupLayoutを用いて作成します。
const bindGroupLayout= gpuDevice. createBindGroupLayout({ entries: [{ binding: 0 , visibility: GPUShaderStage. VERTEX| GPUShaderStage. FRAGMENT, buffer: {} }, { binding: 1 , visibility: GPUShaderStage. FRAGMENT, texture: {} }, { binding: 2 , visibility: GPUShaderStage. FRAGMENT, sampler: {} }] }); const bindGroup= gpuDevice. createBindGroup({ layout: bindGroupLayout, entries: [{ binding: 0 , resource: { buffer: buffer}, }, { binding: 1 , resource: texture}, { binding: 2 , resource: sampler}] }); const pipelineLayout= gpuDevice. createPipelineLayout({ bindGroupLayouts: [ bindGroupLayout] });
9. シェーダーモジュール
9.1. GPUShaderModule
[Exposed =(Window ,Worker ),SecureContext ]interface GPUShaderModule {Promise <GPUCompilationInfo >getCompilationInfo (); };GPUShaderModule includes GPUObjectBase ;
GPUShaderModule
は内部シェーダーモジュールオブジェクトへの参照です。
9.1.1. シェーダーモジュールの生成
dictionary :GPUShaderModuleDescriptor GPUObjectDescriptorBase {required USVString code ;sequence <GPUShaderModuleCompilationHint >compilationHints = []; };
code, 型 USVString-
シェーダーモジュールの WGSL ソースコード。
compilationHints, 型 sequence<GPUShaderModuleCompilationHint>、デフォルト値[]-
GPUShaderModuleCompilationHintのリストです。アプリケーションが提供するヒントには、最終的にエントリーポイントから作成されるパイプラインのエントリーポイント情報を含めるべきです。
実装は、
GPUShaderModuleCompilationHintに含まれる情報を使用して、createShaderModule()内で可能な限り多くのコンパイルを行うべきです。型チェック以外では、これらのヒントは一切検証されません。
注:compilationHintsに情報を指定しても、 性能以外に観測可能な効果はありません。作成されないパイプラインに対してヒントを与えると性能が低下する場合もあります。1つのシェーダーモジュールは複数のエントリーポイントを持つことができ、複数のパイプラインが単一のシェーダーモジュールから作成されるため、 実装側は
createShaderModule()で一度にできるだけ多くのコンパイルを行うことで、複数回createComputePipeline()やcreateRenderPipeline()を呼び出すよりも高い性能を得られる場合があります。ヒントは明示的に名前が指定されたエントリーポイントにのみ適用されます。
GPUProgrammableStage.entryPointとは異なり、デフォルト値はありません(モジュールにエントリーポイントが1つだけであっても)。注: ヒントは観測可能な方法で検証されませんが、ユーザーエージェントは(未知のエントリーポイント名や非互換なパイプラインレイアウトなどの)識別可能なエラーを開発者向けに 表示してもかまいません(例: ブラウザの開発者コンソールなど)。
createShaderModule(descriptor)-
GPUShaderModuleを生成します。呼び出し元:GPUDevicethis。引数:
GPUDevice.createShaderModule(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPUShaderModuleDescriptor✘ ✘ GPUShaderModuleの説明戻り値:
GPUShaderModuleコンテンツタイムラインの手順:
-
sm を ! 新しい WebGPU オブジェクトを作成する(this,
GPUShaderModule, descriptor)。 -
initialization steps を デバイスタイムライン上で実行する。
-
sm を返す。
デバイスタイムライン initialization steps:-
error を、WGSL ソース descriptor.
codeで シェーダーモジュール生成時に発生したエラー、またはエラーがなければnullとする。 -
以下の要件が満たされない場合、 バリデーションエラーを生成し、sm を無効化し、終了する。
注: 分類されていないエラーは シェーダーモジュールの生成時には発生しません。 実装が生成時にそのようなエラーを検出した場合、シェーダーモジュールは有効であるかのように振る舞い、パイプライン生成までエラーの提示を遅延させる必要があります。
注:ユーザーエージェントは、ここで発生するバリデーションエラーのmessageテキストに詳細なコンパイラエラーメッセージやシェーダーテキストを含めるべきではありません: これらの詳細はgetCompilationInfo()で取得できます。 ユーザーエージェントは、開発者向けに人間が読める形式のエラー詳細を表示するべきです (例: ブラウザの開発者コンソールの警告、シェーダー全文表示可能など)。シェーダーのコンパイルエラーは現行標準のアプリケーションではまれなため、ユーザーエージェントは エラー処理 (GPUエラースコープ や
uncapturederrorイベントハンドラ) に関係なく、開発者向けに表示しても良いです。 そうしない場合は、ユーザーが人間向けの詳細を必ず取得できる方法(例: チェックボックスでエラー表示、GPUCompilationInfoオブジェクトをコンソールに表示時に詳細表示など)を用意し、文書化すべきです。 -
GPUShaderModule
を作成する:
// ビューポート全体を赤で塗りつぶす単純なバーテックス・フラグメントシェーダーペア。 const shaderSource= ` var<private> pos : array<vec2<f32>, 3> = array<vec2<f32>, 3>( vec2(-1.0, -1.0), vec2(-1.0, 3.0), vec2(3.0, -1.0)); @vertex fn vertexMain(@builtin(vertex_index) vertexIndex : u32) -> @builtin(position) vec4<f32> { return vec4(pos[vertexIndex], 1.0, 1.0); } @fragment fn fragmentMain() -> @location(0) vec4<f32> { return vec4(1.0, 0.0, 0.0, 1.0); } ` ; const shaderModule= gpuDevice. createShaderModule({ code: shaderSource, });
9.1.1.1. シェーダーモジュールのコンパイルヒント
シェーダーモジュールのコンパイルヒントは、任意の追加情報であり、特定の
GPUShaderModule
エントリーポイントが将来的にどのように使用される予定かを示します。一部の実装では、この情報によってシェーダーモジュールを早期にコンパイルでき、性能向上につながる場合があります。
dictionary {GPUShaderModuleCompilationHint required USVString ; (entryPoint GPUPipelineLayout or GPUAutoLayoutMode )layout ; };
layout, 型(GPUPipelineLayout or GPUAutoLayoutMode)-
GPUPipelineLayoutは、GPUShaderModuleが今後createComputePipeline()やcreateRenderPipeline()の呼び出し時に使用される場合に参照されます。"auto"に設定した場合は、このヒントに関連付けられたエントリーポイント用のデフォルトのパイプラインレイアウトが使用されます。
createShaderModule()
と createComputePipeline()
/
createRenderPipeline()
の両方に同じ情報を渡すべきです。
アプリケーションが createShaderModule()
の呼び出し時にヒント情報を提供できない場合は、通常
createShaderModule()
の呼び出しを遅らせるのではなく、
compilationHints
配列や GPUShaderModuleCompilationHint
の個々のメンバーから未知の情報を省略するべきです。
省略した場合、コンパイルは createComputePipeline()
/
createRenderPipeline()
時に遅延して行われる可能性があります。
著者が createShaderModule()
に渡すヒント情報が、後で同じモジュールに対して
createComputePipeline()
/
createRenderPipeline()
に渡す情報と一致しない可能性がある場合は、
createShaderModule()
にはその情報を渡さないようにすべきです。
不一致の情報を createShaderModule()
に渡すと、不要なコンパイルが発生する場合があります。
9.1.2. シェーダーモジュールのコンパイル情報
enum {GPUCompilationMessageType ,"error" ,"warning" , }; ["info" Exposed =(Window ,Worker ),Serializable ,SecureContext ]interface {GPUCompilationMessage readonly attribute DOMString message ;readonly attribute GPUCompilationMessageType type ;readonly attribute unsigned long long lineNum ;readonly attribute unsigned long long linePos ;readonly attribute unsigned long long offset ;readonly attribute unsigned long long length ; }; [Exposed =(Window ,Worker ),Serializable ,SecureContext ]interface {GPUCompilationInfo readonly attribute FrozenArray <GPUCompilationMessage >; };messages
GPUCompilationMessage
は、GPUShaderModule
コンパイラによって生成される情報、警告、またはエラーメッセージです。これらのメッセージはデベロッパーがシェーダーのcode
の問題を診断しやすいように、人間が読める形で提供されます。
各メッセージはシェーダーソースの1つの箇所または範囲に対応している場合もあれば、特定のコード部分に紐付かない場合もあります。
GPUCompilationMessage
には以下の属性があります:
message, 型 DOMString, 読み取り専用-
このコンパイルメッセージの人間が読めるローカライズ可能なテキスト。
注:
messageは言語および方向情報のベストプラクティスに従うべきです。これには、今後登場する文字列の言語・方向メタデータに関する標準を活用することも含みます。編集上の注: 本書執筆時点では、レガシーAPIと互換性・一貫性を持つ言語/方向の推奨事項はありませんが、今後登場した際は正式に採用してください。
type, 型 GPUCompilationMessageType, 読み取り専用-
メッセージの重大度レベル。
typeが"error"の場合、 シェーダー生成エラーに対応します。 lineNum, 型 unsigned long long, 読み取り専用-
この
messageが対応するシェーダーcodeの行番号。値は1始まりで、1はシェーダーcodeの最初の行を示します。 行区切りは改行です。messageが部分文字列に対応する場合は、その部分文字列が始まる行を指します。メッセージがシェーダーcodeの特定の位置に対応しない場合は、値は0です。 linePos, 型 unsigned long long, 読み取り専用-
シェーダー
lineNum行の先頭から、messageが対応する位置/部分文字列のUTF-16コード単位数。値は1始まりで、linePosが1の場合はその行の最初のコードユニットです。messageが部分文字列に対応する場合は、その部分文字列の最初のUTF-16コードユニットを指します。メッセージがシェーダーcodeの特定の位置に対応しない場合は、値は0です。 offset, 型 unsigned long long, 読み取り専用-
シェーダー
codeの先頭から、messageが対応する位置/部分文字列までのUTF-16コード単位数。同じ位置はlineNumおよびlinePosでも参照されます。メッセージがシェーダーcodeの特定の位置に対応しない場合は、値は0です。 length, 型 unsigned long long, 読み取り専用-
messageが対応する部分文字列のUTF-16コード単位数。メッセージが部分文字列に対応しない場合はlengthは0です。
注: GPUCompilationMessage.lineNum
および
GPUCompilationMessage.linePos
は、主な用途が多くのテキストエディタの行・列番号と照合できる人間向けメッセージの印刷であるため、1始まりです。
注: GPUCompilationMessage.offset
および
GPUCompilationMessage.length
は、シェーダー code
の部分文字列取得に substr() へ渡すのに適しています。
message
が対応する部分文字列を抽出できます。
getCompilationInfo()-
GPUShaderModuleの コンパイル時に生成されたメッセージを返します。メッセージの位置、順序、および内容は実装依存です。 特に、メッセージが
lineNumで順序付けされるとは限りません。呼び出し元:GPUShaderModulethis戻り値:
Promise<GPUCompilationInfo>コンテンツタイムラインの手順:
-
現在の コンテンツタイムライン を contentTimeline とする。
-
promise を新しい Promiseとして生成する。
-
synchronization steps を デバイスタイムライン上で実行する。
-
promise を返す。
デバイスタイムライン synchronization steps:-
this の シェーダーモジュール生成が(成功・失敗問わず)完了したときに event が発生する。
-
タイムラインイベントを監視 event を this.
[[device]]で発生させ、以降の手順は contentTimeline で処理する。
コンテンツタイムラインの手順:-
新しい
GPUCompilationInfoを info とする。 -
シェーダーモジュール生成時に this で生成されたエラー・警告・情報メッセージのリストを messages とする。デバイスが失われた場合は空リスト
[]。 -
messages の各 message について:
-
新しい
GPUCompilationMessageを m とする。 -
m.
messageに message のテキストを設定する。 -
- message がシェーダー
code内の特定の部分文字列や位置に対応する場合: - その他:
- message がシェーダー
-
-
promise を info で解決する。
-
10. パイプライン
パイプラインは、GPUComputePipeline
や GPURenderPipeline
のいずれであっても、バインディングや頂点バッファなどの入力データを処理して、出力レンダーターゲットの色などの出力を生成する、GPUハードウェア・ドライバー・ユーザーエージェントの組み合わせによる機能全体を表します。
構造的には、パイプラインはプログラム可能なステージ(シェーダー)と、ブレンドモードなどの固定機能ステートの連なりで構成されます。
注: 内部的には、ターゲットプラットフォームによっては、ドライバーが一部の固定機能ステートをシェーダーコードに変換し、ユーザーが提供したシェーダーとリンクする場合があります。このリンク処理が、オブジェクトを一体として生成する理由のひとつです。
この組み合わせ状態は1つのオブジェクト
(GPUComputePipeline
または GPURenderPipeline)
として作成され、1つのコマンド
(GPUComputePassEncoder.setPipeline()
または
GPURenderCommandsMixin.setPipeline()
で切り替えます。
パイプラインの生成方法は2つあります:
- 即時パイプライン生成
-
createComputePipeline()およびcreateRenderPipeline()は、パスエンコーダで即座に使用可能なパイプラインオブジェクトを返します。これが失敗すると、パイプラインオブジェクトは無効となり、呼び出しは バリデーションエラーまたは内部エラーを生成します。
注: ハンドルオブジェクトは即座に返されますが、実際のパイプライン生成は同期的ではありません。 パイプライン生成に時間がかかる場合、生成呼び出しからパイプラインが最初に使用される
submit()実行までの間の デバイスタイムライン のどこかで待ちが発生する可能性があります。 このタイミングは規定されていませんが、主に次のいずれかです: 生成時、setPipeline()でパイプラインが初めて使われる時、対応するfinish()(GPUCommandEncoderまたはGPURenderBundleEncoder)時、 またはsubmit()でGPUCommandBufferが実行された時です。 - 非同期 パイプライン生成
-
createComputePipelineAsync()およびcreateRenderPipelineAsync()は、パイプライン生成が完了するとパイプラインオブジェクトに解決されるPromiseを返します。失敗した場合、
PromiseはGPUPipelineErrorで reject されます。
GPUPipelineErrorはパイプライン生成失敗を表します。
[Exposed =(Window ,Worker ),SecureContext ,Serializable ]interface GPUPipelineError :DOMException {constructor (optional DOMString message = "",GPUPipelineErrorInit options );readonly attribute GPUPipelineErrorReason reason ; };dictionary {GPUPipelineErrorInit required GPUPipelineErrorReason ; };reason enum GPUPipelineErrorReason {"validation" ,"internal" , };
GPUPipelineError
のコンストラクタ:
constructor()-
引数:
GPUPipelineError.constructor() メソッドの引数。 パラメータ 型 Nullable Optional 説明 messageDOMString✘ ✔ 基底 DOMExceptionのエラーメッセージoptionsGPUPipelineErrorInit✘ ✘ GPUPipelineError固有のオプションコンテンツタイムラインの手順:
GPUPipelineError
には以下の属性があります:
reason, 型 GPUPipelineErrorReason, 読み取り専用-
パイプライン生成時に遭遇したエラー種別を
GPUPipelineErrorReasonとして公開する読み取り専用スロット属性です:-
"validation": バリデーションエラー -
"internal": 内部エラー
-
GPUPipelineError
オブジェクトはシリアライズ可能オブジェクトです。
-
DOMExceptionのシリアライズ手順を value と serialized に対して実行する。
-
DOMExceptionのデシリアライズ手順を value と serialized に対して実行する。
10.1. ベースパイプライン
enum {GPUAutoLayoutMode , };"auto" dictionary :GPUPipelineDescriptorBase GPUObjectDescriptorBase {required (GPUPipelineLayout or GPUAutoLayoutMode )layout ; };
layout, 型(GPUPipelineLayout or GPUAutoLayoutMode)-
このパイプラインの
GPUPipelineLayoutまたは"auto"を指定すると パイプラインレイアウトが自動生成されます。注:
"auto"を使用した場合、そのパイプラインは他のパイプラインとGPUBindGroupを共有できません。
interface mixin { [GPUPipelineBase NewObject ]GPUBindGroupLayout getBindGroupLayout (unsigned long index ); };
GPUPipelineBase
には以下のデバイスタイムラインプロパティがあります:
[[layout]], 型GPUPipelineLayout-
thisで使用できるリソースのレイアウト定義。
GPUPipelineBase
には以下のメソッドがあります:
getBindGroupLayout(index)-
GPUPipelineBaseのGPUBindGroupLayoutに互換性のあるGPUBindGroupLayoutをindexで取得します。呼び出し元:GPUPipelineBasethis引数:
GPUPipelineBase.getBindGroupLayout(index) メソッドの引数。 パラメータ 型 Nullable Optional 説明 indexunsigned long✘ ✘ パイプラインレイアウトの [[bindGroupLayouts]]シーケンスのインデックス。戻り値:
GPUBindGroupLayoutコンテンツタイムラインの手順:
-
新しい
GPUBindGroupLayoutオブジェクトを layout とする。 -
this の デバイスタイムライン上で initialization steps を実行する。
-
layout を返す。
デバイスタイムライン initialization steps:-
limits を this.
[[device]].[[limits]]とする。 -
以下のいずれかの条件が満たされない場合 バリデーションエラーを生成し、layoutを無効化して終了する。
-
this は 有効であること。
-
index < limits.
maxBindGroupsであること。
-
-
layout を this.
[[layout]].[[bindGroupLayouts]][index] のコピーとして初期化する。注:
GPUBindGroupLayoutは常に値渡しで使われ、参照渡しにはなりません。 つまり、同じ内部オブジェクトを新しいWebGPUインターフェースで返すのと同じです。 毎回新しいGPUBindGroupLayoutWebGPUインターフェースが返されるので、 コンテンツタイムラインとデバイスタイムライン間の往復を避けることができます。
-
10.1.1. デフォルトパイプラインレイアウト
GPUPipelineBase
オブジェクトが layout
に
"auto"
を設定して作成された場合、デフォルトレイアウトが生成されて使用されます。
注: デフォルトレイアウトは簡単なパイプライン向けの便宜で提供されていますが、ほとんどの場合は明示的なレイアウトの利用が推奨されます。デフォルトレイアウトで作成したバインドグループは他のパイプラインと共有できず、シェーダーを変更するとデフォルトレイアウトの構造も変化し、予期しないバインドグループ生成エラーが発生することがあります。
デフォルトパイプラインレイアウトを GPUPipelineBase
pipeline に対して生成するには、
以下のデバイスタイムライン手順を実行する:
-
groupCount を 0 にする。
-
groupDescs を device.
[[limits]].maxBindGroups個の新しいGPUBindGroupLayoutDescriptorオブジェクトの配列とする。 -
groupDescs の各 groupDesc について:
-
pipeline を生成したディスクリプタ内の各
GPUProgrammableStagestageDesc について:-
shaderStage を stageDesc が pipeline で使用されるシェーダーステージの
GPUShaderStageFlagsとする。 -
entryPoint を get the entry point(shaderStage, stageDesc) とする。Assert entryPoint は
nullではない。 -
entryPoint が 静的に使用する各 resource resource について:
-
group を resource の "group" 修飾子とする。
-
binding を resource の "binding" 修飾子とする。
-
entry を新しい
GPUBindGroupLayoutEntryとする。 -
entry.
bindingに bindingを設定する。 -
entry.
visibilityに shaderStage を設定する。 -
resource がサンプラーバインディングの場合:
-
samplerLayout を新しい
GPUSamplerBindingLayoutとする。 -
entry.
samplerに samplerLayout を設定する。
-
-
resource が比較サンプラーバインディングの場合:
-
samplerLayout を新しい
GPUSamplerBindingLayoutとする。 -
samplerLayout.
typeに"comparison"を設定する。 -
entry.
samplerに samplerLayout を設定する。
-
-
resource がバッファバインディングの場合:
-
bufferLayout を新しい
GPUBufferBindingLayoutとする。 -
bufferLayout.
minBindingSizeに resource の最小バッファバインディングサイズを設定する。 -
resource が読み取り専用ストレージバッファの場合:
-
bufferLayout.
typeに"read-only-storage"を設定する。
-
-
resource がストレージバッファの場合:
-
entry.
bufferに bufferLayout を設定する。
-
-
resource がサンプリングテクスチャバインディングの場合:
-
textureLayout を新しい
GPUTextureBindingLayoutとする。 -
resource が深度テクスチャバインディングの場合:
-
textureLayout.
sampleTypeに"depth"を設定する。
そうでない場合、resource のサンプル型が:
f32かつ stageDesc から resource へのサンプラー付きテクスチャ組み込み関数呼び出しが 静的に使用されている場合-
textureLayout.
sampleTypeに"float"を設定する。 f32その他の場合-
textureLayout.
sampleTypeに"unfilterable-float"を設定する。 i32-
textureLayout.
sampleTypeに"sint"を設定する。 u32-
textureLayout.
sampleTypeに"uint"を設定する。
-
-
textureLayout.
viewDimensionに resource の次元を設定する。 -
resource がマルチサンプルテクスチャの場合:
-
textureLayout.
multisampledにtrueを設定する。
-
-
entry.
textureに textureLayout を設定する。
-
-
resource がストレージテクスチャバインディングの場合:
-
storageTextureLayout を新しい
GPUStorageTextureBindingLayoutとする。 -
storageTextureLayout.
formatに resource のフォーマットを設定する。 -
storageTextureLayout.
viewDimensionに resource の次元を設定する。 -
アクセスモードが:
read-
textureLayout.
accessに"read-only"を設定する。 write-
textureLayout.
accessに"write-only"を設定する。 read_write-
textureLayout.
accessに"read-write"を設定する。
-
entry.
storageTextureに storageTextureLayout を設定する。
-
-
groupCount を max(groupCount, group + 1) にする。
-
groupDescs[group] に
bindingが binding と等しい entry previousEntry がある場合:-
entry の
visibilityが previousEntry と異なる場合:-
entry.
visibilityでセットされたビットを previousEntry.visibilityに追加する。
-
-
resource がバッファバインディングで、entry の
buffer.minBindingSizeが previousEntry より大きい場合:-
previousEntry.
buffer.minBindingSizeに entry.buffer.minBindingSizeを設定する。
-
-
resource がサンプリングテクスチャバインディングで、entry の
texture.sampleTypeが previousEntry と異なり、かつ両方ともsampleTypeが"float"または"unfilterable-float"の場合:-
previousEntry.
texture.sampleTypeに"float"を設定する。
-
-
その他のプロパティが entry と previousEntry の間で異なる場合:
-
nullを返す(パイプライン生成は失敗する)。
-
-
resource がストレージテクスチャバインディングで、 entry.storageTexture.
accessが"read-write"、 previousEntry.storageTexture.accessが"write-only"、 かつ previousEntry.storageTexture.formatが § 26.1.1 プレーンカラー形式テーブルに従ってSTORAGE_BINDINGと"read-write"に互換性がある場合:-
previousEntry.storageTexture.
accessを"read-write"に設定する。
それ以外の場合:
-
entry を groupDescs[group] に追加する。
-
-
-
-
-
groupLayouts を新しいリストとする。
-
i を 0 から groupCount - 1 まで順に:
-
groupDesc を groupDescs[i] とする。
-
bindGroupLayout を device.
createBindGroupLayout()(groupDesc) の結果とする。 -
bindGroupLayout.
[[exclusivePipeline]]に pipeline を設定する。 -
bindGroupLayout を groupLayouts に追加する。
-
-
desc を新しい
GPUPipelineLayoutDescriptorとする。 -
desc.
bindGroupLayoutsに groupLayouts を設定する。 -
device.
createPipelineLayout()(desc) を返す。
10.1.2. GPUProgrammableStage
GPUProgrammableStage
は、ユーザーが提供した
GPUShaderModule
内でパイプラインのプログラム可能ステージの1つを制御するエントリーポイントを記述します。
エントリーポイント名はWGSL識別子比較で定義された規則に従います。
dictionary GPUProgrammableStage {required GPUShaderModule module ;USVString entryPoint ;record <USVString ,GPUPipelineConstantValue >constants = {}; };typedef double GPUPipelineConstantValue ; // WGSLのbool, f32, i32, u32, および有効ならf16を表す場合がある。
GPUProgrammableStage
には以下のメンバーがあります:
module, 型 GPUShaderModule-
このプログラム可能ステージが実行するコードを含む
GPUShaderModuleです。 entryPoint, 型 USVString-
module内でこのステージが処理を行う関数名。注:
entryPointは必須ではないため、GPUProgrammableStageを受け取るメソッドは "get the entry point"アルゴリズムを使って どのエントリーポイントを指しているか決定しなければなりません。 constants, 型 record<USVString, GPUPipelineConstantValue>, デフォルト値{}-
シェーダーモジュール
module内の パイプラインオーバーライド可能定数の値を指定します。各パイプラインオーバーライド可能定数は、 1つの パイプラインオーバーライド定数識別子文字列で一意に識別されます。宣言でIDが指定されている場合はパイプライン定数ID、そうでなければ定数の識別子名です。
各キーバリューペアのキーは、 識別子文字列と一致しなければならず、 比較はWGSL識別子比較の規則に従います。 パイプライン実行時、その定数は指定された値を持ちます。
値は
GPUPipelineConstantValue(double)として指定されます。 WGSL型へ変換され、 定数の型がbool/i32/u32/f32/f16のいずれかになります。 変換に失敗した場合はバリデーションエラーが生成されます。WGSLで定義されたパイプラインオーバーライド可能定数:@id ( 0 ) override has_point_light : bool= true ; // アルゴリズム制御用。 @id ( 1200 ) override specular_param : f32= 2.3 ; // 数値制御。 @id ( 1300 ) override gain : f32; // 必ずオーバーライドされる必要あり。 override width : f32= 0.0 ; // APIレベルで指定 // 名前 "width" を使う。 override depth : f32; // APIレベルで指定 // 名前 "depth"。 // 必ずオーバーライドされる必要あり。 override height = 2 * depth ; // デフォルト値 // (APIレベルでセットされてなければ)、 // 他のオーバーライド可能定数に依存。 対応するJavaScriptコード、必須オーバーライドのみ提供:
{ // ... constants: { 1300 : 2.0 , // "gain" depth: - 1 , // "depth" } } 全ての定数をオーバーライドする場合のJavaScriptコード:
{ // ... constants: { 0 : false , // "has_point_light" 1200 : 3.0 , // "specular_param" 1300 : 2.0 , // "gain" width: 20 , // "width" depth: - 1 , // "depth" height: 15 , // "height" } }
GPUShaderStage
stage,
GPUProgrammableStage
descriptor) のデバイスタイムライン手順:
-
descriptor.
entryPointが指定されている場合:-
descriptor.
moduleに、 名前が descriptor.entryPointと一致し、 シェーダーステージが stage と一致するエントリーポイントが含まれているなら、 そのエントリーポイントを返す。そうでなければ
nullを返す。
そうでない場合:
-
descriptor.
module内で、シェーダーステージが stage と一致するエントリーポイントがちょうど1つだけある場合、そのエントリーポイントを返す。そうでなければ
nullを返す。
-
引数:
-
GPUShaderStagestage -
GPUProgrammableStagedescriptor -
GPUPipelineLayoutlayout -
GPUDevicedevice
以下の手順のすべての要件が満たされていなければならない。
どれかが満たされない場合はfalseを返し、すべて満たされていればtrueを返す。
-
descriptor.
moduleは device に対して valid to use with でなければならない。 -
entryPoint を get the entry point(stage, descriptor) とする。
-
entryPoint は
nullであってはならない。 -
entryPoint により 静的に使用される各 binding について:
-
validating shader binding(binding, layout) は
trueを返さなければならない。
-
-
任意の シェーダーステージの関数(entryPoint から辿れる)へのテクスチャ組み込み関数の各呼び出し call について:
-
textureBinding を call で使われるテクスチャバインディングとする。
-
もし textureBinding が sampled texture または depth texture 型であり、 call が
sampler型(sampler_comparisonを除く) のサンプラーバインディング samplerBinding を使う場合:-
texture を textureBinding に対応する
GPUBindGroupLayoutEntryとする。 -
sampler を samplerBinding に対応する
GPUBindGroupLayoutEntryとする。 -
もし sampler.
typeが"filtering"なら、texture.sampleTypeは"float"でなければならない。
注意:
"comparison"サンプラーは"depth"テクスチャでのみ使用できます。なぜなら WGSLtexture_depth_*バインディングにバインドできる唯一のテクスチャ型だからです。 -
-
もし device.
[[features]]が "core-features-and-limits""core-features-and-limits"を含まない場合:-
call が
textureLoadの呼び出しであれば、 textureBinding は depth texture 型であってはならない。 -
call がサンプラーバインディング samplerBinding を使い、かつ textureBinding が depth texture 型なら、 samplerBinding は
sampler_comparison型でなければならない。
-
-
-
descriptor.
constantsに含まれる各 key → value について:-
key は、シェーダーモジュール descriptor.
moduleに定義されている ある pipeline-overridable 定数の pipeline-overridable constant identifier string と WGSL識別子比較により一致しなければならない。 その定数が T 型とする。 ※この定数は entryPoint によって 静的に使用 されている必要はない。 -
IDL値 value を to WGSL type T へ変換する際に
TypeErrorが 投げられてはならない。
-
-
entryPoint により pipeline-overridable constant identifier string key が 静的に使用されている場合:
-
もし key で特定される pipeline-overridable 定数が デフォルト値 を持たないならば、 descriptor.
constantsは key を含んでいなければならない。
-
-
もし device.
[[features]]が "core-features-and-limits""core-features-and-limits"を含まない場合:-
sum を 0 にする。
-
任意の シェーダーステージの関数(entryPoint から辿れる)でテクスチャ組み込み関数呼び出し時に使われる一意なテクスチャ/外部テクスチャバインディング textureBinding 毎に:
-
samplerBindings を、任意のテクスチャ組み込み関数呼び出しで textureBinding と一緒に使われる全てのサンプラーバインディングの集合とする。
-
numPairs を
max(1, samplerBindings の要素数)とする。 -
もし textureBinding が外部テクスチャバインディングであれば:
-
numPairs を
1 + 3 * numPairsとする。
-
-
sum を
sum + numPairsにする。
-
-
sum は device.limits.
maxSampledTexturesPerShaderStage以下でなければならない。 -
sum は device.limits.
maxSamplersPerShaderStage以下でなければならない。
-
引数:
-
シェーダーバインディング宣言 variable、シェーダーモジュールから反映されたモジュールスコープ変数宣言
-
GPUPipelineLayoutlayout
bindGroup をバインドグループインデックス、bindIndex をバインディングインデックスとして、シェーダーバインディング宣言 variable から求める。
下記すべての条件が満たされる場合 true を返す:
-
layout.
[[bindGroupLayouts]][bindGroup] にGPUBindGroupLayoutEntryentry が含まれ、かつ entry.binding== bindIndex である。 -
entry に対して定義されている binding member が以下の場合:
buffer-
"uniform"-
variable はアドレス空間
uniformで宣言されている。 "storage"-
variable はアドレス空間
storageかつアクセスモードread_writeで宣言されている。 "read-only-storage"-
variable はアドレス空間
storageかつアクセスモードreadで宣言されている。
もし entry.
buffer.minBindingSizeが0でない場合、その値はシェーダー中の対応バッファバインディング変数に対する最小バッファバインディングサイズ以上でなければならない。 sampler-
"filtering"または"non-filtering"-
variable の型は
samplerです。 "comparison"-
variable の型は
sampler_comparisonです。
texture-
entry.
texture.multisampledがtrueの場合に限り、variable の型はtexture_multisampled_2d<T>またはtexture_depth_multisampled_2d<T>である。entry.
texture.sampleTypeが以下の場合:"float","unfilterable-float","sint"または"uint"-
variable は次のいずれかの型を持つ:
-
texture_1d<T> -
texture_2d<T> -
texture_2d_array<T> -
texture_cube<T> -
texture_cube_array<T> -
texture_3d<T> -
texture_multisampled_2d<T>
もし entry.
texture.sampleTypeが以下の場合:"float"または"unfilterable-float"-
サンプリング型
Tはf32です。 "sint"-
サンプリング型
Tはi32です。 "uint"-
サンプリング型
Tはu32です。
-
"depth"-
variable は次のいずれかの型を持つ:
-
texture_2d<T> -
texture_2d_array<T> -
texture_cube<T> -
texture_cube_array<T> -
texture_multisampled_2d<T> -
texture_depth_2d -
texture_depth_2d_array -
texture_depth_cube -
texture_depth_cube_array -
texture_depth_multisampled_2d
ここで、サンプリング型
Tはf32です。 -
entry.
texture.viewDimensionが以下の場合:"1d"-
variable の型は
texture_1d<T>です。 "2d"-
variable の型は
texture_2d<T>またはtexture_multisampled_2d<T>です。 "2d-array"-
variable の型は
texture_2d_array<T>です。 "cube"-
variable の型は
texture_cube<T>です。 "cube-array"-
variable の型は
texture_cube_array<T>です。 "3d"-
variable の型は
texture_3d<T>です。
storageTexture-
entry.
storageTexture.viewDimensionが以下の場合:"1d"-
variable の型は
texture_storage_1d<T, A>です。 "2d"-
variable の型は
texture_storage_2d<T, A>です。 "2d-array"-
variable の型は
texture_storage_2d_array<T, A>です。 "3d"-
variable の型は
texture_storage_3d<T, A>です。
entry.
storageTexture.accessが以下の場合:"write-only"-
アクセスモード
Aはwriteです。 "read-only"-
アクセスモード
Aはreadです。 "read-write"-
アクセスモード
Aはread_writeまたはwriteです。
テクセルフォーマット
Tは entry.storageTexture.formatに等しい。
-
T を store型(格納型)とする。
-
もし T がランタイムサイズ配列、またはランタイムサイズ配列を含む場合、 その
array<E>をarray<E, 1>に置き換える。注: これにより常に1要素分のメモリが確保され、配列インデックスを配列長にクランプすることで、メモリ内アクセスが保証されます。
-
SizeOf(T) を返す。
注: この下限を強制することで、バッファ変数による読み書きはバッファの境界領域内のメモリだけにアクセスすることが保証されます。
10.2. GPUComputePipeline
GPUComputePipeline
は、コンピュートシェーダーステージを制御し、
パイプラインの一種であり、
GPUComputePassEncoder
で使用できます。
コンピュートの入力・出力はすべてバインディングに格納され、
指定された GPUPipelineLayout
に従います。
出力は buffer
バインディング(型が "storage")
や storageTexture
バインディング(型が
"write-only"
または
"read-write")
に対応します。
コンピュートパイプラインのステージ:
-
コンピュートシェーダー
[Exposed =(Window ,Worker ),SecureContext ]interface GPUComputePipeline { };GPUComputePipeline includes GPUObjectBase ;GPUComputePipeline includes GPUPipelineBase ;
10.2.1. コンピュートパイプラインの生成
GPUComputePipelineDescriptor
はコンピュートパイプラインを記述します。詳細は
§ 23.1 計算処理を参照してください。
dictionary :GPUComputePipelineDescriptor GPUPipelineDescriptorBase {required GPUProgrammableStage compute ; };
GPUComputePipelineDescriptor
には以下のメンバーがあります:
compute, 型 GPUProgrammableStage-
パイプラインのコンピュートシェーダーのエントリーポイントを記述します。
createComputePipeline(descriptor)-
即時パイプライン生成で
GPUComputePipelineを作成します。呼び出し元:GPUDevicethis.引数:
GPUDevice.createComputePipeline(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPUComputePipelineDescriptor✘ ✘ 作成する GPUComputePipelineの説明。戻り値:
GPUComputePipelineコンテンツタイムラインの手順:
-
pipeline を ! 新しいWebGPUオブジェクトの作成(this,
GPUComputePipeline, descriptor) とする。 -
initialization steps を デバイスタイムライン上で実行する。
-
pipeline を返す。
デバイスタイムライン initialization steps:-
layout を descriptor.
layoutが"auto"なら デフォルトパイプラインレイアウトの新規生成結果、 そうでなければ descriptor.layoutとする。 -
以下のすべての要件が満たされていなければならない。 どれかが満たされない場合はバリデーションエラーを生成し、pipelineを無効化して終了する。
-
layout は thisに対して有効でなければならない。
-
GPUProgrammableStageの検証(
COMPUTE, descriptor.compute, layout, this) が成功しなければならない。 -
entryPoint を get the entry point(
COMPUTE, descriptor.compute) とする。Assert entryPoint は
nullであってはならない。 -
workgroupStorageUsed を entryPoint がworkgroupアドレス空間を持ち 静的に使用されるすべての型 T について、 roundUp(16, SizeOf(T)) の合計とする。
workgroupStorageUsed は device.limits.
maxComputeWorkgroupStorageSize以下でなければならない。 -
entryPoint は device.limits.
maxComputeInvocationsPerWorkgroup以下のinvocation数でなければならない。 -
entryPoint の
workgroup_size属性の各成分は、 [device.limits.maxComputeWorkgroupSizeX, device.limits.maxComputeWorkgroupSizeY, device.limits.maxComputeWorkgroupSizeZ] の対応する成分以下でなければならない。
-
-
パイプライン生成の実装により パイプライン生成 未分類エラーが発生した場合は、 内部エラーを生成し、pipelineを無効化して終了する。
注: 実装がシェーダーモジュール生成時に未分類エラーを検出した場合でも、 エラーはここで通知されます。
-
pipeline.
[[layout]]に layout を設定する。
-
createComputePipelineAsync(descriptor)-
非同期パイプライン生成で
GPUComputePipelineを作成します。 返されるPromiseは、作成されたパイプラインが追加の待機なしで使用可能になったときに解決されます。パイプライン生成が失敗した場合、返される
PromiseはGPUPipelineErrorで reject されます。 (GPUErrorはデバイスにdispatchされません。)注: このメソッドは、可能な限り利用するのが推奨されます。パイプラインのコンパイルによる キュータイムライン のブロックを防ぐためです。
呼び出し元:GPUDevicethis.引数:
GPUDevice.createComputePipelineAsync(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPUComputePipelineDescriptor✘ ✘ 作成する GPUComputePipelineの説明。戻り値:
Promise<GPUComputePipeline>コンテンツタイムラインの手順:
-
現在の コンテンツタイムライン を contentTimeline とする。
-
promise を新しいPromiseとして生成する。
-
initialization steps を デバイスタイムライン上で実行する。
-
promise を返す。
デバイスタイムライン initialization steps:-
pipeline を新しい
GPUComputePipelineとし、this.createComputePipeline()を descriptor で呼び出した場合と同様に生成し、ただしエラーはdeviceにdispatchするのではなくerrorとして捕捉する。 -
pipelineの パイプライン生成 (成功・失敗問わず)完了時に event が発生する。
-
タイムラインイベントを監視 event を this.
[[device]]で発生させ、以降の手順は デバイスタイムライン上で処理する。
デバイスタイムラインの手順:-
pipeline が 有効 または this が 失われている場合:
-
以下の手順を contentTimeline 上で実行:
コンテンツタイムラインの手順:-
promise を pipeline で解決する。
-
-
終了。
注: 失われたデバイスからはエラーは生成されません。 § 22 エラーとデバッグ参照。
-
-
pipeline が 無効 かつ error が 内部エラーの場合は、以下の手順を contentTimeline 上で実行して終了。
コンテンツタイムラインの手順:-
promise を
GPUPipelineErrorのreasonとして"internal"で reject する。
-
-
pipeline が 無効 かつ error が バリデーションエラーの場合は、以下の手順を contentTimeline 上で実行して終了。
コンテンツタイムラインの手順:-
promise を
GPUPipelineErrorのreasonとして"validation"で reject する。
-
-
GPUComputePipeline
の作成例:
const computePipeline= gpuDevice. createComputePipeline({ layout: pipelineLayout, compute: { module: computeShaderModule, entryPoint: 'computeMain' , } });
10.3. GPURenderPipeline
GPURenderPipeline
はパイプラインの一種であり、
バーテックス・フラグメントシェーダーステージを制御します。
GPURenderPassEncoder
や GPURenderBundleEncoder
で使用できます。
レンダーパイプラインの入力:
-
指定された
GPUPipelineLayoutに従うバインディング -
GPUVertexStateで記述される頂点・インデックスバッファ -
GPUColorTargetStateで記述されるカラ―アタッチメント -
任意で、
GPUDepthStencilStateで記述されるデプスステンシルアタッチメント
レンダーパイプラインの出力:
-
storageTextureバインディング(accessが"write-only"または"read-write") -
GPUColorTargetStateで記述されるカラ―アタッチメント -
任意で、
GPUDepthStencilStateで記述されるデプスステンシルアタッチメント
レンダーパイプラインは以下のレンダーステージから構成されます:
-
頂点フェッチ(
GPUVertexState.buffersで制御) -
バーテックスシェーダー(
GPUVertexStateで制御) -
プリミティブアセンブリ(
GPUPrimitiveStateで制御) -
ラスタライズ(
GPUPrimitiveState、GPUDepthStencilState、GPUMultisampleStateで制御) -
フラグメントシェーダー(
GPUFragmentStateで制御) -
ステンシルテスト・操作(
GPUDepthStencilStateで制御) -
デプステスト・書き込み(
GPUDepthStencilStateで制御) -
出力マージ(
GPUFragmentState.targetsで制御)
[Exposed =(Window ,Worker ),SecureContext ]interface GPURenderPipeline { };GPURenderPipeline includes GPUObjectBase ;GPURenderPipeline includes GPUPipelineBase ;
GPURenderPipeline
には以下のデバイスタイムラインプロパティがあります:
[[descriptor]], 型GPURenderPipelineDescriptor, 読み取り専用-
このパイプラインを記述する
GPURenderPipelineDescriptor。GPURenderPipelineDescriptorのすべてのオプションフィールドが定義されています。 [[writesDepth]], 型boolean, 読み取り専用-
パイプラインがデプス/ステンシルアタッチメントのデプス成分に書き込む場合はtrue
[[writesStencil]], 型boolean, 読み取り専用-
パイプラインがデプス/ステンシルアタッチメントのステンシル成分に書き込む場合はtrue
10.3.1. レンダーパイプラインの生成
GPURenderPipelineDescriptor
は、各レンダーステージを構成することでレンダーパイプラインを記述します。詳細は§ 23.2 レンダリングを参照してください。
dictionary :GPURenderPipelineDescriptor GPUPipelineDescriptorBase {required GPUVertexState vertex ;GPUPrimitiveState primitive = {};GPUDepthStencilState depthStencil ;GPUMultisampleState multisample = {};GPUFragmentState fragment ; };
GPURenderPipelineDescriptor
には以下のメンバーがあります:
vertex, 型 GPUVertexState-
パイプラインのバーテックスシェーダーのエントリーポイントと、その入力バッファレイアウトを記述します。
primitive, 型 GPUPrimitiveState、デフォルト値{}-
パイプラインのプリミティブ関連プロパティを記述します。
depthStencil, 型 GPUDepthStencilState-
オプションのデプスステンシルプロパティ(テスト・操作・バイアス)を記述します。
multisample, 型 GPUMultisampleState、デフォルト値{}-
パイプラインのマルチサンプリングプロパティを記述します。
fragment, 型 GPUFragmentState-
パイプラインのフラグメントシェーダーのエントリーポイントと、その出力カラ―を記述します。指定されていない場合は、§ 23.2.8 カラー出力なしモードとなります。
createRenderPipeline(descriptor)-
即時パイプライン生成で
GPURenderPipelineを作成します。呼び出し元:GPUDevicethis.引数:
GPUDevice.createRenderPipeline(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPURenderPipelineDescriptor✘ ✘ 作成する GPURenderPipelineの説明。戻り値:
GPURenderPipelineコンテンツタイムラインの手順:
-
もし descriptor.
fragmentが 指定されている場合:-
各 non-
nullcolorState について、 descriptor.fragment.targetsの要素ごとに:-
? Validate texture format required features を colorState.
formatと this.[[device]]で実行する。
-
-
-
もし descriptor.
depthStencilが 指定されている場合:-
? Validate texture format required features を descriptor.
depthStencil.formatと this.[[device]]で実行する。
-
-
pipeline を ! create a new WebGPU object(this,
GPURenderPipeline, descriptor) に設定する。 -
this の Device timeline で initialization steps を実施する。
-
pipeline を返す。
デバイスタイムライン initialization steps:-
layout を descriptor.
layoutが"auto"なら デフォルトパイプラインレイアウトの新規生成結果、 そうでなければ descriptor.layoutとする。 -
以下すべての要件が満たされていなければならない。 どれかが満たされない場合はバリデーションエラーを生成し、pipelineを無効化して終了する。
-
layout は thisに対して有効でなければならない。
-
GPURenderPipelineDescriptorの検証(descriptor, layout, this) が成功しなければならない。
-
vertexBufferCount を descriptor.
vertex.buffersの最後の非nullエントリのインデックス+1(なければ0)とする。 -
layout.
[[bindGroupLayouts]].size+vertexBufferCount は this.[[device]].[[limits]].maxBindGroupsPlusVertexBuffers以下でなければならない。
-
-
パイプライン生成の実装により パイプライン生成 未分類エラーが発生した場合は、 内部エラーを生成し、pipelineを無効化して終了する。
注: 実装がシェーダーモジュール生成時に未分類エラーを検出した場合でも、 エラーはここで通知されます。
-
pipeline.
[[descriptor]]に descriptor を設定する。 -
pipeline.
[[writesDepth]]に false を設定する。 -
pipeline.
[[writesStencil]]に false を設定する。 -
depthStencil を descriptor.
depthStencilとする。 -
depthStencil が null でない場合:
-
depthStencil.
depthWriteEnabledが指定されている場合:-
pipeline.
[[writesDepth]]に depthStencil.depthWriteEnabledを設定する。
-
-
depthStencil.
stencilWriteMaskが 0 でない場合:-
stencilFront を depthStencil.
stencilFrontとする。 -
stencilBack を depthStencil.
stencilBackとする。 -
cullMode が
"front"でない場合、 stencilFront.passOp、 stencilFront.depthFailOp、 stencilFront.failOpのいずれかが"keep"でない場合:-
pipeline.
[[writesStencil]]に true を設定する。
-
-
cullMode が
"back"でない場合、 stencilBack.passOp、 stencilBack.depthFailOp、 stencilBack.failOpのいずれかが"keep"でない場合:-
pipeline.
[[writesStencil]]に true を設定する。
-
-
-
-
pipeline.
[[layout]]に layout を設定する。
-
createRenderPipelineAsync(descriptor)-
非同期パイプライン生成で
GPURenderPipelineを作成します。 返されるPromiseは、作成されたパイプラインが追加の待機なしで使用可能になったときに解決されます。パイプライン生成が失敗した場合、返される
PromiseはGPUPipelineErrorで reject されます。 (GPUErrorはデバイスにdispatchされません。)注: このメソッドは、可能な限り利用するのが推奨されます。パイプラインのコンパイルによる キュータイムライン のブロックを防ぐためです。
呼び出し元:GPUDevicethis.引数:
GPUDevice.createRenderPipelineAsync(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPURenderPipelineDescriptor✘ ✘ 作成する GPURenderPipelineの説明。戻り値:
Promise<GPURenderPipeline>コンテンツタイムラインの手順:
-
現在の コンテンツタイムライン を contentTimeline とする。
-
promise を新しいPromiseとして生成する。
-
initialization steps を デバイスタイムライン上で実行する。
-
promise を返す。
デバイスタイムライン 初期化ステップ:-
pipeline を新しい
GPURenderPipelineとし、this.createRenderPipeline()を descriptor で呼び出した場合と同様に生成し、ただしエラーはdeviceにdispatchするのではなくerrorとして捕捉する。 -
pipelineの パイプライン生成 (成功・失敗問わず)完了時に event が発生する。
-
タイムラインイベントを監視 event を this.
[[device]]で発生させ、以降の手順は デバイスタイムライン上で処理する。
デバイスタイムラインの手順:-
pipeline が 有効 または this が 失われている場合:
-
以下の手順を contentTimeline 上で実行:
コンテンツタイムラインの手順:-
promise を pipeline で解決する。
-
-
終了。
注: 失われたデバイスからはエラーは生成されません。 § 22 エラーとデバッグ参照。
-
-
pipeline が 無効 かつ error が 内部エラーの場合は、以下の手順を contentTimeline 上で実行して終了。
コンテンツタイムラインの手順:-
promise を
GPUPipelineErrorのreasonとして"internal"で reject する。
-
-
pipeline が 無効 であり、 error が バリデーションエラー の場合、 以下の手順を contentTimeline 上で実行して終了する。
コンテンツタイムラインの手順:-
promise を
GPUPipelineErrorのreasonとして"validation"で reject する。
-
-
引数:
-
GPURenderPipelineDescriptordescriptor -
GPUPipelineLayoutlayout -
GPUDevicedevice
Device timeline の手順:
-
以下すべての条件が満たされた場合、
trueを返す:-
validating GPUVertexState(device, descriptor.
vertex, layout) が成功すること。 -
もし descriptor.
fragmentが 指定されている場合:-
validating GPUFragmentState(device, descriptor.
fragment, layout) が成功すること。 -
もし sample_mask 組み込みが descriptor.
fragmentの シェーダーステージ出力の場合:-
descriptor.
multisample.alphaToCoverageEnabledがfalseであること。
-
-
もし frag_depth 組み込みが descriptor.
fragmentの シェーダーステージ出力の場合:-
descriptor.
depthStencilが 指定されており、かつ descriptor.depthStencil.formatが depth アスペクトを持つこと。
-
-
もし device.
[[features]]が "core-features-and-limits""core-features-and-limits"を含まない場合:-
sample_mask 組み込みは descriptor.
fragmentの シェーダーステージ入力 または シェーダーステージ出力 であってはならない。 -
sample_index 組み込みは descriptor.
fragmentの シェーダーステージ入力 であってはならない。
-
-
-
validating GPUPrimitiveState(descriptor.
primitive, device) が成功すること。 -
もし descriptor.
depthStencilが 指定されている場合:-
validating GPUDepthStencilState(device, descriptor.
depthStencil, descriptor.primitive.topology) が成功すること。
-
-
validating GPUMultisampleState(descriptor.
multisample) が成功すること。 -
もし descriptor.
multisample.alphaToCoverageEnabledが true の場合: -
以下のいずれか少なくとも1つのアタッチメントが存在すること:
-
または descriptor.
depthStencilが指定されている
-
validating inter-stage interfaces(device, descriptor) が
trueを返すこと。
-
引数:
-
シェーダーバインディング宣言 variable(シェーダーモジュールから反映されたモジュールスコープ変数宣言)
戻り値: boolean
Device timeline の手順:
-
variable の interpolation が linear の場合、
falseを返す。 -
variable の interpolation が flat かつ interpolation sampling が either でない場合、
falseを返す。 -
variable の interpolation sampling が sample の場合、
falseを返す。 -
trueを返す。
引数:
-
GPUDevicedevice -
GPURenderPipelineDescriptordescriptor
戻り値: boolean
Device timeline の手順:
-
maxVertexShaderOutputVariables を device.limits.
maxInterStageShaderVariablesに設定する。 -
maxVertexShaderOutputLocation を device.limits.
maxInterStageShaderVariables- 1 に設定する。 -
もし descriptor.
primitive.topologyが"point-list"の場合:-
maxVertexShaderOutputVariables を 1 減らす。
-
-
もし clip_distances が descriptor.
vertexの出力で宣言されている場合:-
clipDistancesSize を clip_distances の配列サイズとする。
-
maxVertexShaderOutputVariables を ceil(clipDistancesSize / 4) 減らす。
-
maxVertexShaderOutputLocation を ceil(clipDistancesSize / 4) 減らす。
-
-
以下のいずれかが満たされない場合は
falseを返す: -
もし device.
[[features]]が "core-features-and-limits""core-features-and-limits"を含まない場合:-
descriptor.
vertexの各ユーザー定義 output について-
Compatibility Mode シェーダーバインディングの検証(output) が失敗した場合、
falseを返す。
-
-
-
もし descriptor.
fragmentが 指定されている場合:-
maxFragmentShaderInputVariables を device.limits.
maxInterStageShaderVariablesに設定する。 -
descriptor.
fragmentの入力として使われる Inter-Stage Builtins ごとに:-
maxFragmentShaderInputVariables を 1 減らす。
-
-
以下のいずれかが満たされない場合、
falseを返す:-
descriptor.
fragmentの各ユーザー定義入力に対し、 descriptor.vertexのユーザー定義出力で、その location、型、interpolation が一致するものがあること。注意: 頂点のみパイプラインでも頂点ステージでユーザー定義出力を持つことができ、その値は破棄される。
-
descriptor.
fragmentのユーザー定義入力の数が maxFragmentShaderInputVariables 以下であること。
-
-
アサート: descriptor.
fragmentの各ユーザー定義入力の location が device.limits.maxInterStageShaderVariablesより小さい(これは上記ルールの帰結) -
もし device.
[[features]]が 含まれていない 場合、"core-features-and-limits":-
descriptor.
fragmentの各ユーザー定義 input について-
Compatibility Mode シェーダーバインディングの検証(input) が失敗したら、
falseを返す。
-
-
-
-
trueを返す。
以下の組み込み値は、インターステージ組み込み値であり、フラグメントシェーダーで使用される場合、maxInterStageShaderVariablesの上限にカウントされる:
-
front_facing -
sample_index -
sample_mask -
primitive_index -
subgroup_invocation_id -
subgroup_size
GPURenderPipeline
の作成例:
const renderPipeline= gpuDevice. createRenderPipeline({ layout: pipelineLayout, vertex: { module: shaderModule, entryPoint: 'vertexMain' }, fragment: { module: shaderModule, entryPoint: 'fragmentMain' , targets: [{ format: 'bgra8unorm' , }], } });
10.3.2. プリミティブ状態
dictionary {GPUPrimitiveState GPUPrimitiveTopology topology = "triangle-list";GPUIndexFormat stripIndexFormat ;GPUFrontFace frontFace = "ccw";GPUCullMode cullMode = "none"; // Requires "depth-clip-control" feature.boolean unclippedDepth =false ; };
GPUPrimitiveState
には以下のメンバーがあり、GPURenderPipeline
が頂点入力からプリミティブを構築しラスタライズする方法を記述します:
topology, 型 GPUPrimitiveTopology、デフォルト値"triangle-list"-
頂点入力から構築するプリミティブの種類。
stripIndexFormat, 型 GPUIndexFormat-
ストリップトポロジー (
"line-strip"または"triangle-strip") のパイプラインに対して、インデックスバッファのフォーマットとプリミティブリスタート値 ("uint16"/0xFFFFまたは"uint32"/0xFFFFFFFF) を決定します。非ストリップトポロジーのパイプラインでは指定できません。注: 一部の実装では、プリミティブリスタート値の知識がパイプライン状態オブジェクトのコンパイルに必要です。
ストリップトポロジーのパイプラインをインデックス付きドローコール (
drawIndexed()またはdrawIndexedIndirect()) で使う場合、これを設定する必要があり、ドローコールで使うインデックスバッファのフォーマット (setIndexBuffer()で設定) と一致しなければなりません。詳細は § 23.2.3 プリミティブアセンブリ を参照してください。
frontFace, 型 GPUFrontFace、デフォルト値"ccw"-
どのポリゴンが表面とみなされるかを定義します。
cullMode, 型 GPUCullMode、デフォルト値"none"-
どのポリゴン方向をカリングするか(除去するか)を定義します。
unclippedDepth, 型 boolean、デフォルト値false-
true の場合、深度クリッピングが無効化されます。
"depth-clip-control"機能が有効化されている必要があります。
-
GPUPrimitiveStatedescriptor -
GPUDevicedevice
Device timeline の手順:
-
以下すべての条件を満たせば、
trueを返す:-
もし descriptor.
topologyが"line-strip"または"triangle-strip"でない場合:-
descriptor.
stripIndexFormatは 指定されていてはならない。
-
-
もし descriptor.
unclippedDepthがtrueなら:-
"depth-clip-control"が device に対して 有効化されている必要がある。
-
-
enum {GPUPrimitiveTopology "point-list" ,"line-list" ,"line-strip" ,"triangle-list" ,"triangle-strip" , };
GPUPrimitiveTopology
は、GPURenderPipeline
で描画コールを行う際に使用されるプリミティブタイプを定義します。詳細は § 23.2.5 ラスタライズ を参照してください:
"point-list"-
各頂点が点プリミティブを定義します。
"line-list"-
連続する2頂点ごとに線プリミティブを定義します。
"line-strip"-
2頂点目以降の各頂点が前の頂点との間に線プリミティブを定義します。
"triangle-list"-
連続する3頂点ごとに三角形プリミティブを定義します。
"triangle-strip"-
3頂点目以降の各頂点が前の2頂点との間に三角形プリミティブを定義します。
enum {GPUFrontFace "ccw" ,"cw" , };
GPUFrontFace
は、GPURenderPipeline
によってどのポリゴンが表面とみなされるかを定義します。詳細は
§ 23.2.5.4 ポリゴンラスタライズ を参照してください:
enum {GPUCullMode "none" ,"front" ,"back" , };
GPUPrimitiveTopology
は、GPURenderPipeline
で描画コールを行う際にどのポリゴンがカリングされるかを定義します。詳細は § 23.2.5.4 ポリゴンラスタライズ を参照してください:
注: GPUFrontFace
および GPUCullMode
は、"point-list"、
"line-list"、
"line-strip"
トポロジーには影響しません。
10.3.3. マルチサンプル状態
dictionary {GPUMultisampleState GPUSize32 count = 1;GPUSampleMask mask = 0xFFFFFFFF;boolean alphaToCoverageEnabled =false ; };
GPUMultisampleState
には以下のメンバーがあり、GPURenderPipeline
がレンダーパスのマルチサンプル付きアタッチメントとどのように相互作用するかを記述します。
count、型 GPUSize32、デフォルト値は1-
ピクセルあたりのサンプル数。この
GPURenderPipelineは、colorAttachmentsやdepthStencilAttachmentなどのアタッチメントテクスチャのsampleCountが一致する場合のみ互換性を持ちます。 mask、型 GPUSampleMask、デフォルト値は0xFFFFFFFF-
どのサンプルに書き込むかを決定するマスク。
alphaToCoverageEnabled、型 boolean、デフォルトはfalse-
trueの場合、フラグメントのアルファチャンネルを使用してサンプルカバレッジマスクを生成することを示します。
-
GPUMultisampleStatedescriptor
Device timeline の手順:
-
次のすべての条件を満たす時、
trueを返す:-
descriptor.
countは 1 または 4 のいずれかでなければならない。 -
もし descriptor.
alphaToCoverageEnabledがtrueの場合:-
descriptor.
countは 1 より大きい。
-
-
10.3.4. フラグメント状態
dictionary :GPUFragmentState GPUProgrammableStage {required sequence <GPUColorTargetState ?>targets ; };
targets, 型sequence<GPUColorTargetState?>-
このパイプラインが書き込むカラ―ターゲットのフォーマットや動作を定義する
GPUColorTargetStateのリスト。
引数:
-
GPUDevicedevice -
GPUFragmentStatedescriptor -
GPUPipelineLayoutlayout
Device timeline の手順:
-
以下の要件がすべて満たされた場合
trueを返す:-
GPUProgrammableStage の検証(
FRAGMENT, descriptor, layout, device ) が成功すること。 -
descriptor.
targets.size は device.[[limits]].maxColorAttachments以下でなければならない。 -
各 シェーダーステージ出力 output について:
-
output の location は device.
[[limits]].maxColorAttachmentsより小さくなければならない。
-
-
entryPoint を get the entry point(
FRAGMENT, descriptor ) とする。 -
usesDualSourceBlending を
falseにする。 -
各 index について descriptor.
targets内の non-null値 colorState を調べる:-
colorState.
formatは § 26.1.1 Plain color formats でRENDER_ATTACHMENT機能を持つものとしてリストされている必要がある。 -
colorState.
writeMaskは 16 未満でなければならない。 -
もし colorState.
blendが 指定されているなら:-
colorState.
blend.colorは 有効な GPUBlendComponent でなければならない。 -
colorState.
blend.alphaも 有効な GPUBlendComponent でなければならない。 -
もし colorState.
blend.color.srcFactorまたは colorState.blend.color.dstFactorまたは colorState.blend.alpha.srcFactorまたは colorState.blend.alpha.dstFactorが対応するブレンドユニットの2番目の入力("src1","one-minus-src1","src1-alpha","one-minus-src1-alpha"のいずれか)を使う場合:-
usesDualSourceBlending を
trueに設定。
-
-
各 シェーダーステージ出力 output で、 location が index であるものについて:
-
colorState.
formatの各コンポーネントごとに、output に対応するコンポーネントがなければならない(RGBAならvec4、RGBならvec3またはvec4、RGならvec2,vec3,vec4)。 -
もし
GPUTextureSampleType(§ 26.1 Texture Format Capabilities)が:"float"および/または"unfilterable-float"-
output は浮動小数点スカラ型でなければならない。
"sint"-
output は符号付き整数スカラ型でなければならない。
"uint"-
output は符号なし整数スカラ型でなければならない。
-
もし colorState.
blendが 指定されていて かつ colorState.blend.color.srcFactorまたは .dstFactorが source alpha ("src-alpha","one-minus-src-alpha","src-alpha-saturated","src1-alpha","one-minus-src1-alpha")なら:-
output はアルファチャンネルを持つ(すなわち vec4 である)こと。
-
-
-
もし colorState.
writeMaskが 0 でない場合:-
entryPoint は シェーダーステージ出力を持ち、 location が index に等しく、 blend_src が省略(あるいは0)であること。
-
-
-
もし usesDualSourceBlending が
trueなら:-
entryPoint の シェーダーステージ出力 のうち location を持つものは全て同一struct内で定義され、 dual source blendingを利用しなければならない。
-
GPUFragmentStateのカラ―アタッチメント1サンプルあたりバイト数の検証( device, descriptor.
targets) が成功すること。 -
もし device.
[[features]]が "core-features-and-limits""core-features-and-limits"を含まない場合:-
全ての non-null
GPUColorTargetStatecolorState について descriptor.targets中で次のメンバー値がすべて等しい必要がある: -
シェーダーステージの関数の各 function について:
-
function は dpdxFine、 dpdyFine、 fwidthFine を使用してはならない。
-
-
-
引数:
-
GPUDevicedevice -
sequence<
GPUColorTargetState?> targets
Device timeline の手順:
-
formats を空の list<
GPUTextureFormat?> とする -
各 target in targets について:
-
カラ―アタッチメント1サンプルあたりバイト数の算出(formats) が device.
[[limits]].maxColorAttachmentBytesPerSample以下でなければならない。
注意: フラグメントシェーダはパイプラインが使用する以上の値を出力することもあります。その場合、値は無視されます。
GPUBlendComponent
component が論理 device
device で以下の場合
有効な
GPUBlendComponent です:
10.3.5. カラ―ターゲット状態
dictionary {GPUColorTargetState required GPUTextureFormat format ;GPUBlendState blend ;GPUColorWriteFlags writeMask = 0xF; // GPUColorWrite.ALL };
format, 型 GPUTextureFormat-
このカラ―ターゲットの
GPUTextureFormat。 パイプラインは、対応するカラ―アタッチメントにこのフォーマットのGPUTextureViewを使うGPURenderPassEncoderとだけ互換性があります。 blend, 型 GPUBlendState-
このカラ―ターゲットのブレンディングの挙動。未定義の場合、ブレンディングは無効化されます。
writeMask, 型 GPUColorWriteFlags、デフォルト値0xF-
このカラ―ターゲットへの描画時に、どのチャンネルに書き込むかを制御するビットマスク。
dictionary {GPUBlendState required GPUBlendComponent color ;required GPUBlendComponent alpha ; };
color, 型 GPUBlendComponent-
対応するレンダーターゲットのカラーチャンネルのブレンディング挙動を定義します。
alpha, 型 GPUBlendComponent-
対応するレンダーターゲットのアルファチャンネルのブレンディング挙動を定義します。
typedef [EnforceRange ]unsigned long ; [GPUColorWriteFlags Exposed =(Window ,Worker ),SecureContext ]namespace {GPUColorWrite const GPUFlagsConstant = 0x1;RED const GPUFlagsConstant = 0x2;GREEN const GPUFlagsConstant = 0x4;BLUE const GPUFlagsConstant = 0x8;ALPHA const GPUFlagsConstant = 0xF; };ALL
10.3.5.1. ブレンド状態
dictionary {GPUBlendComponent GPUBlendOperation operation = "add";GPUBlendFactor srcFactor = "one";GPUBlendFactor dstFactor = "zero"; };
GPUBlendComponent
には以下のメンバーがあり、フラグメントのカラーおよびアルファ成分のブレンド方法を記述します:
operation, 型 GPUBlendOperation、デフォルト値"add"-
ターゲットアタッチメント成分に書き込まれる値の計算に使われる
GPUBlendOperationを定義します。 srcFactor, 型 GPUBlendFactor、デフォルト値"one"-
フラグメントシェーダーからの値に対して行う
GPUBlendFactorの操作を定義します。 dstFactor, 型 GPUBlendFactor、デフォルト値"zero"-
ターゲットアタッチメントからの値に対して行う
GPUBlendFactorの操作を定義します。
以下の表は、あるフラグメント位置でのカラー成分を記述するための記法を示します:
RGBAsrc
| カラ―アタッチメントに対してフラグメントシェーダーが出力したカラー。 シェーダーがアルファチャンネルを返さない場合、src-alpha ブレンドファクターは使用できません。 |
RGBAsrc1
| カラ―アタッチメントに対して、"@blend_src" 属性
が 1 のフラグメントシェーダーのカラー出力。
シェーダーがアルファチャンネルを返さない場合、src1-alpha ブレンドファクターは使用できません。
|
RGBAdst
| カラ―アタッチメントに現在入っているカラー。
グリーン/ブルー/アルファチャンネルがない場合は、デフォルトで 0, 0, 1 となります。
|
RGBAconst
| 現在の [[blendConstant]]。
|
RGBAsrcFactor
| srcFactor
で定義されたソースブレンドファクター成分。
|
RGBAdstFactor
| dstFactor
で定義されたデスティネーションブレンドファクター成分。
|
enum {GPUBlendFactor "zero" ,"one" ,"src" ,"one-minus-src" ,"src-alpha" ,"one-minus-src-alpha" ,"dst" ,"one-minus-dst" ,"dst-alpha" ,"one-minus-dst-alpha" ,"src-alpha-saturated" ,"constant" ,"one-minus-constant" ,"src1" ,"one-minus-src1" ,"src1-alpha" ,"one-minus-src1-alpha" , };
GPUBlendFactor
はソースまたはデスティネーションのブレンドファクターがどのように計算されるかを定義します:
| GPUBlendFactor | ブレンドファクター RGBA 成分 | 機能 |
|---|---|---|
"zero"
| (0, 0, 0, 0)
| |
"one"
| (1, 1, 1, 1)
| |
"src"
| (Rsrc, Gsrc, Bsrc, Asrc)
| |
"one-minus-src"
| (1 - Rsrc, 1 - Gsrc, 1 - Bsrc, 1 - Asrc)
| |
"src-alpha"
| (Asrc, Asrc, Asrc, Asrc)
| |
"one-minus-src-alpha"
| (1 - Asrc, 1 - Asrc, 1 - Asrc, 1 - Asrc)
| |
"dst"
| (Rdst, Gdst, Bdst, Adst)
| |
"one-minus-dst"
| (1 - Rdst, 1 - Gdst, 1 - Bdst, 1 - Adst)
| |
"dst-alpha"
| (Adst, Adst, Adst, Adst)
| |
"one-minus-dst-alpha"
| (1 - Adst, 1 - Adst, 1 - Adst, 1 - Adst)
| |
"src-alpha-saturated"
| (min(Asrc, 1 - Adst), min(Asrc, 1 - Adst), min(Asrc, 1 - Adst), 1)
| |
"constant"
| (Rconst, Gconst, Bconst, Aconst)
| |
"one-minus-constant"
| (1 - Rconst, 1 - Gconst, 1 - Bconst, 1 - Aconst)
| |
"src1"
| (Rsrc1, Gsrc1, Bsrc1, Asrc1)
| dual-source-blending
|
"one-minus-src1"
| (1 - Rsrc1, 1 - Gsrc1, 1 - Bsrc1, 1 - Asrc1)
| |
"src1-alpha"
| (Asrc1, Asrc1, Asrc1, Asrc1)
| |
"one-minus-src1-alpha"
| (1 - Asrc1, 1 - Asrc1, 1 - Asrc1, 1 - Asrc1)
|
enum {GPUBlendOperation "add" ,"subtract" ,"reverse-subtract" ,"min" ,"max" , };
GPUBlendOperation
はソースとデスティネーションのブレンドファクターを組み合わせるアルゴリズムを定義します:
| GPUBlendOperation | RGBA成分 |
|---|---|
"add"
| RGBAsrc × RGBAsrcFactor + RGBAdst × RGBAdstFactor
|
"subtract"
| RGBAsrc × RGBAsrcFactor - RGBAdst × RGBAdstFactor
|
"reverse-subtract"
| RGBAdst × RGBAdstFactor - RGBAsrc × RGBAsrcFactor
|
"min"
| min(RGBAsrc, RGBAdst)
|
"max"
| max(RGBAsrc, RGBAdst)
|
10.3.6. デプス・ステンシル状態
dictionary {GPUDepthStencilState required GPUTextureFormat format ;boolean depthWriteEnabled ;GPUCompareFunction depthCompare ;GPUStencilFaceState stencilFront = {};GPUStencilFaceState stencilBack = {};GPUStencilValue stencilReadMask = 0xFFFFFFFF;GPUStencilValue stencilWriteMask = 0xFFFFFFFF;GPUDepthBias depthBias = 0;float depthBiasSlopeScale = 0;float depthBiasClamp = 0; };
GPUDepthStencilState
には以下のメンバーがあり、GPURenderPipeline
がレンダーパスのdepthStencilAttachment
にどのような影響を与えるかを記述します:
format, 型 GPUTextureFormat-
この
GPURenderPipelineが互換性を持つdepthStencilAttachmentのformat。 depthWriteEnabled, 型 boolean-
この
GPURenderPipelineがdepthStencilAttachmentの深度値を書き換えることができるかを示します。 depthCompare, 型 GPUCompareFunction-
フラグメントの深度値を
depthStencilAttachmentの深度値と比較するための演算方法。 stencilFront, 型 GPUStencilFaceState、デフォルト値{}-
表面プリミティブに対してステンシル比較・操作をどのように行うかを定義します。
stencilBack, 型 GPUStencilFaceState、デフォルト値{}-
裏面プリミティブに対してステンシル比較・操作をどのように行うかを定義します。
stencilReadMask, 型 GPUStencilValue、デフォルト値0xFFFFFFFF-
ステンシル比較テストを行う際に、どの
depthStencilAttachmentのステンシル値ビットを読み取るかを制御するビットマスク。 stencilWriteMask, 型 GPUStencilValue、デフォルト値0xFFFFFFFF-
ステンシル操作を行う際に、どの
depthStencilAttachmentのステンシル値ビットに書き込むかを制御するビットマスク。 depthBias, 型 GPUDepthBias、デフォルト値0-
各三角形フラグメントに加算される定数深度バイアス。詳細はバイアス付きフラグメント深度参照。
depthBiasSlopeScale, 型 float、デフォルト値0-
三角形フラグメントの傾きに応じてスケールされる深度バイアス。詳細はバイアス付きフラグメント深度参照。
depthBiasClamp, 型 float、デフォルト値0-
三角形フラグメントの最大深度バイアス。詳細はバイアス付きフラグメント深度参照。
注: depthBias、
depthBiasSlopeScale、
および
depthBiasClamp
は"point-list"、
"line-list"、
"line-strip"
プリミティブには効果がなく、0でなければなりません。
depthStencilAttachment
attachmentに対して
GPUDepthStencilState
stateを使って描画する際、以下のキュータイムラインの手順で計算されます:
-
r を format における0より大きい最小の正の表現可能値(32ビットfloatに変換)とする。
-
maxDepthSlope をフラグメントの深度値の水平・垂直方向の最大傾きとする。
-
format がunormフォーマットの場合:
-
bias を
(float)state.とする。depthBias* r + state.depthBiasSlopeScale* maxDepthSlope
それ以外でformatがfloatフォーマットの場合:
-
bias を
(float)state.とする。depthBias* 2^(exp(max depth in primitive) - r) + state.depthBiasSlopeScale* maxDepthSlope
-
-
state.
depthBiasClamp>0の場合:-
bias を
min(state.とする。depthBiasClamp, bias)
それ以外で,state.
depthBiasClamp<0の場合:-
bias を
max(state.とする。depthBiasClamp, bias)
-
-
state.
depthBias≠0または state.depthBiasSlopeScale≠0の場合:-
フラグメントの深度値に
fragment depth value + biasを設定する。
-
引数:
-
GPUDevicedevice -
GPUDepthStencilStatedescriptor -
GPUPrimitiveTopologytopology
Device timeline の手順:
-
次のすべての条件が満たされる場合に限り、
trueを返す:-
descriptor.
formatは depth-or-stencil format である。 -
もし descriptor.
depthWriteEnabledがtrueであるか、 descriptor.depthCompareが 指定されていて かつ"always"でない場合:-
descriptor.
formatは depth コンポーネントを持たなければならない。
-
-
もし descriptor.
stencilFrontまたは descriptor.stencilBackがデフォルト値でない場合:-
descriptor.
formatは stencil コンポーネントを持たなければならない。
-
-
もし descriptor.
formatが depth コンポーネントを持つ場合:-
descriptor.
depthWriteEnabledは 指定されている必要がある。 -
以下のいずれかの場合には descriptor.
depthCompareが 指定されていなければならない:-
descriptor.
depthWriteEnabledがtrueである場合 -
descriptor.
stencilFront.depthFailOpが"keep"でない場合 -
descriptor.
stencilBack.depthFailOpが"keep"でない場合
-
-
-
もし topology が
"point-list","line-list", または"line-strip"の場合:-
descriptor.
depthBiasは 0 でなければならない。 -
descriptor.
depthBiasSlopeScaleは 0 でなければならない。 -
descriptor.
depthBiasClampは 0 でなければならない。
-
-
もし device.
[[features]]が "core-features-and-limits""core-features-and-limits"を含まない場合:-
descriptor.
depthBiasClampは 0 でなければなりません。
-
-
dictionary {GPUStencilFaceState GPUCompareFunction compare = "always";GPUStencilOperation failOp = "keep";GPUStencilOperation depthFailOp = "keep";GPUStencilOperation passOp = "keep"; };
GPUStencilFaceState
には以下のメンバーがあり、ステンシル比較と操作の方法を記述します:
compare, 型 GPUCompareFunction、デフォルト値"always"-
フラグメントの
depthStencilAttachmentのステンシル値に対して[[stencilReference]]の値をテストする際に使用されるGPUCompareFunction。 failOp, 型 GPUStencilOperation、デフォルト値"keep"-
compareで記述されるフラグメントステンシル比較テストに失敗した場合に実行されるGPUStencilOperation。 depthFailOp, 型 GPUStencilOperation、デフォルト値"keep"-
depthCompareで記述されるフラグメント深度比較に失敗した場合に実行されるGPUStencilOperation。 passOp, 型 GPUStencilOperation、デフォルト値"keep"-
compareで記述されるフラグメントステンシル比較テストに成功した場合に実行されるGPUStencilOperation。
enum {GPUStencilOperation "keep" ,"zero" ,"replace" ,"invert" ,"increment-clamp" ,"decrement-clamp" ,"increment-wrap" ,"decrement-wrap" , };
GPUStencilOperation
では以下の操作を定義します:
"keep"-
現在のステンシル値を保持します。
"zero"-
ステンシル値を
0に設定します。 "replace"-
ステンシル値を
[[stencilReference]]に設定します。 "invert"-
現在のステンシル値をビット反転します。
"increment-clamp"-
現在のステンシル値をインクリメントし、
depthStencilAttachmentの ステンシルアスペクトの最大表現値までクランプします。 "decrement-clamp"-
現在のステンシル値をデクリメントし、
0までクランプします。 "increment-wrap"-
現在のステンシル値をインクリメントし、値が最大表現値を超えた場合はゼロにラップします(
depthStencilAttachmentの ステンシルアスペクト)。 "decrement-wrap"-
現在のステンシル値をデクリメントし、値が
0未満になった場合はdepthStencilAttachmentの ステンシルアスペクトの最大表現値にラップします。
10.3.7. バーテックス状態
enum {GPUIndexFormat "uint16" ,"uint32" , };
インデックスフォーマットは、バッファ内のインデックス値のデータ型を決定し、ストリッププリミティブトポロジー
("line-strip"
または
"triangle-strip")
で使用される場合は、プリミティブリスタート値も指定します。
プリミティブリスタート値は、
どのインデックス値が新しいプリミティブの開始を示すか(以前のインデックス頂点でストリップを継続するのではなく)を示します。
GPUPrimitiveState
でストリッププリミティブトポロジーを指定する場合、インデックス付き描画に使う場合は
stripIndexFormat
を必ず指定し、パイプライン生成時に使用される
プリミティブリスタート値が分かるようにします。
GPUPrimitiveState
でリストトポロジーを指定する場合は、
インデックス付き描画時にsetIndexBuffer()
で渡したインデックスフォーマットを使います。
| インデックスフォーマット | バイトサイズ | プリミティブリスタート値 |
|---|---|---|
"uint16"
| 2 | 0xFFFF |
"uint32"
| 4 | 0xFFFFFFFF |
10.3.7.1. バーテックスフォーマット
GPUVertexFormat
はバーテックス属性のデータがバーテックスバッファからどのように解釈・シェーダーへ公開されるかを示します。
フォーマット名は成分の順序、各成分のビット数、および成分のバーテックスデータ型を指定します。
各バーテックスデータ型は、 ビット数に関係なく、同じ基本型のWGSLスカラー型にマッピングできます:
| バーテックスフォーマット接頭辞 | バーテックスデータ型 | 対応するWGSL型 |
|---|---|---|
uint
| 符号なし整数 | u32
|
sint
| 符号付き整数 | i32
|
unorm
| 符号なし正規化 | f16, f32
|
snorm
| 符号付き正規化 | |
float
| 浮動小数点 |
複数成分フォーマットでは "x" の後の数字が成分数を示します。バーテックスフォーマットとシェーダー型の成分数が一致しない場合は、成分が切り捨てられるかデフォルト値で埋められます。
"unorm8x2"
のバーテックス属性と、バイト値 [0x7F, 0xFF]
を持つ場合、シェーダーでは以下の型でアクセスできます:
| シェーダー型 | シェーダー値 |
|---|---|
f16
| 0.5h
|
f32
| 0.5f
|
vec2<f16>
| vec2(0.5h, 1.0h)
|
vec2<f32>
| vec2(0.5f, 1.0f)
|
vec3<f16>
| vec2(0.5h, 1.0h, 0.0h)
|
vec3<f32>
| vec2(0.5f, 1.0f, 0.0f)
|
vec4<f16>
| vec2(0.5h, 1.0h, 0.0h, 1.0h)
|
vec4<f32>
| vec2(0.5f, 1.0f, 0.0f, 1.0f)
|
バーテックスフォーマットがシェーダーでどのように公開されるかは § 23.2.2 バーテックス処理 を参照してください。
enum {GPUVertexFormat "uint8" ,"uint8x2" ,"uint8x4" ,"sint8" ,"sint8x2" ,"sint8x4" ,"unorm8" ,"unorm8x2" ,"unorm8x4" ,"snorm8" ,"snorm8x2" ,"snorm8x4" ,"uint16" ,"uint16x2" ,"uint16x4" ,"sint16" ,"sint16x2" ,"sint16x4" ,"unorm16" ,"unorm16x2" ,"unorm16x4" ,"snorm16" ,"snorm16x2" ,"snorm16x4" ,"float16" ,"float16x2" ,"float16x4" ,"float32" ,"float32x2" ,"float32x3" ,"float32x4" ,"uint32" ,"uint32x2" ,"uint32x3" ,"uint32x4" ,"sint32" ,"sint32x2" ,"sint32x3" ,"sint32x4" ,"unorm10-10-10-2" ,"unorm8x4-bgra" , };
| バーテックスフォーマット | データ型 | 成分数 | バイトサイズ | WGSL型例 |
|---|---|---|---|---|
"uint8"
| 符号なし整数 | 1 | 1 | u32
|
"uint8x2"
| 符号なし整数 | 2 | 2 | vec2<u32>
|
"uint8x4"
| 符号なし整数 | 4 | 4 | vec4<u32>
|
"sint8"
| 符号付き整数 | 1 | 1 | i32
|
"sint8x2"
| 符号付き整数 | 2 | 2 | vec2<i32>
|
"sint8x4"
| 符号付き整数 | 4 | 4 | vec4<i32>
|
"unorm8"
| 符号なし正規化 | 1 | 1 | f32
|
"unorm8x2"
| 符号なし正規化 | 2 | 2 | vec2<f32>
|
"unorm8x4"
| 符号なし正規化 | 4 | 4 | vec4<f32>
|
"snorm8"
| 符号付き正規化 | 1 | 1 | f32
|
"snorm8x2"
| 符号付き正規化 | 2 | 2 | vec2<f32>
|
"snorm8x4"
| 符号付き正規化 | 4 | 4 | vec4<f32>
|
"uint16"
| 符号なし整数 | 1 | 2 | u32
|
"uint16x2"
| 符号なし整数 | 2 | 4 | vec2<u32>
|
"uint16x4"
| 符号なし整数 | 4 | 8 | vec4<u32>
|
"sint16"
| 符号付き整数 | 1 | 2 | i32
|
"sint16x2"
| 符号付き整数 | 2 | 4 | vec2<i32>
|
"sint16x4"
| 符号付き整数 | 4 | 8 | vec4<i32>
|
"unorm16"
| 符号なし正規化 | 1 | 2 | f32
|
"unorm16x2"
| 符号なし正規化 | 2 | 4 | vec2<f32>
|
"unorm16x4"
| 符号なし正規化 | 4 | 8 | vec4<f32>
|
"snorm16"
| 符号付き正規化 | 1 | 2 | f32
|
"snorm16x2"
| 符号付き正規化 | 2 | 4 | vec2<f32>
|
"snorm16x4"
| 符号付き正規化 | 4 | 8 | vec4<f32>
|
"float16"
| 浮動小数点 | 1 | 2 | f32
|
"float16x2"
| 浮動小数点 | 2 | 4 | vec2<f16>
|
"float16x4"
| 浮動小数点 | 4 | 8 | vec4<f16>
|
"float32"
| 浮動小数点 | 1 | 4 | f32
|
"float32x2"
| 浮動小数点 | 2 | 8 | vec2<f32>
|
"float32x3"
| 浮動小数点 | 3 | 12 | vec3<f32>
|
"float32x4"
| 浮動小数点 | 4 | 16 | vec4<f32>
|
"uint32"
| 符号なし整数 | 1 | 4 | u32
|
"uint32x2"
| 符号なし整数 | 2 | 8 | vec2<u32>
|
"uint32x3"
| 符号なし整数 | 3 | 12 | vec3<u32>
|
"uint32x4"
| 符号なし整数 | 4 | 16 | vec4<u32>
|
"sint32"
| 符号付き整数 | 1 | 4 | i32
|
"sint32x2"
| 符号付き整数 | 2 | 8 | vec2<i32>
|
"sint32x3"
| 符号付き整数 | 3 | 12 | vec3<i32>
|
"sint32x4"
| 符号付き整数 | 4 | 16 | vec4<i32>
|
"unorm10-10-10-2"
| 符号なし正規化 | 4 | 4 | vec4<f32>
|
"unorm8x4-bgra"
| 符号なし正規化 | 4 | 4 | vec4<f32>
|
enum {GPUVertexStepMode "vertex" ,"instance" , };
ステップモードは、現在のバーテックスまたはインスタンスインデックスに基づいて、バーテックスバッファデータのアドレス計算方法を設定します:
"vertex"-
各バーテックスごとに
arrayStrideでアドレスが進み、 インスタンスごとにリセットされます。 "instance"-
各インスタンスごとに
arrayStrideでアドレスが進みます。
dictionary :GPUVertexState GPUProgrammableStage {sequence <GPUVertexBufferLayout ?>buffers = []; };
buffers, 型sequence<GPUVertexBufferLayout?>、デフォルト値[]-
このパイプラインで使用するバーテックスバッファのバーテックス属性データのレイアウトを定義する
GPUVertexBufferLayoutのリスト。
バーテックスバッファは概念的には
バッファメモリへの構造体の配列としてのビューです。
arrayStride
は、その配列の要素間のバイト単位のストライドです。
バーテックスバッファの各要素は、メモリレイアウトが
attributes
で定義された構造体のようなもので、
それぞれが構造体のメンバーとなります。
各GPUVertexAttribute
は
format
と
offset
(バイト単位) を構造体内の位置として記述します。
各属性はバーテックスシェーダーで個別の入力として表れ、それぞれ数値のlocationにバインドされます。
このlocationはshaderLocation
で指定され、GPUVertexState
内で一意でなければなりません。
dictionary {GPUVertexBufferLayout required GPUSize64 arrayStride ;GPUVertexStepMode stepMode = "vertex";required sequence <GPUVertexAttribute >attributes ; };
arrayStride, 型 GPUSize64-
この配列の要素間のバイト単位のストライド。
stepMode, 型 GPUVertexStepMode、デフォルト値"vertex"-
この配列の各要素が頂点ごとのデータかインスタンスごとのデータか。
attributes, 型 sequence<GPUVertexAttribute>-
各要素内のバーテックス属性のレイアウトを定義する配列。
dictionary {GPUVertexAttribute required GPUVertexFormat format ;required GPUSize64 offset ;required GPUIndex32 shaderLocation ; };
format, 型 GPUVertexFormat-
この属性の
GPUVertexFormat。 offset, 型 GPUSize64-
その属性のデータが要素の先頭から何バイト目か。
shaderLocation, 型 GPUIndex32-
この属性に関連付けられる数値のlocationで、
vertex.moduleで宣言する "@location" 属性 に対応します。
引数:
-
GPUDevicedevice -
GPUVertexBufferLayoutdescriptor
Device timeline の手順:
-
以下すべての条件を満たした場合に限り、
trueを返す:-
descriptor.
arrayStride≤ device.[[device]].[[limits]].maxVertexBufferArrayStride。 -
descriptor.
arrayStrideは4の倍数でなければならない。 -
descriptor.
attributesのリスト内の各属性 attrib について:-
もし descriptor.
arrayStrideがゼロの場合:-
attrib.
offset+ byteSize(attrib.format) ≤ device.[[device]].[[limits]].maxVertexBufferArrayStride。
それ以外の場合:
-
attrib.
offset+ byteSize(attrib.format) ≤ descriptor.arrayStride。
-
-
attrib.
offsetは 4 と byteSize(attrib.format) の小さい方の倍数でなければならない。 -
attrib.
shaderLocationは device.[[device]].[[limits]].maxVertexAttributesより小さくなければならない。
-
-
引数:
-
GPUDevicedevice -
GPUVertexStatedescriptor -
GPUPipelineLayoutlayout
Device timeline の手順:
-
entryPoint を get the entry point(
VERTEX, descriptor) とする。 -
アサート entryPoint が
nullでない。 -
以下の手順の要件がすべて満たされる必要がある。
-
GPUProgrammableStage の検証(
VERTEX, descriptor, layout, device) が成功しなければならない。 -
descriptor.
buffers.size が device.[[device]].[[limits]].maxVertexBuffers以下でなければならない。 -
descriptor.
buffersの各 vertexBuffer レイアウト記述は GPUVertexBufferLayout の検証(device, vertexBuffer) に合格しなければならない。 -
totalEffectiveVertexAttributes を descriptor.
buffers内の全ての vertexBuffer のattributes.size の合計とする。 -
もし device.
[[features]]が "core-features-and-limits""core-features-and-limits"を含まない場合:-
もし vertex_index 組み込みが descriptor.
vertexの シェーダーステージ入力の場合:-
totalEffectiveVertexAttributes に 1 を加算する。
-
-
もし instance_index 組み込みが descriptor.
vertexの シェーダーステージ入力の場合:-
totalEffectiveVertexAttributes に 1 を加算する。
-
-
-
totalEffectiveVertexAttributes は device.
[[device]].[[limits]].maxVertexAttributes以下でなければならない。 -
entryPoint により 静的に使用される 各頂点属性宣言(location location、型 T)について、 descriptor.
buffers[i]? .attributes[j].shaderLocation== location となる組 (i, j) がちょうど1つ存在しなければならない。その
GPUVertexAttributeを attrib とする。 -
T は attrib.
formatの vertex data type と互換でなければならない:- "unorm", "snorm", "float"
-
T は
f32またはvecN<f32>。 - "uint"
-
T は
u32またはvecN<u32>。 - "sint"
-
T は
i32またはvecN<i32>。
-
11. コピー
11.1. バッファコピー
バッファコピー操作は生のバイト単位で行われます。
WebGPUは「バッファ化」された GPUCommandEncoder
コマンドを提供します:
および「即時」 GPUQueue
操作:
-
writeBuffer()(ArrayBufferからGPUBufferへの書き込み)
11.2. テクセルコピー
テクセルコピー 操作はバイトではなくテクスチャ/「画像」データを操作します。
WebGPU は「バッファ化された」 GPUCommandEncoder
コマンドを提供します:
および「即時」の GPUQueue
操作:
-
writeTexture(), ArrayBuffer からArrayBufferからGPUTextureへの書き込み用 -
copyExternalImageToTexture(), Web プラットフォームの画像ソースからテクスチャへのコピー用
テクセルコピーは、ソース内の有効で有限かつ非サブノーマルな数値が宛先で同じ数値になることのみを保証します。 具体的には、テクセルブロックはそれらの値のみを保持するようにデコードされ再エンコードされる場合があります。 複数のバイト表現が可能な場合、表現の選択は実装依存です。
-
任意の浮動小数点のゼロ値は -0.0 または +0.0 のいずれかで表現される可能性があります。
-
任意の浮動小数点のサブノーマル値は保持されるか -0.0 または +0.0 に置き換えられる可能性があります。
-
任意の浮動小数点の
NaNまたはInfinityの値は、不定値 に置き換えられる可能性があります。 -
パック形式や
snorm形式は、表現される値が上記の規則に従う限りビット表現を変更する場合があります。例えば:-
snorm形式は -1.0 を -127 または -128 として表現することがあり得ます。 -
例えば
"rgb9e5ufloat"のようなフォーマットは、いくつかの値に対して複数のビット表現を持つことがあります。
-
注:
RENDER_ATTACHMENT または
STORAGE_BINDING
をサポートするフォーマットでは、
これは WGSL シェーダーを使用してテクスチャに書き込むことに類似していると考えられ、実装としてそのように行われる場合があります。
一般に、WGSL の浮動小数点挙動 が観測されることがあります。
以下の定義がこれらのメソッドで使われます:
11.2.1. GPUTexelCopyBufferLayout
"GPUTexelCopyBufferLayout"
はバイト配列(GPUBuffer
または AllowSharedBufferSource)の中のテクセルのレイアウトを
"テクセルコピー"操作で記述します。
dictionary GPUTexelCopyBufferLayout {GPUSize64 offset = 0;GPUSize32 bytesPerRow ;GPUSize32 rowsPerImage ; };
テクセル画像は1つ以上のテクセルブロックの行から構成され、ここではテクセルブロック行と呼びます。
各テクセルブロック行は同じ数のテクセルブロックを含み、
1つのテクセル画像内のすべてのテクセルブロックは同じGPUTextureFormatです。
GPUTexelCopyBufferLayout
は、線形メモリ内のテクセル画像のレイアウトです。
テクスチャとGPUBuffer間でデータをコピーする場合や、
GPUQueueからテクスチャに書き込む場合に使用されます。
バイト配列とテクスチャ間のコピー操作は常に テクセルブロック 単位で行われます。 テクセルブロック の一部だけを更新することはできません。
テクセルブロックは、 各 テクセルブロック行 内にリニアメモリレイアウトで詰めて格納され、 テクセルコピー時は 各 テクセルブロック が直ちに前の テクセルブロック の後ろに続き、 パディングはありません。 これは 特定アスペクト の depth-or-stencil format テクスチャへのコピー・コピー元にも当てはまります。 ステンシル値はバイト配列上に隙間なく詰められます。 デプス値は("depth16unorm" や "depth32float" のような)適切な型の配列として詰められます。
offset、型は GPUSize64、デフォルトは0-
テクセルデータソース(たとえば
GPUTexelCopyBufferInfo.bufferなど)の先頭から、その中のテクセルデータ開始までのバイト単位のオフセット。 bytesPerRow、型は GPUSize32-
各 テクセルブロック行 の先頭から次の テクセルブロック行 までのバイト単位のストライド。
複数の テクセルブロック行 (すなわちコピーの高さまたは深さが1ブロックを超える場合)に必要です。
rowsPerImage、型は GPUSize32-
1つのテクセルイメージ (テクスチャの)あたりの テクセルブロック行 の数。
rowsPerImage×bytesPerRowがデータの各 テクセルイメージ 先頭から次の テクセルイメージ 先頭までのストライド(バイト単位)となります。複数の テクセルイメージ(コピー先・元の深さが1を超える場合)に必要です。
11.2.2. GPUTexelCopyBufferInfo
"GPUTexelCopyBufferInfo"
は「info」(GPUBufferと
GPUTexelCopyBufferLayout)を
"テクセルコピー"操作のバッファのソースまたはデスティネーションとして記述します。
copySizeと合わせて、GPUBuffer内のテクセル領域のフットプリントを記述します。
dictionary GPUTexelCopyBufferInfo :GPUTexelCopyBufferLayout {required GPUBuffer buffer ; };
buffer, 型 GPUBuffer-
コピーされるテクセルデータを保持する、またはコピー後のテクセルデータが格納されるバッファ(メソッドにより異なる)。
引数:
-
GPUTexelCopyBufferInfoimageCopyBuffer
戻り値: boolean
デバイスタイムライン の手順:
-
次のすべての条件が満たされた場合に限り、
trueを返す:-
imageCopyBuffer.
bytesPerRowは256の倍数でなければならない。
11.2.3. GPUTexelCopyTextureInfo
"GPUTexelCopyTextureInfo"
は「info」(GPUTextureなど)
を "テクセルコピー"操作のテクスチャのソースまたはデスティネーションとして記述します。
copySizeと合わせて、テクスチャのサブ領域
(同じミップマップレベル上の1つ以上の連続したテクスチャサブリソース)を記述します。
dictionary GPUTexelCopyTextureInfo {required GPUTexture texture ;GPUIntegerCoordinate mipLevel = 0;GPUOrigin3D origin = {};GPUTextureAspect aspect = "all"; };
texture, 型 GPUTexture-
コピー元またはコピー先のテクスチャ。
mipLevel, 型 GPUIntegerCoordinate、デフォルト値0-
コピー元またはコピー先の
textureのミップマップレベル。 origin, 型 GPUOrigin3D、デフォルト値{}-
コピーの原点(コピー元またはコピー先のテクスチャサブ領域の最小コーナー)。
copySizeと合わせてコピーサブ領域全体を定義します。 aspect, 型 GPUTextureAspect、デフォルト値"all"-
コピー元またはコピー先の
textureのどのアスペクトをコピーするかを定義します。
GPUTexelCopyTextureInfo
copyTextureについて、以下の手順で決定されます:
GPUTexelCopyBufferLayout
bufferLayout で記述されるデータが、
テクセルブロック x,
y および depth slice または array layer z の
GPUTexture
texture であるとき、以下の手順で求めます:
-
blockBytes を texture.
formatの テクセルブロック コピー フットプリントとする。 -
imageOffset を (z × bufferLayout.
rowsPerImage× bufferLayout.bytesPerRow) + bufferLayout.offsetとする。 -
rowOffset を (y × bufferLayout.
bytesPerRow) + imageOffset とする。 -
blockOffset を (x × blockBytes) + rowOffset とする。
-
blockOffset を返す。
引数:
-
GPUTexelCopyTextureInfotexelCopyTextureInfo -
GPUExtent3DcopySize
戻り値: boolean
デバイスタイムラインの手順:
-
blockWidth を texelCopyTextureInfo.
texture.formatの テクセルブロック幅とする。 -
blockHeight を texelCopyTextureInfo.
texture.formatの テクセルブロック高さとする。 -
次のすべてが成り立つ場合に限り
trueを返す:-
テクスチャコピー範囲の検証(texelCopyTextureInfo, copySize) が
trueを返す。 -
texelCopyTextureInfo.
textureは 有効なGPUTextureでなければならない。 -
texelCopyTextureInfo.
mipLevelは texelCopyTextureInfo.texture.mipLevelCountより小さくなければならない。 -
次のいずれかの場合に、texelCopyTextureInfo の 物理サブリソースサイズ が copySize に一致する:
-
texelCopyTextureInfo.
texture.sampleCount> 1.
-
引数:
-
GPUTexelCopyTextureInfotexelCopyTextureInfo -
GPUTexelCopyBufferLayoutbufferLayout -
GPUSize64OutdataLength -
GPUExtent3DcopySize -
GPUTextureUsagetextureUsage -
booleanaligned
戻り値: boolean
デバイスタイムライン の手順:
-
texture を texelCopyTextureInfo.
textureとする。 -
aspectSpecificFormat = texture.
formatとする。 -
offsetAlignment = texture.
formatの テクセルブロックコピー フットプリント。 -
次のすべてが満たされる場合のみ
trueを返す:-
GPUTexelCopyTextureInfo の検証(texelCopyTextureInfo, copySize) が
trueを返す。 -
texture.
sampleCountは 1 である。 -
texture.
usageが textureUsage を含む。 -
もし texture.
formatが デプスまたはステンシルフォーマット の場合:-
texelCopyTextureInfo.
aspectは texture.formatの単一のアスペクトを参照しなければならない。 -
もし textureUsage が次のいずれか:
COPY_SRC-
そのアスペクトは § 26.1.2 Depth-stencil formats に従い、有効な texel copy ソースであること。
COPY_DST-
そのアスペクトは § 26.1.2 Depth-stencil formats に従い、有効な texel copy 書き込み先であること。
-
aspectSpecificFormat を アスペクト固有のフォーマットに § 26.1.2 Depth-stencil formatsに従い設定する。
-
offsetAlignment を4に設定する。
-
-
もし aligned が
trueなら:-
bufferLayout.
offsetは offsetAlignment の倍数であること。
-
-
リニアテクスチャデータの検証(bufferLayout, dataLength, aspectSpecificFormat, copySize) が成功すること。
-
11.2.4.
GPUCopyExternalImageDestInfo
WebGPUのテクスチャは生の数値データを保持しており、色を説明するセマンティックなメタデータはタグ付けされていません。
ただし、copyExternalImageToTexture()
は色情報を持つソースからコピーを行います。
「GPUCopyExternalImageDestInfo」
は、「copyExternalImageToTexture()」操作の「dest」すなわち「宛先」に関する「info」を表します。
これはGPUTexelCopyTextureInfo
であり、さらに色空間/エンコーディングおよびアルファプリマルチプライ情報のメタデータがタグ付けされているため、コピー時にセマンティックな色データが保持されます。
このメタデータはコピー操作の意味論のみに影響し、宛先となるテクスチャオブジェクト自体の状態や意味論には影響しません。
dictionary GPUCopyExternalImageDestInfo :GPUTexelCopyTextureInfo {PredefinedColorSpace colorSpace = "srgb";boolean premultipliedAlpha =false ; };
colorSpace、 型は PredefinedColorSpace、デフォルトは"srgb"-
宛先テクスチャへデータをエンコードする際に使われる色空間とエンコーディングを記述します。
この変換により、フォーマットが表現できる場合は [0, 1] の範囲外の値がターゲットテクスチャに書き込まれる場合があります。 そうでない場合、結果はターゲットテクスチャフォーマットの範囲にクランプされます。
注:
colorSpaceがソース画像と一致している場合、変換は不要かもしれません。§ 3.11.2 色空間変換の省略を参照してください。 premultipliedAlpha、 型は boolean、デフォルトはfalse-
テクスチャに書き込まれるデータのRGBチャンネルが、アルファチャンネルでプリマルチプライされるかどうかを記述します。
このオプションが
trueかつsourceもプリマルチプライされている場合、対応するアルファ値を超えていてもソースのRGB値は保持されなければなりません。注:
premultipliedAlphaがソース画像と一致している場合、変換は不要かもしれません。§ 3.11.2 色空間変換の省略を参照してください。
11.2.5.
GPUCopyExternalImageSourceInfo
「GPUCopyExternalImageSourceInfo」
は、「copyExternalImageToTexture()」操作の「source」すなわち「ソース」に関する「info」を表します。
typedef (ImageBitmap or ImageData or HTMLImageElement or HTMLVideoElement or VideoFrame or HTMLCanvasElement or OffscreenCanvas );GPUCopyExternalImageSource dictionary GPUCopyExternalImageSourceInfo {required GPUCopyExternalImageSource source ;GPUOrigin2D origin = {};boolean flipY =false ; };
GPUCopyExternalImageSourceInfo
には以下のメンバーがあります:
source, 型 GPUCopyExternalImageSource-
テクセルコピーのソース。 コピー元データは
copyExternalImageToTexture()発行時点でキャプチャされます。ソースサイズは外部ソース寸法の表に従って決まります。 origin, 型 GPUOrigin2D、デフォルト値{}-
コピーの原点(コピー元サブ領域の最小(左上)コーナー)。
copySizeと合わせてコピーサブ領域全体を定義します。 flipY, 型 boolean、デフォルト値false-
ソース画像が垂直方向に反転されるか否かを記述します。
このオプションが
trueの場合、コピーは上下逆転されます(ソース領域の最下行がコピー先領域の最初の行になる等)。originオプションは依然としてソース画像の左上基準で、下方向に増加します。
外部ソースをテクスチャの作成やコピー時に使う場合、外部ソース寸法 はソースタイプごとに以下の表で定義されます:
11.2.6. サブルーチン
引数:
-
GPUTexelCopyTextureInfotexelCopyTextureInfo
戻り値: GPUExtent3D
texelCopyTextureInfoのGPUTexelCopyTextureInfo物理サブリソースサイズは以下のように算出されます:
そのwidth、height、depthOrArrayLayersはそれぞれ、
texelCopyTextureInfo.texture
のサブリソースの
物理ミップレベル固有テクスチャ範囲の
幅、高さ、深さ(ミップマップレベル
texelCopyTextureInfo.mipLevel)。
引数:
GPUTexelCopyBufferLayoutlayout-
リニアテクスチャデータのレイアウト。
GPUSize64byteSize-
リニアデータの総サイズ(バイト単位)。
GPUTextureFormatformat-
テクスチャのフォーマット。
GPUExtent3DcopyExtent-
コピーするテクスチャの範囲。
Device timeline の手順:
-
次を定義する:
-
widthInBlocks は copyExtent.width を format のテクセルブロック幅で割った値とする。 整数であることをアサートする。
-
heightInBlocks は copyExtent.height を format のテクセルブロック高さで割った値とする。 整数であることをアサートする。
-
bytesInLastRow は widthInBlocks × format のテクセルブロックコピーのフットプリントとする。
-
-
次の入力バリデーション要件が満たされていない場合は失敗とする:
-
heightInBlocks > 1 の場合、 layout.
bytesPerRowを必ず指定する必要がある。 -
copyExtent.depthOrArrayLayers > 1 の場合、 layout.
bytesPerRowおよび layout.rowsPerImageを必ず指定する必要がある。 -
指定されている場合、layout.
bytesPerRowは bytesInLastRow 以上でなければならない。 -
指定されている場合、layout.
rowsPerImageは heightInBlocks 以上でなければならない。
-
-
次を定義する:
-
bytesPerRow は layout.
bytesPerRow?? 0。 -
rowsPerImage は layout.
rowsPerImage?? 0。
注: これらのデフォルト値は常に0倍となるため効果がありません。
-
-
requiredBytesInCopy を 0 とする。
-
copyExtent.depthOrArrayLayers > 0 の場合:
-
requiredBytesInCopy に bytesPerRow × rowsPerImage × (copyExtent.depthOrArrayLayers − 1) を加算する。
-
heightInBlocks > 0 の場合:
-
requiredBytesInCopy に bytesPerRow × (heightInBlocks − 1) + bytesInLastRow を加算する。
-
-
-
次の条件が満たされていなければ失敗とする:
-
レイアウトがリニアデータ内に収まること: layout.
offset+ requiredBytesInCopy ≤ byteSize。
-
引数:
GPUTexelCopyTextureInfotexelCopyTextureInfo-
コピーされるテクスチャサブリソースおよびコピー開始位置。
GPUExtent3DcopySize-
テクスチャのサイズ。
Device timeline の手順:
-
blockWidth を texelCopyTextureInfo.
texture.formatのテクセルブロック幅とする。 -
blockHeight を texelCopyTextureInfo.
texture.formatのテクセルブロック高さとする。 -
subresourceSize を texelCopyTextureInfo の物理サブリソースサイズとする。
-
以下のすべての条件が満たされているかどうかを返す:
-
(texelCopyTextureInfo.
origin.x + copySize.width) ≤ subresourceSize.width -
(texelCopyTextureInfo.
origin.y + copySize.height) ≤ subresourceSize.height -
(texelCopyTextureInfo.
origin.z + copySize.depthOrArrayLayers) ≤ subresourceSize.depthOrArrayLayers -
copySize.width は blockWidth の倍数でなければならない。
-
copySize.height は blockHeight の倍数でなければならない。
注: テクスチャコピー範囲は 圧縮フォーマット の場合物理的(切り上げ済み)のサイズと比較されるため、テクスチャ内に完全には収まっていないブロックにもコピーが可能です。
-
GPUTextureFormat
format1 と format2 は コピー互換 である、もし:
-
format1 が format2 と等しいか、
-
format1 と format2 の違いが
srgbフォーマット(-srgbサフィックスの有無)だけの場合。
texture
のサブリソースのうち、各サブリソース s が次を満たすものとする:
12. コマンドバッファ
コマンドバッファは、GPUコマンド(キュータイムラインのステップブロック)の事前記録リストであり、
GPUQueueに送信して実行できます。
各GPUコマンドは、
キュータイムライン上で実行される作業(状態設定、描画、リソースコピーなど)を表します。
GPUCommandBuffer
は一度しか送信できず、送信時に無効化されます。
複数回送信で描画コマンドを再利用したい場合は、GPURenderBundleを利用してください。
12.1. GPUCommandBuffer
[Exposed =(Window ,Worker ),SecureContext ]interface GPUCommandBuffer { };GPUCommandBuffer includes GPUObjectBase ;
GPUCommandBuffer
には以下のデバイスタイムラインプロパティがあります:
[[command_list]]、型は リスト<GPUコマンド>、読み取り専用[[renderState]]、型は RenderState、初期値はnull-
現在実行中のレンダーパスコマンドで使用される状態。
[[used_bind_groups]]、 型は セット<GPUBindGroup>、 読み取り専用-
このコマンドバッファで使用されるすべての
GPUBindGroupの セット。
12.1.1. コマンドバッファ生成
dictionary :GPUCommandBufferDescriptor GPUObjectDescriptorBase { };
13. コマンドエンコード
13.1. GPUCommandsMixin
GPUCommandsMixin
は、コマンドをエンコードするすべてのインターフェイスに共通する状態を定義します。
メソッドはありません。
interface mixin GPUCommandsMixin { };
GPUCommandsMixin
には以下のデバイスタイムラインプロパティがあります:
[[state]]、型は エンコーダー状態、初期値は "open"-
エンコーダーの現在の状態。
[[commands]]、型は リスト<GPUコマンド>、初期値は[]-
これらのコマンドを含む
GPUCommandBufferがサブミットされたときに リストの GPUコマンドを キュータイムライン上で実行します。 [[used_bind_groups]]、 型は セット<GPUBindGroup>、 初期値は空-
コマンドエンコード中に setBindGroup() でセットされたすべての
GPUBindGroupの セット。
エンコーダ状態は以下のいずれかです:
- "open"
-
エンコーダは新しいコマンドのエンコードに利用可能です。
- "locked"
-
エンコーダは子エンコーダによってロックされているため利用できません: これは
GPUCommandEncoderであり、GPURenderPassEncoderまたはGPUComputePassEncoderがアクティブな場合です。 パスが終了すると、エンコーダは再び"open"になります。この状態でコマンドを発行すると、エンコーダを無効化します。
- "ended"
-
エンコーダは終了しており、新しいコマンドはエンコードできません。
この状態でコマンドを発行すると、検証エラーを生成します。
GPUCommandsMixin
encoderについて以下のデバイスタイムライン手順を実行:
GPUCommandsMixin
encoder
がGPUコマンドcommandのステップを発行する場合、以下のデバイスタイムライン手順を実行:
-
Append command を encoder.
[[commands]]に追加。 -
commandが
GPUCommandBufferの一部として実行される場合:-
commandのステップを実行する。
-
13.2. GPUCommandEncoder
[Exposed =(Window ,Worker ),SecureContext ]interface GPUCommandEncoder {GPURenderPassEncoder beginRenderPass (GPURenderPassDescriptor descriptor );GPUComputePassEncoder beginComputePass (optional GPUComputePassDescriptor descriptor = {});undefined copyBufferToBuffer (GPUBuffer ,source GPUBuffer ,destination optional GPUSize64 );size undefined copyBufferToBuffer (GPUBuffer source ,GPUSize64 sourceOffset ,GPUBuffer destination ,GPUSize64 destinationOffset ,optional GPUSize64 size );undefined copyBufferToTexture (GPUTexelCopyBufferInfo source ,GPUTexelCopyTextureInfo destination ,GPUExtent3D copySize );undefined copyTextureToBuffer (GPUTexelCopyTextureInfo source ,GPUTexelCopyBufferInfo destination ,GPUExtent3D copySize );undefined copyTextureToTexture (GPUTexelCopyTextureInfo source ,GPUTexelCopyTextureInfo destination ,GPUExtent3D copySize );undefined clearBuffer (GPUBuffer buffer ,optional GPUSize64 offset = 0,optional GPUSize64 size );undefined resolveQuerySet (GPUQuerySet querySet ,GPUSize32 firstQuery ,GPUSize32 queryCount ,GPUBuffer destination ,GPUSize64 destinationOffset );GPUCommandBuffer finish (optional GPUCommandBufferDescriptor descriptor = {}); };GPUCommandEncoder includes GPUObjectBase ;GPUCommandEncoder includes GPUCommandsMixin ;GPUCommandEncoder includes GPUDebugCommandsMixin ;
13.2.1. コマンドエンコーダ生成
dictionary :GPUCommandEncoderDescriptor GPUObjectDescriptorBase { };
createCommandEncoder(descriptor)-
GPUCommandEncoderを生成します。呼び出し対象:GPUDevicethis.引数:
GPUDevice.createCommandEncoder(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPUCommandEncoderDescriptor✘ ✔ 作成する GPUCommandEncoderの記述。戻り値:
GPUCommandEncoderコンテンツタイムライン手順:
-
e を ! 新しいWebGPUオブジェクトを生成(this,
GPUCommandEncoder, descriptor)とする。 -
thisのデバイスタイムラインで初期化手順を実行する。
-
eを返す。
デバイスタイムライン 初期化手順: -
GPUCommandEncoder
を生成し、バッファのクリアコマンドをエンコードし、
エンコーダをfinishしてGPUCommandBuffer
を取得し、GPUQueueに送信する例。
const commandEncoder= gpuDevice. createCommandEncoder(); commandEncoder. clearBuffer( buffer); const commandBuffer= commandEncoder. finish(); gpuDevice. queue. submit([ commandBuffer]);
13.3. パスエンコード
beginRenderPass(descriptor)-
descriptorで記述されたレンダーパスのエンコードを開始します。
呼び出し対象:GPUCommandEncoderthis。引数:
GPUCommandEncoder.beginRenderPass(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptorGPURenderPassDescriptor✘ ✘ 生成する GPURenderPassEncoderの記述。戻り値:
GPURenderPassEncoderコンテンツタイムライン手順:
-
descriptor.
colorAttachmentsの各 non-nullな colorAttachment について:-
もし colorAttachment.
clearValueが 指定されている場合:-
? GPUColor shapeの検証(colorAttachment.
clearValue) を実行する。
-
-
-
pass を新しい
GPURenderPassEncoderオブジェクトとする。 -
this の Device timeline で initialization steps を実行する。
-
pass を返す。
デバイスタイムラインの initialization steps:-
エンコーダ状態の検証を this に対して実行する。 もし false を返した場合、invalidate を pass に対して行いreturnする。
-
attachmentRegions を [リスト] ([テクスチャサブリソース,
depthSlice?] のペア、初期値空) として初期化する。各ペアは描画先になるテクスチャ領域を示し、"3d"テクスチャの場合のみ1つのdepth sliceを含む。 -
descriptor.
colorAttachmentsの各 non-nullcolorAttachment について:-
colorAttachment.
view, colorAttachment.depthSlice??nullのペアを attachmentRegions に追加する。 -
もし colorAttachment.
resolveTargetがnullでない場合:-
[colorAttachment.
resolveTarget,undefined] を attachmentRegions に追加する。
-
-
-
次の要件のいずれかを満たさなければ、invalidate を pass に対して実行し、returnする。
-
descriptor はデバイス this.
[[device]]のもと、 Valid Usage のルールを満たしていること。 -
attachmentRegions に含まれるテクスチャ領域の集合が互いに重複しない(pairwise disjoint)。 すなわち、2つの領域が重なってはならない。
-
-
usage scope へ追加を attachmentRegions中の各テクスチャサブリソース について、usage attachmentで pass.
[[usage scope]]に実施する。 -
depthStencilAttachment を descriptor.
depthStencilAttachmentとする。 -
もし depthStencilAttachment が
nullでない場合:-
depthStencilView を depthStencilAttachment.
viewとする。 -
usage scope へ追加を depth サブリソース(もしあれば)について pass.
[[usage scope]]でusage attachment-read (depthStencilAttachment.depthReadOnlyが true の場合)、それ以外は attachment で実行する。 -
usage scope へ追加を stencil サブリソース(もしあれば)について pass.
[[usage scope]]でusage attachment-read (depthStencilAttachment.stencilReadOnlyが true の場合)、それ以外はattachmentで実行する。 -
pass.
[[depthReadOnly]]を depthStencilAttachment.depthReadOnlyに設定する。 -
pass.
[[stencilReadOnly]]を depthStencilAttachment.stencilReadOnlyに設定する。
-
-
pass.
[[layout]]をderive render targets layout from pass(descriptor) に設定する。 -
もし descriptor.
timestampWritesが 指定されている場合:-
timestampWrites を descriptor.
timestampWritesとする。 -
もし timestampWrites.
beginningOfPassWriteIndexが 指定されているなら append で 以下の手順で GPUコマンド を this.[[commands]]に追加:-
パスコマンド実行前に、現在のキュータイムスタンプ を timestampWrites.
beginningOfPassWriteIndexの timestampWrites.querySetの該当インデックスに書き込む。
-
-
もし timestampWrites.
endOfPassWriteIndexが 指定されているなら pass.[[endTimestampWrite]]に以下の手順による GPUコマンド を設定:-
パスコマンド実行後に、現在のキュータイムスタンプ を timestampWrites.
endOfPassWriteIndexのtimestampWrites.querySetの該当インデックスに書き込む。
-
-
-
pass.
[[drawCount]]を 0 に設定する。 -
pass.
[[maxDrawCount]]を descriptor.maxDrawCountに設定する。 -
pass.
[[maxDrawCount]]を descriptor.maxDrawCountに設定する。 -
コマンドをエンキューする: this に対し、後続手順を Queueタイムライン で実行するように登録する。
キュータイムライン 手順:-
現在実行中の
GPUCommandBufferの[[renderState]]を新しい RenderState にする。 -
[[renderState]].[[colorAttachments]]に descriptor.colorAttachmentsを設定する。 -
[[renderState]].[[depthStencilAttachment]]に descriptor.depthStencilAttachmentを設定する。 -
descriptor.
colorAttachmentsの各 non-nullcolorAttachment について:-
colorView を colorAttachment.
viewとする。 -
もし colorView.
[[descriptor]].dimensionが:"3d"-
colorSubregion を colorAttachment.
depthSliceにする。 - その他
-
colorSubregion を colorView にする。
-
もし colorAttachment.
loadOpが:"load"-
colorSubregion に関連付けられたフレームバッファメモリに colorSubregion の内容をロードする。
"clear"-
colorSubregion に関連付けられたフレームバッファメモリ内のすべてのテクセルを、colorAttachment.
clearValueで初期化する。
-
-
もし depthStencilAttachment が
nullでない場合:-
もし depthStencilAttachment.
depthLoadOpが:- provided でない場合
-
アサート:depthStencilAttachment.
depthReadOnlyがtrueであり、depthStencilView の depth サブリソースの内容を depthStencilView に関連付けられたフレームバッファメモリへロードする。 "load"-
depthStencilView の depth サブリソース の内容を depthStencilView に関連付けられたフレームバッファメモリへロードする。
"clear"-
depthStencilView の depth サブリソース に関連付けられたフレームバッファメモリ内のすべてのテクセルを depthStencilAttachment.
depthClearValueで初期化する。
-
もし depthStencilAttachment.
stencilLoadOpが:- provided でない場合
-
アサート:depthStencilAttachment.
stencilReadOnlyがtrueであり、depthStencilView の stencil サブリソース の内容を depthStencilView に関連付けられたフレームバッファメモリへロードする。 "load"-
depthStencilView の stencil サブリソース の内容を depthStencilView に関連付けられたフレームバッファメモリへロードする。
"clear"-
depthStencilView の stencil サブリソース に関連付けられたフレームバッファメモリ内のすべてのテクセルを depthStencilAttachment.
stencilClearValueで初期化する。
注: read-only depth-stencil アタッチメントは暗黙的に
"load"操作として扱われます。read-onlyアタッチメントに対しloadOpの指定が禁止される(バリデーションで検出される)のは GPURenderPassDepthStencilAttachment Valid Usage内で行われます。 -
-
beginComputePass(descriptor)-
descriptorで記述されたコンピュートパスのエンコードを開始します。
呼び出し元:GPUCommandEncoderthis.引数:
GPUCommandEncoder.beginComputePass(descriptor) メソッドの引数。 パラメーター 型 Nullable Optional 説明 descriptorGPUComputePassDescriptor✘ ✔ Content timeline 手順:
-
pass を新しい
GPUComputePassEncoderオブジェクトとする。 -
this の Device timeline で initialization steps を実施する。
-
pass を返す。
Device timeline initialization steps:-
エンコーダ状態の検証を this に対して行う。 もし false を返した場合、invalidate を pass に対して行い、returnする。
-
次のいずれかの要件が満たされない場合、invalidate を pass に対して行い、returnする。
-
もし descriptor.
timestampWritesが 指定されている場合:-
timestampWritesの検証(this.
[[device]], descriptor.timestampWrites) が true を返すこと。
-
-
-
もし descriptor.
timestampWritesが 指定されている場合:-
timestampWrites を descriptor.
timestampWritesに設定する。 -
もし timestampWrites.
beginningOfPassWriteIndexが 指定されているなら、 append で 以下の手順による GPUコマンド を this.[[commands]]に追加:-
このパスのコマンドの実行開始前に、現在のキュータイムスタンプ を timestampWrites.
beginningOfPassWriteIndex番号の timestampWrites.querySetに書き込む。
-
-
もし timestampWrites.
endOfPassWriteIndexが 指定されているなら、 pass.[[endTimestampWrite]]に以下の手順を持つ GPUコマンド を設定:-
このパスのコマンドの実行終了後に、現在のキュータイムスタンプ を timestampWrites.
endOfPassWriteIndex番号の timestampWrites.querySetに書き込む。
-
-
-
13.4. バッファコピーコマンド
copyBufferToBuffer() は2つのオーバーロードがあります:
copyBufferToBuffer(source, destination, size)-
省略記法であり、
copyBufferToBuffer(source, 0, destination, 0, size)と同等です。 copyBufferToBuffer(source, sourceOffset, destination, destinationOffset, size)-
GPUCommandEncoderに、あるGPUBufferのサブ領域から別のGPUBufferのサブ領域へデータをコピーするコマンドをエンコードします。呼び出し元:GPUCommandEncoderthis。引数:
GPUCommandEncoder.copyBufferToBuffer(source, sourceOffset, destination, destinationOffset, size) メソッドの引数。 パラメーター 型 Nullable Optional 説明 sourceGPUBuffer✘ ✘ コピー元の GPUBuffer。sourceOffsetGPUSize64✘ ✘ source 内でコピー開始バイトオフセット。 destinationGPUBuffer✘ ✘ コピー先の GPUBuffer。destinationOffsetGPUSize64✘ ✘ destination 内でコピー後のデータ配置バイトオフセット。 sizeGPUSize64✘ ✔ コピーするバイト数。 戻り値:
undefinedContent timeline 手順:
-
続く手順を this.
[[device]]のDevice timelineに発行する。
Device timeline 手順:-
エンコーダ状態の検証を this に対して実施。false を返した場合は return。
-
もし size が
undefinedなら source.size− sourceOffset とする。 -
下記条件に一つでも満たされないものがあれば invalidate を this に対し行い、return:
-
source は valid to use with this であること。
-
destination は valid to use with this であること。
-
size は4の倍数。
-
sourceOffset は4の倍数。
-
destinationOffset は4の倍数。
-
source.
size≥ (sourceOffset + size)。 -
destination.
size≥ (destinationOffset + size)。 -
source と destination が同じ
GPUBufferでないこと。
-
-
Enqueue a command を this で実行し、以降の手順をQueue timelineで実施。
Queue timeline 手順:-
source の sourceOffset から size バイトを destination の destinationOffset からコピーする。
-
clearBuffer(buffer, offset, size)-
GPUCommandEncoderに対し、GPUBufferのサブリージョンをゼロで埋めるコマンドをエンコードします。呼び出し元:GPUCommandEncoderthis。引数:
GPUCommandEncoder.clearBuffer(buffer, offset, size) メソッドの引数。 パラメータ 型 Nullable Optional 説明 bufferGPUBuffer✘ ✘ クリア対象の GPUBuffer。offsetGPUSize64✘ ✔ buffer 内でクリア範囲が始まるバイトオフセット。 sizeGPUSize64✘ ✔ クリアするサブリージョンのバイト数。省略時は buffer のサイズから offset を引いたものが既定値。 戻り値:
undefinedContent timeline 手順:
-
後続手順を this.
[[device]]のDevice timelineで発行する。
Device timeline 手順:-
エンコーダ状態の検証を this に対し実行し、falseのとき return。
-
size が未指定の場合、size を
max(0, buffer.に設定する。size- offset) -
次のいずれか満たさない場合、invalidate を this に対し実行し、return:
-
buffer が valid to use with this であること。
-
size は4の倍数である。
-
offset は4の倍数である。
-
buffer.
size≥ (offset + size)。
-
-
Enqueue a command を this で発行し、以降の手順を Queue timeline で実施する。
Queue timeline 手順:-
buffer の offset から size バイト分を
0でクリアする。
-
13.5. テクセルコピーコマンド
copyBufferToTexture(source, destination, copySize)-
GPUCommandEncoderに、GPUBufferのサブ領域から1つまたは複数の連続したテクスチャサブリソースのサブ領域へデータをコピーするコマンドをエンコードします。呼び出し対象:GPUCommandEncoderthis。引数:
GPUCommandEncoder.copyBufferToTexture(source, destination, copySize) メソッドの引数。 パラメータ 型 Nullable Optional 説明 sourceGPUTexelCopyBufferInfo✘ ✘ copySizeと組み合わせて、コピー元バッファの領域を定義します。 destinationGPUTexelCopyTextureInfo✘ ✘ copySizeと組み合わせて、コピー先テクスチャサブリソースの領域を定義します。 copySizeGPUExtent3D✘ ✘ 戻り値:
undefinedコンテンツタイムライン手順:
-
? GPUOrigin3D の形状を検証する(destination.
origin)。 -
? GPUExtent3D の形状を検証する(copySize)。
-
以降の手順は this.
[[device]]の Device timeline 上で実行する:
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
aligned = trueとする。
-
次の条件を満たしていなければ、thisを無効化して返す。
-
GPUTexelCopyBufferInfoの検証(source) がtrueを返すこと。
-
テクスチャバッファコピーの検証(destination, source, dataLength, copySize,
COPY_DST, aligned) がtrueを返すこと。
-
-
thisにコマンドのエンキューを行い、以降の手順を
キュータイムラインで実行。
Queue timeline の手順:-
blockHeight を destination.
textureのテクセルブロック高さとする。 -
dstOrigin を destination.
originとする。 -
dstBlockOriginX を (dstOrigin.x ÷ blockWidth) とする。
-
dstBlockOriginY を (dstOrigin.y ÷ blockHeight) とする。
-
blockColumns を (copySize.width ÷ blockWidth) とする。
-
blockRows を (copySize.height ÷ blockHeight) とする。
-
アサート:dstBlockOriginX、 dstBlockOriginY、blockColumns、blockRowsは整数である。
-
各 z について [0, copySize.depthOrArrayLayers − 1] の範囲で:
-
dstSubregion を texture copy sub-region (z + dstOrigin.z) of destination とする。
-
各 y について [0, blockRows − 1] の範囲で:
-
各 x について [0, blockColumns − 1] の範囲で:
-
blockOffset を テクセルブロックのバイトオフセット (source の (x, y, z) に対し、 destination.
texture用)とする。 -
dstSubregion の (dstBlockOriginX + x, dstBlockOriginY + y) テクセルブロックを、 source.
bufferの blockOffset 位置から取得される同等テクセル表現に設定する。
-
-
-
-
copyTextureToBuffer(source, destination, copySize)-
GPUCommandEncoderに、1つまたは複数の連続したテクスチャサブリソースのサブ領域からGPUBufferのサブ領域へデータをコピーするコマンドをエンコードします。呼び出し元:GPUCommandEncoderthis。引数:
GPUCommandEncoder.copyTextureToBuffer(source, destination, copySize) メソッドの引数。 パラメータ 型 Nullable Optional 説明 sourceGPUTexelCopyTextureInfo✘ ✘ copySize と組み合わせて、元となる テクスチャサブリソース の範囲を定義します。 destinationGPUTexelCopyBufferInfo✘ ✘ copySize と組み合わせて、コピー先バッファの範囲を定義します。 copySizeGPUExtent3D✘ ✘ 戻り値:
undefinedContent timeline 手順:
-
? GPUOrigin3D shapeの検証(source.
origin) を行う。 -
? GPUExtent3D shapeの検証(copySize) を行う。
-
続く手順を this.
[[device]]のDevice timelineに発行します。
Device timeline 手順:-
エンコーダ状態の検証をthisに対して行い、false なら return。
-
aligned を
trueにする。 -
下記のいずれか満たされなければ invalidate を this で実施し return。
-
GPUTexelCopyBufferInfoの検証(destination) が
trueを返すこと。 -
テクスチャ・バッファコピーの検証 (source, destination, dataLength, copySize,
COPY_SRC, aligned) がtrueを返すこと。
-
-
Enqueue a command をthisで実施し、以降はQueue timeline上で手順を行う。
Queue timeline手順:-
blockHeight をsource.
textureのテクセルブロック高さとする。 -
srcOrigin を source.
originとする。 -
srcBlockOriginX を (srcOrigin.x ÷ blockWidth) とする。
-
srcBlockOriginY を (srcOrigin.y ÷ blockHeight) とする。
-
blockColumns を (copySize.width ÷ blockWidth) とする。
-
blockRows を (copySize.height ÷ blockHeight) とする。
-
アサート : srcBlockOriginX、srcBlockOriginY、blockColumns、blockRows は整数であること。
-
z を [0, copySize.depthOrArrayLayers − 1] の範囲で繰り返す:
-
srcSubregion を texture copy sub-region (z + srcOrigin.z) of source とする。
-
y を [0, blockRows − 1] の範囲で繰り返す:
-
x を [0, blockColumns − 1] の範囲で繰り返す:
-
blockOffset を テクセルブロックのバイトオフセット (destination、(x, y, z)、source.
texture用)とする。 -
destination.
bufferの blockOffset に、 同等テクセル表現 として srcSubregion の (srcBlockOriginX + x, srcBlockOriginY + y) テクセルブロック を格納する。
-
-
-
-
copyTextureToTexture(source, destination, copySize)-
GPUCommandEncoderに、1つまたは複数の連続したテクスチャサブリソースのサブ領域から、他の1つまたは複数の連続したテクスチャサブリソースのサブ領域へデータをコピーするコマンドをエンコードします。呼び出し対象:GPUCommandEncoderthis。引数:
GPUCommandEncoder.copyTextureToTexture(source, destination, copySize) メソッドの引数。 パラメータ 型 Nullable Optional 説明 sourceGPUTexelCopyTextureInfo✘ ✘ copySizeと組み合わせて、コピー元テクスチャサブリソースの領域を定義します。 destinationGPUTexelCopyTextureInfo✘ ✘ copySizeと組み合わせて、コピー先テクスチャサブリソースの領域を定義します。 copySizeGPUExtent3D✘ ✘ 戻り値:
undefinedContent timeline の手順:
-
? GPUOrigin3D の形状を検証する(source.
origin)。 -
? GPUOrigin3D の形状を検証する(destination.
origin)。 -
? GPUExtent3D の形状を検証する(copySize)。
-
続く手順を this.
[[device]]の Device timeline で実施する:
デバイスタイムライン 手順:-
エンコーダ状態の検証を this に対して行う。false なら return。
-
以下のいずれかの条件を満たさない場合、invalidate を this に対し実行し return:
-
srcTexture を source.
textureとする。 -
dstTexture を destination.
textureとする。 -
GPUTexelCopyTextureInfo の検証(source, copySize) が
trueを返すこと。 -
GPUTexelCopyTextureInfo の検証(destination, copySize) が
trueを返すこと。 -
srcTexture.
sampleCountと dstTexture.sampleCountが等しいこと。 -
もし srcTexture.
formatがデプスステンシルフォーマットなら: -
テクスチャコピーのためのサブリソース集合(source, copySize) と テクスチャコピーのためのサブリソース集合(destination, copySize) は互いに重複しない。
-
もし device.
[[features]]が "core-features-and-limits""core-features-and-limits"を含まない場合:-
source.
texture.formatおよび destination.texture.formatは 圧縮フォーマット であってはならない。 -
source.
texture.sampleCountと destination.texture.sampleCountはともに 1 でなければならない。
-
-
-
コマンドをエンキューし、 以降はQueue timelineで手順を実施する。
Queue timeline 手順:-
blockHeight を source.
textureの テクセルブロック高さとする。 -
srcOrigin を source.
originとする。 -
srcBlockOriginX を (srcOrigin.x ÷ blockWidth) とする。
-
srcBlockOriginY を (srcOrigin.y ÷ blockHeight) とする。
-
dstOrigin を destination.
originとする。 -
dstBlockOriginX を (dstOrigin.x ÷ blockWidth) とする。
-
dstBlockOriginY を (dstOrigin.y ÷ blockHeight) とする。
-
blockColumns を (copySize.width ÷ blockWidth) とする。
-
blockRows を (copySize.height ÷ blockHeight) とする。
-
アサート:srcBlockOriginX、srcBlockOriginY、dstBlockOriginX、dstBlockOriginY、blockColumns、blockRows は整数である。
-
各 z について [0, copySize.depthOrArrayLayers − 1] の範囲で:
-
srcSubregion を texture copy sub-region(z + srcOrigin.z) of source とする。
-
dstSubregion を texture copy sub-region(z + dstOrigin.z) of destination とする。
-
各 y について [0, blockRows − 1] の範囲で:
-
各 x について [0, blockColumns − 1] の範囲で:
-
dstSubregion の (dstBlockOriginX + x, dstBlockOriginY + y) テクセルブロックを、srcSubregion の (srcBlockOriginX + x, srcBlockOriginY + y) テクセルブロックの同等テクセル表現に設定する。
-
-
-
-
13.6. クエリ
resolveQuerySet(querySet, firstQuery, queryCount, destination, destinationOffset)-
GPUQuerySetのクエリ結果を、GPUBufferの範囲に出力します。呼び出し元:GPUCommandEncoderthis。引数:
GPUCommandEncoder.resolveQuerySet(querySet, firstQuery, queryCount, destination, destinationOffset) メソッドの引数。 パラメータ 型 Nullable Optional 説明 querySetGPUQuerySet✘ ✘ firstQueryGPUSize32✘ ✘ queryCountGPUSize32✘ ✘ destinationGPUBuffer✘ ✘ destinationOffsetGPUSize64✘ ✘ 戻り値:
undefinedContent timeline 手順:
-
続く手順を this.
[[device]]の Device timeline で実施する。
Device timeline 手順:-
エンコーダ状態の検証を this に対して行う。 false なら return。
-
以下のいずれか満たさない場合、invalidate を this に対して行い、return。
-
querySet が valid to use with this であること。
-
destination が valid to use with this であること。
-
destination.
usageがQUERY_RESOLVEを含むこと。 -
firstQuery < querySet のクエリ数。
-
(firstQuery + queryCount) ≤ querySet のクエリ数。
-
destinationOffset は256の倍数である。
-
destinationOffset + 8 × queryCount ≤ destination.
size。
-
-
コマンドをエンキューし、 以降の手順は Queue timeline で行う。
Queue timeline 手順:-
queryIndex を firstQuery にする。
-
offset を destinationOffset にする。
-
queryIndex < firstQuery + queryCount の間は:
-
destination の offset から8バイトに querySet の queryIndex 番目の値を書き込む。
-
queryIndex を queryIndex + 1 にする。
-
offset を offset + 8 にする。
-
-
13.7. ファイナライズ
GPUCommandBuffer
に、GPUCommandEncoder
で記録されたコマンドを含めるには、
finish()
を呼び出します。
finish()
が呼び出されると、
そのコマンドエンコーダはこれ以上使用できなくなります。
finish(descriptor)-
コマンド列の記録を完了し、対応する
GPUCommandBufferを返します。呼び出し元:GPUCommandEncoderthis。引数:
GPUCommandEncoder.finish(descriptor) メソッドの引数。 パラメーター 型 Nullable Optional 説明 descriptorGPUCommandBufferDescriptor✘ ✔ 戻り値:
GPUCommandBufferContent timeline の手順:
-
commandBuffer を新しい
GPUCommandBufferとする。 -
this.
[[device]]の Device timeline で finish steps を実施する。 -
commandBuffer を返す。
Device timeline finish steps:-
下記要件をすべて満たす場合 validationSucceeded を
true、 満たさない場合falseとする。-
this が valid であること。
-
this.
[[debug_group_stack]]が 空 であること。
-
-
もし validationSucceeded が
falseなら:-
バリデーションエラー生成 を実行する。
-
-
commandBuffer.
[[command_list]]を this.[[commands]]に設定する。 -
commandBuffer.
[[used_bind_groups]]を this.[[used_bind_groups]]に設定する。
-
14. プログラマブルパス
interface mixin {GPUBindingCommandsMixin undefined setBindGroup (GPUIndex32 index ,GPUBindGroup ?bindGroup ,optional sequence <GPUBufferDynamicOffset >dynamicOffsets = []);undefined setBindGroup (GPUIndex32 index ,GPUBindGroup ?bindGroup , [AllowShared ]Uint32Array dynamicOffsetsData ,GPUSize64 dynamicOffsetsDataStart ,GPUSize32 dynamicOffsetsDataLength ); };
GPUBindingCommandsMixin
は同じオブジェクト上に
GPUObjectBase
と GPUCommandsMixin
のメンバーが存在することを前提としています。
これらのミックスインも含むインターフェイスのみがGPUBindingCommandsMixinをincludeできます。
GPUBindingCommandsMixin
には以下のデバイスタイムラインプロパティがあります:
[[bind_groups]]、型は 順序付きマップ<GPUIndex32,GPUBindGroup>、 初期値は空-
各インデックスに対する現在の
GPUBindGroup。 [[dynamic_offsets]]、型は 順序付きマップ<GPUIndex32, リスト<GPUBufferDynamicOffset>>, 初期値は空-
各
[[bind_groups]]エントリに対する現在のダイナミックオフセット。
14.1. バインドグループ
setBindGroup() には2つのオーバーロードがあります:
setBindGroup(index, bindGroup, dynamicOffsets)-
指定されたインデックスの現在の
GPUBindGroupを設定します。呼び出し対象:GPUBindingCommandsMixinの this.引数:
index, 型はGPUIndex32, 非null、必須-
バインドグループを設定するインデックス。
bindGroup, 型はGPUBindGroup, nullable、必須-
その後のレンダーまたはコンピュートコマンドで使用するバインドグループ。
dynamicOffsets, 型は sequence<GPUBufferDynamicOffset>, 非null、デフォルトは[]-
bindGroup の各エントリで
buffer.hasDynamicOffsetとマークされた各エントリに対する、バイト単位のバッファオフセットを格納する配列です。順序はGPUBindGroupLayoutEntry.bindingによります。詳細は 注 を参照してください。
戻り値:
undefinedコンテンツタイムライン の手順:
-
次の手順を this の Device timeline 上で発行します。
[[device]]。
Device timeline の手順:-
エンコーダーの状態を検証する を this に対して実行します。false が返ったら終了します。
-
dynamicOffsetCount を、もし
bindGroupがnullなら 0、そうでなければ bindGroup.[[layout]].[[dynamicOffsetCount]]とします。 -
以下の要件のいずれかが満たされない場合、invalidate を this に対して行い、戻ります。
-
index は < this.
[[device]].[[limits]].maxBindGroupsでなければなりません。 -
dynamicOffsets.size は dynamicOffsetCount と等しくなければなりません。
-
-
もし bindGroup が
nullの場合:-
削除 this.
[[bind_groups]][index]。 -
削除 this.
[[dynamic_offsets]][index]。
それ以外の場合:
-
以下の要件のいずれかが満たされない場合、invalidate を this に対して行い、戻ります。
-
bindGroup は このエンコーダーで使用可能 でなければなりません。
-
各動的バインディングごとに反復処理 (bufferBinding, bufferLayout, dynamicOffsetIndex) を bindGroup に対して行ったとき:
-
bufferBinding.
offset+ dynamicOffsets[dynamicOffsetIndex] + bufferLayout.minBindingSizeは ≤ bufferBinding.buffer.sizeでなければなりません。 -
もし bufferLayout.
typeが"uniform"の場合:-
dynamicOffset は
minUniformBufferOffsetAlignmentの倍数でなければなりません。
-
-
もし bufferLayout.
typeが"storage"または"read-only-storage"の場合:-
dynamicOffset は
minStorageBufferOffsetAlignmentの倍数でなければなりません。
-
-
-
-
this.
[[bind_groups]][index] を bindGroup に設定します。 -
this.
[[dynamic_offsets]][index] を dynamicOffsets のコピーに設定します。 -
Append により bindGroup を this.
[[used_bind_groups]]に追加します。 -
もし this が
GPURenderCommandsMixinの場合:-
this.
[[bind_groups]]内の各 bindGroup について、 merge により bindGroup.[[usedResources]]を this.[[usage scope]]に統合します。
-
-
setBindGroup(index, bindGroup, dynamicOffsetsData, dynamicOffsetsDataStart, dynamicOffsetsDataLength)-
指定されたインデックスの現在の
GPUBindGroupを設定します。動的オフセットをUint32Arrayの一部として指定します。呼び出し対象:GPUBindingCommandsMixinの this。引数:
GPUBindingCommandsMixin.setBindGroup(index, bindGroup, dynamicOffsetsData, dynamicOffsetsDataStart, dynamicOffsetsDataLength) メソッドの引数。 パラメータ 型 Nullable Optional 説明 indexGPUIndex32✘ ✘ バインドグループを設定するインデックス。 bindGroupGPUBindGroup?✔ ✘ 後続のレンダーまたはコンピュートコマンドで使用するバインドグループ。 dynamicOffsetsDataUint32Array✘ ✘ bindGroup 内で buffer.hasDynamicOffsetとしてマークされた各エントリのバッファオフセット(バイト単位)が格納された配列。
GPUBindGroupLayoutEntry.bindingの順で並んでいます。詳細については 注記 を参照してください。dynamicOffsetsDataStartGPUSize64✘ ✘ dynamicOffsetsData 内の、バッファオフセットデータが始まる要素のオフセット。 dynamicOffsetsDataLengthGPUSize32✘ ✘ dynamicOffsetsData から読み取るバッファオフセットの数。 戻り値:
undefinedコンテンツタイムライン の手順:
-
以下の要件のいずれかが満たされない場合、
RangeErrorを投げて終了します。-
dynamicOffsetsDataStart は ≥ 0 でなければなりません。
-
dynamicOffsetsDataStart + dynamicOffsetsDataLength は dynamicOffsetsData.
length以下でなければなりません。
-
-
dynamicOffsets を、list として、 dynamicOffsetsDataStart から始まる dynamicOffsetsDataLength 個の要素について、 コピーされた dynamicOffsetsData の範囲を含むものとします。
-
次に this.
setBindGroup(index, bindGroup, dynamicOffsets) を呼び出します。
-
GPUBindGroupLayoutEntry.binding
順に適用されます。
つまり、もし dynamic bindings が GPUBindGroupLayoutEntry
の各要素で、
GPUBindGroupLayout
内で buffer?.hasDynamicOffset
が true に設定され、かつ GPUBindGroupLayoutEntry.binding
でソートされているなら、setBindGroup() に渡された dynamic offset[i] は
dynamic bindings[i] に対応します。
GPUBindGroupLayout
を例とします。
// Note the bindings are listed out-of-order in this array, but it // doesn't matter because they will be sorted by binding index. let layout= gpuDevice. createBindGroupLayout({ entries: [{ binding: 1 , buffer: {}, }, { binding: 2 , buffer: { dynamicOffset: true }, }, { binding: 0 , buffer: { dynamicOffset: true }, }] });
次の呼び出しで作成された GPUBindGroup
によって使用されます:
// Like above, the array order doesn't matter here. // It doesn't even need to match the order used in the layout. let bindGroup= gpuDevice. createBindGroup({ layout: layout, entries: [{ binding: 1 , resource: { buffer: bufferA, offset: 256 }, }, { binding: 2 , resource: { buffer: bufferB, offset: 512 }, }, { binding: 0 , resource: { buffer: bufferC}, }] });
そして次の呼び出しでバインドされます:
pass. setBindGroup( 0 , bindGroup, [ 1024 , 2048 ]);
次のバッファオフセットが適用されます:
| Binding | Buffer | Offset |
|---|---|---|
| 0 | bufferC | 1024 (動的) |
| 1 | bufferA | 256 (静的) |
| 2 | bufferB | 2560 (静的 + 動的) |
GPUBindGroup
bindGroup 内の各 動的バインディングオフセット に対して、各動的オフセットごとに実行する
steps のリストを指定し、次の デバイスタイムライン のステップを実行します:
-
dynamicOffsetIndex を
0にします。 -
layout を bindGroup.
[[layout]]とします。 -
bindGroup.
[[entries]]内の各GPUBindGroupEntryentry を、entry.bindingの増加順に処理します:-
bindingDescriptor を layout.
[[entryMap]][entry.binding] とします。 -
もし bindingDescriptor.
buffer?.hasDynamicOffsetがtrueなら:-
bufferBinding を get as buffer binding(entry.
resource) とします。 -
bufferLayout を bindingDescriptor.
bufferとします。 -
steps を bufferBinding, bufferLayout, および dynamicOffsetIndex で呼び出します。
-
dynamicOffsetIndex を dynamicOffsetIndex +
1にします。
-
-
引数:
GPUBindingCommandsMixinencoder-
バインドグループが検証されるエンコーダー。
GPUPipelineBasepipeline-
エンコーダーのバインドグループが互換性があるか検証するパイプライン。
Device timeline の手順:
-
以下の条件のいずれかが満たされない場合、
falseを返します:-
bindGroupLayouts を pipeline.
[[layout]].[[bindGroupLayouts]]とします。 -
pipeline は
nullであってはなりません。 -
パイプラインで使用されるすべてのバインドグループは設定され、パイプラインレイアウトと互換でなければなりません。判定は次の通りです:
bindGroupLayouts 内の各 (
GPUIndex32index,GPUBindGroupLayoutbindGroupLayout) について:-
もし bindGroupLayout が
nullなら、continue します。 -
bindGroup を encoder.
[[bind_groups]][index] とします。 -
dynamicOffsets を encoder.
[[dynamic_offsets]][index] とします。 -
bindGroup は
nullであってはなりません。 -
bindGroup.
[[layout]]は group-equivalent で bindGroupLayout と一致していなければなりません。 -
dynamicOffsetIndex を 0 にします。
-
bindGroup.
[[entries]]内の各GPUBindGroupEntrybindGroupEntry を、bindGroupEntry.bindingでソートした順に処理します:-
bindGroupLayoutEntry を bindGroup.
[[layout]].[[entryMap]][bindGroupEntry.binding] とします。 -
もし bindGroupLayoutEntry.
bufferが提供されていない場合、continue します。 -
bound を get as buffer binding(bindGroupEntry.
resource) とします。 -
もし bindGroupLayoutEntry.
buffer.hasDynamicOffsetなら:-
bound.
offsetに dynamicOffsets[dynamicOffsetIndex] を加算します。 -
dynamicOffsetIndex を 1 増やします。
-
-
もし bindGroupEntry.
[[prevalidatedSize]]がfalseの場合:-
effective buffer binding size(bound) は、minimum buffer binding size (パイプラインのシェーダー内で bindGroupEntry に対応するバインディング変数)以上でなければなりません。
-
-
-
-
エンコーダーのバインドグループが書き込み可能なリソースとエイリアスしているか(encoder, pipeline) は
falseでなければなりません。 -
もし encoder.
[[device]].[[features]]が "core-features-and-limits""core-features-and-limits"を含まない場合:-
同じ
GPUTextureを参照するすべてのバインディングは互換性のあるGPUTextureViewを持たなければなりません。判定は次の通りです:bindGroupLayouts 内の各 (
GPUIndex32index1,GPUBindGroupLayoutbindGroupLayout1) について:-
もし bindGroupLayout1 が
nullなら、continue します。 -
bindGroup1 を encoder.
[[bind_groups]][index1] とします。 -
bindGroup1.
[[entries]]内の各GPUBindGroupEntrybindGroupEntry1 について:-
もし bindGroupEntry1.
resourceがGPUTextureViewでないなら、continue します。 -
descriptor1 を bindGroupEntry1.
resource.[[descriptor]]とします。 -
bindGroupLayouts 内の各 (
GPUIndex32index2,GPUBindGroupLayoutbindGroupLayout2) について:-
もし bindGroupLayout2 が
nullなら、continue します。 -
bindGroup2 を encoder.
[[bind_groups]][index2] とします。 -
bindGroup2.
[[entries]]内の各GPUBindGroupEntrybindGroupEntry2 について:-
もし bindGroupEntry2.
resourceがGPUTextureViewでないなら、continue します。 -
もし bindGroupEntry1.
resource.[[texture]]が bindGroupEntry2.resource.[[texture]]と等しくない場合、continue します。 -
descriptor2 を bindGroupEntry2.
resource.[[descriptor]]とします。 -
descriptor2.
baseMipLevelは descriptor1.baseMipLevelと等しくなければなりません。 -
descriptor2.
mipLevelCountは descriptor1.mipLevelCountと等しくなければなりません。
-
-
-
-
-
-
それ以外の場合は true を返します。
GPUTextureView
オブジェクトを用いてテクスチャサブリソースで重複する場合に true になります。
注: このアルゴリズムは usage scope storage exception の使用を制限します。
引数:
GPUBindingCommandsMixinencoder-
バインドグループが検証されるエンコーダー。
GPUPipelineBasepipeline-
エンコーダーのバインドグループが互換性があるか検証するパイプライン。
Device timeline の手順:
-
各 stage について [
VERTEX,FRAGMENT,COMPUTE] について次を行います:-
bufferBindings を (
GPUBufferBinding,boolean) ペアの リスト とします。後者はそのリソースが書き込みとして使われたかを示します。 -
textureViews を (
GPUTextureView,boolean) ペアの リスト とします。後者はそのリソースが書き込みとして使われたかを示します。 -
pipeline.
[[layout]].[[bindGroupLayouts]]の各 (GPUIndex32bindGroupIndex,GPUBindGroupLayoutbindGroupLayout) について次を行います:-
bindGroup を encoder.
[[bind_groups]][bindGroupIndex] とします。 -
bindGroupLayoutEntries を bindGroupLayout.
[[descriptor]].entriesとします。 -
bufferRanges を、動的オフセットとして encoder.
[[dynamic_offsets]][bindGroupIndex] を用いた bindGroup の バインドされたバッファ範囲 とします。 -
bufferRanges 内の各 (
GPUBindGroupLayoutEntrybindGroupLayoutEntry,GPUBufferBindingresource) について、その bindGroupLayoutEntry.visibilityが stage を含む場合に次を行います:-
resourceWritable を (bindGroupLayoutEntry.
buffer.type=="storage") とします。 -
bufferBindings 内の各 (
GPUBufferBindingpastResource,booleanpastResourceWritable) について次を行います:-
もし (resourceWritable または pastResourceWritable) が true で、かつ pastResource と resource が buffer-binding-aliasing であるなら、
trueを返します。
-
-
Append (resource, resourceWritable) を bufferBindings に追加します。
-
-
bindGroupLayoutEntries 内の各
GPUBindGroupLayoutEntrybindGroupLayoutEntry と対応するGPUTextureViewの resource について、その bindGroupLayoutEntry.visibilityが stage を含む場合に次を行います:-
もし bindGroupLayoutEntry.
storageTextureが提供されていないなら、continue します。 -
resourceWritable を bindGroupLayoutEntry.
storageTexture.accessが書き込み可能なアクセスモードかどうかで決めます。 -
textureViews 内の各 (
GPUTextureViewpastResource,booleanpastResourceWritable) について次を行います:-
もし (resourceWritable または pastResourceWritable) が true で、かつ pastResource と resource が texture-view-aliasing であるなら、
trueを返します。
-
-
Append (resource, resourceWritable) を textureViews に追加します。
-
-
-
-
falseを返します。
注: 実装はこのアルゴリズムを最適化することが強く推奨されます。
15. デバッグマーカー
GPUDebugCommandsMixinは、コマンドグループにデバッグラベルを適用したり、コマンド列に単一ラベルを挿入したりするためのメソッドを提供します。
デバッググループは入れ子にして、ラベル付きコマンドの階層を作ることができ、バランスが取れていなければなりません。
オブジェクトラベルと同様、これらのラベルには必須の動作はありませんが、エラーメッセージやブラウザ開発者ツールに表示されたり、ネイティブAPIバックエンドに渡されたりする場合があります。
interface mixin GPUDebugCommandsMixin {undefined pushDebugGroup (USVString groupLabel );undefined popDebugGroup ();undefined insertDebugMarker (USVString markerLabel ); };
GPUDebugCommandsMixin
は同じオブジェクト上に
GPUObjectBase
と GPUCommandsMixin
のメンバーが存在することを前提としています。
これらのミックスインも含むインターフェイスのみがGPUDebugCommandsMixinをincludeできます。
GPUDebugCommandsMixin
には以下のデバイスタイムラインプロパティがあります:
[[debug_group_stack]], 型 stack<USVString>-
アクティブなデバッググループラベルのスタック。
GPUDebugCommandsMixin
には以下のメソッドがあります:
pushDebugGroup(groupLabel)-
後続のコマンドを含むラベル付きデバッググループを開始します。
Called on:GPUDebugCommandsMixinの this。Arguments:
メソッド GPUDebugCommandsMixin.pushDebugGroup(groupLabel) の引数。 Parameter Type Nullable Optional Description groupLabelUSVString✘ ✘ コマンドグループのラベル。 Returns:
undefinedContent timeline の手順:
-
次の手順を this.
[[device]]の Device timeline 上で発行します。
Device timeline の手順:-
Validate the encoder state を this に対して実行します。false が返った場合は戻ります。
-
Push groupLabel を this.
[[debug_group_stack]]に追加します。
-
popDebugGroup()-
pushDebugGroup()によって直近に開始されたラベル付きデバッググループを終了します。Called on:GPUDebugCommandsMixinの this。Returns:
undefinedContent timeline の手順:
-
次の手順を this.
[[device]]の Device timeline 上で発行します。
Device timeline の手順:-
Validate the encoder state を this に対して実行します。false が返った場合は戻ります。
-
以下の要件のいずれかが満たされない場合、invalidate を this に対して行い、戻ります。
-
this.
[[debug_group_stack]]は 空であってはなりません。
-
-
Pop を用いて this.
[[debug_group_stack]]からエントリを取り出します。
-
insertDebugMarker(markerLabel)-
コマンドの流れのある点をラベルでマークします。
Called on:GPUDebugCommandsMixinの this。Arguments:
メソッド GPUDebugCommandsMixin.insertDebugMarker(markerLabel) の引数。 Parameter Type Nullable Optional Description markerLabelUSVString✘ ✘ 挿入するラベル。 Returns:
undefinedContent timeline の手順:
-
次の手順を this.
[[device]]の Device timeline 上で発行します。
Device timeline の手順:-
Validate the encoder state を this に対して実行します。false が返った場合は戻ります。
-
16. コンピュートパス
16.1. GPUComputePassEncoder
[Exposed =(Window ,Worker ),SecureContext ]interface GPUComputePassEncoder {undefined setPipeline (GPUComputePipeline pipeline );undefined dispatchWorkgroups (GPUSize32 workgroupCountX ,optional GPUSize32 workgroupCountY = 1,optional GPUSize32 workgroupCountZ = 1);undefined dispatchWorkgroupsIndirect (GPUBuffer indirectBuffer ,GPUSize64 indirectOffset );undefined end (); };GPUComputePassEncoder includes GPUObjectBase ;GPUComputePassEncoder includes GPUCommandsMixin ;GPUComputePassEncoder includes GPUDebugCommandsMixin ;GPUComputePassEncoder includes GPUBindingCommandsMixin ;
GPUComputePassEncoder
には以下のデバイスタイムラインプロパティがあります:
[[command_encoder]], 型GPUCommandEncoder, 読み取り専用-
このコンピュートパスエンコーダを生成した
GPUCommandEncoder。 [[endTimestampWrite]], 型 GPU command?, 読み取り専用, デフォルトはnull-
パス終了時にタイムスタンプを書き込むGPUコマンド(ある場合)。
[[pipeline]], 型GPUComputePipeline, 初期値はnull
16.1.1. コンピュートパスエンコーダ生成
dictionary {GPUComputePassTimestampWrites required GPUQuerySet querySet ;GPUSize32 beginningOfPassWriteIndex ;GPUSize32 endOfPassWriteIndex ; };
querySet、 型:GPUQuerySet-
クエリ結果が書き込まれる
GPUQuerySet。型は"timestamp"です。 beginningOfPassWriteIndex、 型:GPUSize32-
指定された場合、コンピュートパスの開始時のタイムスタンプが書き込まれる
querySet内のクエリインデックスを示します。 endOfPassWriteIndex、 型:GPUSize32-
指定された場合、コンピュートパスの終了時のタイムスタンプが書き込まれる
querySet内のクエリインデックスを示します。
注: タイムスタンプクエリーの値はナノ秒単位で書き込まれますが、その値がどのように決定されるかは 実装依存です。詳細は § 20.4 タイムスタンプクエリー を参照してください。
dictionary :GPUComputePassDescriptor GPUObjectDescriptorBase {GPUComputePassTimestampWrites timestampWrites ; };
timestampWrites, 型 GPUComputePassTimestampWrites-
このパスでどのタイムスタンプ値を書き込み、どこに書き込むかを定義します。
16.1.2. ディスパッチ
setPipeline(pipeline)-
現在の
GPUComputePipelineを設定します。呼び出し元:GPUComputePassEncoderの this。引数:
GPUComputePassEncoder.setPipeline(pipeline) メソッドの引数。 パラメータ 型 Nullable Optional 説明 pipelineGPUComputePipeline✘ ✘ 以降のディスパッチコマンドに使用するコンピュートパイプライン。 戻り値:
undefinedコンテントタイムラインの手順:
-
次の手順を this.
[[device]]のDevice timelineに発行します。
Device timeline の手順:-
Encoderの状態を検証(this) を実行します。false なら終了。
-
次の条件のいずれかが満たされない場合は、invalidate を this に対して行い、終了します。
-
pipeline は this で使用可能 でなければなりません。
-
-
this.
[[pipeline]]を pipeline に設定します。
-
dispatchWorkgroups(workgroupCountX, workgroupCountY, workgroupCountZ)-
現在の
GPUComputePipelineで行うべき処理をディスパッチします。 詳細仕様については§ 23.1 コンピューティングを参照してください。呼び出し元:GPUComputePassEncoderの this。引数:
GPUComputePassEncoder.dispatchWorkgroups(workgroupCountX, workgroupCountY, workgroupCountZ) メソッドの引数。 パラメータ 型 Nullable Optional 説明 workgroupCountXGPUSize32✘ ✘ ディスパッチするワークグループのX方向のグリッド数。 workgroupCountYGPUSize32✘ ✔ ディスパッチするワークグループのY方向のグリッド数。 workgroupCountZGPUSize32✘ ✔ ディスパッチするワークグループのZ方向のグリッド数。 注:x、y、zの値(dispatchWorkgroups()およびdispatchWorkgroupsIndirect()へ渡す)は、それぞれの次元の ワークグループ数 であって、各次元のシェーダ呼び出し回数 ではありません。これは現代のネイティブGPU APIの動作と一致しますが、OpenCLの動作とは異なります。例えば、
GPUShaderModuleでエントリポイントを@workgroup_size(4, 4)と定義し、computePass.dispatchWorkgroups(8, 8);とディスパッチした場合、 エントリポイントは合計で1024回呼び出されます。 つまり 4x4 のワークグループを、X軸/Y軸でそれぞれ8回ディスパッチします。 (4*4*8*8=1024)戻り値:
undefinedコンテントタイムラインの手順:
-
次の手順を this.
[[device]]のDevice timelineに発行します。
Device timeline の手順:-
Encoderの状態を検証(this) を実行します。false なら終了。
-
usageScope を空のusage scopeとします。
-
this.
[[bind_groups]]の各 bindGroup について、 merge で bindGroup.[[usedResources]]を this.[[usage scope]]に統合します。 -
次の条件のいずれかが満たされない場合は、invalidate を this に対して行い、終了します。
-
usageScope はusage scope validationを満たす必要があります。
-
Validate encoder bind groups(this, this.
[[pipeline]]) がtrueであること。 -
workgroupCountX、workgroupCountY、workgroupCountZ のすべてが、 this.device.limits.
maxComputeWorkgroupsPerDimension以下であること。
-
-
bindingState を、this の現状態のスナップショットとします。
-
Enqueue a command を this に発行し、以降の手順をQueue timeline上で行います。
Queue timeline の手順:-
[workgroupCountX, workgroupCountY, workgroupCountZ] のサイズのワークグループグリッドを bindingState.
[[pipeline]]で実行し、 bindingState.[[bind_groups]]を使用します。
-
dispatchWorkgroupsIndirect(indirectBuffer, indirectOffset)-
現在の
GPUComputePipelineでGPUBufferから読み取ったパラメータを用いて ディスパッチします。 詳細な仕様は§ 23.1 コンピューティングを参照してください。バッファ内にエンコードされる indirect dispatch parameters は、 3つの32ビット符号なし整数値(合計12バイト)の緊密なブロックであり、
dispatchWorkgroups()の引数と同じ順番で格納してください。 例:let dispatchIndirectParameters= new Uint32Array( 3 ); dispatchIndirectParameters[ 0 ] = workgroupCountX; dispatchIndirectParameters[ 1 ] = workgroupCountY; dispatchIndirectParameters[ 2 ] = workgroupCountZ; 呼び出し元:GPUComputePassEncoderの this。引数:
GPUComputePassEncoder.dispatchWorkgroupsIndirect(indirectBuffer, indirectOffset) メソッドの引数。 パラメータ 型 Nullable Optional 説明 indirectBufferGPUBuffer✘ ✘ indirect dispatch parameters を含むバッファ。 indirectOffsetGPUSize64✘ ✘ indirectBuffer の何バイト目からディスパッチデータが開始するかのオフセット。 戻り値:
undefinedコンテントタイムラインの手順:
-
次の手順を this.
[[device]]のDevice timelineに発行します。
Device timeline の手順:-
Encoderの状態を検証(this) を実行します。false なら終了。
-
usageScope を空のusage scopeとします。
-
this.
[[bind_groups]]の各 bindGroup について、 merge で bindGroup.[[usedResources]]を this.[[usage scope]]に統合します。 -
次の条件のいずれかが満たされない場合は、invalidate を this に対して行い、終了します。
-
usageScope はusage scope validationを満たす必要があります。
-
Validate encoder bind groups(this, this.
[[pipeline]]) がtrueであること。 -
indirectBuffer は this で使用可能 であること。
-
indirectOffset + sizeof(indirect dispatch parameters) が indirectBuffer.
size以下であること。 -
indirectOffset は 4 の倍数であること。
-
-
bindingState を、this の現状態のスナップショットとします。
-
Enqueue a command を this に発行し、以降の手順をQueue timeline上で行います。
Queue timeline の手順:-
indirectBuffer の indirectOffset バイト位置から 符号なし32bit整数として workgroupCountX を読み出します。
-
indirectBuffer の (indirectOffset + 4) バイト位置から workgroupCountY を読み出します。
-
indirectBuffer の (indirectOffset + 8) バイト位置から workgroupCountZ を読み出します。
-
もし workgroupCountX または workgroupCountY または workgroupCountZ のいずれかが this.device.limits.
maxComputeWorkgroupsPerDimensionを超えていたら、処理を終了する。 -
[workgroupCountX, workgroupCountY, workgroupCountZ] のサイズのワークグループグリッドを bindingState.
[[pipeline]]で実行し、 bindingState.[[bind_groups]]を使用します。
-
16.1.3. ファイナライズ
ユーザーがパスのコマンド記録を完了したら end()
を呼び出すことでコンピュートパスエンコーダを終了できます。end()
が呼び出されると、コンピュートパスエンコーダはそれ以降使用できません。
end()-
コンピュートパスコマンドのシーケンスの記録を完了します。
呼び出し元:GPUComputePassEncoderの this。戻り値:
undefinedコンテンツタイムライン の手順:
-
次の手順を this.
[[device]]の Device timeline で発行します。
Device timeline の手順:-
parentEncoder を this.
[[command_encoder]]とします。 -
次の要件のいずれかが満たされない場合、 検証エラーを生成 して終了します。
-
Extend を用い、parentEncoder.
[[used_bind_groups]]に this.[[used_bind_groups]]を追加します。 -
次の要件のいずれかが満たされない場合、parentEncoder を無効化 して終了します。
-
this が valid でなければなりません。
-
this.
[[debug_group_stack]]は 空 でなければなりません。
-
-
Extend を用い、 parentEncoder.
[[commands]]に this.[[commands]]を追加します。 -
もし this.
[[endTimestampWrite]]がnullでない場合:-
Extend を用い、 parentEncoder.
[[commands]]に this.[[endTimestampWrite]]を追加します。
-
-
17. レンダーパス
17.1. GPURenderPassEncoder
[Exposed =(Window ,Worker ),SecureContext ]interface GPURenderPassEncoder {undefined setViewport (float x ,float y ,float width ,float height ,float minDepth ,float maxDepth );undefined setScissorRect (GPUIntegerCoordinate x ,GPUIntegerCoordinate y ,GPUIntegerCoordinate width ,GPUIntegerCoordinate height );undefined setBlendConstant (GPUColor color );undefined setStencilReference (GPUStencilValue reference );undefined beginOcclusionQuery (GPUSize32 queryIndex );undefined endOcclusionQuery ();undefined executeBundles (sequence <GPURenderBundle >bundles );undefined end (); };GPURenderPassEncoder includes GPUObjectBase ;GPURenderPassEncoder includes GPUCommandsMixin ;GPURenderPassEncoder includes GPUDebugCommandsMixin ;GPURenderPassEncoder includes GPUBindingCommandsMixin ;GPURenderPassEncoder includes GPURenderCommandsMixin ;
GPURenderPassEncoder
には以下のデバイスタイムラインプロパティがあります:
[[command_encoder]]、型はGPUCommandEncoder、 読み取り専用-
このレンダーパスエンコーダーを生成した
GPUCommandEncoderです。 [[attachment_size]]、読み取り専用-
次のエクステントに設定されます:
-
width, height= パスのレンダーアタッチメントの寸法
-
[[occlusion_query_set]]、 型はGPUQuerySet、読み取り専用-
このパスのオクルージョンクエリ結果を格納する
GPUQuerySetであり、 パス作成時にGPURenderPassDescriptor.occlusionQuerySetで初期化されます。 [[endTimestampWrite]]、型は GPU command?、読み取り専用、デフォルトはnull-
パス終了時にタイムスタンプを書き込む GPU command(もしあれば)。
[[maxDrawCount]]、型はGPUSize64、読み取り専用-
このパスで許可される最大ドロー回数です。
[[occlusion_query_active]]、 型はboolean-
パスの
[[occlusion_query_set]]への書き込みが行われているかどうか。
エンコードされたレンダーパスコマンドを GPUCommandBuffer
の一部として実行するとき、
内部で
RenderState オブジェクトが
描画に必要な現在の状態を追跡するために使用されます。
RenderState は次の queue timeline プロパティ を持ちます:
[[occlusionQueryIndex]]、型はGPUSize32-
[[occlusion_query_set]]内でオクルージョンクエリ結果を保存するインデックスです。 [[viewport]]-
現在のビューポートの矩形とデプス範囲。初期値は次の通りです:
-
x, y=0.0, 0.0 -
width, height= パスのレンダーターゲットの寸法 -
minDepth, maxDepth=0.0, 1.0
-
[[scissorRect]]-
現在のシザー矩形。初期値は次の通りです:
-
x, y=0, 0 -
width, height= パスのレンダーターゲットの寸法
-
[[blendConstant]]、型はGPUColor-
現在のブレンド定数値。初期値は
[0, 0, 0, 0]です。 [[stencilReference]]、型はGPUStencilValue-
現在のステンシルリファレンス値。初期値は
0です。 [[colorAttachments]]、型は sequence<GPURenderPassColorAttachment?>-
このレンダーパスのカラ―アタッチメントとその状態です。
[[depthStencilAttachment]]、型はGPURenderPassDepthStencilAttachment?-
このレンダーパスのデプス/ステンシルアタッチメントとその状態です。
レンダーパスにはframebuffer memoryもあり、各アタッチメントに対応するテクセルデータを格納し、ドローコマンドで書き込まれたり、ブレンドやデプス/ステンシルテストで読み取られたりする。
注: GPUハードウェアによっては、framebuffer memoryがアタッチメントテクスチャで割り当てられたメモリである場合や、タイルベースアーキテクチャのようにテクスチャデータがコピーされる別領域のメモリである場合もある。
17.1.1. レンダーパスエンコーダ生成
dictionary {GPURenderPassTimestampWrites required GPUQuerySet querySet ;GPUSize32 beginningOfPassWriteIndex ;GPUSize32 endOfPassWriteIndex ; };
querySet、型:GPUQuerySet-
クエリ結果が書き込まれる
GPUQuerySetです。型は"timestamp"です。 beginningOfPassWriteIndex、 型:GPUSize32-
指定された場合、レンダーパス開始時のタイムスタンプが書き込まれる
querySetのクエリインデックスを示します。 endOfPassWriteIndex、 型:GPUSize32-
指定された場合、レンダーパス終了時のタイムスタンプが書き込まれる
querySetのクエリインデックスを示します。
注: タイムスタンプクエリの値はナノ秒単位で書き込まれますが、その値がどのように決定されるかは 実装依存です。詳細は § 20.4 タイムスタンプクエリ を参照してください。
dictionary :GPURenderPassDescriptor GPUObjectDescriptorBase {required sequence <GPURenderPassColorAttachment ?>colorAttachments ;GPURenderPassDepthStencilAttachment depthStencilAttachment ;GPUQuerySet occlusionQuerySet ;GPURenderPassTimestampWrites timestampWrites ;GPUSize64 maxDrawCount = 50000000; };
colorAttachments, 型sequence<GPURenderPassColorAttachment?>-
このシーケンス内の
GPURenderPassColorAttachment値の集合が、このレンダーパスの実行時に出力されるカラーアタッチメントを定義します。使用互換性のため、どのカラーアタッチメントも他のアタッチメントやパス内で使われるリソースとエイリアスしてはなりません。
depthStencilAttachment, 型 GPURenderPassDepthStencilAttachment-
実行時に出力・テストされるデプス/ステンシルアタッチメントを定義する
GPURenderPassDepthStencilAttachment値。使用互換性のため、どの書き込み可能なデプス/ステンシルアタッチメントも他のアタッチメントやパス内で使われるリソースとエイリアスしてはなりません。
occlusionQuerySet, 型 GPUQuerySet-
このパスのオクルージョンクエリ結果の格納先を定義する
GPUQuerySet値。 timestampWrites, 型 GPURenderPassTimestampWrites-
このパスでどのタイムスタンプ値を書き込み、どこに書き込むかを定義します。
maxDrawCount, 型 GPUSize64、デフォルト値は50000000-
このレンダーパスで実行される最大ドロー呼び出し数。一部の実装ではレンダーパス前に投入される処理のサイズ決定に使われます。デフォルト値のままで問題ありませんが、より多くのドロー呼び出しが行われることが分かっている場合は調整してください。
GPUDevice
deviceとGPURenderPassDescriptor
thisが与えられた場合、以下の検証ルールが適用されます:
-
this.
colorAttachments.size は device.[[limits]].maxColorAttachments以下でなければなりません。 -
this.
colorAttachments内の null でない各 colorAttachment について:-
colorAttachment.
viewは device で使用可能 でなければなりません。 -
もし colorAttachment.
resolveTargetが 提供 されている場合:-
colorAttachment.
resolveTargetは device で使用可能 でなければなりません。
-
-
colorAttachment は GPURenderPassColorAttachment Valid Usage のルールを満たさなければなりません。
-
-
もし this.
depthStencilAttachmentが 提供 されている場合:-
this.
depthStencilAttachment.viewは device で使用可能 でなければなりません。 -
this.
depthStencilAttachmentは GPURenderPassDepthStencilAttachment Valid Usage のルールを満たさなければなりません。
-
-
少なくとも1つのアタッチメントが存在しなければなりません。例えば:
-
this.
colorAttachments内に null でない値がある、もしくは -
this.
depthStencilAttachmentが存在する。
-
-
GPURenderPassDescriptorのcolor attachment bytes per sampleの検証(device, this.
colorAttachments) に成功すること。 -
null でない this.
colorAttachmentsの各メンバーおよび this.depthStencilAttachmentが存在する場合はその .viewについて、すべてのsampleCountが等しくなければなりません。 -
null でない this.
colorAttachmentsの各メンバーおよび this.depthStencilAttachmentが存在する場合はその .viewの[[renderExtent]]も一致しなければなりません。 -
もし this.
occlusionQuerySetが 提供 されている場合:-
this.
occlusionQuerySetは device で使用可能 でなければなりません。 -
this.
occlusionQuerySet.typeはocclusionでなければなりません。
-
-
もし this.
timestampWritesが 提供 されている場合:-
timestampWritesの検証(device, this.
timestampWrites) の結果は true でなければなりません。
-
引数:
-
GPUDevicedevice -
sequence<
GPURenderPassColorAttachment?> colorAttachments
デバイスタイムラインの手順:
-
formats を空の リスト<
GPUTextureFormat?> とします。 -
colorAttachments 内の各 colorAttachment について:
-
もし colorAttachment が
undefinedなら、continue。 -
Append で colorAttachment.
view.[[descriptor]].formatを formats に追加する。
-
-
カラーアタッチメントのサンプルごとのバイト数の計算(formats) の結果は device.
[[limits]].maxColorAttachmentBytesPerSample以下でなければなりません。
17.1.1.1. カラ―アタッチメント
dictionary {GPURenderPassColorAttachment required (GPUTexture or GPUTextureView )view ;GPUIntegerCoordinate depthSlice ; (GPUTexture or GPUTextureView )resolveTarget ;GPUColor clearValue ;required GPULoadOp loadOp ;required GPUStoreOp storeOp ; };
view, 型:(GPUTexture または GPUTextureView)-
このカラ―アタッチメントの出力先となるテクスチャサブリソースを記述します。 サブリソースは、 get as texture view(
view) の結果で決まります。 depthSlice, 型:GPUIntegerCoordinateresolveTarget, 型:(GPUTexture または GPUTextureView)-
もし
viewがマルチサンプルの場合、このカラ―アタッチメントの結果を受け取るテクスチャサブリソースを記述します。 サブリソースは get as texture view(resolveTarget) により決定されます。 clearValue, 型:GPUColor-
レンダーパスを実行する前に
viewをクリアする値を示します。指定されていない場合、デフォルトは{r: 0, g: 0, b: 0, a: 0}です。loadOpが"clear"以外の場合は無視されます。clearValueの各成分は全て double 値です。これらはレンダーアタッチメントと一致するテクスチャフォーマットの テクセル値へ変換されます。 変換に失敗した場合はバリデーションエラーとなります。 loadOp, 型:GPULoadOp-
レンダーパス実行前に
viewに対して行うロード操作を示します。注:クリアを優先することが推奨されています。詳細は
"clear"を参照してください。 storeOp, 型:GPUStoreOp-
レンダーパス実行後に
viewに対して行うストア操作です。
GPURenderPassColorAttachment
this が与えられたとき:
-
renderViewDescriptor を this.
view.[[descriptor]]とします。 -
renderTexture を this.
view.[[texture]]とします。 -
以下のすべての要件を満たす必要があります。
-
renderViewDescriptor.
formatはカラー描画可能フォーマットでなければなりません。 -
this.
viewは描画可能テクスチャビューでなければなりません。 -
もし renderViewDescriptor.
dimensionが"3d"の場合:-
this.
depthSliceは指定され、 ロジカルmiplevel別テクスチャエクステントの depthOrArrayLayers より小さくなければなりません(このサブリソースは mipmap level renderViewDescriptor.baseMipLevelで)。
それ以外の場合:
-
this.
depthSliceは指定されていてはなりません。
-
-
-
IDL値の this.
clearValueを テクセル値へ変換 した結果が renderViewDescriptor.formatに対してTypeErrorを投げてはなりません。注: 値がフォーマットの範囲外でも、WGSLのプリミティブ型(
f32,i32,u32)の範囲内であればエラーにはなりません。
-
-
もし this.
resolveTargetが指定されている場合:-
resolveViewDescriptor を this.
resolveTarget.[[descriptor]]とする。 -
resolveTexture を this.
resolveTarget.[[texture]]とする。 -
renderTexture.
sampleCountは1より大きくなければなりません。 -
resolveTexture.
sampleCountは1でなければなりません。 -
this.
resolveTargetは3Dでない描画可能テクスチャビューでなければなりません。 -
this.
resolveTarget.[[renderExtent]]と this.view.[[renderExtent]]が一致しなければなりません。 -
resolveViewDescriptor.
formatは renderViewDescriptor.formatと等しくなければなりません。 -
resolveViewDescriptor.
formatは§ 26.1.1 プレーンカラーフォーマットに従い、リゾルブ対応フォーマットでなければなりません。
-
-
GPUTextureView
view は、もし次のデバイスタイムライン手順のすべてを満たす場合
描画可能テクスチャビュー
です:
-
descriptor を view.
[[descriptor]]とする。 -
descriptor.
usageはRENDER_ATTACHMENTを含む必要があります。 -
descriptor.
dimensionは"2d"または"2d-array"または"3d"でなければなりません。 -
descriptor.
mipLevelCountは1でなければなりません。 -
descriptor.
arrayLayerCountは1でなければなりません。 -
descriptor.
aspectは view.[[texture]]のすべてのアスペクトを参照していなければなりません。 -
descriptor.
swizzleは"rgba"でなければなりません。
引数:
-
sequence<
GPUTextureFormat?> formats
戻り値: GPUSize32
-
total を 0 とする。
-
formats 内の非nullの各 format について
-
Assert: format がカラー描画可能フォーマットである。
-
renderTargetPixelByteCost を format の render target pixel byte costとする。
-
renderTargetComponentAlignment を format の render target component alignmentとする。
-
total を renderTargetComponentAlignment の最小の倍数(total以上)に切り上げる。
-
renderTargetPixelByteCost を total に加算する。
-
-
total を返す。
17.1.1.2. デプス/ステンシルアタッチメント
dictionary {GPURenderPassDepthStencilAttachment required (GPUTexture or GPUTextureView )view ;float depthClearValue ;GPULoadOp depthLoadOp ;GPUStoreOp depthStoreOp ;boolean depthReadOnly =false ;GPUStencilValue stencilClearValue = 0;GPULoadOp stencilLoadOp ;GPUStoreOp stencilStoreOp ;boolean stencilReadOnly =false ; };
view, 型(GPUTexture または GPUTextureView)-
このデプス/ステンシルアタッチメントで出力・読み取りされるテクスチャサブリソースを記述します。 サブリソースはget as texture view(
view)呼び出しで決定されます。 depthClearValue, 型 float-
レンダーパス実行前に
viewのデプス成分をクリアする値を示します。depthLoadOpが"clear"でない場合は無視されます。 0.0以上1.0以下でなければなりません。 depthLoadOp, 型 GPULoadOp-
レンダーパス実行前に
viewのデプス成分に対して行うロード操作を示します。注: クリアを推奨します。詳細は
"clear"を参照してください。 depthStoreOp, 型 GPUStoreOp-
レンダーパス実行後に
viewのデプス成分に対して行うストア操作。 depthReadOnly, 型 boolean, デフォルトはfalse-
viewのデプス成分が読み取り専用であることを示します。 stencilClearValue, 型 GPUStencilValue, デフォルトは0-
レンダーパス実行前に
viewのステンシル成分をクリアする値を示します。stencilLoadOpが"clear"でない場合は無視されます。値はviewのステンシルアスペクトの型に変換され、1テクセル分のステンシルアスペクトビット数分のLSBを利用します。
stencilLoadOp, 型 GPULoadOp-
レンダーパス実行前に
viewのステンシル成分に対して行うロード操作を示します。注: クリアを推奨します。詳細は
"clear"を参照してください。 stencilStoreOp, 型 GPUStoreOp-
レンダーパス実行後に
viewのステンシル成分に対して行うストア操作。 stencilReadOnly, 型 boolean, デフォルトはfalse-
viewのステンシル成分が読み取り専用であることを示します。
GPURenderPassDepthStencilAttachment
の this に対して、次のバリデーションルールが適用されます:
-
this.
viewはデプスまたはステンシルフォーマットを持っていなければなりません。 -
this.
viewは描画可能テクスチャビューでなければなりません。 -
format を this.
view.[[descriptor]].formatとする。 -
もし this.
depthLoadOpが"clear"の場合、 this.depthClearValueは指定され、0.0以上1.0以下でなければなりません。 -
もし format がデプスアスペクトを持ち、かつ this.
depthReadOnlyがfalseの場合:-
this.
depthLoadOpは指定されていなければなりません。 -
this.
depthStoreOpは指定されていなければなりません。
それ以外の場合:
-
this.
depthLoadOpは指定されていてはなりません。 -
this.
depthStoreOpは指定されていてはなりません。
-
-
もし format がステンシルアスペクトを持ち、かつ this.
stencilReadOnlyがfalseの場合:-
this.
stencilLoadOpは指定されていなければなりません。 -
this.
stencilStoreOpは指定されていなければなりません。
それ以外の場合:
-
this.
stencilLoadOpは指定されていてはなりません。 -
this.
stencilStoreOpは指定されていてはなりません。
-
17.1.1.3. ロード/ストア操作
enum {GPULoadOp "load" ,"clear" , };
"load"-
このアタッチメントの既存の値をレンダーパスにロードします。
"clear"-
このアタッチメントのクリア値をレンダーパスにロードします。
注: 一部のGPUハードウェア(主にモバイル)では、
"clear"の方がはるかに高速です。これは、メインメモリからタイルローカルメモリへのデータロードを回避できるためです。 他のGPUハードウェアでは大きな違いはありません。そのため、初期値が重要でない場合(例:レンダーターゲットをスカイボックスでクリアする場合)は"clear"を"load"よりも推奨します。
enum {GPUStoreOp "store" ,"discard" , };
"store"-
レンダーパスの実行結果をこのアタッチメントに保存します。
"discard"-
レンダーパスの実行結果をこのアタッチメントで破棄します。
注: 破棄されたアタッチメントはゼロクリアされたかのように扱われますが、実装はレンダーパス終了時に明示的なクリアを行う必要はありません。 パス終了時に明示的なクリアを行わない実装は、アタッチメントの内容を読み込む(サンプリング、コピー、次のレンダーパスへ
"load"でアタッチ、キャンバス表示や読み出し (get a copy of the image contents of a context) など)前に遅延クリアを行わなければなりません。
17.1.1.4. レンダーパスレイアウト
GPURenderPassLayout
はGPURenderBundleのレンダーターゲットのレイアウトを宣言します。
また、内部的には
GPURenderPassEncoder
のレイアウトや
GPURenderPipeline
のレイアウトにも使われます。
この型は、レンダーパス・レンダーバンドル・レンダーパイプライン間の互換性判定に使われます。
dictionary :GPURenderPassLayout GPUObjectDescriptorBase {required sequence <GPUTextureFormat ?>colorFormats ;GPUTextureFormat depthStencilFormat ;GPUSize32 sampleCount = 1; };
colorFormats, 型sequence<GPUTextureFormat?>-
このパスまたはバンドルのカラ―アタッチメントの
GPUTextureFormatのリスト。 depthStencilFormat, 型 GPUTextureFormat-
このパスまたはバンドルのデプス/ステンシルアタッチメントの
GPUTextureFormat。 sampleCount, 型 GPUSize32, デフォルトは1-
このパスまたはバンドルのアタッチメントのピクセルごとのサンプル数。
GPURenderPassLayout
値は等しいのは:
-
それぞれの
depthStencilFormatとsampleCountが等しいこと、かつ -
それぞれの
colorFormatsが末尾のnullを無視して等しいこと。
引数:
-
GPURenderPassDescriptordescriptor
戻り値: GPURenderPassLayout
デバイスタイムライン手順:
-
layout を新しい
GPURenderPassLayoutオブジェクトとします。 -
descriptor.
colorAttachmentsの各 colorAttachment について:-
もし colorAttachment が
nullでなければ:-
layout.
sampleCountを colorAttachment.view.[[texture]].sampleCountに設定します。 -
colorAttachment.
view.[[descriptor]].formatを layout.colorFormatsに追加します。
それ以外の場合:
-
nullを layout.colorFormatsに追加します。
-
-
-
depthStencilAttachment を descriptor.
depthStencilAttachmentとします。 -
もし depthStencilAttachment が
nullでなければ:-
view を depthStencilAttachment.
viewとします。 -
layout.
sampleCountを view.[[texture]].sampleCountに設定します。 -
layout.
depthStencilFormatを view.[[descriptor]].formatに設定します。
-
-
layout を返します。
引数:
-
GPURenderPipelineDescriptordescriptor
戻り値: GPURenderPassLayout
デバイスタイムラインの手順:
-
layout を新しい
GPURenderPassLayoutオブジェクトとします。 -
layout.
sampleCountを descriptor.multisample.countに設定します。 -
もし descriptor.
depthStencilが指定されていれば:-
layout.
depthStencilFormatを descriptor.depthStencil.formatに設定します。
-
-
もし descriptor.
fragmentが指定されていれば:-
descriptor.
fragment.targetsの各 colorTarget について:-
colorTarget が
nullでなければ colorTarget.formatを layout.colorFormatsに追加し、nullならnullを追加する。
-
-
-
layout を返します。
17.1.2. ファイナライズ
レンダーパスのコマンド記録が完了したら、end()
を呼び出すことでレンダーパスエンコーダを終了できます。end()
が呼び出された後は、このレンダーパスエンコーダは使用できません。
end()-
レンダーパスコマンドシーケンスの記録を完了します。
呼び出し対象:GPURenderPassEncoderthis。戻り値:
undefinedコンテンツタイムラインの手順:
-
次の手順を this.
[[device]]のDevice timelineで発行します。
Device timeline の手順:-
parentEncoder を this.
[[command_encoder]]とします。 -
以下の要件のいずれかを満たさない場合、 バリデーションエラーを生成し終了します。
-
Extend で parentEncoder.
[[used_bind_groups]]に this.[[used_bind_groups]]を追加します。 -
次のいずれかを満たさない場合、invalidateを parentEncoder に行い終了します。
-
this は valid でなければなりません。
-
this.
[[usage scope]]は usage scope validation を満たさなければなりません。 -
this.
[[debug_group_stack]]は空でなければなりません。 -
this.
[[occlusion_query_active]]はfalseでなければなりません。 -
this.
[[drawCount]]は this.[[maxDrawCount]]以下であること。
-
-
Extend で parentEncoder.
[[commands]]に this.[[commands]]を追加します。 -
もし this.
[[endTimestampWrite]]がnullでない場合:-
Extend で parentEncoder.
[[commands]]に this.[[endTimestampWrite]]を追加します。
-
-
レンダーコマンドをエンキューする を this に対し行い、以降の手順を Queue timeline で renderState とともに実行します。
Queue timeline の手順:-
renderState.
[[colorAttachments]]内の non-nullな各 colorAttachment について:-
colorView を colorAttachment.
viewとします。 -
もし colorView.
[[descriptor]].dimensionが:"3d"-
colorSubregion を colorAttachment.
depthSliceof colorView とする。 - その他
-
colorSubregion を colorView とする。
-
もし colorAttachment.
resolveTargetがnullでなければ:-
colorSubregion の各 テクセル の複数サンプルを 1 サンプルにリゾルブし colorAttachment.
resolveTargetにコピーします。
-
-
colorAttachment.
storeOpが:"store"-
colorSubregion に関連付けられた フレームバッファメモリ の内容を colorSubregion に保存します。
"discard"-
colorSubregion の各 テクセル をゼロにします。
-
-
depthStencilAttachment を renderState.
[[depthStencilAttachment]]とする。 -
depthStencilAttachment が
nullでなければ:-
depthStencilAttachment.
depthStoreOpが: -
depthStencilAttachment.
stencilStoreOpが:
-
-
renderState を
nullに設定します。
注: 破棄されたアタッチメントはゼロクリアされたかのように動作しますが、実装はレンダーパス終了時にクリアを行う必要はありません。 詳細は
"discard"の注を参照してください。注: Read-only depth-stencil アタッチメントは暗黙的に
"store"操作として扱われますが、内容がレンダーパス中に変更されないため実装はアタッチメントの更新を行う必要がありません。read-only アタッチメントに store op を指定してはいけないというバリデーションは GPURenderPassDepthStencilAttachment 有効使用条件 内で検証されます。 -
17.2. GPURenderCommandsMixin
GPURenderCommandsMixin
はGPURenderPassEncoder
とGPURenderBundleEncoder
に共通のレンダリングコマンドを定義します。
interface mixin GPURenderCommandsMixin {undefined setPipeline (GPURenderPipeline pipeline );undefined setIndexBuffer (GPUBuffer buffer ,GPUIndexFormat indexFormat ,optional GPUSize64 offset = 0,optional GPUSize64 size );undefined setVertexBuffer (GPUIndex32 slot ,GPUBuffer ?buffer ,optional GPUSize64 offset = 0,optional GPUSize64 size );undefined draw (GPUSize32 vertexCount ,optional GPUSize32 instanceCount = 1,optional GPUSize32 firstVertex = 0,optional GPUSize32 firstInstance = 0);undefined drawIndexed (GPUSize32 indexCount ,optional GPUSize32 instanceCount = 1,optional GPUSize32 firstIndex = 0,optional GPUSignedOffset32 baseVertex = 0,optional GPUSize32 firstInstance = 0);undefined drawIndirect (GPUBuffer indirectBuffer ,GPUSize64 indirectOffset );undefined drawIndexedIndirect (GPUBuffer indirectBuffer ,GPUSize64 indirectOffset ); };
GPURenderCommandsMixin
は、同じオブジェクト上に
GPUObjectBase、
GPUCommandsMixin、
GPUBindingCommandsMixin
のメンバーが存在することを前提としています。
これらのミックスインも含むインターフェイスのみがGPURenderCommandsMixinをincludeできます。
GPURenderCommandsMixin
には以下のデバイスタイムラインプロパティがあります:
[[layout]]、型はGPURenderPassLayout、読み取り専用-
このレンダーパスのレイアウト。
[[depthReadOnly]]、型はboolean、読み取り専用-
trueなら、デプス成分が変更されないことを示します。 [[stencilReadOnly]]、型はboolean、読み取り専用-
trueなら、ステンシル成分が変更されないことを示します。 [[usage scope]]、型はusage scope、初期値は空-
このレンダーパスまたはバンドルに対するusage scope。
[[pipeline]]、型はGPURenderPipeline、初期値はnull[[index_buffer]]、型はGPUBuffer、初期値はnull-
インデックスデータの読み出しに使われる現在のバッファ。
[[index_format]]、型はGPUIndexFormat-
[[index_buffer]]内のインデックスデータのフォーマット。 [[index_buffer_offset]]、型はGPUSize64-
現在設定されている
[[index_buffer]]のバイトオフセット。 [[index_buffer_size]]、型はGPUSize64-
現在設定されている
[[index_buffer]]のサイズ(バイト単位)、初期値は0。 [[vertex_buffers]]、型は ordered map<slot,GPUBuffer>、初期値は空-
各スロット用に頂点データ読み出しのために使われる現在の
GPUBuffer。 [[vertex_buffer_sizes]]、型は ordered map<slot,GPUSize64>、初期値は空-
各スロットで現在設定されている
GPUBufferのサイズ(バイト単位)。 [[drawCount]]、型はGPUSize64-
このエンコーダーに記録されたドローコマンドの数。
GPURenderCommandsMixin
encoder に対して レンダーコマンドをエンキューする
(GPU Command command と
RenderState renderState
を伴う)の
device timeline 手順は次の通り:
-
Append で encoder.
[[commands]]に command を追加する。 -
command を
GPUCommandBuffercommandBuffer の一部として実行する際:-
commandBuffer.
[[renderState]]を renderState として command の手順を発行する。
-
17.2.1. 描画
setPipeline(pipeline)-
現在使用する
GPURenderPipelineを設定します。呼び出し対象:GPURenderCommandsMixinthis.引数:
メソッド GPURenderCommandsMixin.setPipeline(pipeline) の引数。 パラメーター 型 Nullable Optional 説明 pipelineGPURenderPipeline✘ ✘ その後の描画コマンドで使用するレンダーパイプライン。 戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で発行します。対象は this の
[[device]]です。
Device timeline の手順:-
エンコーダー状態を検証します(対象は this)。false を返した場合は終了します。
-
pipelineTargetsLayout を derive render targets layout from pipeline(pipeline.
[[descriptor]]) とします。 -
次のいずれかの条件が満たされない場合は、invalidate を this に対して行い、終了します。
-
pipeline が valid to use with this であること。
-
this.
[[layout]]が equals pipelineTargetsLayout であること。 -
もし pipeline.
[[writesDepth]]が真なら、 this.[[depthReadOnly]]はfalseでなければなりません。 -
もし pipeline.
[[writesStencil]]が真なら、 this.[[stencilReadOnly]]はfalseでなければなりません。
-
-
this.
[[pipeline]]を pipeline に設定します。
-
setIndexBuffer(buffer, indexFormat, offset, size)-
現在のインデックスバッファを設定します。
呼び出し対象:GPURenderCommandsMixinthis.引数:
メソッド GPURenderCommandsMixin.setIndexBuffer(buffer, indexFormat, offset, size) の引数。 パラメーター 型 Nullable Optional 説明 bufferGPUBuffer✘ ✘ その後の描画コマンドで使用するインデックスデータを含むバッファ。 indexFormatGPUIndexFormat✘ ✘ buffer に含まれるインデックスデータのフォーマット。 offsetGPUSize64✘ ✔ インデックスデータが始まる buffer 内のバイト単位のオフセット。既定値は 0です。sizeGPUSize64✘ ✔ buffer 内のインデックスデータのバイト数。既定値はバッファのサイズからオフセットを引いた値です。 戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で発行します(対象は this.
[[device]])。
Device timeline の手順:-
エンコーダー状態を検証します(対象は this)。false を返した場合は終了します。
-
size が与えられていない場合、size を max(0, buffer.
size- offset) に設定します。 -
次のいずれかの条件が満たされない場合は、invalidate を this に対して行い、終了します。
-
buffer が valid to use with this であること。
-
offset が indexFormat のバイトサイズの倍数であること。
-
offset + size ≤ buffer.
sizeであること。
-
-
Add buffer を
[[usage scope]]に使用法 input で追加します。 -
this.
[[index_buffer]]を buffer に設定します。 -
this.
[[index_format]]を indexFormat に設定します。 -
this.
[[index_buffer_offset]]を offset に設定します。 -
this.
[[index_buffer_size]]を size に設定します。
-
setVertexBuffer(slot, buffer, offset, size)-
指定したスロットに対する現在の頂点バッファを設定します。
呼び出し対象:GPURenderCommandsMixinthis.引数:
メソッド GPURenderCommandsMixin.setVertexBuffer(slot, buffer, offset, size) の引数。 パラメーター 型 Nullable Optional 説明 slotGPUIndex32✘ ✘ 頂点バッファを設定するスロット。 bufferGPUBuffer?✔ ✘ その後の描画コマンドで使用する頂点データを含むバッファ。 offsetGPUSize64✘ ✔ buffer 内で頂点データが始まるバイト単位のオフセット。既定値は 0です。sizeGPUSize64✘ ✔ buffer 内の頂点データのバイト数。既定値はバッファのサイズからオフセットを引いた値です。 戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で発行します(対象は this.
[[device]])。
Device timeline の手順:-
エンコーダー状態を検証します(対象は this)。false を返した場合は終了します。
-
bufferSize を、buffer が
nullの場合は 0、そうでなければ buffer.sizeに設定します。 -
size が与えられていない場合、size を max(0, bufferSize - offset) に設定します。
-
次の要件のいずれかが満たされない場合は、invalidate を this に対して行い、終了します。
-
slot は this.
[[device]].[[limits]].maxVertexBuffersより小さい必要があります。 -
offset は 4 の倍数である必要があります。
-
offset + size が ≤ bufferSize である必要があります。
-
-
もし buffer が
nullの場合:-
Remove this.
[[vertex_buffers]][slot]。 -
Remove this.
[[vertex_buffer_sizes]][slot]。
それ以外の場合:
-
次の要件のいずれかが満たされない場合は、invalidate を this に対して行い、終了します。
-
buffer が valid to use with this であること。
-
-
Add buffer を
[[usage scope]]に使用法 input で追加します。 -
this.
[[vertex_buffers]][slot] を buffer に設定します。 -
this.
[[vertex_buffer_sizes]][slot] を size に設定します。
-
-
draw(vertexCount, instanceCount, firstVertex, firstInstance)-
プリミティブを描画します。 詳細な仕様は § 23.2 Rendering を参照してください。
呼び出し対象:GPURenderCommandsMixinthis.引数:
メソッド GPURenderCommandsMixin.draw(vertexCount, instanceCount, firstVertex, firstInstance) の引数。 パラメーター 型 Nullable Optional 説明 vertexCountGPUSize32✘ ✘ 描画する頂点の数。 instanceCountGPUSize32✘ ✔ 描画するインスタンスの数。 firstVertexGPUSize32✘ ✔ 頂点バッファ内の描画開始頂点へのオフセット(頂点単位)。 firstInstanceGPUSize32✘ ✔ 描画を開始する最初のインスタンス。 戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で発行します(対象は this.
[[device]])。
Device timeline の手順:-
エンコーダー状態を検証します(対象は this)。false を返した場合は終了します。
-
以下の手順群の要件がすべて満たされている必要があります。もし満たされない場合は、invalidate を this に対して行い、終了します。
-
この this で valid to draw である必要があります。
-
buffers を this.
[[pipeline]].[[descriptor]].vertex.buffersとします。 -
各
GPUIndex32の slot について、0から buffers.size(非包含)まで繰り返します:-
もし buffers[slot] が
nullなら、continue します。 -
bufferSize を this.
[[vertex_buffer_sizes]][slot] とします。 -
stride を buffers[slot].
arrayStrideとします。 -
attributes を buffers[slot].
attributesとします。 -
lastStride を、attributes の各 attribute に対して (attribute.
offset+ byteSize(attribute.format)) の最大値、または attributes が empty の場合は 0 とします。 -
strideCount を buffers[slot].
stepModeに基づいて計算します:"vertex"-
firstVertex + vertexCount
"instance"-
firstInstance + instanceCount
-
もし strideCount ≠
0なら:-
(strideCount −
1) × stride + lastStride が bufferSize 以下でなければなりません。
-
-
-
-
this.
[[drawCount]]を 1 増やします。 -
bindingState を this の現在の状態のスナップショットとして取得します。
-
レンダーコマンドをキューに追加します。実行時に renderState と共に Queue timeline 上で後続の手順を発行します。
Queue timeline の手順:-
instanceCount 個のインスタンスを、インスタンス firstInstance から開始して描画します。各プリミティブは vertexCount 頂点からなり、頂点は firstVertex から始まります。状態は bindingState と renderState を使用します。
-
drawIndexed(indexCount, instanceCount, firstIndex, baseVertex, firstInstance)-
インデックス付きのプリミティブを描画します。 詳細な仕様は § 23.2 Rendering を参照してください。
呼び出し対象:GPURenderCommandsMixinthis.引数:
メソッド GPURenderCommandsMixin.drawIndexed(indexCount, instanceCount, firstIndex, baseVertex, firstInstance) の引数。 パラメーター 型 Nullable Optional 説明 indexCountGPUSize32✘ ✘ 描画するインデックスの数。 instanceCountGPUSize32✘ ✔ 描画するインスタンスの数。 firstIndexGPUSize32✘ ✔ インデックスバッファ内で描画を開始するオフセット(インデックス単位)。 baseVertexGPUSignedOffset32✘ ✔ 各インデックス値に加算され、頂点バッファのインデックスに使用される値。 firstInstanceGPUSize32✘ ✔ 描画を開始する最初のインスタンス。 戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で発行します(対象は this.
[[device]])。
Device timeline の手順:-
エンコーダー状態を検証します(対象は this)。false を返した場合は終了します。
-
次のいずれかの条件が満たされない場合は、invalidate を this に対して行い、終了します。
-
この this で valid to draw indexed であること。
-
firstIndex + indexCount ≤ this.
[[index_buffer_size]]÷ this.[[index_format]]のバイトサイズであること。 -
buffers を this.
[[pipeline]].[[descriptor]].vertex.buffersとします。 -
各
GPUIndex32の slot について、0から buffers.size(非包含)まで繰り返します:-
もし buffers[slot] が
nullなら、continue します。 -
bufferSize を this.
[[vertex_buffer_sizes]][slot] とします。 -
stride を buffers[slot].
arrayStrideとします。 -
lastStride を buffers[slot].
attributesの各 attribute に対して attribute.offset+ byteSize(attribute.format) の最大値として定義します。 -
strideCount を firstInstance + instanceCount とします。
-
もし buffers[slot].
stepModeが"instance"であり、かつ strideCount ≠0なら:-
(strideCount −
1) × stride + lastStride ≤ bufferSize を保証します。
-
-
-
-
this.
[[drawCount]]を 1 増やします。 -
bindingState を this の現在の状態のスナップショットとして取得します。
-
レンダーコマンドをキューに追加します。実行時に renderState と共に Queue timeline 上で後続の手順を発行します。
Queue timeline の手順:-
instanceCount 個のインスタンスを、インスタンス firstInstance から開始して描画します。各プリミティブは indexCount 個のインデックスで構成され、インデックスは firstIndex から始まり、頂点は baseVertex に対応します。状態は bindingState と renderState を使用します。
注: WebGPU アプリケーションは、
GPUVertexStepMode"vertex"を持つ任意のバインドされた頂点バッファの範囲外のインデックスを決して使用すべきではありません。 WebGPU 実装はこれを扱う方法が異なるため、さまざまな動作が許容されます。描画コール全体が破棄される場合もあれば、WGSL の invalid memory reference によりその属性へのアクセスが記述される場合もあります。 -
drawIndirect(indirectBuffer, indirectOffset)-
GPUBufferから読み取ったパラメーターを使用してプリミティブを描画します。 詳細な仕様は § 23.2 Rendering を参照してください。バッファにエンコードされる indirect draw parameters は、引数の順序と同じ順序で格納された、緊密に詰められた 32 ビット符号なし整数 4 個(計 16 バイト)でなければなりません。例えば:
let drawIndirectParameters= new Uint32Array( 4 ); drawIndirectParameters[ 0 ] = vertexCount; drawIndirectParameters[ 1 ] = instanceCount; drawIndirectParameters[ 2 ] = firstVertex; drawIndirectParameters[ 3 ] = firstInstance; firstInstanceに対応する値は、"indirect-first-instance"feature が有効でない限り 0 でなければなりません。もしその feature が有効でなく、firstInstanceが 0 でない場合、drawIndirect()の呼び出しは no-op として扱われます。呼び出し対象:GPURenderCommandsMixinthis.引数:
メソッド GPURenderCommandsMixin.drawIndirect(indirectBuffer, indirectOffset) の引数。 パラメーター 型 Nullable Optional 説明 indirectBufferGPUBuffer✘ ✘ indirect draw parameters を含むバッファ。 indirectOffsetGPUSize64✘ ✘ indirectBuffer 内で描画データが始まるバイト単位のオフセット。 戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で発行します(対象は this.
[[device]])。
Device timeline の手順:-
エンコーダー状態を検証します(対象は this)。false を返した場合は終了します。
-
次のいずれかの条件が満たされない場合は、invalidate を this に対して行い、終了します。
-
この this で valid to draw であること。
-
indirectBuffer が valid to use with this であること。
-
indirectOffset + sizeof(indirect draw parameters) ≤ indirectBuffer.
sizeであること。 -
indirectOffset が 4 の倍数であること。
-
-
Add indirectBuffer を
[[usage scope]]に使用法 input で追加します。 -
this.
[[drawCount]]を 1 増やします。 -
bindingState を this の現在の状態のスナップショットとして取得します。
-
レンダーコマンドをキューに追加します。実行時に renderState と共に Queue timeline 上で後続の手順を発行します。
Queue timeline の手順:-
vertexCount を indirectBuffer から indirectOffset バイト位置で読み取った符号なし 32-bit 整数とします。
-
instanceCount を indirectBuffer から (indirectOffset + 4) バイト位置で読み取った符号なし 32-bit 整数とします。
-
firstVertex を indirectBuffer から (indirectOffset + 8) バイト位置で読み取った符号なし 32-bit 整数とします。
-
firstInstance を indirectBuffer から (indirectOffset + 12) バイト位置で読み取った符号なし 32-bit 整数とします。
-
instanceCount 個のインスタンスを、インスタンス firstInstance から開始して描画します。各プリミティブは vertexCount 頂点からなり、頂点は firstVertex から始まります。状態は bindingState と renderState を使用します。
-
drawIndexedIndirect(indirectBuffer, indirectOffset)-
GPUBufferから読み取ったパラメーターを使用してインデックス付きプリミティブを描画します。 詳細な仕様は § 23.2 Rendering を参照してください。バッファにエンコードされる indirect drawIndexed parameters は、引数の順序と同じ順序で格納された、緊密に詰められた 32 ビット値 5 個(計 20 バイト)でなければなりません。
baseVertexに対応する値は符号付き 32 ビット整数で、他はすべて符号なし 32 ビット整数です。例えば:let drawIndexedIndirectParameters= new Uint32Array( 5 ); let drawIndexedIndirectParametersSigned= new Int32Array( drawIndexedIndirectParameters. buffer); drawIndexedIndirectParameters[ 0 ] = indexCount; drawIndexedIndirectParameters[ 1 ] = instanceCount; drawIndexedIndirectParameters[ 2 ] = firstIndex; // baseVertex is a signed value. drawIndexedIndirectParametersSigned[ 3 ] = baseVertex; drawIndexedIndirectParameters[ 4 ] = firstInstance; firstInstanceに対応する値は、"indirect-first-instance"feature が有効でない限り 0 でなければなりません。もしその feature が有効でなく、firstInstanceが 0 でない場合、drawIndexedIndirect()の呼び出しは no-op として扱われます。呼び出し対象:GPURenderCommandsMixinthis.引数:
メソッド GPURenderCommandsMixin.drawIndexedIndirect(indirectBuffer, indirectOffset) の引数。 パラメーター 型 Nullable Optional 説明 indirectBufferGPUBuffer✘ ✘ indirect drawIndexed parameters を含むバッファ。 indirectOffsetGPUSize64✘ ✘ indirectBuffer 内で描画データが始まるバイト単位のオフセット。 戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で発行します(対象は this.
[[device]])。
Device timeline の手順:-
エンコーダー状態を検証します(対象は this)。false を返した場合は終了します。
-
次のいずれかの条件が満たされない場合は、invalidate を this に対して行い、終了します。
-
この this で valid to draw indexed であること。
-
indirectBuffer が valid to use with this であること。
-
indirectOffset + sizeof(indirect drawIndexed parameters) ≤ indirectBuffer.
sizeであること。 -
indirectOffset が 4 の倍数であること。
-
-
Add indirectBuffer を
[[usage scope]]に使用法 input で追加します。 -
this.
[[drawCount]]を 1 増やします。 -
bindingState を this の現在の状態のスナップショットとして取得します。
-
レンダーコマンドをキューに追加します。実行時に renderState と共に Queue timeline 上で後続の手順を発行します。
Queue timeline の手順:-
indexCount を indirectBuffer から indirectOffset バイト位置で読み取った符号なし 32-bit 整数とします。
-
instanceCount を indirectBuffer から (indirectOffset + 4) バイト位置で読み取った符号なし 32-bit 整数とします。
-
firstIndex を indirectBuffer から (indirectOffset + 8) バイト位置で読み取った符号なし 32-bit 整数とします。
-
baseVertex を indirectBuffer から (indirectOffset + 12) バイト位置で読み取った符号付き 32-bit 整数とします。
-
firstInstance を indirectBuffer から (indirectOffset + 16) バイト位置で読み取った符号なし 32-bit 整数とします。
-
instanceCount 個のインスタンスを、インスタンス firstInstance から開始して描画します。各プリミティブは indexCount 個のインデックスで構成され、インデックスは firstIndex から始まり、頂点は baseVertex に対応します。状態は bindingState と renderState を使用します。
-
To determine if it’s valid to draw with GPURenderCommandsMixin
encoder,
run the following device
timeline steps:
-
次のいずれかの条件を満たさない場合は、
falseを返します:-
Validate encoder bind groups(encoder, encoder.
[[pipeline]]) はtrueでなければなりません。 -
pipelineDescriptor を encoder.
[[pipeline]].[[descriptor]]とします。 -
各
GPUIndex32slot について、0から pipelineDescriptor.vertex.buffers.size まで次を確認します:-
もし pipelineDescriptor.
vertex.buffers[slot] がnullでない場合、encoder.[[vertex_buffers]]は slot を 含んでいる 必要があります。
-
-
maxBindGroupsPlusVertexBuffersを検証します:-
bindGroupSpaceUsed を ( encoder.
[[bind_groups]]内の最大キー ) + 1 とします。 -
vertexBufferSpaceUsed を ( encoder.
[[vertex_buffers]]内の最大キー ) + 1 とします。 -
bindGroupSpaceUsed + vertexBufferSpaceUsed は ≤ encoder.
[[device]].[[limits]].maxBindGroupsPlusVertexBuffersでなければなりません。
-
それ以外の場合は、
trueを返します。 -
To determine if it’s valid to draw indexed with GPURenderCommandsMixin
encoder,
run the following device
timeline steps:
-
次のいずれかの条件を満たさない場合は、
falseを返します:-
valid to draw が encoder で成立している必要があります。
-
encoder.
[[index_buffer]]はnullであってはなりません。 -
topology を encoder.
[[pipeline]].[[descriptor]].primitive.topologyとします。 -
もし topology が
"line-strip"または"triangle-strip"の場合:-
encoder.
[[index_format]]は encoder.[[pipeline]].[[descriptor]].primitive.stripIndexFormatと等しくなければなりません。
-
それ以外の場合は、
trueを返します。 -
17.2.2. ラスタライズ状態
GPURenderPassEncoder
には、描画コマンドがこのエンコーダで使用されるアタッチメントにラスタライズされる方法に影響するいくつかのメソッドがあります。
setViewport(x, y, width, height, minDepth, maxDepth)-
ラスタライズ段階で使用されるビューポートを設定し、正規化デバイス座標からビューポート座標へ線形に写像します。
呼び出し対象:GPURenderPassEncoderthis.引数:
メソッド GPURenderPassEncoder.setViewport(x, y, width, height, minDepth, maxDepth) の引数。 パラメーター 型 Nullable Optional 説明 xfloat✘ ✘ ビューポートの最小 X 値(ピクセル単位)。 yfloat✘ ✘ ビューポートの最小 Y 値(ピクセル単位)。 widthfloat✘ ✘ ビューポートの幅(ピクセル単位)。 heightfloat✘ ✘ ビューポートの高さ(ピクセル単位)。 minDepthfloat✘ ✘ ビューポートの最小深度値。 maxDepthfloat✘ ✘ ビューポートの最大深度値。 戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で、this.
[[device]]に対して発行します。
Device timeline の手順:-
Validate the encoder state を this に対して実行します。false を返した場合は終了します。
-
maxViewportRange を this.
limits.maxTextureDimension2D×2とします。 -
次のいずれかの条件が満たされない場合、invalidate を this に対して行い、終了します。
-
x ≥ −maxViewportRange
-
y ≥ −maxViewportRange
-
0≤ width ≤ this.limits.maxTextureDimension2D -
0≤ height ≤ this.limits.maxTextureDimension2D -
x + width ≤ maxViewportRange −
1 -
y + height ≤ maxViewportRange −
1 -
0.0≤ minDepth ≤1.0 -
0.0≤ maxDepth ≤1.0 -
minDepth ≤ maxDepth
-
-
Enqueue a render command を this に対して行い、実行時に renderState とともに Queue timeline 上で後続の手順を発行するようにします。
Queue timeline の手順:-
x, y, width, height を、整数丸めよりも粗くない一様な精度に丸めます。
-
renderState.
[[viewport]]を範囲 x, y, width, height, minDepth, maxDepth に設定します。
-
setScissorRect(x, y, width, height)-
ラスタライズ段階で使用されるシザーレクタングルを設定します。 ビューポート座標に変換された後、シザーレクタングルの外側にある断片は破棄されます。
呼び出し対象:GPURenderPassEncoderthis.引数:
メソッド GPURenderPassEncoder.setScissorRect(x, y, width, height) の引数。 パラメーター 型 Nullable Optional 説明 xGPUIntegerCoordinate✘ ✘ シザーレクタングルの最小 X 値(ピクセル単位)。 yGPUIntegerCoordinate✘ ✘ シザーレクタングルの最小 Y 値(ピクセル単位)。 widthGPUIntegerCoordinate✘ ✘ シザーレクタングルの幅(ピクセル単位)。 heightGPUIntegerCoordinate✘ ✘ シザーレクタングルの高さ(ピクセル単位)。 戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で、this.
[[device]]に対して発行します。
Device timeline の手順:-
Validate the encoder state を this に対して実行します。false を返した場合は終了します。
-
次のいずれかの条件が満たされない場合、invalidate を this に対して行い、終了します。
-
x + width ≤ this.
[[attachment_size]].width. -
y + height ≤ this.
[[attachment_size]].height.
-
-
Enqueue a render command を this に対して行い、実行時に renderState とともに Queue timeline 上で後続の手順を発行するようにします。
Queue timeline の手順:-
renderState.
[[scissorRect]]を範囲 x, y, width, height に設定します。
-
setBlendConstant(color)-
"constant"および"one-minus-constant"のGPUBlendFactorとして使用される定数のブレンド色とアルファ値を設定します。呼び出し対象:GPURenderPassEncoderthis.引数:
メソッド GPURenderPassEncoder.setBlendConstant(color) の引数。 パラメーター 型 Nullable Optional 説明 colorGPUColor✘ ✘ ブレンドに使用する色。 戻り値:
undefinedContent timeline の手順:
-
? validate GPUColor shape(color) を実行します。
-
後続の手順を Device timeline 上で、this.
[[device]]に対して発行します。
Device timeline の手順:-
Validate the encoder state を this に対して実行します。false を返した場合は終了します。
-
Enqueue a render command を this に対して行い、実行時に renderState とともに Queue timeline 上で後続の手順を発行するようにします。
Queue timeline の手順:-
renderState.
[[blendConstant]]を color に設定します。
-
setStencilReference(reference)-
[[stencilReference]]を、"replace"のようなステンシルテストで使用される値に設定します(GPUStencilOperation)。呼び出し対象:GPURenderPassEncoderthis.引数:
メソッド GPURenderPassEncoder.setStencilReference(reference) の引数。 パラメーター 型 Nullable Optional 説明 referenceGPUStencilValue✘ ✘ 新しいステンシル参照値。 戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で、this.
[[device]]に対して発行します。
Device timeline の手順:-
Validate the encoder state を this に対して実行します。false を返した場合は終了します。
-
Enqueue a render command を this に対して行い、実行時に renderState とともに Queue timeline 上で後続の手順を発行するようにします。
Queue timeline の手順:-
renderState.
[[stencilReference]]を reference に設定します。
-
17.2.3. クエリ
beginOcclusionQuery(queryIndex)-
呼び出し対象:
GPURenderPassEncoderthis.引数:
GPURenderPassEncoder.beginOcclusionQuery(queryIndex) メソッドの引数。 パラメーター 型 Nullable Optional 説明 queryIndexGPUSize32✘ ✘ クエリセット内でのクエリのインデックス。 戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で this.
[[device]]に対して発行する。
Device timeline の手順:-
エンコーダー状態を検証 を this に対して実行する。false を返した場合は終了。
-
次のいずれかの条件を満たさない場合は invalidate を this に対して行い、終了する。
-
this.
[[occlusion_query_set]]がnullでないこと。 -
queryIndex が this.
[[occlusion_query_set]].countより小さいこと。 -
同じ queryIndex のクエリがこのパス内で以前に書き込まれていないこと。
-
this.
[[occlusion_query_active]]がfalseであること。
-
-
this.
[[occlusion_query_active]]をtrueに設定する。 -
レンダーコマンドをキューに追加し、実行時に renderState とともにQueue timeline 上で後続の手順を発行する。
Queue timeline の手順:-
renderState.
[[occlusionQueryIndex]]を queryIndex に設定する。
-
endOcclusionQuery()-
呼び出し対象:
GPURenderPassEncoderthis.戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で this.
[[device]]に対して発行する。
Device timeline の手順:-
エンコーダー状態を検証 を this に対して実行する。false を返した場合は終了。
-
次のいずれかの条件を満たさない場合は invalidate を this に対して行い、終了する。
-
this.
[[occlusion_query_active]]がtrueであること。
-
-
this.
[[occlusion_query_active]]をfalseに設定する。 -
レンダーコマンドをキューに追加し、実行時に renderState とともにQueue timeline 上で後続の手順を発行する。
Queue timeline の手順:-
passingFragments を、対応する
beginOcclusionQuery()コマンドが実行されてから、いずれかのフラグメントサンプルがすべての per-fragment テストに合格した場合は非ゼロ、それ以外はゼロとする。注: ドローコールが1つもなければ、passingFragments はゼロです。
-
passingFragments を this.
[[occlusion_query_set]]の renderState.[[occlusionQueryIndex]]番号に書き込む。
-
17.2.4. バンドル
executeBundles(bundles)-
指定された
GPURenderBundleに事前に記録されたコマンドを、このレンダーパスの一部として実行します。GPURenderBundleを実行するとき、レンダーパスのパイプライン、バインドグループ、および頂点・インデックスバッファは継承されません。1つのGPURenderBundleの実行後、レンダーパスのパイプライン・バインドグループ・頂点/インデックスバッファの状態はクリア(初期値・空の値)されます。注: 状態は「復元」されるのではなく「クリア」されます。 これは、
GPURenderBundleの実行数が 0 個であっても発生します。呼び出し対象:GPURenderPassEncoderthis.引数:
メソッド GPURenderPassEncoder.executeBundles(bundles) の引数。 パラメーター 型 Nullable Optional 説明 bundlessequence<GPURenderBundle>✘ ✘ 実行するレンダーバンドルのリスト。 戻り値:
undefinedContent timeline の手順:
-
後続の手順を Device timeline 上で this.
[[device]]に対して発行します。
Device timeline の手順:-
エンコーダー状態を検証 を this に対して実行。false を返した場合は終了。
-
次のいずれかの条件を満たさない場合、invalidate を this に対して行い終了します。
-
bundles の各 bundle について:
-
bundle は valid to use with this でなければなりません。
-
this.
[[layout]]は bundle.[[layout]]と等しい必要があります。 -
もし this.
[[depthReadOnly]]が true の場合、bundle.[[depthReadOnly]]も true でなければなりません。 -
もし this.
[[stencilReadOnly]]が true の場合、bundle.[[stencilReadOnly]]も true でなければなりません。
-
-
-
bundles の各 bundle について:
-
this.
[[drawCount]]を bundle.[[drawCount]]分増加させます。 -
Merge bundle.
[[usage scope]]を this.[[usage scope]]にマージします。 -
Extend this.
[[used_bind_groups]]に bundle.[[used_bind_groups]]を拡張します。 -
レンダーコマンドをキューに追加し、実行時に renderState とともに Queue timeline 上で次の手順を実行します:
Queue timeline の手順:-
bundle.
[[command_list]]の各コマンドを renderState とともに実行します。注: renderState はレンダーバンドルの実行によっては変更できません。バインディング状態はバンドルのエンコード時にキャプチャされているので、バンドル実行時には使用されません。
-
-
-
レンダーパスのバインディング状態をリセットします(this)。
-
レンダーパスのバインディング状態をリセットするには、GPURenderPassEncoder
encoder に対して
下記の device
timeline 手順を実行します:
-
クリア encoder.
[[bind_groups]]. -
encoder.
[[pipeline]]をnullに設定します。 -
encoder.
[[index_buffer]]をnullに設定します。 -
クリア encoder.
[[vertex_buffers]].
18. バンドル
バンドルは部分的かつ制限されたパスで、一度エンコードすると通常のコマンドバッファのように使用後に失効することなく、今後のパスエンコーダの一部として複数回実行できます。これにより、繰り返し変更なく発行されるコマンドのエンコードおよびサブミッションのオーバーヘッドを減らすことができます。
18.1. GPURenderBundle
[Exposed =(Window ,Worker ),SecureContext ]interface GPURenderBundle { };GPURenderBundle includes GPUObjectBase ;
[[command_list]], of type list<GPU command>-
この
GPURenderBundleを実行するときにGPURenderPassEncoderに送信される リスト(GPU コマンド)です。 [[used_bind_groups]], of type set<GPUBindGroup>, readonly-
このレンダーバンドルで使用されたすべての
GPUBindGroupの セット。 [[usage scope]], of type usage scope, initially empty-
このレンダーバンドルの使用範囲(usage scope)であり、後で
executeBundles()内でGPURenderPassEncoderの[[usage scope]]にマージされるために保存されています。 [[layout]], of typeGPURenderPassLayout-
このレンダーバンドルのレイアウト。
[[depthReadOnly]], of typeboolean-
trueの場合、このレンダーバンドルの実行によって深度成分が変更されないことを示します。 [[stencilReadOnly]], of typeboolean-
trueの場合、このレンダーバンドルの実行によってステンシル成分が変更されないことを示します。 [[drawCount]], of typeGPUSize64-
この
GPURenderBundleに含まれているドローコマンドの数です。
18.1.1. レンダーバンドルの作成
dictionary :GPURenderBundleDescriptor GPUObjectDescriptorBase { };
[Exposed =(Window ,Worker ),SecureContext ]interface {GPURenderBundleEncoder GPURenderBundle finish (optional GPURenderBundleDescriptor descriptor = {}); };GPURenderBundleEncoder includes GPUObjectBase ;GPURenderBundleEncoder includes GPUCommandsMixin ;GPURenderBundleEncoder includes GPUDebugCommandsMixin ;GPURenderBundleEncoder includes GPUBindingCommandsMixin ;GPURenderBundleEncoder includes GPURenderCommandsMixin ;
createRenderBundleEncoder(descriptor)-
GPURenderBundleEncoderを作成します。呼び出し対象:GPUDevicethis.引数:
GPUDevice.createRenderBundleEncoder(descriptor) メソッドの引数。 パラメーター 型 Nullable Optional 説明 descriptorGPURenderBundleEncoderDescriptor✘ ✘ 作成する GPURenderBundleEncoderの説明。Content timeline の手順:
-
? 各非
null要素に対してテクスチャフォーマットに必要な機能の検証を descriptor.colorFormatsに対し、this.[[device]]で実施する。 -
もし descriptor.
depthStencilFormatが 指定されている場合:-
? テクスチャフォーマットの必要な機能を検証を descriptor.
depthStencilFormatに対して、this.[[device]]で実行する。
-
-
e を ! create a new WebGPU object(this,
GPURenderBundleEncoder, descriptor) とします。 -
下記 Device timeline の 初期化手順 を this で実行します。
-
e を返します。
Device timeline 初期化手順:-
以下の条件が満たされない場合、 バリデーションエラーを生成 し、invalidate を e に対して実行し、終了する。
-
this は lost であってはならない。
-
descriptor.
colorFormats.size は this.[[limits]].maxColorAttachments以下でなければならない。 -
各非
nullの colorFormat について descriptor.colorFormatsの要素:-
colorFormat は color renderable format でなければならない。
-
-
Calculating color attachment bytes per sample(descriptor.
colorFormats) が this.[[limits]].maxColorAttachmentBytesPerSample以下でなければならない。 -
もし descriptor.
depthStencilFormatが 指定されている場合:-
descriptor.
depthStencilFormatは depth-or-stencil format でなければならない。
-
-
以下のいずれかのアタッチメントが少なくとも1つ存在しなければならない:
-
descriptor.
colorFormatsにnullでない値が存在する、または -
descriptor.
depthStencilFormatが指定されている。
-
-
-
e.
[[layout]]に descriptor に含まれるGPURenderPassLayoutインターフェースのコピーを設定します。 -
e.
[[depthReadOnly]]に descriptor.depthReadOnlyを設定します。 -
e.
[[stencilReadOnly]]に descriptor.stencilReadOnlyを設定します。 -
e.
[[drawCount]]に 0 を設定します。
-
18.1.2. エンコーディング
dictionary :GPURenderBundleEncoderDescriptor GPURenderPassLayout {boolean depthReadOnly =false ;boolean stencilReadOnly =false ; };
depthReadOnly, 型: boolean、デフォルト値はfalse-
trueの場合、このレンダーバンドルは、実行されるレンダーパスのGPURenderPassDepthStencilAttachmentの depth 成分を変更しないことを示します。read-only depth-stencil を参照してください。
stencilReadOnly, 型: boolean、デフォルト値はfalse-
trueの場合、このレンダーバンドルは、実行されるレンダーパスのGPURenderPassDepthStencilAttachmentの stencil 成分を変更しないことを示します。read-only depth-stencil を参照してください。
18.1.3. ファイナライズ
finish(descriptor)-
レンダーバンドルコマンド列の記録を完了します。
呼び出し対象:GPURenderBundleEncoderthis.引数:
GPURenderBundleEncoder.finish(descriptor) メソッドの引数。 パラメーター 型 Nullable Optional 説明 descriptorGPURenderBundleDescriptor✘ ✔ 戻り値:
GPURenderBundleContent timeline の手順:
-
renderBundle を新しい
GPURenderBundleとします。 -
this.
[[device]]の Device timeline 上で finish steps を発行します。 -
renderBundle を返します。
Device timeline finish steps:-
下記すべての要件を満たす場合は validationSucceeded を
true、満たさない場合はfalseとします。-
this は valid でなければなりません。
-
this.
[[usage scope]]は usage scope validation を満たしていなければなりません。 -
this.
[[debug_group_stack]]は 空でなければなりません。
-
-
validationSucceeded が
falseの場合:-
バリデーションエラーを発生 させます。
-
無効化されたinvalidated
GPURenderBundleを返します。
-
-
renderBundle.
[[command_list]]を this.[[commands]]に設定します。 -
renderBundle.
[[used_bind_groups]]を this.[[used_bind_groups]]に設定します。 -
renderBundle.
[[usage scope]]を this.[[usage scope]]に設定します。 -
renderBundle.
[[drawCount]]を this.[[drawCount]]に設定します。
-
19. キュー
19.1. GPUQueueDescriptor
GPUQueueDescriptor
はキューリクエストを記述します。
dictionary GPUQueueDescriptor :GPUObjectDescriptorBase { };
19.2. GPUQueue
[Exposed =(Window ,Worker ),SecureContext ]interface GPUQueue {undefined submit (sequence <GPUCommandBuffer >commandBuffers );Promise <undefined >onSubmittedWorkDone ();undefined writeBuffer (GPUBuffer buffer ,GPUSize64 bufferOffset ,AllowSharedBufferSource data ,optional GPUSize64 dataOffset = 0,optional GPUSize64 size );undefined writeTexture (GPUTexelCopyTextureInfo destination ,AllowSharedBufferSource data ,GPUTexelCopyBufferLayout dataLayout ,GPUExtent3D size );undefined copyExternalImageToTexture (GPUCopyExternalImageSourceInfo source ,GPUCopyExternalImageDestInfo destination ,GPUExtent3D copySize ); };GPUQueue includes GPUObjectBase ;
GPUQueue
には以下のメソッドがあります:
writeBuffer(buffer, bufferOffset, data, dataOffset, size)-
指定したデータを
GPUBufferに書き込む操作を発行します。呼び出し対象:GPUQueuethis.引数:
GPUQueue.writeBuffer(buffer, bufferOffset, data, dataOffset, size) メソッドの引数。 パラメータ 型 Nullable Optional 説明 bufferGPUBuffer✘ ✘ 書き込み先のバッファ。 bufferOffsetGPUSize64✘ ✘ buffer の書き込み開始位置(バイト単位のオフセット)。 dataAllowSharedBufferSource✘ ✘ buffer に書き込むデータ。 dataOffsetGPUSize64✘ ✔ data の書き込み開始位置。data が TypedArrayの場合は要素単位、それ以外はバイト単位。sizeGPUSize64✘ ✔ data から buffer に書き込む内容のサイズ。data が TypedArrayの場合は要素単位、それ以外はバイト単位。返り値:
undefinedコンテンツタイムラインのステップ:
-
data が
ArrayBufferまたはDataViewの場合、要素型は "byte"。 それ以外の場合、data は TypedArray であり、要素型は TypedArray の型とする。 -
dataSize を data の要素数とする。
-
size が指定されていない場合、 contentsSize を dataSize − dataOffset とする。 指定されている場合は contentsSize を size とする。
-
次の条件のいずれかを満たさない場合、
OperationErrorを投げて return。-
contentsSize ≥ 0。
-
dataOffset + contentsSize ≤ dataSize。
-
contentsSize(バイト換算)は4バイトの倍数であること。
-
-
dataContents を buffer source のコピーとして data から取得する。
-
contents を dataContents の dataOffset から contentsSize 要素分とする。
-
後続のステップを this の デバイスタイムラインで実行する。
デバイスタイムラインのステップ:-
次の条件のいずれかを満たさない場合、 バリデーションエラー生成して return。
-
buffer は this と一緒に使用可能である。
-
buffer.
[[internal state]]は "available" である。 -
bufferOffset(バイト換算)は4バイトの倍数。
-
bufferOffset + contentsSize(バイト換算)は buffer.
sizeバイト以下。
-
-
後続のステップを this の キュータイムラインで実行する。
キュータイムラインのステップ:-
contents を buffer の bufferOffset から書き込む。
-
writeTexture(destination, data, dataLayout, size)-
提供されたデータを
GPUTextureに書き込む操作を発行します。呼び出し対象:GPUQueuethis.引数:
GPUQueue.writeTexture(destination, data, dataLayout, size) メソッドの引数。 パラメーター 型 Nullable Optional 説明 destinationGPUTexelCopyTextureInfo✘ ✘ 書き込み先となるテクスチャサブリソースおよび原点。 dataAllowSharedBufferSource✘ ✘ destination に書き込むデータ。 dataLayoutGPUTexelCopyBufferLayout✘ ✘ data 内のコンテンツのレイアウト。 sizeGPUExtent3D✘ ✘ data から destination へ書き込むコンテンツの範囲。 戻り値:
undefinedContent timeline の手順:
-
? validate GPUOrigin3D shape(destination.
origin) を実行します。 -
? validate GPUExtent3D shape(size) を実行します。
-
dataBytes を buffer source に保持されているバイト列のコピーとして取得します。
注: これは data の全てをデバイスタイムラインにコピーするものとして記述されていますが、実際には data は必要以上に大きい場合があります。実装では必要なバイトだけをコピーして最適化すべきです。
-
この後の手順を Device timeline 上で this に対して発行します。
Device timeline の手順:-
aligned を
falseとします。 -
dataLength を dataBytes の 長さとします。
-
次のいずれかの条件が満たされない場合は バリデーションエラーを生成し、終了します。
-
destination.
texture.[[destroyed]]はfalseでなければなりません。 -
validating texture buffer copy(destination, dataLayout, dataLength, size,
COPY_DST, aligned) がtrueを返さなければなりません。
注:
GPUCommandEncoder.copyBufferToTexture()とは異なり、 dataLayout.bytesPerRowや dataLayout.offsetにアラインメント要件はありません。 -
-
この後の手順を Queue timeline 上で this に対して発行します。
Queue timeline の手順:-
blockHeight を destination.
textureの テクセルブロック高さとします。 -
dstOrigin を destination.
originとします。 -
dstBlockOriginX を (dstOrigin.x ÷ blockWidth) とします。
-
dstBlockOriginY を (dstOrigin.y ÷ blockHeight) とします。
-
blockColumns を (copySize.width ÷ blockWidth) とします。
-
blockRows を (copySize.height ÷ blockHeight) とします。
-
アサート:dstBlockOriginX、dstBlockOriginY、blockColumns、blockRows が整数であること。
-
[0, copySize.depthOrArrayLayers − 1] の範囲の各 z について:
-
dstSubregion を texture copy sub-region (z + dstOrigin.z) of destination とする。
-
[0, blockRows − 1] の範囲の各 y について:
-
[0, blockColumns − 1] の範囲の各 x について:
-
blockOffset を texel block byte offset (dataLayout, (x, y, z), destination.
texture) とする。 -
dstSubregion の (dstBlockOriginX + x, dstBlockOriginY + y) の テクセルブロック を、dataBytes の blockOffset 位置で記述される 等価テクセル表現に設定します。
-
-
-
-
copyExternalImageToTexture(source, destination, copySize)-
プラットフォーム画像/キャンバスの内容を宛先テクスチャにコピーします。
この操作は
GPUCopyExternalImageDestInfoのパラメータに従って 色空間エンコード を行います。-srgbテクスチャへのコピーは、対応する非-srgbフォーマットへのコピーとは、同じテクスチャバイトになり、デコード値は異なります。 コピー操作後、宛先テクスチャのサンプリング結果は、フォーマットが-srgbかどうかで異なります(他が同じ場合)。注:"webgl"/"webgl2"コンテキストキャンバスからコピーする場合、 WebGL 描画バッファはフレーム提示サイクルの一部タイミング(画像が表示のため合成器に移動された後)に存在しないことがあります。 これを避けるには、以下のいずれかを行います:-
WebGLレンダリング操作と同じタスク内で
copyExternalImageToTexture()を発行し、コピーがWebGLキャンバス提示前に行われるようにする。 -
それができない場合は、
preserveDrawingBufferオプションをWebGLContextAttributesでtrueに設定することで、提示後も描画バッファにフレーム内容のコピーが残ります。 ただし、この追加コピーにはパフォーマンスコストが発生する可能性があります。
呼び出し対象:GPUQueuethis.引数:
GPUQueue.copyExternalImageToTexture(source, destination, copySize) メソッドの引数。 パラメータ 型 Nullable Optional 説明 sourceGPUCopyExternalImageSourceInfo✘ ✘ コピー元画像および destination への原点情報。 destinationGPUCopyExternalImageDestInfo✘ ✘ 書き込み先のテクスチャサブリソース、原点、エンコードメタデータ。 copySizeGPUExtent3D✘ ✘ source から destination に書き込む内容の範囲。 返り値:
undefinedコンテンツタイムラインのステップ:
-
? GPUOrigin2D の形状を検証(source.
origin). -
? GPUOrigin3D の形状を検証(destination.
origin). -
? GPUExtent3D の形状を検証(copySize)。
-
sourceImage を source.
source -
sourceImage が オリジン・クリーンでない場合、
SecurityErrorを throw して return。 -
次のいずれかの要件を満たさない場合、
OperationErrorを throw して return。-
source.origin.x + copySize.width は sourceImage の幅以下でなければならない。
-
source.origin.y + copySize.height は sourceImage の高さ以下でなければならない。
-
copySize.depthOrArrayLayers は 1 以下である必要がある。
-
-
usability を ? 画像引数の usability をチェック(source)とする。
-
後続のステップを this のデバイスタイムラインで実行する。
Device timeline の手順:-
texture を destination.
textureとする。 -
次のいずれかの要件を満たさない場合は、バリデーションエラーを生成し、終了する。
-
usability は
goodでなければならない。 -
texture.
[[destroyed]]はfalseでなければならない。 -
texture は valid to use with this でなければならない。
-
validating GPUTexelCopyTextureInfo(destination, copySize) は
trueを返さなければならない。 -
texture.
usageにはRENDER_ATTACHMENTおよびCOPY_DSTの両方が含まれていなければならない。 -
texture.
sampleCountは 1 でなければならない。 -
texture.
formatは plain color format であり、RENDER_ATTACHMENTをサポートし、unorm/unorm-srgbまたはfloat/ufloatフォーマットでなければならない(snorm・uint・sintではない)。
-
-
もし copySize.depthOrArrayLayers が 0 より大きければ、 この後の手順を Queue timeline 上で this に対して発行する。
Queue timeline の手順:-
アサート: destination.
textureの texel block width が 1、 texel block height が 1、 そして copySize.depthOrArrayLayers が 1 であること。 -
srcOrigin を source.
originとする。 -
dstOrigin を destination.
originとする。 -
dstSubregion を texture copy sub-region (dstOrigin.z) of destination とする。
-
[0, copySize.height − 1] の各 y について:
-
srcY を次のように決定する。 source.
flipYがfalseの場合は y、そうでなければ (copySize.height − 1 − y)。 -
[0, copySize.width − 1] の各 x について:
-
srcColor を source.
sourceの (srcOrigin.x + x, srcOrigin.y + srcY) の カラーマネージドカラー値とする。 -
dstColor を、 destination.
colorSpaceや destination.premultipliedAlphaに必要なカラ―エンコーディングを srcColor に適用した時の RGBA 数値とする。 -
もし texture.
formatが-srgbフォーマットの場合:-
dstColor に sRGB 非線形→線形変換を適用した結果を設定する。
注: この変換は、次のステップで
-srgbフォーマットに書き込む際に行われる sRGB 線形→非線形変換を相殺するためのもので、 sRGB 相当の入力画像の精度を損なわず、元画像の「線形」色値がテクスチャから読み取れるようにするためのものです(これが-srgbフォーマットを使う一般的な目的)。 -
-
dstSubregion の (dstOrigin.x + x, dstOrigin.y + y) の テクセルブロック を dstColor の 等価テクセル表現 に設定する。
-
-
-
submit(commandBuffers)-
このキュー上でGPUによるコマンドバッファの実行をスケジュールします。
提出されたコマンドバッファは再利用できません。
呼び出し対象:GPUQueuethis.引数:
GPUQueue.submit(commandBuffers) メソッドの引数。 パラメーター 型 Nullable Optional 説明 commandBufferssequence<GPUCommandBuffer>✘ ✘ 戻り値:
undefinedContent timeline の手順:
-
この後の手順を Device timeline 上で this に対して発行する:
Device timeline の手順:-
以下の要件が満たされていない場合、バリデーションエラーを生成し、 invalidate を commandBuffers の各
GPUCommandBufferに対して行い終了する。-
commandBuffers 内の全ての
GPUCommandBufferは一意でなければならない。 -
commandBuffers の各 commandBuffer について:
-
commandBuffer は valid to use with this でなければならない。
-
commandBuffer.
[[used_bind_groups]]の各 bindGroup について:-
GPUBindingResource型の各リソースについて、その型が:GPUBufferb-
b.
[[internal state]]は "available" でなければならない。 GPUTexturet-
t.
[[destroyed]]はfalseでなければならない。 GPUExternalTextureet-
et.
[[expired]]はfalseでなければならない。 GPUQuerySetqs-
qs.
[[destroyed]]はfalseでなければならない。
-
注: オクルージョンクエリについては、
occlusionQuerySetはbeginRenderPass()で利用されるだけでなく、beginOcclusionQuery()も利用されなければ「使用」したことにはなりません。 -
-
-
commandBuffers の各 commandBuffer について:
-
Invalidate commandBuffer。
-
-
この後の手順を Queue timeline 上で this に対して発行する:
Queue timeline の手順:-
commandBuffers の各 commandBuffer について:
-
commandBuffer.
[[command_list]]内の各コマンドを実行する。
-
-
onSubmittedWorkDone()-
このキューが現時点までに提出されたすべての処理を終了したときに resolve される
Promiseを返します。この
Promiseの resolve は、当該呼び出し以前にmapAsync()を呼び出し、その後このキューでのみ利用されたGPUBufferの mapAsync の完了も意味します。呼び出し対象:GPUQueuethis.コンテントタイムライン手順:
-
contentTimeline を現在の コンテントタイムライン とする。
-
promise を 新しい promise とする。
-
synchronization steps を デバイスタイムライン 上の this に対して発行する。
-
promise を返す。
デバイスタイムライン synchronization steps:-
現在キューに登録されている全ての操作が完了した時に event が発生するものとする。
-
タイムラインイベントをリッスン event を this.
[[device]]上で行い、 その後の手順は contentTimeline 上でハンドルされる。
コンテントタイムライン手順: -
20. クエリ
20.1. GPUQuerySet
[Exposed =(Window ,Worker ),SecureContext ]interface GPUQuerySet {undefined destroy ();readonly attribute GPUQueryType type ;readonly attribute GPUSize32Out count ; };GPUQuerySet includes GPUObjectBase ;
GPUQuerySet
には以下の 不変プロパティがあります:
type, 型 GPUQueryType, readonly-
この
GPUQuerySetが管理するクエリの種類。 count, 型 GPUSize32Out, readonly-
この
GPUQuerySetが管理するクエリ数。
GPUQuerySet
には以下の デバイスタイムラインプロパティがあります:
[[destroyed]], 型boolean, 初期値false-
クエリセットが破棄されると、いかなる操作にも使用できなくなり、基礎となるメモリが解放される可能性があります。
20.1.1. クエリセットの作成
GPUQuerySetDescriptor
は GPUQuerySet
の作成時に使用するオプションを指定します。
dictionary :GPUQuerySetDescriptor GPUObjectDescriptorBase {required GPUQueryType type ;required GPUSize32 count ; };
type, 型 GPUQueryType-
GPUQuerySetが管理するクエリの型です。 count, 型 GPUSize32-
GPUQuerySetが管理するクエリの数です。
createQuerySet(descriptor)-
GPUQuerySetを生成します。呼び出し対象:GPUDevicethis.引数:
GPUDevice.createQuerySet(descriptor) メソッドの引数。 パラメーター 型 Nullable Optional 説明 descriptorGPUQuerySetDescriptor✘ ✘ 作成する GPUQuerySetの説明。戻り値:
GPUQuerySetContent timeline 手順:
-
もし descriptor.
typeが"timestamp"であり、 かつ"timestamp-query"が このデバイスで有効 でなければ:-
TypeErrorをスローします。
-
-
q を ! create a new WebGPU object(this,
GPUQuerySet, descriptor) とします。 -
Device timeline 上で initialization steps を発行します。
-
q を返します。
Device timeline initialization steps:-
次のいずれかの要件が満たされない場合、バリデーションエラーを生成 し、 invalidate を q に対して行い、終了します。
-
q 用のデバイスアロケーションを作成し、クエリセット内の各エントリはゼロで初期化します。
もしアロケーションが副作用無しに失敗した場合は out-of-memory エラーを生成し、invalidate を q に対して行い、終了します。
-
GPUQuerySet
の作成例。
const querySet= gpuDevice. createQuerySet({ type: 'occlusion' , count: 32 });
20.1.2. クエリセットの破棄
アプリケーションが GPUQuerySet
を不要と判断した場合、destroy()
を呼び出すことでガベージコレクション前にアクセスを失うことができます。
GPUQuerySet
には以下のメソッドがあります:
destroy()-
GPUQuerySetを破棄します。Device timeline 手順:-
this.
[[destroyed]]をtrueに設定します。
-
20.2. クエリタイプ
enum {GPUQueryType ,"occlusion" , };"timestamp"
20.3. オクルージョンクエリ
オクルージョンクエリはレンダーパスでのみ利用でき、シザー、サンプルマスク、アルファ・トゥ・カバレージ、ステンシル、深度テストなどを含む一連の描画コマンドに対して、すべてのフラグメントテストを通過したフラグメントサンプル数を問い合わせます。クエリの結果が非ゼロの場合、少なくともひとつのサンプルがテストを通過しレンダーパイプラインの出力マージ段階に到達したことを示し、0の場合はサンプルがテストを通過しなかったことを示します。
レンダーパスを開始する際、GPURenderPassDescriptor.occlusionQuerySet
を設定することで、パス内でオクルージョンクエリが使用可能となります。オクルージョンクエリは beginOcclusionQuery()
と
endOcclusionQuery()
をペアで呼び出すことで開始・終了され、ネストはできません。クエリ結果は GPUBuffer
に 64ビット符号なし整数として GPUCommandEncoder.resolveQuerySet()
で解決されます。
20.4. タイムスタンプクエリ
タイムスタンプクエリは、以下の方法で GPUQuerySet
にタイムスタンプを書き込むことができます:
そしてタイムスタンプ値(ナノ秒単位で 64ビット符号なし整数)を
GPUBuffer
に GPUCommandEncoder.resolveQuerySet()
で解決します。
タイムスタンプ値は実装依存です。 アプリケーションは任意のタイムスタンプ結果を扱えるようにし、予期しないタイムスタンプによってアプリケーションが異常終了しないように実装すべきです。
注: 物理デバイスがタイムスタンプカウンタを時折リセットすることがあり、その結果、タイムスタンプ間の差分が負になるなど予期しない値が生じる場合があります。 これらのケースは稀であり、そのようなデータポイントは安全に破棄できます。
タイムスタンプクエリは高分解能タイマー(§ 2.1.7.2 デバイス/キュータイムラインのタイミング参照)を利用して実装されます。 セキュリティ・プライバシーの懸念を軽減するため、その精度は低減されなければなりません:
キュータイムラインのステップを実行して、現在のキュータイムスタンプを取得します:
-
fineTimestamp を現在の キュータイムラインの 現在のタイムスタンプ値(ナノ秒単位、実装依存の過去のある時点基準)とする。
-
fineTimestamp に coarsen time を呼び出し、
crossOriginIsolatedCapabilityはfalseに設定して結果を返す。
注: クロスオリジン分離はデバイスタイムラインや
キュータイムラインには決して適用されません。そのため、crossOriginIsolatedCapability
が true になることはありません。
引数:
-
GPUDevicedevice -
(timestampWritesGPUComputePassTimestampWritesまたはGPURenderPassTimestampWrites)
デバイスタイムラインのステップ:
-
以下の要件が満たされていれば
trueを返し、そうでなければfalseを返す:-
timestampWrites.
querySetは device で valid to use with であること。 -
timestampWrites.
querySet.typeが"timestamp"であること。 -
timestampWrites の書き込みインデックスメンバー (
beginningOfPassWriteIndex、endOfPassWriteIndex)について:
21. キャンバス描画
21.1. HTMLCanvasElement.getContext()
GPUCanvasContext
オブジェクトは getContext()
メソッドを HTMLCanvasElement
インスタンスに対して呼び出し、文字列リテラル 'webgpu' を contextType 引数として渡すことで
作成
されます。
HTMLCanvasElement
から
GPUCanvasContext
を取得する例:
const canvas= document. createElement( 'canvas' ); const context= canvas. getContext( 'webgpu' );
WebGLや2Dコンテキストの作成とは異なり、
HTMLCanvasElement.getContext()
や
OffscreenCanvas.getContext()
の第二引数(コンテキスト作成属性辞書 options)は無視されます。
代わりに GPUCanvasContext.configure()
を使い、キャンバスの構成を置き換えずに変更できます。
HTMLCanvasElement
または OffscreenCanvas
canvas で 'webgpu' コンテキストを作成するには、
以下のコンテンツタイムラインのステップを実行します:
-
context を新しい
GPUCanvasContextとする。 -
context.
canvasに canvas を設定する。 -
context の 描画バッファを置き換える。
-
context を返す。
注: WebGPUキャンバスコンテキスト取得時に無視される options
引数が与えられた場合、実装は開発者向け警告を表示すべきです。
21.2. GPUCanvasContext
[Exposed =(Window ,Worker ),SecureContext ]interface {GPUCanvasContext readonly attribute (HTMLCanvasElement or OffscreenCanvas )canvas ;undefined configure (GPUCanvasConfiguration configuration );undefined unconfigure ();GPUCanvasConfiguration ?getConfiguration ();GPUTexture getCurrentTexture (); };
GPUCanvasContext
には以下のコンテンツタイムラインプロパティがあります:
canvas, 型:(HTMLCanvasElement or OffscreenCanvas), 読み取り専用-
このコンテキストが作成されたキャンバス。
[[configuration]], 型GPUCanvasConfiguration?, 初期値null-
このコンテキストが現在設定されているオプション。
設定されていないか、
unconfiguredされた場合はnull。 [[textureDescriptor]], 型GPUTextureDescriptor?, 初期値null-
現在設定されているテクスチャディスクリプタ(
[[configuration]]とキャンバスから派生)。設定されていないか、
unconfiguredされた場合はnull。 [[drawingBuffer]]、画像。初期値は キャンバスと同じサイズの透過黒画像-
ドローイングバッファはキャンバスの作業用イメージデータです。 これは
[[currentTexture]](getCurrentTexture()で返される)を介して書き込み可能として公開されます。ドローイングバッファは 画像内容のコピー取得 の際(キャンバスが表示または読み取られるとき)に使われます。たとえ
[[configuration]].alphaModeが"opaque"であっても、透過になる場合があります。alphaModeは "画像内容のコピー取得" アルゴリズムの結果のみに影響します。ドローイングバッファは
[[currentTexture]]より寿命が長く、キャンバスが表示された後でも以前の内容を保持します。 Replace the drawing buffer の際のみ完全にクリアされます。ドローイングバッファが読み取られる場合は、直前にサブミットされた全ての作業(例:queue submission)の書き込みが
[[currentTexture]]を通して完了していることを実装で保障しなければなりません。 [[currentTexture]], 型GPUTexture?, 初期値null-
現在フレーム描画用の
GPUTextureです。 基となる[[drawingBuffer]]への書き込みビューとして公開されます。getCurrentTexture()によりnullなら初期化され、常にこのスロットを返します。可視キャンバスの定常状態では、currentTexture でドローイングバッファへの変更は WebGPUキャンバスの描画更新 で提示されます。 それ以前またはその時に、このテクスチャも破棄され、
[[currentTexture]]はnullとなります。これにより、次にgetCurrentTexture()すれば新たに作られます。Destroyingしてもドローイングバッファ内容には影響なく、書き込みアクセスのみ即時終了します。 同じフレーム内でgetCurrentTexture()を呼ぶと同じ破棄済みテクスチャを返し続けます。Expire the current texture は currentTexture を
nullにします。 これはconfigure()や、キャンバスのリサイズ、提示、transferToImageBitmap()などで呼ばれます。 [[lastPresentedImage]], 型(readonly image)?, 初期値null-
このキャンバスで最後に "WebGPU キャンバスの描画更新" で提示された画像です。 デバイスが失われたり破棄された場合、この画像はキャンバスを白紙化しないためのフォールバック用に、 "画像内容のコピー取得" で用いられることがあります。
注: このプロパティはフォールバックを実装する場合のみ必要で、実装は任意です。
GPUCanvasContext
には以下のメソッドがあります:
configure(configuration)-
このキャンバスのコンテキストを設定します。 この際 Replace the drawing buffer でドローイングバッファは透過黒で初期化されます。
getConfiguration() の feature detection 例も参照してください。
呼び出し対象:GPUCanvasContextthis.引数:
GPUCanvasContext.configure(configuration) メソッドの引数。 パラメーター 型 Nullable Optional 説明 configurationGPUCanvasConfiguration✘ ✘ コンテキストの望ましい設定内容。 戻り値: undefined
コンテントタイムライン手順:
-
device を configuration.
deviceとする。 -
? テクスチャフォーマット必要機能の検証 を configuration.
formatと device.[[device]]で行う。 -
? テクスチャフォーマット必要機能の検証 を configuration.
viewFormatsの各要素と device.[[device]]で行う。 -
もし サポートされているコンテキストフォーマット が 含まない configuration.
formatなら、TypeErrorをスローする。 -
descriptor を キャンバスと設定のための GPUTextureDescriptor(this.
canvas, configuration) とする。 -
this.
[[configuration]]を configuration に設定する。注: これは実装定義の
GPUCanvasConfigurationで定義されたメンバのみを公開する。 これらのメンバの仕様については 機能検出 の注記を参照のこと。 -
this.
[[textureDescriptor]]を descriptor に設定する。 -
描画バッファの置き換えをthisに対して行う。
-
後続の手順を device の デバイスタイムライン で実施する。
Device timeline の手順:-
次の要件が満たされない場合 バリデーションエラー生成し終了する。
-
validating GPUTextureDescriptor(device, descriptor) はtrueを返さなければならない。
注: この早期バリデーションは 次の
configure()呼び出しまで有効ですが、sizeの検証はキャンバスリサイズ時にのみ変化します。 -
-
unconfigure()-
コンテキスト設定を解除し、設定中に生成されたテクスチャを破棄します。
呼び出し対象:GPUCanvasContextthis.戻り値: undefined
コンテントタイムライン手順:
-
this.
[[configuration]]にnullをセット。 -
this.
[[textureDescriptor]]にnullをセット。 -
Replace the drawing buffer を this に対して行う。
-
getConfiguration()-
現在のコンテキスト設定を返します。未設定の場合は
nullです。注: このメソッドは主に
GPUCanvasConfigurationの メンバーやサブメンバーの feature detection 用です。 対応メンバーの場合は、もともと与えられた値を返します。呼び出し対象:GPUCanvasContextthis.戻り値:
GPUCanvasConfigurationまたはnullコンテントタイムライン手順:
-
configuration を this.
[[configuration]]のコピーとする。 -
configuration を返す。
-
getCurrentTexture()-
次の合成描画で
GPUTextureを取得します。これはGPUCanvasContextによりドキュメントへコンポジットされます。注:アプリケーションはgetCurrentTexture()を同じタスク内でレンダリングとあわせて呼び出すべきです。 そうしないとレンダリングが終わる前にテクスチャがこの手順で破棄される場合があります。失効タスク(expiry task、下記定義)は実装任意です。 仮に実装されても、タスクソースの優先順位までは定義されておらず、次のタスクで早々に来る場合もあれば全タスクソースが空になるまで遅延する場合もありえます (automatic expiry task source を参照)。 可視キャンバスの描画提示 (WebGPUキャンバスの描画更新) および "Expire the current texture" を呼ぶ他の経路では必ず失効します。
呼び出し対象:GPUCanvasContextthis.戻り値:
GPUTextureコンテントタイムライン手順:
-
もし this.
[[configuration]]がnullなら、InvalidStateErrorを throw し、return。 -
アサート this.
[[textureDescriptor]]がnullでないこと。 -
device を this.
[[configuration]].deviceとする。 -
もし this.
[[currentTexture]]がnullなら:-
Replace the drawing buffer を this に対して行う。
-
this.
[[currentTexture]]を device.createTexture()に this.[[textureDescriptor]]を渡して呼び出した結果とし(ただし underlying storage は this.[[drawingBuffer]]を指す)、注: テクスチャの作成に失敗した(例:バリデーションエラーや out-of-memory)場合はエラー生成し、invalidated な
GPUTextureを返します。ここでのバリデーションの多くはconfigure()のものと被りますが必ず二重チェックしてください。
-
-
オプションで 自動失効タスクをキュー追加。device device と以下の手順を使用:
-
Expire the current texture を this に対して行う。
注: これは WebGPUキャンバスの描画更新 ですでに起きていれば何も起きません。
-
-
this.
[[currentTexture]]を返す。
注: "Expire the current texture" が走るまで、destroyやバリデーション失敗、アロケーション失敗があっても全て
getCurrentTexture()は同じGPUTextureを返します。 -
引数:
-
context:
GPUCanvasContext
返り値: 画像内容
コンテンツタイムラインのステップ:
-
snapshot を context.
canvasと同じサイズの透明な黒画像にする。 -
configuration を context.
[[configuration]]とする。 -
configuration が
nullの場合:-
snapshot を返す。
注:
nullは、contextが未設定またはunconfiguredの場合に configuration となる。 これは、canvasにcontextがない場合の挙動と同じである。 -
-
提出されたすべての作業項目(例: queue submission)が画像(context.
[[currentTexture]]を通じて)への書き込みを完了していることを保証する。 -
configuration.
deviceが 有効 である場合:-
snapshot を context.
[[drawingBuffer]]のコピーにする。
それ以外の場合、context.
[[lastPresentedImage]]がnullでなければ:-
任意で snapshot を context.
[[lastPresentedImage]]のコピーにする。注: これは任意である。
[[lastPresentedImage]]は、デバイスロスの原因によっては存在しない場合がある。 実装はその画像にアクセス可能であっても、スキップしてもよい。
-
-
alphaMode を configuration.
alphaModeとする。 -
alphaMode が
"opaque"の場合:-
snapshot のアルファチャンネルを 1.0 でクリアする。
注:
[[currentTexture]]が破棄されている場合(例えば "Expire the current texture" の時)、アルファチャンネルは観測できなくなり、実装はインプレースでクリアしてもよい。 -
snapshot に不透明のタグを付ける。
それ以外の場合:
-
snapshot に alphaMode のタグを付ける。
-
-
snapshot に
colorSpaceおよびtoneMappingを configuration の値でタグ付けする。 -
snapshot を返す。
GPUCanvasContext
contextに対して次のコンテンツタイムラインのステップを実行する:
-
現在のテクスチャの期限切れ処理を context に対して実行する。
-
configuration を context.
[[configuration]]とする。 -
context.
[[drawingBuffer]]に context.canvasと同じ サイズの透過黒画像を設定する。-
configuration が null の場合、drawing buffer は色空間
"srgb"とタグ付けされる。この場合、drawing buffer は設定されるまで空白のまま。 -
そうでなければ、drawing buffer は指定の configuration.
formatを持ち、指定の configuration.colorSpaceと configuration.toneMappingでタグ付けされる。
注: configuration.
alphaModeは "コンテキストの画像内容のコピーを取得する" までは無視される。注:新しく置き換えられた drawing buffer 画像は透過黒でクリアされたかのように振る舞うが、"discard"後のように、 必要になった時のみ lazy にクリアしてもよい。注: drawing buffer が既にクリア済みで正しい設定であれば、これは多くの場合何も起こらない(no-op)。
-
GPUCanvasContext
context に対して以下の コンテンツタイムラインのステップを実行する:
-
context.
[[currentTexture]]がnullでない場合:-
context.
[[currentTexture]].destroy()を呼び出す(context.[[drawingBuffer]]は破棄しない)ことで画像への書き込みアクセスを終了する。 -
context.
[[currentTexture]]をnullに設定する。
-
21.3. HTML仕様フック
以下のアルゴリズムはHTML仕様のアルゴリズムへ「フック」し、指定されたタイミングで実行されなければなりません。
HTMLCanvasElement
または OffscreenCanvas
上で
GPUCanvasContext
context の "bitmap" が読み取られる場合、以下の コンテンツタイムラインステップを実行する:
-
context の画像内容のコピーを返す。
-
HTMLCanvasElementの描画が更新されるとき。-
キャンバスが placeholder canvas element(
OffscreenCanvas)の場合も含む。
-
-
transferToImageBitmap()が bitmap からImageBitmapを生成する場合。 (transferToImageBitmap from WebGPU も参照) -
WebGPUキャンバス内容が他のWeb API(
drawImage()、texImage2D()、texSubImage2D()、toDataURL()、toBlob()など)で読み取られる場合。
alphaMode
が "opaque"
の場合、アルファチャンネルをクリアする必要があります。実装がアルファチャンネルを無視して画像を読み取る/表示できる場合、このステップを省略しても構いません。
アプリケーションがキャンバスを相互運用のみに使い、表示を目的としない場合は、必要がなければ
"opaque"
を避けて下さい。
HTMLCanvasElement
または OffscreenCanvas
placeholder canvas elementを持つもの)
で、キャンバスの画像内容取得の前に、
イベントループ処理モデルの以下のサブステップで発生します:
-
「その
Documentの描画またはUIの更新」 -
「その専用ワーカーの描画の更新」
注:
ServiceWorker や SharedWorker には「描画の更新」ステップはありません。これらはユーザー可視のキャンバスを描画できないためです。
requestAnimationFrame()
は
ServiceWorkerGlobalScope
や SharedWorkerGlobalScope
にはありません。また
OffscreenCanvasは
transferControlToOffscreen()
で生成されたものはこれらのワーカーに送信できません。
以下のコンテンツタイムラインステップを実行する:
-
現在のテクスチャの期限切れ処理を context に対して実行する。
注: これは
getCurrentTexture()でキューされたタスクで既に実行されていれば、効果はありません。 -
context.
[[lastPresentedImage]]に context.[[drawingBuffer]]を設定する。注: これはコピーではなく参照です。current texture の期限切れ後は drawing buffer の内容は in-place で変化しません。
注:
new OffscreenCanvas() で生成された単体の OffscreenCanvas
にはこの処理は発生しません。
transferToImageBitmap()
が GPUCanvasContext
context を持つキャンバスで呼ばれ、キャンバスのbitmapから ImageBitmap
が作成された後に、以下の コンテンツタイムラインステップを実行する:
-
描画バッファを置き換えるを context に対して実行する。
注: これにより transferToImageBitmap()
は画像内容を ImageBitmap へ「移動」する(必要に応じてアルファクリアも)、コピーは行われません。
-
キャンバスサイズの更新アルゴリズム。
21.4. GPUCanvasConfiguration
サポートされるコンテキストフォーマットは、集合である GPUTextureFormat
の次の値です:
«"bgra8unorm"、
"rgba8unorm"、
"rgba16float"»。
これらのフォーマットは、
GPUCanvasConfiguration.format
として指定された場合、指定された
GPUCanvasConfiguration.device
に関わらず、サポートされなければなりません。
注:キャンバスの構成では、srgb フォーマット(例:"bgra8unorm-srgb")は使用できません。
代わりに非srgb相当("bgra8unorm")を使い、
srgbフォーマットをviewFormatsで指定し、
createView()
によりsrgbフォーマットのビューを作成してください。
enum GPUCanvasAlphaMode {"opaque" ,"premultiplied" , };enum GPUCanvasToneMappingMode {"standard" ,"extended" , };dictionary {GPUCanvasToneMapping GPUCanvasToneMappingMode = "standard"; };mode dictionary {GPUCanvasConfiguration required GPUDevice device ;required GPUTextureFormat format ;GPUTextureUsageFlags usage = 0x10; // GPUTextureUsage.RENDER_ATTACHMENTsequence <GPUTextureFormat >viewFormats = [];PredefinedColorSpace colorSpace = "srgb";GPUCanvasToneMapping toneMapping = {};GPUCanvasAlphaMode alphaMode = "opaque"; };
GPUCanvasConfiguration
には以下のメンバーがあります:
device, 型: GPUDevice-
GPUDeviceは、getCurrentTexture()により返されるテクスチャが互換性を持つデバイスです。 format, 型: GPUTextureFormat-
getCurrentTexture()により返されるテクスチャのフォーマット。 Supported context formats のいずれかでなければなりません。 usage, 型: GPUTextureUsageFlags、デフォルトは0x10-
getCurrentTexture()により返されるテクスチャのusage。RENDER_ATTACHMENTがデフォルトですが、usage を明示的に設定した場合は自動付与されません。RENDER_ATTACHMENTをレンダーパスのカラ―ターゲットとして使いたい場合は必ず usage に含めてください。 viewFormats, 型: sequence<GPUTextureFormat>、デフォルトは[]-
getCurrentTexture()から生成されるビューが利用可能なフォーマットのリストです。 colorSpace, 型: PredefinedColorSpace、デフォルトは"srgb"-
getCurrentTexture()に書き込まれる値をどの色空間で表示するかを指定します。 toneMapping, 型: GPUCanvasToneMapping、デフォルトは{}-
getCurrentTexture()のコンテンツをどのように表示するかを決定するトーンマッピングです。注:これは必須機能ですが、user agent が未実装の場合はデフォルトGPUCanvasToneMappingのみサポートとなるかもしれません。 その場合、このメンバーはGPUCanvasConfigurationの実装から 除外すべき で、feature detection (getConfiguration())で 判別可能にすべきです。特にHDR機能がある実装(dynamic-range が high を返す場合)では重要です。
このメンバーが存在し
highな dynamic range を expose する場合、canvas はHDRとして描画されるべき であり、HDRディスプレイのSDR範囲にクランプすべきではありません。 alphaMode, 型: GPUCanvasAlphaMode、デフォルトは"opaque"-
getCurrentTexture()から読み込んだり、表示したり、画像ソースとして使ったときにアルファ値がどのように影響するかを指定します。
GPUCanvasContext
と GPUDevice
を使って、このコンテキストに推奨フォーマットで設定する例:
const canvas= document. createElement( 'canvas' ); const context= canvas. getContext( 'webgpu' ); context. configure({ device: gpuDevice, format: navigator. gpu. getPreferredCanvasFormat(), });
HTMLCanvasElement
または OffscreenCanvas)
canvas,
GPUCanvasConfiguration
configuration)
は、次のメンバーを持つ GPUTextureDescriptor
です:
-
size: [canvas.width, canvas.height, 1] -
viewFormats: configuration.viewFormats
その他のプロパティはデフォルト値となります。
canvas.width は HTMLCanvasElement.width
または OffscreenCanvas.width
を指します。
canvas.height は HTMLCanvasElement.height
または OffscreenCanvas.height
を指します。
21.4.1. キャンバスの色空間
表示時、キャンバス内の色値は画面の色空間へ変換されます。
toneMapping
は、画面の色空間における [0, 1] 範囲外の値の扱いを決定します。
21.4.2. キャンバスコンテキストのサイズ指定
全てのキャンバス設定は configure()
で指定されますが、解像度(サイズ)はキャンバスの width と height で指定されます。
注: WebGLや2dキャンバスと同様に、WebGPUキャンバスのサイズ変更は描画バッファの内容を失います。 WebGPUでは、これは描画バッファを置き換えることで行われます。
HTMLCanvasElement
または OffscreenCanvas
canvas が
GPUCanvasContext
context を持ち、その width または height 属性が設定されたとき、
キャンバスサイズの更新を以下の
コンテンツタイムライン
の手順で行います:
-
描画バッファを置き換えるを context に対して実行する。
-
configuration を context.
[[configuration]]とする。 -
configuration が
nullでない場合:-
context.
[[textureDescriptor]]に キャンバスと設定用のGPUTextureDescriptor(canvas, configuration) を設定する。
-
注: この処理により、GPUTextureDescriptor
がデバイスの
maxTextureDimension2D
を超える場合があります。その場合、
getCurrentTexture()
内でバリデーションが失敗します。
注: このアルゴリズムは、値が変化しなくても
canvas の width または height 属性が設定されるたびに実行されます。
21.5. GPUCanvasToneMappingMode
このenumは、色値が画面にどのように表示されるかを指定します。
"standard"-
画面の標準ダイナミックレンジ内の色値は変更されず、それ以外の色値は画面の標準ダイナミックレンジに射影されます。
注: この射影は、画面の色空間で色値を
[0, 1]範囲にクランプすることでよく実現されます。 "extended"-
画面の拡張ダイナミックレンジ内の色値は変更されず、それ以外の色値は画面の拡張ダイナミックレンジに射影されます。
注: この射影は、画面の色空間で色値を画面が表示可能な値の範囲にクランプすることでよく実現されます(1より大きい値も含む場合があります)。
例えば、値(2.5, -0.15, -0.15)が'srgb'キャンバスに書き込まれた場合:sRGB画面で
[0, 4]範囲を表示できる場合、まずsRGBへ変換(キャンバスもsRGBなので変換なし)、次にディスプレイ空間へ射影されます。 成分ごとにクランプすると、sRGB値(2.5, 0.0, 0.0)となります。Display P3画面で
[0, 2]範囲を表示できる場合、Display P3色空間に(2.3, 0.545, 0.386)へ変換され、ディスプレイ空間へ射影されます。 成分ごとにクランプすると、Display P3値(2.0, 0.545, 0.386)となります。
21.6. GPUCanvasAlphaMode
このenumは、キャンバス内容を読み出す際・ 画面表示や画像ソースとして利用 (drawImage, toDataURLなど)する際の解釈方法を選択します。
以下では、src はキャンバステクスチャ内の値、dst はキャンバスが合成される画像(例:HTMLページ描画や2Dキャンバス)です。
"opaque"-
RGBを不透明として読み出し、アルファ値を無視します。 内容がすでに不透明でない場合は、"コンテキストの画像内容のコピーを取得する"でアルファチャンネルが 1.0 にクリアされます。
"premultiplied"-
RGBAをプリマルチプライドとして読み出します:色値は自身のアルファ値で乗算されています。 100%赤・50%アルファなら
[0.5, 0, 0, 0.5]となります。キャンバステクスチャがガマット外のプリマルチプライドRGBA値を含む場合、読み出し時の挙動は次の通りです:
- 画像ソースとして利用
-
値は保持され、色空間変換に記載の通り扱われます。
- 画面表示
-
合成結果は未定義です。
注: 色空間変換で合成前にガマット内値になる場合でも、合成の中間フォーマットが規定されていないため未定義となります。
22. エラーとデバッグ
WebGPUの通常動作中、エラーは dispatch error を通じて発生します。
デバイスが 失われた 後は、可能な限りエラーは表示されなくなります。 この時点以降、実装はバリデーションやエラー追跡を行う必要はありません:
-
デバイス上のオブジェクトの有効性は観測できなくなります。
-
popErrorScope()およびuncapturederrorはエラーの報告を停止します。 (デバイス損失自体によるエラーは生成されません。 代わりに、GPUDevice.lostの promise が解決され、デバイスが失われたことを示します。) -
content timeline にメッセージを返す全ての操作は、通常の手順を省略します。 ほとんどの操作は成功したように見えますが、
mapAsync()だけは例外で、デバイス損失後は正しいマッピングデータを提供できないためエラーが発生します。他の種類の操作(メッセージを返さないもの)が実行されるかどうかは観測できません。
22.1. 重大なエラー
enum {GPUDeviceLostReason ,"unknown" , }; ["destroyed" Exposed =(Window ,Worker ),SecureContext ]interface {GPUDeviceLostInfo readonly attribute GPUDeviceLostReason ;reason readonly attribute DOMString ; };message partial interface GPUDevice {readonly attribute Promise <GPUDeviceLostInfo >lost ; };
GPUDevice
には、次の属性が追加されています:
lost, 型は Promise<GPUDeviceLostInfo>, readonly-
デバイス作成時に生成される promise を保持する スロット裏付け属性です。 デバイスの存続期間中は pending 状態となり、デバイスが失われた時に解決されます。
初期化時、新しい promise に設定されます。
22.2. GPUError
[Exposed =(Window ,Worker ),SecureContext ]interface GPUError {readonly attribute DOMString message ; };
GPUError は、
popErrorScope()
や
uncapturederror
イベントから発生する全てのエラーの基底インターフェースです。
エラーは、それぞれのアルゴリズムで明示的に条件とサブタイプを指定している操作に対してのみ生成されなければなりません。
失われたデバイスからはエラーは生成されません。 § 22 エラーとデバッグ を参照してください。
注: GPUError
は、今後の現行標準のバージョンで新しいサブタイプが追加される可能性があります。
アプリケーションはこの可能性を考慮し、可能な場合はエラーの message
のみを使用し、必要に応じて
instanceof
で特定してください。エラーをシリアライズする必要がある場合(例:JSONやデバッグレポートなど)は、error.constructor.name を使用してください。
GPUError には、以下の
不変プロパティ があります:
message, 型は DOMString、readonly-
発生したエラーの情報を提供する、人間が読めるローカライズ可能なテキストメッセージです。
注: このメッセージは、通常アプリケーション開発者がアプリケーションをデバッグし、デバッグレポート用の情報を取得するために意図されています。エンドユーザーに表示するものではありません。
注: ユーザーエージェントは、
"out-of-memory"などの 空きメモリ量やその他メモリ枯渇時の条件など、機械処理可能な詳細情報をこのメッセージに含めるべきではありません。注:
messageは、 言語と方向情報のベストプラクティスに従うべきです。これは、将来的に文字列の言語・方向メタデータの報告に関する標準が登場した場合、それを活用することを含みます。編集上の注記: この文書執筆時点では、レガシーAPIとの互換性・一貫性を保つ言語/方向推奨事項はありませんが、今後標準化され次第正式に採用してください。
[Exposed =(Window ,Worker ),SecureContext ]interface :GPUValidationError GPUError {(constructor DOMString ); };message
GPUValidationError
は GPUError
のサブタイプであり、
操作がすべてのバリデーション要件を満たさなかったことを示します。バリデーションエラーは常にアプリケーションエラーに該当し、同じ
[[features]]
と [[limits]]
を使用した場合、全てのデバイスで同じように失敗することが期待されます。
GPUDevice
device で以下の手順を実行します:
Device timeline の手順:
-
error を、新たな
GPUValidationError(適切なエラーメッセージ付き)として生成する。 -
Dispatch error により error を device に通知する。
[Exposed =(Window ,Worker ),SecureContext ]interface :GPUOutOfMemoryError GPUError {(constructor DOMString ); };message
GPUOutOfMemoryError
は GPUError
のサブタイプであり、
操作の実行に必要なメモリが不足していたことを示します。要求メモリサイズを減らす(例:より小さいテクスチャサイズを使う)か、他のリソースで使用中のメモリを先に解放すれば、再試行時に成功する場合があります。
GPUDevice
device で以下の手順を実行します:
Device timeline の手順:
-
error を、新たな
GPUOutOfMemoryError(適切なエラーメッセージ付き)として生成する。 -
Dispatch error により error を device に通知する。
[Exposed =(Window ,Worker ),SecureContext ]interface :GPUInternalError GPUError {(constructor DOMString ); };message
GPUInternalError
は GPUError
のサブタイプであり、
すべてのバリデーション要件を満たしているにもかかわらず、システムや実装固有の理由で操作が失敗したことを示します。
例えば、その操作が supported
limits では容易に表現できない実装の制限を超えている場合などです。この操作は他のデバイスや環境では成功する場合もあります。
GPUDevice
device で以下の手順を実行します:
Device timeline の手順:
-
error を、新たな
GPUInternalError(適切なエラーメッセージ付き)として生成する。 -
Dispatch error により error を device に通知する。
22.3. エラースコープ
GPUエラースコープは、
GPUError が
GPUエラースコープが現在のときに生成されたものを捕捉します。
エラースコープは、WebGPU呼び出しのセット内で発生したエラーを分離するために用いられ、主にデバッグや操作の耐障害性向上のために使われます。
GPUエラースコープは、以下のデバイスタイムラインプロパティを持ちます:
[[errors]], 型は list<GPUError>, 初期値 []-
GPUエラースコープが現在のときに観測された
GPUErrorを保持します。 [[filter]], 型はGPUErrorFilter-
この GPUエラースコープ が観測する
GPUErrorの種類を決定します。
enum {GPUErrorFilter "validation" ,"out-of-memory" ,"internal" , };partial interface GPUDevice {undefined pushErrorScope (GPUErrorFilter filter );Promise <GPUError ?>popErrorScope (); };
GPUErrorFilter
は pushErrorScope()
呼び出し時に捕捉するべきエラーの種類を定義します:
"validation"-
このエラースコープは
GPUValidationErrorを捕捉します。 "out-of-memory"-
このエラースコープは
GPUOutOfMemoryErrorを捕捉します。 "internal"-
このエラースコープは
GPUInternalErrorを捕捉します。
GPUDevice
には、次の デバイスタイムライン属性 があります:
[[errorScopeStack]]、型 stack<GPU error scope>-
スタック で、 GPU エラー スコープ を
GPUDeviceに push したものです。
GPUError
error と GPUDevice
device について判定するには、次を device timeline で実行します:
Device timeline 手順:
-
もし error が次のいずれかのインスタンスであれば:
GPUValidationError-
type を "validation" とする。
GPUOutOfMemoryError-
type を "out-of-memory" とする。
GPUInternalError-
type を "internal" とする。
-
scope を device.
[[errorScopeStack]]の最後の アイテム とする。 -
scope が
undefinedでない間:-
もし scope.
[[filter]]が type なら scope を返す。 -
scope を device.
[[errorScopeStack]]の直前の アイテム にする。
-
-
undefinedを返す。
GPUError
error を GPUDevice
device に通知するには、次の device timeline 手順を実行する:
注: lost なデバイスからはエラーは発生しません。 このアルゴリズムが device が lost になっている間に呼ばれても、 アプリケーションからは観測できません。 § 22 エラーとデバッグ参照。
-
scope を current error scope(error と device 用)とする。
-
もし scope が
undefinedでなければ:-
Append で error を scope.
[[errors]]に追加する。 -
return。
それ以外は、次の手順を content timeline で実行:
-
-
ユーザーエージェントが選択する場合は、次の手順で GPUDevice 用globalタスク を device にキュー:
-
GPUUncapturedErrorEventを "uncapturederror" イベント名で device 上に発火し、errorを error に設定する。
-
注: このイベント後は、 user agent は
開発者にエラー内容を通知するべき です(例えばブラウザ開発者ツールのコンソールに警告表示)。
ただしイベントの defaultPrevented
が true なら警告は表示しないでください。すなわち preventDefault()
の呼び出しは警告を抑制します。
注: ユーザーエージェントは、GPUUncapturedErrorEvent
を GPUDevice
ごとに発生させる数を制限する場合もあります。
これは過度なエラーハンドリングやログ出力でパフォーマンスが下がるのを避けるためです。
pushErrorScope(filter)-
新しい GPU エラースコープ を
[[errorScopeStack]]に push します(this用)。呼び出し対象:GPUDevicethis.引数:
GPUDevice.pushErrorScope(filter) メソッドの引数。 パラメーター 型 Nullable Optional 説明 filterGPUErrorFilter✘ ✘ このエラースコープが観測するエラーの種類 戻り値:
undefinedコンテントタイムライン手順:
-
この後の手順を Device timeline 上で this に発行。
Device timeline 手順:-
scope を新しい GPU エラースコープ にする。
-
scope.
[[filter]]を filter に設定する。 -
Push で scope を this.
[[errorScopeStack]]へ push する。
-
popErrorScope()-
GPU エラースコープ を
[[errorScopeStack]]から pop し、そのエラースコープで観測された何らかのGPUErrorまたは観測されなければnullを resolve するPromiseを返します。Promise解決順序の保証はありません。
呼び出し対象:GPUDevicethis.コンテントタイムライン手順:
-
contentTimeline を現在の コンテントタイムライン とする。
-
promise を 新しい promise にする。
-
check steps を Device timeline 上で this に対して発行する。
-
promise を返す。
Device timeline の check steps:-
this が lost の場合:
-
以下の手順を contentTimeline で実行:
-
return。
注: lost なデバイスからはエラーは発生しません。 § 22 エラーとデバッグ参照。
-
-
次の要件が満たされない場合:
-
this.
[[errorScopeStack]].size が 0 より大きいこと。
この場合、contentTimeline で以下の手順を実行し return:
コンテントタイムライン手順:-
拒否する promise を
OperationErrorで。
-
-
scope を pop で this.
[[errorScopeStack]]から取得。 -
error を scope.
[[errors]]のいずれか一つ、なければnullとする。リスト内で E1, E2 のエラーがあり E2 が E1 により発生したときは、E2 は選択すべきでない。
注: 例: E1 は
t=createTexture()のエラーで、 E2 はt.createView()でtが invalid なときに発生するエラーなど。 どちらもGPUValidationErrorだが、message違いだけ(これは主に人が読むためのもの)。 -
今すぐまたは将来の不定のタイミングで、contentTimeline で次の手順を実行:
注:
popErrorScope()の複数呼び出しの解決順序や error の選択は非決定ですが、適切な状態観測ポイントであればspec要件は満たします。 例えばシェーダーコンパイルなどはデバイスタイムライン外で行いつつ後でまとめてエラー通知できることを許容しています。
-
GPUDevice
操作でバリデーションエラーを error scope で捕捉する例:
gpuDevice. pushErrorScope( 'validation' ); let sampler= gpuDevice. createSampler({ maxAnisotropy: 0 , // 無効。maxAnisotropyは少なくとも1でなければならない。 }); gpuDevice. popErrorScope(). then(( error) => { if ( error) { // サンプラー作成時にエラーがあったため捨てる。 sampler= null ; console. error( `An error occured while creating sampler: ${ error. message} ` ); } });
例:単一リソース(テクスチャやバッファなど)のcreateだけを覆うエラースコープは out of memory などの検出に向いており、この場合は何か他のリソースを解放した上で再度試行するようなことも可能です。
一方、どのコマンドが失敗したかの特定はエラースコープではできません。たとえば、モデル読込み時の全コマンドをまとめて1つの error scope で囲むと、メモリ由来かどうかの切り分けが困難になります。この場合は失敗時にリソース解放よりも別モデル選択や警告表示のような緩やかな対応が推奨されます。メモリ枯渇対策がしたい場合は、アロケーション直前だけをネストした error scope で囲むのが良いでしょう。
22.4. テレメトリ
GPUError が生成され、
それがどの GPUエラースコープ
でも検出されなかった場合、
ユーザーエージェントは 任意で イベントを発火 し、
uncapturederror という名前で
GPUDevice
に対して
GPUUncapturedErrorEvent
を使うことができます。
注: uncapturederror
イベントはテレメトリーや予期せぬエラーの報告用途を想定しています。すべての未捕捉エラーに対して必ずしも発火されるわけではありません(例えば、通知されるエラー数に上限がある場合があります)。したがって、アプリケーションの通常動作中に発生しうる既知のエラー処理には使うべきではありません。そのような場合は
pushErrorScope()
および
popErrorScope()
の利用を推奨します。
[Exposed =(Window ,Worker ),SecureContext ]interface :GPUUncapturedErrorEvent Event {(constructor DOMString ,type GPUUncapturedErrorEventInit ); [gpuUncapturedErrorEventInitDict SameObject ]readonly attribute GPUError error ; };dictionary :GPUUncapturedErrorEventInit EventInit {required GPUError ; };error
GPUUncapturedErrorEvent
には次の属性があります:
error, 型は GPUError, readonly-
非捕捉エラーを表すオブジェクトを保持する スロット裏付け属性。 この型は
popErrorScope()で返されるエラーと同じです。
partial interface GPUDevice {attribute EventHandler onuncapturederror ; };
GPUDevice
には、以下の コンテンツタイムライン属性 があります:
onuncapturederror, 型は EventHandler-
uncapturederrorイベントタイプ用の イベントハンドラーIDL属性。
GPUDevice の
未捕捉エラーを監視する例:
gpuDevice. addEventListener( 'uncapturederror' , ( event) => { // イベントリスナーを追加すると、コンソールログが抑制される可能性があるため、エラーを再表示する。 console. error( 'WebGPUのエラーが捕捉されませんでした:' , event. error); myEngineDebugReport. uncapturedErrors. push({ type: event. error. constructor . name, message: event. error. message, }); });
23. 詳細な操作
このセクションでは、各種GPU操作の詳細について説明します。
23.1. コンピューティング
コンピューティング操作は、GPUのプログラマブルハードウェアへ直接アクセスします。
コンピュートシェーダーにはシェーダーステージ入力や出力はなく、
ストレージバインディングに書き込むことで副作用が結果となります。
GPUBufferBindingLayout
で
GPUBufferBindingType
"storage"
または GPUStorageTextureBindingLayout
としてバインドされます。
これらの操作は GPUComputePassEncoder
で以下のようにエンコードされます:
主なコンピュートアルゴリズム:
引数:
-
descriptor: 現在の
GPUComputePipelineの記述。 -
dispatchCall: ディスパッチ呼び出しのパラメータ。関数引数や
INDIRECTバッファから与えられる場合があります。
-
computeStage を descriptor.
computeとする。 -
workgroupSize を computeStage.
entryPointに computeStage.constantsを適用した結果で計算する。 -
workgroupX を
[0, dispatchCall.の範囲で繰り返す:workgroupCountX]-
workgroupY を
[0, dispatchCall.の範囲で繰り返す:workgroupCountY]-
workgroupZ を
[0, dispatchCall.の範囲で繰り返す:workgroupCountZ]-
localX を
[0, workgroupSize.の範囲で繰り返す:x]-
localY を
[0, workgroupSize.の範囲で繰り返す:y]-
localZ を
[0, workgroupSize.の範囲で繰り返す:y]-
invocation を
{ computeStage, workgroupX, workgroupY, workgroupZ, localX, localY, localZ }とする -
追加 invocation を computeInvocations に。
-
-
-
-
-
-
-
computeInvocations 内の各 invocation について、デバイスが選択した任意の順序(並列を含む)で:
-
シェーダーの 組み込み値 を設定する:
-
num_workgroups 組み込み値を必要に応じて
(
dispatchCall.workgroupCountX,
dispatchCall.workgroupCountY,
dispatchCall.workgroupCountZ
) -
workgroup_id 組み込み値を必要に応じて
(
invocation.workgroupX,
invocation.workgroupY,
invocation.workgroupZ
) -
local_invocation_id 組み込み値を必要に応じて
(
invocation.localX,
invocation.localY,
invocation.localZ
) -
global_invocation_id 組み込み値を必要に応じて
(.
invocation.workgroupX * workgroupSize.x+ invocation.localX,
invocation.workgroupY * workgroupSize.y+ invocation.localY,
invocation.workgroupZ * workgroupSize.z+ invocation.localZ
) -
local_invocation_index 組み込み値を必要に応じて
invocation.localX + (invocation.localY * workgroupSize.x) + (invocation.localZ * workgroupSize.x* workgroupSize.y)
-
-
invocation.computeStage で記述されたコンピュートシェーダーのエントリポイントを実行する。
-
注: シェーダー呼び出しの順序は保証されず、一般的にはデバイスの能力に応じて並列で実行されます。 開発者は、ある呼び出しやワークグループが他のものより先に完了するとは限らないことを前提としてください。 一部のデバイスでは一貫した順序で実行されるように見えることがありますが、この挙動は全デバイスで同じにはならないため、依存しないようにしてください。 呼び出し間で同期が必要な場合は、同期組み込み関数 を用いて実行を調整してください。
デバイスは、 失われる場合があります。 例えば、シェーダー実行が終了しない場合、 ユーザーエージェントが判断する合理的な時間内に終了しないときです。
23.2 レンダリング
レンダリングは、GPURenderPassEncoder
内で実行される一連のGPU操作によって行われ、
レンダーパスのアタッチメントで参照されるテクスチャデータが変更されます。
これらの操作は以下のメソッドでエンコードされます:
注: レンダリングはGPUの伝統的な用途であり、ハードウェアの複数の固定機能ブロックによってサポートされています。
主なレンダリングアルゴリズム:
引数:
-
pipeline: 現在の
GPURenderPipeline。 -
drawCall: ドロー呼び出しのパラメータ。関数引数や
INDIRECTバッファから与えられる場合があります。 -
state: ドロー呼び出しが発行された
GPURenderCommandsMixinの RenderState。
-
descriptor を pipeline.
[[descriptor]]とする。 -
インデックス解決。§ 23.2.1 インデックス解決参照。
vertexList を resolve indices(drawCall, state) の結果とする。
-
頂点処理。§ 23.2.2 頂点処理参照。
process vertices(vertexList, drawCall, descriptor.
vertex, state) を実行する。 -
プリミティブ組み立て。§ 23.2.3 プリミティブ組み立て参照。
assemble primitives(vertexList, drawCall, descriptor.
primitive) を実行する。 -
プリミティブクリッピング。§ 23.2.4 プリミティブクリッピング参照。
この段階の結果を primitiveList とする。
-
ラスタライズ。§ 23.2.5 ラスタライズ参照。
rasterize(primitiveList, state) の結果を rasterizationList とする。
-
フラグメント処理。§ 23.2.6 フラグメント処理参照。
各 rasterPoint について process fragment(rasterPoint, descriptor, state) を実行し、fragments のリストを集める。
-
ピクセル書き込み。§ 23.2.7 出力マージ参照。
fragments の各非null fragment について:
-
process depth stencil(fragment, pipeline, state) を実行する。
-
process color attachments(fragment, pipeline, state) を実行する。
-
23.2.1. インデックス解決
レンダリングの最初の段階では、パイプラインは各インスタンスごとに処理する頂点のリストを構築します。
引数:
-
drawCall: ドロー呼び出しのパラメータ。関数引数や
INDIRECTバッファから与えられる場合があります。 -
state: ドロー呼び出し時の
GPURenderCommandsMixinのスナップショット。
戻り値: 整数インデックスのリスト。
-
vertexIndexList を空のインデックスリストとする。
-
drawCall がインデックス付きドロー呼び出しの場合:
-
vertexIndexList を drawCall.indexCount 個の整数で初期化する。
-
0 .. drawCall.indexCount(非包含)の範囲で i を繰り返す:
-
relativeVertexIndex を fetch index(i + drawCall.
firstIndex, state.[[index_buffer]]) とする。 -
relativeVertexIndex が特別な値
"out of bounds"の場合、空リストを返す。注: 実装はこの状況が発生した際、特に検出が容易な場合(非インダイレクトのインデックス付きドロー呼び出しなど)、警告を表示することができます。
-
vertexIndexList に drawCall.
baseVertex+ relativeVertexIndex を追加する。
-
それ以外の場合:
-
vertexIndexList を drawCall.vertexCount 個の整数で初期化する。
-
各 vertexIndexList の項目 i を drawCall.firstVertex + i の値に設定する。
-
-
vertexIndexList を返す。
注:
インダイレクトドロー呼び出しの場合、indexCount、vertexCount やその他 drawCall
のプロパティはドローコマンド自身ではなくインダイレクトバッファから読み取られます。
引数:
-
i: 取得する頂点インデックスのインデックス。
-
state: ドロー呼び出し時の
GPURenderCommandsMixinのスナップショット。
戻り値: 符号なし整数または "out of bounds"
-
indexSize を state.
[[index_format]]で定義する: -
もし state.
[[index_buffer_offset]]+ |i + 1| × indexSize > state.[[index_buffer_size]]なら、特別な値"out of bounds"を返す。 -
state.
[[index_buffer]]のデータを、 オフセット state.[[index_buffer_offset]]+ i × indexSize から indexSize バイト分、符号なし整数として解釈し返す。
23.2.2. 頂点処理
頂点処理ステージは、レンダーパイプラインのプログラマブルステージであり、 頂点属性データを処理し、 § 23.2.4 プリミティブクリッピングのクリップ空間位置や、 § 23.2.6 フラグメント処理用のその他データを生成します。
引数:
-
vertexIndexList: 処理する頂点インデックスのリスト(mutable, 参照渡し)。
-
drawCall: ドロー呼び出しのパラメータ。関数引数や
INDIRECTバッファから与えられる場合があります。 -
desc: 型
GPUVertexStateのディスクリプター。 -
state: ドロー呼び出し時点の
GPURenderCommandsMixinのスナップショット。
各頂点vertexIndexはvertexIndexList内の全インスタンスrawInstanceIndexごとに独立して処理されます。
rawInstanceIndexは0からdrawCall.instanceCount - 1までの範囲です。この処理は並列で実行され、副作用(
GPUBufferBindingType
"storage"バインディングへの書き込みなど)は任意の順序で発生します。
-
instanceIndex を rawInstanceIndex + drawCall.firstInstance とする。
-
各非
nullなvertexBufferLayoutについて、desc.buffersのリストで:-
i をこのリスト内のバッファレイアウトのインデックスとする。
-
vertexBuffer、vertexBufferOffset、vertexBufferBindingSize を state.
[[vertex_buffers]]のスロットiのバッファ・オフセット・サイズとする。 -
vertexBufferLayout.
stepModeに応じて、vertexElementIndexを決定する:"vertex"-
vertexIndex
"instance"-
instanceIndex
-
drawCallOutOfBounds を
falseにする。 -
各attributeDescについて、vertexBufferLayout.
attributesで:-
attributeOffset を vertexBufferOffset + vertexElementIndex * vertexBufferLayout.
arrayStride+ attributeDesc.offsetとする。 -
もし attributeOffset + byteSize(attributeDesc.
format) > vertexBufferOffset + vertexBufferBindingSize なら:-
drawCallOutOfBounds を
trueにする。 -
実装依存(implementation-defined)で、 vertexIndexListを空にして返し、ドロー呼び出しをキャンセルする。
注: これにより、実装がドロー呼び出し前にインデックスバッファの範囲外値を検出できるようになり、無効なメモリ参照の挙動の代わりとなります。
-
-
-
各attributeDescについて、vertexBufferLayout.
attributesで:-
もし drawCallOutOfBounds が
trueなら:-
WGSLの無効なメモリ参照挙動に従い、vertexBufferから属性dataをロードする。
注: 無効なメモリ参照は、たとえドロー呼び出し全体が範囲外でも、属性が範囲内なら「正しい」値をロードできるなどの挙動を許容します。
それ以外の場合:
-
attributeOffset を vertexBufferOffset + vertexElementIndex * vertexBufferLayout.
arrayStride+ attributeDesc.offsetとする。 -
vertexBufferから、attributeOffsetオフセットでattributeDesc.
formatフォーマットの属性dataをロードする。コンポーネントはバッファメモリからx,y,z,wの順でロードされる。
-
-
dataをチャネルフォーマット規則に従い、シェーダー可視フォーマットに変換する。
-
シェーダー型に合わせてdataサイズを調整する:
-
両方がスカラー、または両方が同じ次元数のベクトルなら調整不要。
-
dataがベクトルでシェーダー型がスカラーなら、最初のコンポーネントのみ抽出。
-
両方がベクトルで、dataが高次元なら余分な成分を切り捨て。
-
シェーダー型が高次元ベクトル、またはdataがスカラーの場合、不足成分は
vec4<*>(0, 0, 0, 1)で埋める。
-
-
dataを、頂点シェーダー入力ロケーションattributeDesc.
shaderLocationにバインドする。
-
-
-
各
GPUBindGroupグループについて、state.[[bind_groups]]のindexで:-
バインドグループ内の各
GPUBindingResourceリソースについて:-
このリソースの対応する
GPUBindGroupLayoutEntryをentryとする。 -
もしentry.
visibilityがVERTEXを含む場合:-
リソースをグループindexとバインディング
GPUBindGroupLayoutEntry.bindingでシェーダーにバインドする。
-
-
-
-
シェーダー組み込み値を設定する:
-
vertex_index組み込み値(あれば)をvertexIndexに設定。 -
instance_index組み込み値(あれば)をinstanceIndexに設定。
-
-
descで記述された頂点シェーダーのエントリポイントを呼び出す。
注: ターゲットプラットフォームは頂点シェーダー呼び出しの結果をキャッシュします。 同じvertexIndexが複数回現れても、複数回呼び出される保証はありません。逆に、1つのvertexIndexが1回だけ処理される保証もありません。
デバイスは、 失われる場合があります。 例えば、シェーダー実行が終了しないとユーザーエージェントが判断した合理的な時間内に処理が終わらない場合です。
23.2.3. プリミティブ生成
プリミティブはGPUの固定機能ステージによって生成されます。
引数:
-
vertexIndexList: 処理する頂点インデックスのリスト。
-
drawCall: ドロー呼び出しのパラメータ。関数引数や
INDIRECTバッファから与えられる場合があります。 -
desc: 型
GPUPrimitiveStateのディスクリプター。
各インスタンスについて、プリミティブはシェーダーで処理された頂点(vertexIndexList)から生成されます。
-
まず、プリミティブトポロジーがストリップ(つまり desc.
stripIndexFormatがundefinedでない)かつdrawCallがインデックス付きの場合は、 vertexIndexListをdesc.stripIndexFormatの最大値をセパレータとして分割します。例:
[1, 2, 65535, 4, 5, 6](型"uint16")は[1, 2]と[4, 5, 6]に分割されます。 -
各サブリストvlについて、プリミティブ生成はdesc.
topologyで決定されます:"line-list"-
ラインプリミティブは(vl.0, vl.1)、(vl.2, vl.3)、(vl.4, vl.5)のように2頂点ずつ構成されます。
"line-strip"-
ラインプリミティブは(vl.0, vl.1)、(vl.1, vl.2)、(vl.2, vl.3)のように1頂点ずつ進めて構成されます。
"triangle-list"-
トライアングルプリミティブは(vl.0, vl.1, vl.2)、(vl.3, vl.4, vl.5)、(vl.6, vl.7, vl.8)のように3頂点ずつ構成されます。
"triangle-strip"-
トライアングルプリミティブは(vl.0, vl.1, vl.2)、(vl.2, vl.1, vl.3)、(vl.2, vl.3, vl.4)、(vl.4, vl.3, vl.5)のように1頂点ずつ進めて構成されます。
不完全なプリミティブは破棄されます。
23.2.4. プリミティブクリッピング
頂点シェーダーは組み込みposition(型vec4<f32>)を生成する必要があり、
これは頂点のクリップ空間座標における
クリップ位置を示します。
プリミティブはクリップボリュームにクリッピングされます。これは、プリミティブ内の任意のクリップ位置pについて、以下の不等式で定義されます:
-
−p.w ≤ p.x ≤ p.w
-
−p.w ≤ p.y ≤ p.w
-
0 ≤ p.z ≤ p.w (デプスクリッピング)
"clip-distances"機能が有効な場合、
このクリップボリュームは、
頂点ステージの出力でclip_distancesを宣言することで、
ユーザー定義の半空間でさらに制限できます。clip_distances配列の各値はプリミティブ内で線形補間され、
補間値が0未満の部分がクリッピングされます。
もしdescriptor.primitive.unclippedDepthがtrueの場合、
デプスクリッピングは適用されません:z次元でクリップボリュームが制限されません。
プリミティブのすべての辺がクリップボリューム内に完全に含まれる場合、
このステージは何も変更しません。
プリミティブの辺がクリップボリューム境界と交差する場合、
交差する辺はクリップボリューム境界上に新しい辺で再接続されます。
三角形プリミティブの場合(descriptor.primitive.topologyが
"triangle-list"
または
"triangle-strip")、
この再接続により内部的に新しい頂点がポリゴン内に導入されることがあります。
プリミティブがクリップボリューム境界の辺と交差する場合、 クリップされたポリゴンはこの境界辺上の点を含める必要があります。
頂点シェーダーが"perspective"補間で修飾された他の浮動小数点値(スカラーやベクトル)を出力する場合もクリッピングされます。 クリップボリューム内の頂点の出力値はクリッピングの影響を受けませんが、 クリッピングで生成された頂点に割り当てられる出力値はクリッピングされます。
頂点aとb間の辺がクリッピングされ、頂点cが生成されたとき、 tを辺の比率とすると、 c.p = t × a.p + (1 − t) × b.p (ここでx.pは頂点xのクリップ位置)。
各頂点出力値"v"について、対応するフラグメント入力がある場合、 a.v、b.vがそれぞれ頂点a、bの出力です。 クリップされたシェーダー出力c.vは補間修飾子に基づき生成されます:
- flat
-
フラット補間は影響を受けず、provoking vertex (誘発頂点)に基づきます。これはシェーダーで宣言された補間サンプリングモードによって決まります。 出力値はプリミティブ全体で同じになり、provoking vertex の頂点出力と一致します。
- linear
-
補間比は clip position の遠近座標に対して調整されるため、 補間結果はスクリーンスペースで線形になります。
- perspective
-
値はクリップ空間で線形補間され、遠近補正された値が得られます。
プリミティブクリッピングの結果は、クリップボリューム内に含まれる新しいプリミティブ集合です。
23.2.5. ラスタライズ
ラスタライズは、生成されたプリミティブを
フレームバッファ(現行のGPURenderPassEncoderのレンダーアタッチメント集合)に対応する
2次元レンダリング領域へマッピングするハードウェア処理ステージです。
このレンダリング領域は均等なピクセルグリッドに分割されています。
フレームバッファの座標系はレンダーターゲットの左上隅から始まり、 各単位は正確に1ピクセルに対応します。詳細は§ 3.3 座標系を参照してください。
ラスタライズでは、プリミティブが影響するピクセル集合を決定します。マルチサンプリングの場合、
各ピクセルはさらに
descriptor.multisample.count
個のサンプルに分割されます。
標準サンプルパターンは以下の通りです。
サンプル位置は、ピクセルの左上隅を基準としたフレームバッファ座標で表され、ピクセル範囲は(0, 0)から(1, 1)です:
multisample.count
| サンプル位置 |
|---|---|
| 1 | サンプル0: (0.5, 0.5) |
| 4 |
サンプル0: (0.375, 0.125) サンプル1: (0.875, 0.375) サンプル2: (0.125, 0.625) サンプル3: (0.625, 0.875) |
ラスタライズを行う際、実装は与えられた
multisample.count
の標準サンプルパターンを使用しなければなりません。
FragmentDestinationは以下を含みます:
- position
-
フレームバッファ座標を使った2次元ピクセル位置
- sampleIndex
-
§ 23.2.10 サンプルごとのシェーディングが有効な場合は整数、それ以外は
null
また、正規化デバイス座標(NDC)の概念も使用します。 この座標系では、ビューポートの境界はXとYが−1から1、Zが0から1の範囲です。
ラスタライズは、以下のデータを持つRasterizationPointのリストを生成します:
- destination
- coverageMask
-
マルチサンプルカバレッジマスク(§ 23.2.11 サンプルマスキング参照)
- frontFacing
-
プリミティブの表面側の点ならtrue
- perspectiveDivisor
-
プリミティブ全体で補間された1.0 ÷ Wを参照
- depth
-
ビューポート座標での深度、すなわち
[[viewport]]のminDepthとmaxDepthの間 - primitiveVertices
-
プリミティブを構成する頂点出力のリスト
- barycentricCoordinates
引数:
-
primitiveList: ラスタライズするプリミティブのリスト。
-
state: アクティブなRenderState。
戻り値: RasterizationPointのリスト。
primitiveList内の各プリミティブは独立して処理されますが、プリミティブの順序は後続の深度・ステンシル操作やピクセル書き込みに影響します。
-
まず、クリップ済み頂点をNDC(正規化デバイス座標)へ変換します。 出力位置pについて、NDC位置と遠近除算は次の通り:
ndc(p) = ベクトル(p.x ÷ p.w, p.y ÷ p.w, p.z ÷ p.w)
divisor(p) = 1.0 ÷ p.w
-
vpをstate.
[[viewport]]とする。 NDC位置nを ビューポート座標にマッピング:-
レンダーターゲットのオフセットとサイズからフレームバッファ座標を計算:
framebufferCoords(n) = ベクトル(vp.
x+ 0.5 × (n.x + 1) × vp.width, vp.y+ 0.5 × (−n.y + 1) × vp.height) -
[0,1]をビューポート深度範囲に線形マッピングして深度を計算:
depth(n) = vp.
minDepth+ n.z× ( vp.maxDepth- vp.minDepth)
-
-
rasterizationPointsを各点の属性(
divisor(p)、framebufferCoords(n)、depth(n)など)を、 プリミティブ上の位置に応じて補間して得る。同じ補間方法は§ 23.2.4 プリミティブクリッピングと同様。 属性がユーザー定義(組み込み出力値でない)場合、 補間タイプはWGSLの@interpolate属性で指定されます。 -
具体的なラスタライズアルゴリズムは
primitive.topologyに依存します:"point-list"-
点が§ 23.2.4 プリミティブクリッピングで除外されていなければ、§ 23.2.5.1 点ラスタライズへ。
"line-list"または"line-strip"-
ラインは§ 23.2.4 プリミティブクリッピングで切断され、§ 23.2.5.2 ラインラスタライズへ。
"triangle-list"または"triangle-strip"-
§ 23.2.4 プリミティブクリッピングで生成されたポリゴンは§ 23.2.5.4 ポリゴンラスタライズへ。
-
rasterizationPointsから、rpのrp.destination.positionがstate.
[[scissorRect]]外の点をすべて除去する。 -
rasterizationPointsを返す。
23.2.5.1. 点ラスタライズ
点のフレームバッファ座標を含むピクセル内で、1つのFragmentDestinationが選択されます。
カバレッジマスクはマルチサンプリングモードによって異なります:
- サンプル頻度
-
coverageMask = 1 ≪
sampleIndex - ピクセル頻度マルチサンプリング
-
coverageMask = 1 ≪ descriptor.
multisample.count− 1 - マルチサンプリングなし
-
coverageMask = 1
23.2.5.2. ラインラスタライズ
ラインラスタライズに使用される正確なアルゴリズムは定義されておらず、実装ごとに異なる場合があります。例えば、ラインセグメントの周囲に1px幅の矩形を§ 23.2.5.4 ポリゴンラスタライズで描画したり、Bresenhamのラインアルゴリズムを使ってFragmentDestinationを選択することもあります。
注: ラインラスタライズアルゴリズムの詳細については、基本ラインセグメントラスタライズやBresenhamラインセグメントラスタライズ(Vulkan 1.3現行標準)を参照してください。
23.2.5.3. バリセントリック座標
バリセントリック座標は、フレームバッファ空間内の凸多角形(頂点数n、頂点vi)の中の点pについて定義される、n個の数biのリストです。 各biは0から1の範囲で、頂点viへの近さを表します。 これらの和は常に一定です:
∑ (bi) = 1
これらの座標により、多角形内(またはその境界上)の任意の点pは次のように一意に指定されます:
p = ∑ (bi × pi)
頂点が3つの多角形、すなわち三角形の場合、 任意の点pのバリセントリック座標は次のように計算できます:
Apolygon = A(v1, v2, v3) b1 = A(p, b2, b3) ÷ Apolygon b2 = A(b1, p, b3) ÷ Apolygon b3 = A(b1, b2, p) ÷ Apolygon
ここで、A(点のリスト)は指定された頂点集合による多角形の面積です。
3つ以上の頂点を持つ多角形の場合、厳密なアルゴリズムは実装依存となります。 一つの実装例としては、多角形を三角形分割し、点が含まれる三角形に基づいてバリセントリック座標を計算する方法があります。
23.2.5.4. ポリゴンラスタライズ
ポリゴンが投影方向に向いていれば表面側、 そうでなければ裏面側です。
引数:
戻り値: RasterizationPointのリスト。
-
rasterizationPoints を空リストとする。
-
v(i) を、ラスタライズされた多角形のクリッピング済み頂点番号 i(1から始まる)の フレームバッファ座標とする。
注: このセクションでは「三角形」ではなく「多角形(polygon)」という用語を用いています。 これは § 23.2.4 プリミティブクリッピング の段階で追加の頂点が導入されている可能性があるためです。 これはアプリケーションからは観測されません。
-
多角形が前面かどうかを決定する。これは フレームバッファ座標における多角形の area の符号によって決まる:
area = 0.5 × ((v1.x × vn.y − vn.x × v1.y) + ∑ (vi+1.x × vi.y − vi.x × vi+1.y))
-
フラグメントの集合を、多角形内のフレームバッファ空間で決定する。 これらはピクセル単位処理の対象となる位置である。 この操作は「ポイントサンプリング」と呼ばれる。 ロジックはdescriptor.
multisampleに基づく:- disabled
-
フラグメントはピクセル中心に関連付けられる。 すなわち、座標Cで fract(C) = vector2(0.5, 0.5) を満たし、 フレームバッファ空間で多角形内部にある点全てが対象。 ピクセル中心が多角形の辺上にある場合、それを含めるかどうかは定義されていない。
注: これはラスタライザの精度に依存する問題となる。
- enabled
-
各ピクセルには descriptor.
multisample.count箇所の位置が関連付けられ、 これらは 実装依存 である。 位置には順序があり、フレームバッファの全ピクセルで同じリストとなる。 各位置はマルチサンプリングされたフレームバッファ内の1つのフラグメントに対応する。ラスタライザは各ピクセルごとにヒットした位置のマスクを構築し、これをフラグメントシェーダの "sample-mask" 組み込み変数として提供する。
-
生成された各FragmentDestination型のフラグメントについて:
-
rp を新しい RasterizationPoint オブジェクトとする。
-
そのフラグメントの § 23.2.5.3 バリセントリック座標に基づきリストbを計算し、 rp.barycentricCoordinates に b を設定する。
-
di を vi のデプス値とする。
-
rp.depth を ∑ (bi × di) に設定する。
-
rp を rasterizationPoints に追加する。
-
-
rasterizationPoints を返す。
23.2.6. フラグメント処理
フラグメント処理ステージは、レンダーパイプラインのプログラマブルステージであり、 レンダーターゲットに書き込むフラグメントデータ(多くの場合は色)を計算します。
このステージは、各RasterizationPointに対して、 Fragmentを生成します:
-
destinationはFragmentDestinationを参照します。
-
frontFacingはプリミティブの表面側フラグメントであればtrueです。
-
coverageMaskはマルチサンプルのカバレッジマスク(§ 23.2.11 サンプルマスキング参照)を参照します。
-
depthはビューポート座標での深度を参照します。 すなわち
[[viewport]]のminDepthからmaxDepthまでの間です。 -
colorsは、
colorAttachments内の各ターゲットに対する色値リストです。 -
depthPassed は、フラグメントが
depthCompare演算に合格した場合trueです。 -
stencilPassed は、フラグメントがステンシル
compare演算に合格した場合trueです。
引数:
-
rp: RasterizationPoint(§ 23.2.5 ラスタライズで生成)。
-
descriptor: 型
GPURenderPipelineDescriptorのディスクリプター。 -
state: アクティブなRenderState。
戻り値: Fragmentまたはnull。
-
fragmentDesc を descriptor.
fragmentとする。 -
depthStencilDesc を descriptor.
depthStencilとする。 -
fragment を新しいFragmentオブジェクトとする。
-
fragment.destination を rp.destinationに設定。
-
fragment.frontFacing を rp.frontFacingに設定。
-
fragment.coverageMask を rp.coverageMaskに設定。
-
シェーダーで
frag_depth組み込み値が生成されない場合:-
fragment.depthPassed を compare fragment(fragment.destination, fragment.depth, "depth", state.
[[depthStencilAttachment]], depthStencilDesc?.depthCompare) とする。
-
-
stencilState を、rp.frontFacingが
trueであればdepthStencilDesc?.stencilFront、 そうでなければdepthStencilDesc?.stencilBackとする。 -
fragment.stencilPassed を compare fragment(fragment.destination, state.
[[stencilReference]], "stencil", state.[[depthStencilAttachment]], stencilState?.compare) に設定。 -
fragmentDescが
nullでなければ:-
もしfragment.depthPassedが
falseで、シェーダーエントリポイントがfrag_depth組み込み値を生成せず、ストレージバインディングへの書き込みもない場合、以下の手順は省略可能。 -
シェーダー入力組み込み値を設定する。エントリポイントの各非複合引数(組み込み値で注釈されたもの)は、注釈に基づき値を設定:
position-
vec4<f32>(rp.destination.position, rp.depth, rp.perspectiveDivisor) front_facing-
rp.frontFacing
sample_indexsample_mask-
rp.coverageMask
-
フラグメントステージのユーザー指定シェーダーステージ入力ごとに:
-
value を、rp.barycentricCoordinates、 rp.primitiveVerticesおよび入力の補間修飾子に基づき補間して算出。
-
対応するフラグメントシェーダーlocation入力値にvalueを設定。
-
-
fragmentDescで記述されたフラグメントシェーダーのエントリポイントを呼び出す。
デバイスは、 失われる場合があります。 例えば、シェーダー実行が終了しない場合、 ユーザーエージェントが判断する合理的な時間内に処理が終わらない場合です。
-
フラグメントが
discardを発行した場合、nullを返す。 -
fragment.colorsを、シェーダーからのユーザー指定シェーダーステージ出力値に設定。
-
シェーダー出力組み込み値を取得:
-
もし
frag_depth組み込み値がシェーダーからvalueとして生成された場合:-
vp を state.
[[viewport]]とする。 -
fragment.depth を clamp(value, vp.
minDepth, vp.maxDepth)に設定。 -
fragment.depthPassed を compare fragment( fragment.destination, fragment.depth, "depth", state.
[[depthStencilAttachment]], depthStencilDesc?.depthCompare)に設定。
-
-
-
もし
sample_mask組み込み値がシェーダーからvalueとして生成された場合:-
fragment.coverageMaskを fragment.coverageMask ∧ value に設定。
-
それ以外の場合は§ 23.2.8 色出力なしモードとなり、fragment.colorsは空です。
-
-
fragmentを返す。
引数:
-
destination: FragmentDestination。
-
value: 比較対象の値。
-
aspect: attachmentから値をサンプリングするaspect。
-
attachment: 比較対象となるアタッチメント。
-
compareFunc: 使用する
GPUCompareFunction、またはundefined。
戻り値: 比較が合格すればtrue、そうでなければfalse
-
attachmentが
undefinedまたはaspectを持たなければ、trueを返す。 -
compareFuncが
undefinedまたは"always"なら、trueを返す。 -
attachmentValueをattachmentのaspect値でdestination位置から取得する。
-
valueとattachmentValueをcompareFuncで比較して合格なら
true、不合格ならfalseを返す。
フラグメントの処理は並列で行われますが、副作用(
GPUBufferBindingType
"storage"バインディングへの書き込みなど)は任意の順序で発生し得ます。
23.2.7. 出力マージ
出力マージは、レンダーパイプラインの固定機能ステージであり、 フラグメントの色、深度、ステンシルデータをレンダーパスのアタッチメントに書き込むために出力します。
引数:
-
fragment: Fragment(§ 23.2.6 フラグメント処理で生成)。
-
pipeline: 現在の
GPURenderPipeline。 -
state: アクティブなRenderState。
-
depthStencilDesc を pipeline.
[[descriptor]].depthStencilとする。 -
もし pipeline.
[[writesDepth]]がtrueかつ fragment.depthPassed がtrueなら:-
state.
[[depthStencilAttachment]]のdepthアスペクト値をfragment.destinationでfragment.depthに設定する。
-
-
もし pipeline.
[[writesStencil]]が true なら:-
stencilState を depthStencilDesc.
stencilFront(fragment.frontFacingがtrueなら)またはdepthStencilDesc.stencilBack(それ以外)に設定。 -
もし fragment.stencilPassed が
falseなら:-
stencilOp を stencilState.
failOpに設定。
それ以外で fragment.depthPassed が
falseなら:-
stencilOp を stencilState.
depthFailOpに設定。
それ以外:
-
stencilOp を stencilState.
passOpに設定。
-
-
state.
[[depthStencilAttachment]]のstencilアスペクト値を fragment.destinationで、stencilOpで指定された操作を行い更新する。
-
このステージへの深度入力(存在すれば)は、現在の[[viewport]]の深度範囲にクランプされます(フラグメントシェーダーステージがfrag_depth組み込み値を書き込むかどうかに関係なく)。
引数:
-
fragment: Fragment(§ 23.2.6 フラグメント処理で生成)。
-
pipeline: 現在の
GPURenderPipeline。 -
state: アクティブなRenderState。
-
もし fragment.depthPassed が
falseまたは fragment.stencilPassed がfalseなら、return。 -
targets を pipeline.
[[descriptor]].fragment.targetsとする。 -
state.
[[colorAttachments]]の各attachmentについて:-
color を fragment.colors から attachment に対応する値とする。
-
targetDesc を targets の attachment に対応するエントリーとする。
-
fragment.destination における attachment の値を color に設定する。
-
23.2.8. 色出力なし
色出力なしモードでは、パイプラインはカラーアタッチメント出力を生成しません。
パイプラインはラスタライズを行い、 頂点位置出力に基づく深度値を生成します。深度テストとステンシル操作は引き続き利用可能です。
23.2.9. アルファtoカバレッジ
アルファtoカバレッジモードでは、
フラグメントシェーダーの出力値(@location(0))のalpha成分に基づいて、
MSAAサンプルの追加アルファtoカバレッジマスクが生成されます。
追加マスクの生成アルゴリズムはプラットフォーム依存であり、ピクセル毎に異なる場合があります。 保証されるのは以下の通りです:
-
もし alpha ≤ 0.0 の場合、結果は 0x0 となります。
-
もし alpha ≥ 1.0 の場合、結果は 0xFFFFFFFF となります。
-
中間の alpha 値では、マスク内の1に設定されるビット数が比例するべきです。 ただし、すべてのプラットフォームで、あるピクセルに対して alpha が増加するにつれてマスク内の1のビット数が単調に増加することが保証されているわけではありません。
23.2.10. サンプルごとのシェーディング
マルチサンプリングされたレンダーアタッチメントへの描画時、フラグメントシェーダーはピクセルごとまたはサンプルごとに実行できます。
フラグメントシェーダーは、sample_index 組み込み値または
sample 補間サンプリングが使われ、シェーダー出力で利用される場合、
必ずサンプルごとに実行しなければなりません。それ以外の場合、フラグメントシェーダーはピクセルごとに実行してもよく、
その結果は最終サンプルマスクに含まれる各サンプルにブロードキャストされます。
サンプルごとのシェーディングを使う場合、サンプルNの色出力は、sample_index ==
Nで現在のピクセルについてフラグメントシェーダー実行で生成されます。
23.2.11. サンプルマスキング
ピクセルの最終サンプルマスクは、
ラスタライズマスク
& mask
& シェーダー出力マスク
として計算されます。
マスクの下位countビットのみが考慮されます。
最終サンプルマスクの位置Nにある最下位ビットが"0"の場合、 フラグメントシェーダーの全アタッチメントに対応するサンプルNのサンプルカラー出力は破棄されます。 また、深度ステンシルアタッチメントの該当サンプルに対しては、深度テストやステンシル演算も実行されません。
ラスタライズマスクはラスタライズステージで生成され、 ラスタライズされたポリゴンの形状に基づきます。形状に含まれるサンプルは、マスク内の該当ビットが1になります。
シェーダー出力マスクは、
フラグメントシェーダーの"sample_mask" 組み込み値の出力値を取ります。
この組み込み値がフラグメントシェーダーから出力されず、
alphaToCoverageEnabledが有効な場合、
シェーダー出力マスクは
アルファtoカバレッジマスクとなります。
それ以外はデフォルトで0xFFFFFFFFとなります。
24. 型定義
typedef [EnforceRange ]unsigned long ;GPUBufferDynamicOffset typedef [EnforceRange ]unsigned long ;GPUStencilValue typedef [EnforceRange ]unsigned long ;GPUSampleMask typedef [EnforceRange ]long ;GPUDepthBias typedef [EnforceRange ]unsigned long long ;GPUSize64 typedef [EnforceRange ]unsigned long ;GPUIntegerCoordinate typedef [EnforceRange ]unsigned long ;GPUIndex32 typedef [EnforceRange ]unsigned long ;GPUSize32 typedef [EnforceRange ]long ;GPUSignedOffset32 typedef unsigned long long ;GPUSize64Out typedef unsigned long ;GPUIntegerCoordinateOut typedef unsigned long ;GPUSize32Out typedef unsigned long ;GPUFlagsConstant
24.1. 色とベクトル
dictionary {GPUColorDict required double r ;required double g ;required double b ;required double a ; };typedef (sequence <double >or GPUColorDict );GPUColor
注:
double型は32ビット符号付き/符号なし整数および単精度浮動小数点数を正確に保持できる十分なサイズです。
r, 型は double-
赤チャンネルの値。
g, 型は double-
緑チャンネルの値。
b, 型は double-
青チャンネルの値。
a, 型は double-
アルファチャンネルの値。
GPUColor
値 color について、その型に応じて次のように構文を解釈する:
-
color.r は
GPUColorDict.rまたはシーケンスの最初の要素(そのような要素が存在することを 保証)を指す。 -
color.g は
GPUColorDict.gまたはシーケンスの2番目の要素(そのような要素が存在することを 保証)を指す。 -
color.b は
GPUColorDict.bまたはシーケンスの3番目の要素(そのような要素が存在することを 保証)を指す。 -
color.a は
GPUColorDict.aまたはシーケンスの4番目の要素(そのような要素が存在することを 保証)を指す。
dictionary {GPUOrigin2DDict GPUIntegerCoordinate = 0;x GPUIntegerCoordinate = 0; };y typedef (sequence <GPUIntegerCoordinate >or GPUOrigin2DDict );GPUOrigin2D
GPUOrigin2D
値 origin について、型に応じて以下の構文:
-
origin.x は
GPUOrigin2DDict.xまたはシーケンスの1番目の要素(存在しなければ0)を参照します。 -
origin.y は
GPUOrigin2DDict.yまたはシーケンスの2番目の要素(存在しなければ0)を参照します。
dictionary {GPUOrigin3DDict GPUIntegerCoordinate = 0;x GPUIntegerCoordinate = 0;y GPUIntegerCoordinate = 0; };z typedef (sequence <GPUIntegerCoordinate >or GPUOrigin3DDict );GPUOrigin3D
GPUOrigin3D
値 origin について、型に応じて以下の構文:
-
origin.x は
GPUOrigin3DDict.xまたはシーケンスの1番目の要素(存在しなければ0)を参照します。 -
origin.y は
GPUOrigin3DDict.yまたはシーケンスの2番目の要素(存在しなければ0)を参照します。 -
origin.z は
GPUOrigin3DDict.zまたはシーケンスの3番目の要素(存在しなければ0)を参照します。
dictionary {GPUExtent3DDict required GPUIntegerCoordinate width ;GPUIntegerCoordinate height = 1;GPUIntegerCoordinate depthOrArrayLayers = 1; };typedef (sequence <GPUIntegerCoordinate >or GPUExtent3DDict );GPUExtent3D
width, 型 GPUIntegerCoordinate-
範囲の幅。
height, 型 GPUIntegerCoordinate、デフォルト値は1-
範囲の高さ。
depthOrArrayLayers, 型 GPUIntegerCoordinate、デフォルト値は1-
範囲の深さ、あるいは格納している配列レイヤー数。
GPUTextureとGPUTextureDimensionが"3d"の場合はテクスチャの深さを定義する。GPUTextureとGPUTextureDimensionが"2d"の場合は、そのテクスチャ内の配列レイヤーの数を定義する。
GPUExtent3D
値 extent について、その型に応じて次のように構文を解釈する:
-
extent.width は
GPUExtent3DDict.widthまたはシーケンスの最初の要素(そのような要素が存在することを 保証)を指す。 -
extent.height は
GPUExtent3DDict.heightまたはシーケンスの2番目の要素(存在しなければ1とする)を指す。 -
extent.depthOrArrayLayers は
GPUExtent3DDict.depthOrArrayLayersまたはシーケンスの3番目の要素(存在しなければ1とする)を指す。
引数:
-
extent: 検証対象となる
GPUExtent3D。
返り値: undefined
Content timeline の手順:
-
次の場合は
TypeErrorを投げる:
25. 機能索引
25.1. "core-features-and-limits"
すべてのCore WebGPU機能および制限が利用可能になります。
これは常に利用可能ですが、featureLevel
が "compatibility"
に設定されている場合は、利用できる場合とできない場合があります(詳細は各定義を参照してください)。
25.2. "depth-clip-control"
デプスクリッピングを無効化できるようになります。
この機能は以下のオプションAPIサーフェスを追加します:
-
新しい
GPUPrimitiveState辞書メンバー:
25.3. "depth32float-stencil8"
"depth32float-stencil8"フォーマットのテクスチャを明示的に作成可能になります。
この機能は以下のオプションAPIサーフェスを追加します:
25.4. "texture-compression-bc"
BC圧縮フォーマット("S3TC"、"RGTC"、"BPTC"フォーマットを含む)のテクスチャを明示的に作成可能になります。2Dテクスチャのみ対応。
注: "texture-compression-bc"対応アダプターは必ずしも"texture-compression-bc-sliced-3d"対応ではありません。"texture-compression-bc-sliced-3d"を使うには、"texture-compression-bc"を明示的に有効化する必要があります。この機能のみでBCフォーマットは有効化されません。
この機能は以下のオプションAPIサーフェスを追加します:
-
新しい
GPUTextureFormat列挙値:
25.5. "texture-compression-bc-sliced-3d"
BC圧縮フォーマットのテクスチャに対して3d次元が利用可能になります。
注: "texture-compression-bc"対応アダプターは必ずしも"texture-compression-bc-sliced-3d"対応ではありません。"texture-compression-bc-sliced-3d"を使うには、"texture-compression-bc"を明示的に有効化する必要があります。この機能のみでBCフォーマットは有効化されません。
この機能はオプションAPIサーフェスを追加しません。
25.6. "texture-compression-etc2"
ETC2圧縮フォーマットのテクスチャを明示的に作成可能になります。2Dテクスチャのみ対応。
この機能は以下のオプションAPIサーフェスを追加します:
-
新しい
GPUTextureFormat列挙値:
25.7. "texture-compression-astc"
ASTC圧縮フォーマットのテクスチャを明示的に作成可能になります。2Dテクスチャのみ対応。
この機能は以下のオプションAPIサーフェスを追加します:
-
新しい
GPUTextureFormat列挙値:
25.8. "texture-compression-astc-sliced-3d"
ASTC圧縮フォーマットのテクスチャに対して3d次元が利用可能になります。
注: "texture-compression-astc"対応アダプターは必ずしも"texture-compression-astc-sliced-3d"対応ではありません。"texture-compression-astc-sliced-3d"を使うには、"texture-compression-astc"を明示的に有効化する必要があります。この機能のみでASTCフォーマットは有効化されません。
この機能はオプションAPIサーフェスを追加しません。
25.9. "timestamp-query"
GPUコマンドバッファからタイムスタンプをクエリする機能を追加します。§ 20.4 タイムスタンプクエリ参照。
この機能は以下のオプションAPIサーフェスを追加します:
-
新しい
GPUQueryType値: -
新しい
GPUComputePassDescriptorメンバー: -
新しい
GPURenderPassDescriptorメンバー:
25.10. "indirect-first-instance"
インダイレクトドローのパラメータおよびインダイレクトドローインデックス付きパラメータで非ゼロのfirstInstance値を使用可能にします。
この機能はオプションAPIサーフェスを追加しません。
25.11.
"shader-f16"
WGSLで半精度浮動小数点型f16が利用可能になります。
この機能は以下のオプションAPIサーフェスを追加します:
-
新しいWGSL拡張:
25.12. "rg11b10ufloat-renderable"
RENDER_ATTACHMENT
用途が、フォーマット"rg11b10ufloat"のテクスチャに許可されます。また、このフォーマットのテクスチャに対してブレンド、マルチサンプリング、リゾルブも可能となります。
暗黙的に、"rg11b10ufloat"をcopyExternalImageToTexture()の宛先フォーマットとして許可します。
この機能はオプションAPIサーフェスを追加しません。
注:この機能は、"texture-formats-tier1"により自動的に有効化されます。そして"texture-formats-tier2"によっても自動的に有効化されます。
25.13. "bgra8unorm-storage"
STORAGE_BINDING用途として"bgra8unorm"フォーマットのテクスチャが利用できます。
この機能はオプションAPIサーフェスを追加しません。
25.14. "float32-filterable"
"r32float"、
"rg32float"、
"rgba32float"
フォーマットのテクスチャをフィルタ可能にします。
25.15. "float32-blendable"
"r32float"、
"rg32float"、
"rgba32float"
フォーマットのテクスチャをブレンド可能にします。
25.16. "clip-distances"
WGSLでclip_distancesが利用可能になります。
この機能は以下のオプションAPIサーフェスを追加します:
-
新しいWGSL拡張:
25.17. "dual-source-blending"
WGSLでblend_srcの使用を可能にし、かつピクセルシェーダーの出力
(@blend_src(0) と @blend_src(1))の両方を、単一のカラーアタッチメント
location 0 でのブレンディング操作の入力として同時に使用できるようにします。
この機能は以下のオプションAPIサーフェスを追加します:
-
下記
GPUBlendFactorの利用が可能になります: -
新しいWGSL拡張:
25.18.
"subgroups"
WGSLでサブグループおよびクアッド演算の利用が可能になります。
この機能はオプションAPIサーフェスを追加しませんが、アダプターでこの機能が利用可能な場合、GPUAdapterInfoの
以下のエントリが実値を返します:
-
新しいWGSL拡張:
25.19. "texture-formats-tier1"
デバイス作成時に"texture-formats-tier1"
を有効にすると、
"rg11b10ufloat-renderable"
も有効になります。
以下の項目はそれに加えて適用されます。
下記の新しいGPUTextureFormatについて、
RENDER_ATTACHMENT、
ブレンド可能、
multisampling機能、
STORAGE_BINDING機能(
"read-only"および
"write-only"
GPUStorageTextureAccessが利用可能になります:
下記GPUTextureFormatについて、
RENDER_ATTACHMENT、
ブレンド可能、
multisamplingとresolve機能も利用可能です:
下記GPUTextureFormatについて、
"read-only"または
"write-only"
GPUStorageTextureAccessが利用可能です:
copyExternalImageToTexture()
で次の新しい宛先フォーマットが暗黙的に許可されます:
注:この機能は"texture-formats-tier2"によって自動的に有効化されます。
25.20. "texture-formats-tier2"
デバイス作成時に"texture-formats-tier2"
を有効にすると、
"texture-formats-tier1"
も有効になります。
以下の項目はそれに加えて適用されます。
以下のGPUTextureFormat
について、"read-write"
GPUStorageTextureAccess
が許可されます:
25.21. "primitive-index"
WGSLでprimitive_indexの利用が可能になります。
この機能は以下のオプションAPIサーフェスを追加します:
-
新しいWGSL拡張:
25.22. "texture-component-swizzle"
GPUTextureView
を TEXTURE_BINDING
として使用する際に、テクスチャの赤/緑/青/アルファチャンネルから色成分を並べ替えたり置き換えたりできるようにします。
§ 26.1.2.1 Depth/Stencil テクスチャの読み取りとサンプリング の以前は実装依存だった動作も定義します。
この機能は以下の オプション API サーフェス を追加します:
-
新しい
GPUTextureViewDescriptor辞書メンバー:
26. 付録
26.1. テクスチャフォーマットの機能
26.1.1. プレーンカラー形式
すべてのサポートされるプレーンカラー形式は、次の用途をサポートします:
COPY_SRC、
COPY_DST、
TEXTURE_BINDING、
および次元"3d"。
RENDER_ATTACHMENTと
STORAGE_BINDINGの列は、
GPUTextureUsage.RENDER_ATTACHMENTおよび
GPUTextureUsage.STORAGE_BINDING用途のサポートを示します。
レンダーターゲットのピクセルバイトコストと
レンダーターゲットのコンポーネントアラインメントは、
maxColorAttachmentBytesPerSample制限のバリデーションに使用されます。
注: これらの形式それぞれのテクセルブロックのメモリコストは、 テクセルブロックのコピーのフットプリントと同じです。
26.1.2. 深度・ステンシル形式
深度またはステンシル形式は、深度および/またはステンシルのアスペクトを持つ任意の形式です。 複合深度ステンシル形式は、深度またはステンシル形式のうち、深度とステンシルの両方のアスペクトを持つものです。
すべての深度またはステンシル形式は、COPY_SRC、
COPY_DST、
TEXTURE_BINDING、
RENDER_ATTACHMENT
用途をサポートします。
これらの形式はすべてマルチサンプリングに対応しています。
ただし、特定のコピー操作はソースおよびデスティネーションの形式を制限し、これらの形式はいずれも"3d"次元のテクスチャをサポートしません。
深度テクスチャは"filtering"
サンプラーでは使用できませんが、フィルタリングを使用していても"comparison"
サンプラーでは常に使用できます。
| 形式 |
注:
テクセルブロックのメモリコスト(バイト数)
| アスペクト | GPUTextureSampleType
| 有効なテクセルコピー元 | 有効なテクセルコピー先 | テクセルブロックのコピーのフットプリント(バイト数) | アスペクト専用形式 |
|---|---|---|---|---|---|---|---|
stencil8
| 1 − 4 | ステンシル | "uint"
| ✓ | 1 | stencil8
| |
depth16unorm
| 2 | 深度 | "depth",
"unfilterable-float"
| ✓ | 2 | depth16unorm
| |
depth24plus
| 4 | 深度 | "depth",
"unfilterable-float"
| ✗ | – | depth24plus
| |
depth24plus-stencil8
| 4 − 8 | 深度 | "depth",
"unfilterable-float"
| ✗ | – | depth24plus
| |
| ステンシル | "uint"
| ✓ | 1 | stencil8
| |||
depth32float
| 4 | 深度 | "depth",
"unfilterable-float"
| ✓ | ✗ | 4 | depth32float
|
depth32float-stencil8
| 5 − 8 | 深度 | "depth",
"unfilterable-float"
| ✓ | ✗ | 4 | depth32float
|
| ステンシル | "uint"
| ✓ | 1 | stencil8
| |||
24ビット深度は、0.0から1.0の範囲を持つ24ビット符号なし正規化深度形式を指します。公開されていれば"depth24unorm"と表記されます。
26.1.2.1. 深度・ステンシルテクスチャの読み取りとサンプリング
深度アスペクトの GPUTextureView
を バインドすることは、
texture_depth_* バインディングにも、他の非深度2D/キューブテクスチャ型のバインディングにも可能である。
ステンシルアスペクトの GPUTextureView
は通常のテクスチャバインディングタイプにバインドしなければならない。
GPUBindGroupLayout
における sampleType
は "uint"
でなければならない。
"texture-component-swizzle"
機能が有効な場合、テクスチャのdepthまたはstencilアスペクトの読み出しやサンプリングは、テクスチャが (V, 0, 0, 1)
の値を持つかのように振る舞います(Vは実際のdepthまたはstencil値)。有効でない場合は値が (V, X, X, X) となり、各Xは実装依存の未定義値です。
実際の互換性問題を減らすため、実装は 可能な限り、(V, 0, 0, 1) を提供するべきです。たとえ "texture-component-swizzle"
機能が有効でなくてもです。
depthアスペクトのバインディングでは、未定義値は texture_depth_* タイプのバインディングからは見えません。
texture_2d<f32>型でtexにバインドしたとき:
-
textureSample(tex, ...)はvec4<f32>(D, X, X, X)を返します。 -
textureGather(0, tex, ...)はvec4<f32>(D1, D2, D3, D4)を返します。 -
textureGather(2, tex, ...)はvec4<f32>(X1, X2, X3, X4)(完全に未定義値)を返します。
注:
depthと同様のより制約されたstencilサンプラー型を追加しない限り、実装がdepth/stencil読みに関するドライバ差異を効率よく吸収するのは困難です。
これはWebGLで移植性の問題にはならなかったため、WebGPUでも問題にならないと考えられます。
実際には、ハードウェアによっては(V, V, V, V)または(V, 0, 0, 1)(Vはdepthまたはstencil値)が返されます。
26.1.2.2. 深度・ステンシルテクスチャのコピー
depth32float形式("depth32float"と"depth32float-stencil8")の深度アスペクトは範囲が限定されています。
そのため、この形式へのコピーは同じ形式の他のテクスチャからのみ有効です。
depth24plus形式("depth24plus"と"depth24plus-stencil8")の深度アスペクトは不透明な表現(24ビット深度または"depth32float"として実装)を持ちます。
そのため、depthアスペクトのテクセルコピーはこれらの形式では許可されません。
-
これらの形式全ては、
frag_depth出力を使ってフラグメントシェーダーから深度値を書き込むことでレンダーパスで書き込み可能です。 -
"depth24plus"形式のテクスチャはシェーダーテクスチャとして読み取り可能で、テクスチャ(レンダーパスのアタッチメントとして)やバッファ(コンピュートシェーダーのストレージバッファバインディング経由)への書き込みが可能です。
26.1.3. パック形式
すべてのパックテクスチャ形式はCOPY_SRC、
COPY_DST、
TEXTURE_BINDING
用途をサポートします。
これらの形式はすべてフィルタ可能です。
どの形式もレンダー可能でもなく、マルチサンプリングにも対応しません。
圧縮形式は、ブロックサイズが1×1を超える任意の形式を指します。
注: これらの形式それぞれのテクセルブロックのメモリコストは、 テクセルブロックのコピーのフットプリントと同じです。