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)順序について、以下を除き保証しません:
-
ある
GPUQueue
qに対し、 p1 = q.onSubmittedWorkDone()
を先に呼び、 p2 = q.onSubmittedWorkDone()
を後で呼んだ場合、p1はp2より先に解決されなければなりません。 -
ある
GPUQueue
qと同じGPUDevice
上のGPUBuffer
bに対し、 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スクリプトの実行に関連付けられます。 本仕様で記載されているすべてのメソッド呼び出しを含みます。
ある
GPUDevice
device
の操作でコンテンツタイムラインへ手順を発行するには、 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セッションとの互換性を持つようにリクエストされたことを示します。
アダプターには次のデバイスタイムラインプロパティがあります:
[[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 に加える。
-
-
追加で
"core-features-and-limits"
を features に加える。 -
limitsを、すべての値がデフォルト値に設定されたsupported limitsオブジェクトとする。
-
descriptor.
requiredLimits
の各(key, value)ペアについて:-
valueが
undefined
でなく、かつlimits[key]より良い場合:-
limits[key]にvalueを設定。
-
-
-
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が有効(enabled
for)であるとは、
GPUObjectBase
objectにおいて、
object.[[device]]
.[[features]]
がfeatureを含む場合のみです。
各機能が有効にする機能内容の説明は機能一覧を参照してください。
注: サポートされている場合でも、機能を有効にすることが必ずしも望ましいとは限りません。有効化によってパフォーマンスへの影響が生じる可能性があるためです。 このため、またデバイスや実装間の移植性を高めるためにも、アプリケーションは実際に必要となる可能性のある機能のみをリクエストするべきです。
3.6.2. 制限
制限は、デバイス上でWebGPUを利用する際の数値的な制約です。
注: サポートされている場合でも、「より良い」リミットを設定することが必ずしも望ましいとは限りません。設定によってパフォーマンスに影響が出る可能性があるためです。 このため、またデバイスや実装間の移植性を高めるためにも、アプリケーションは実際に必要となる場合のみ、デフォルトより良いリミットをリクエストするべきです。
各制限にはデフォルト値があります。
アダプターは常にデフォルトまたはより良い制限値をサポートすることが保証されています(§ 4.2.1 アダプター機能保証参照)。
デバイスは生成時に決定された制限値のみをサポートします(§ 3.6 オプション機能参照)。 API呼び出しは、これらの制限値(アダプターの制限値ではなく)に従って検証されます。より良い/悪い値は利用できません。
任意の制限値について、ある値は他の値よりも優れている場合があります。 優れている制限値は常に検証を緩和し、より多くのプログラムが有効となります。各制限クラスごとに「優れている」の定義があります。
制限値ごとに異なる制限クラスがあります:
- 最大値
-
制限はAPIへ渡される値の最大値を強制します。
高い値ほどより良い値です。
- アライメント
-
制限はAPIへ渡される値の最小アライメント(値は制限値の倍数でなければならない)を強制します。
低い値ほどより良い値です。
設定できるのはデフォルト値以下かつ2の累乗(≤ デフォルト値)のみです。 2の累乗でない値は無効です。 より高い2の累乗値はデフォルト値に丸められます。
supported limitsオブジェクトは、WebGPUで定義されるすべての制限値を保持します:
制限名 | 型 | 制限クラス | デフォルト値 |
---|---|---|---|
maxTextureDimension1D
| GPUSize32
| 最大値 | 8192 |
size .width
に指定できる最大値(テクスチャでdimension
"1d" 指定時)。
| |||
maxTextureDimension2D
| GPUSize32
| 最大値 | 8192 |
size .widthおよび
size .height
に指定できる最大値(テクスチャで
dimension
"2d" 指定時)。
| |||
maxTextureDimension3D
| GPUSize32
| 最大値 | 2048 |
size .width、
size .height
およびsize .depthOrArrayLayers
に指定できる最大値(テクスチャで
dimension
"3d" 指定時)。
| |||
maxTextureArrayLayers
| GPUSize32
| 最大値 | 256 |
size .depthOrArrayLayers
に指定できる最大値(テクスチャで
dimension
"2d" 指定時)。
| |||
maxBindGroups
| GPUSize32
| 最大値 | 4 |
GPUBindGroupLayouts
をbindGroupLayouts
に指定できる最大数(GPUPipelineLayout 作成時)。
| |||
maxBindGroupsPlusVertexBuffers
| GPUSize32
| 最大値 | 24 |
バインドグループと頂点バッファスロットの同時利用最大数(空スロットも含む、最大インデックス以下のすべて)。createRenderPipeline() やdraw呼び出しで検証される。
| |||
maxBindingsPerBindGroup
| GPUSize32
| 最大値 | 1000 |
GPUBindGroupLayout 作成時に利用できるバインディングインデックス数。
注意: この制限は規定ですが任意です。
デフォルトのバインディングスロット制限では、1つのバインドグループで1000個のバインディングは実際には利用不可能ですが、
| |||
maxDynamicUniformBuffersPerPipelineLayout
| GPUSize32
| 最大値 | 8 |
GPUBindGroupLayoutEntry
のうち、動的オフセット付きユニフォームバッファがGPUPipelineLayout 全体で利用できる最大数。
バインディングスロット制限を超える場合を参照。
| |||
maxDynamicStorageBuffersPerPipelineLayout
| GPUSize32
| 最大値 | 4 |
GPUBindGroupLayoutEntry
のうち、動的オフセット付きストレージバッファがGPUPipelineLayout 全体で利用できる最大数。
バインディングスロット制限を超える場合を参照。
| |||
maxSampledTexturesPerShaderStage
| GPUSize32
| 最大値 | 16 |
各GPUShaderStage
stage ごとに、
GPUBindGroupLayoutEntry
のうちサンプリングテクスチャがGPUPipelineLayout 全体で利用できる最大数。
バインディングスロット制限を超える場合を参照。
| |||
maxSamplersPerShaderStage
| GPUSize32
| 最大値 | 16 |
各GPUShaderStage
stage ごとに、
GPUBindGroupLayoutEntry
のうちサンプラーがGPUPipelineLayout 全体で利用できる最大数。
バインディングスロット制限を超える場合を参照。
| |||
maxStorageBuffersPerShaderStage
| GPUSize32
| 最大値 | 8 |
各GPUShaderStage
stage ごとに、
GPUBindGroupLayoutEntry
のうちストレージバッファがGPUPipelineLayout 全体で利用できる最大数。
バインディングスロット制限を超える場合を参照。
| |||
maxStorageTexturesPerShaderStage
| GPUSize32
| 最大値 | 4 |
各GPUShaderStage
stage ごとに、
GPUBindGroupLayoutEntry
のうちストレージテクスチャがGPUPipelineLayout 全体で利用できる最大数。
バインディングスロット制限を超える場合を参照。
| |||
maxUniformBuffersPerShaderStage
| GPUSize32
| 最大値 | 12 |
各GPUShaderStage
stage ごとに、
GPUBindGroupLayoutEntry
のうちユニフォームバッファがGPUPipelineLayout 全体で利用できる最大数。
バインディングスロット制限を超える場合を参照。
| |||
maxUniformBufferBindingSize
| GPUSize64
| 最大値 | 65536 バイト |
GPUBufferBinding .size
の最大値(
GPUBindGroupLayoutEntry
entry の
entry.buffer ?.type
が "uniform"
の場合)。
| |||
maxStorageBufferBindingSize
| GPUSize64
| 最大値 | 134217728 バイト (128 MiB) |
GPUBufferBinding .size
の最大値(
GPUBindGroupLayoutEntry
entry の
entry.buffer ?.type
が "storage"
または "read-only-storage"
の場合)。
| |||
minUniformBufferOffsetAlignment
| GPUSize32
| アライメント | 256 バイト |
GPUBufferBinding .offset
および setBindGroup()で指定する動的オフセットのアライメント(
GPUBindGroupLayoutEntry
entry の
entry.buffer ?.type
が "uniform"
の場合)。
| |||
minStorageBufferOffsetAlignment
| GPUSize32
| アライメント | 256 バイト |
GPUBufferBinding .offset
および setBindGroup()で指定する動的オフセットのアライメント(
GPUBindGroupLayoutEntry
entry の
entry.buffer ?.type
が "storage"
または "read-only-storage"
の場合)。
| |||
maxVertexBuffers
| GPUSize32
| 最大値 | 8 |
buffers
の最大数(GPURenderPipeline 作成時)。
| |||
maxBufferSize
| GPUSize64
| 最大値 | 268435456 バイト (256 MiB) |
size
の最大値(GPUBuffer 作成時)。
| |||
maxVertexAttributes
| GPUSize32
| 最大値 | 16 |
attributes
の合計最大数(buffers を含む、GPURenderPipeline 作成時)。
| |||
maxVertexBufferArrayStride
| GPUSize32
| 最大値 | 2048 バイト |
arrayStride
の最大値(GPURenderPipeline 作成時)。
| |||
maxInterStageShaderVariables
| GPUSize32
| 最大値 | 16 |
ステージ間通信(頂点出力やフラグメント入力など)の入出力変数の最大数。 | |||
maxColorAttachments
| GPUSize32
| 最大値 | 8 |
GPURenderPipelineDescriptor .fragment .targets 、
GPURenderPassDescriptor .colorAttachments 、
GPURenderPassLayout .colorFormats
で指定できるカラーアタッチメント最大数。
| |||
maxColorAttachmentBytesPerSample
| GPUSize32
| 最大値 | 32 |
すべてのカラーアタッチメントに対し、レンダーパイプライン出力データの1サンプル(ピクセルまたはサブピクセル)保持に必要な最大バイト数。 | |||
maxComputeWorkgroupStorageSize
| GPUSize32
| 最大値 | 16384 バイト |
計算ステージのworkgroupストレージで利用できる最大バイト数(シェーダーエントリポイントごと)。 | |||
maxComputeInvocationsPerWorkgroup
| GPUSize32
| 最大値 | 256 |
計算ステージのworkgroup_size 各次元の積の最大値(シェーダーエントリポイントごと)。
| |||
maxComputeWorkgroupSizeX
| GPUSize32
| 最大値 | 256 |
計算ステージのworkgroup_size のX次元最大値(シェーダーエントリポイントごと)。
| |||
maxComputeWorkgroupSizeY
| GPUSize32
| 最大値 | 256 |
計算ステージのworkgroup_size のY次元最大値(シェーダーエントリポイントごと)。
| |||
maxComputeWorkgroupSizeZ
| GPUSize32
| 最大値 | 64 |
計算ステージの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 ;
maxStorageTexturesPerShaderStage 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は、
アダプターまたはデバイスがサポートする機能の
GPUFeatureName
値です。GPUFeatureName
enumのいずれかの文字列しか含めてはなりません。
[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)
-
ユーザーエージェントにアダプターを要求します。 ユーザーエージェントはアダプターを返すかどうか選択し、返す場合は指定オプションに従って決定します。
呼び出し元:GPU
this.引数:
GPU.requestAdapter(options)メソッドの引数 パラメータ 型 Nullable Optional 説明 options
GPURequestAdapterOptions
✘ ✔ アダプター選択基準。 戻り値:
Promise
<GPUAdapter
?>コンテンツタイムライン手順:
-
contentTimelineを現在のコンテンツタイムラインとする。
-
promiseを新しいPromiseとする。
-
initialization stepsをthisのデバイスタイムラインで発行する。
-
promiseを返す。
デバイスタイムライン initialization steps:-
次の手順の要求はすべて満たされなければなりません。
-
options.
featureLevel
は 機能レベル文字列でなければなりません。
満たされ、かつユーザーエージェントがアダプター返却を選択した場合:
-
adapterにアダプターを、§ 4.2.2 アダプター選択ルールとoptionsの基準に従い、 § 4.2.1 アダプター機能保証に従って選択・初期化する:
-
adapter.
[[limits]]
と adapter.[[features]]
をアダプターのサポート機能に応じて設定する。 adapter.[[features]]
には"core-features-and-limits"
が含まれていなければならない。 -
adapterがフォールバックアダプター基準を満たす場合は adapter.
[[fallback]]
をtrue
に、それ以外はfalse
にする。 -
adapter.
[[xrCompatible]]
に options.xrCompatible
を設定する。
-
それ以外の場合:
-
adapterを
null
にする。
-
-
以降の手順をcontentTimelineで発行する。
コンテンツタイムライン手順:-
もし adapter が
null
でなければ:-
解決する promise を、新しい
GPUAdapter
で adapter をカプセル化して解決する。
それ以外の場合:
-
解決する promise を
null
で解決する。
-
-
getPreferredCanvasFormat()
-
8bit深度・標準ダイナミックレンジコンテンツ表示に最適な
GPUTextureFormat
を返します。 返す値は"rgba8unorm"
または"bgra8unorm"
のみです。返された値は
format
としてconfigure()
をGPUCanvasContext
で呼ぶ際に渡すことで、関連するキャンバスの効率的な表示が保証されます。注意: 画面表示されないキャンバスでは、このフォーマット利用が有利とは限りません。
呼び出し元:GPU
this.戻り値:
GPUTextureFormat
コンテンツタイムライン手順:
-
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"
-
アダプター要求の「機能レベル」。
許可される機能レベル文字列値は:
- "core"
-
効果なし。
- "compatibility"
-
効果なし。
注意: この値は将来的に追加検証制約へのオプトイン用途で予約されています。現時点では使用しないでください。
powerPreference
, 型 GPUPowerPreference-
システムの利用可能アダプターからどの種類のアダプターを選択するかのヒントを任意で指定します。
このヒント値は選択されるアダプターに影響する場合がありますが、アダプター返却有無には影響しません。
注意: このヒントの主な用途は、マルチGPU環境で使用するGPUを選択することです。 例えば一部ノートPCは低消費電力統合GPUと高性能離散GPUを持ちます。このヒントは選択GPUの電源設定にも影響する場合があります。
注意: バッテリー状態や外部ディスプレイ・着脱式GPUなどのハード構成により、同じpowerPreferenceでも異なるアダプターが選択される場合があります。 一般的には同一ハード構成・状態と
powerPreference
なら同じアダプターが選ばれる傾向です。以下のいずれかの値:
undefined
(未指定時)-
ユーザーエージェントへのヒントなし。
"low-power"
-
パフォーマンスより消費電力節約を優先する要求。
注意: 通常、描画性能制約がない場合(例:1fpsのみ描画、簡単なジオメトリやシェーダーのみ、HTMLキャンバス小サイズなど)はこれを使うべきです。 許容されるなら本値利用を推奨します。携帯機器のバッテリ寿命向上に大きく寄与します。
"high-performance"
-
消費電力よりパフォーマンスを優先する要求。
注意: この値を選択すると、デバイス生成時、ユーザーエージェントが電力節約のため低消費電力アダプターに切替え、デバイスロスを強制しやすくなります。 本当に必要な場合以外は指定を控えましょう。携帯機器のバッテリ寿命が大幅に低下する場合があります。
forceFallbackAdapter
, 型 boolean, デフォルトfalse
-
true
指定時、フォールバックアダプターのみ返却可能。ユーザーエージェントがrequestAdapter()
で フォールバックアダプター未対応ならnull
で解決。注意:
requestAdapter()
はforceFallbackAdapter
がfalse
でも他に適切なアダプターがなかった場合やユーザーエージェント判断で フォールバックアダプターを返す場合があります。 フォールバックアダプターでの動作を防ぎたい場合、info
.isFallbackAdapter
属性を確認してからGPUDevice
を要求してください。 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"
状態になります。呼び出し元:GPUAdapter
this.引数:
GPUAdapter.requestDevice(descriptor)メソッドの引数 パラメータ 型 Nullable Optional 説明 descriptor
GPUDeviceDescriptor
✘ ✔ 要求する GPUDevice
の詳細。コンテンツタイムライン手順:
-
contentTimelineを現在のコンテンツタイムラインとする。
-
promiseを新しいPromiseとする。
-
adapterをthis.
[[adapter]]
とする。 -
initialization stepsをthisのデバイスタイムラインで発行する。
-
promiseを返す。
デバイスタイムライン initialization steps:-
次のいずれかの要件を満たしていない場合:
-
descriptor.
requiredFeatures
の値セットはadapter.[[features]]
の部分集合でなければならない。
満たさない場合、以降の手順をcontentTimelineで実行し終了:
コンテンツタイムライン手順:注意: このエラーは、ブラウザが機能名を全く認識しない(
GPUFeatureName
定義にない)場合と同じです。 ブラウザが機能をサポートしない場合と、特定アダプターが機能をサポートしない場合の動作が収束します。 -
-
次のすべての要件を満たさなければなりません:
-
adapter.
[[state]]
は"consumed"
であってはならない。 -
descriptor.
requiredLimits
の各[key, value](valueがundefined
でないもの)について:-
keyはsupported limitsメンバー名でなければならない。
-
valueはadapter.
[[limits]]
[key]より良い値であってはならない。
注意: keyが未認識の場合、valueが
undefined
でも開発者向け警告表示を検討すべきです。 -
満たさない場合、以降の手順をcontentTimelineで実行し終了:
コンテンツタイムライン手順:-
rejectでpromiseを
OperationError
で解決。
-
-
adapter.
[[state]]
が"expired"
またはユーザーエージェントが要求を満たせない場合:-
deviceを新しい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
の値は常に一定です。毎回同じオブジェクトが返されます。初回生成方法:
呼び出し元:GPUDevice
this.戻り値:
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
を作成します。呼び出し元:GPUDevice
this.引数:
GPUDevice.createBuffer(descriptor)メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUBufferDescriptor
✘ ✘ 作成する 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
を破棄します。注意: バッファは何度破棄しても有効です。
呼び出し元:GPUBuffer
this.戻り値:
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()
が完了していることを意味します。呼び出し元:GPUBuffer
this.引数:
GPUBuffer.mapAsync(mode, offset, size)メソッドの引数。 パラメータ 型 Nullable Optional 説明 mode
GPUMapModeFlags
✘ ✘ バッファを読み取り/書き込みどちらでマップするか。 offset
GPUSize64
✘ ✔ マップ範囲の開始バイトオフセット。 size
GPUSize64
✘ ✔ マップする範囲のバイト数。 コンテンツタイムライン手順:
-
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
のものです。呼び出し元:GPUBuffer
this.引数:
GPUBuffer.getMappedRange(offset, size)メソッドの引数。 パラメータ 型 Nullable Optional 説明 offset
GPUSize64
✘ ✔ バッファ内容取得開始のバイトオフセット。 size
GPUSize64
✘ ✔ 返す 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で再び利用可能にします。
呼び出し元:GPUBuffer
this.戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[pending_map]]
がnull
でない場合:-
this.
[[pending_map]]
をAbortError
で拒否する。 -
this.
[[pending_map]]
をnull
に設定
-
-
this.
[[mapping]]
がnull
の場合:-
Return。
-
-
各
ArrayBuffer
abについて、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 ; };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
の集合。
GPUTexture
には以下のデバイスタイムラインプロパティがあります:
[[destroyed]]
, 型boolean
, 初期値false
-
テクスチャが破棄された場合、いかなる操作にも利用できなくなり、基盤となるメモリも解放可能となります。
引数:
-
GPUExtent3D
baseSize -
GPUSize32
mipLevel
戻り値: GPUExtent3DDict
デバイスタイムライン手順:
-
extentを新しい
GPUExtent3DDict
オブジェクトとする。 -
extent.
depthOrArrayLayers
に1を設定。 -
extentを返す。
論理ミップレベル別テクスチャ範囲とは、特定のミップレベルにおけるテクスチャのテクセル単位のサイズです。次の手順で算出されます:
引数:
-
GPUTextureDescriptor
descriptor -
GPUSize32
mipLevel
戻り値: 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を返す。
物理ミップレベル別テクスチャ範囲とは、特定のミップレベルにおけるテクスチャのテクセル単位のサイズ(テクセルブロックを完全に構成するための余分なパディングを含む)です。次の手順で算出されます:
引数:
-
GPUTextureDescriptor
descriptor -
GPUSize32
mipLevel
戻り値: 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 = []; };
GPUTextureDescriptor
には以下のメンバーがあります:
size
, 型 GPUExtent3D-
テクスチャの幅・高さ・深度またはレイヤー数。
mipLevelCount
, 型 GPUIntegerCoordinate(デフォルト値1
)-
このテクスチャが持つミップレベルの数。
sampleCount
, 型 GPUSize32(デフォルト値1
)-
テクスチャのサンプル数。
sampleCount
>1
の場合はマルチサンプルテクスチャ。 dimension
, 型 GPUTextureDimension(デフォルト値"2d"
)-
テクスチャが一次元か、二次元レイヤー配列か、三次元か。
format
, 型 GPUTextureFormat-
テクスチャのフォーマット。
usage
, 型 GPUTextureUsageFlags-
テクスチャの許可用途。
viewFormats
, 型 sequence<GPUTextureFormat>(デフォルト値[]
)-
このテクスチャで
format
としてcreateView()
を呼び出す際に許可される値(実際のformat
を含む)。注:このリストにフォーマットを追加するとパフォーマンスに大きな影響が出る可能性があるため、不要な追加は避けてください。実際の影響はシステム依存ですので、アプリケーションごとに様々なシステムで検証が必要です。 例えば、あるシステムでは
format
やviewFormats
に"rgba8unorm-srgb"
を入れると、"rgba8unorm"
のテクスチャより最適でなくなる場合があります。他フォーマットや組み合わせでも同様の注意点があります。このリストのフォーマットは、テクスチャのフォーマットとテクスチャビュー・フォーマット互換でなければなりません。
2つのGPUTextureFormat
formatとviewFormatは、以下の場合テクスチャビュー・フォーマット互換です:-
formatとviewFormatが等しい場合
-
formatとviewFormatが
srgb
(-srgb
サフィックス)だけが異なる場合
-
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
)。
引数:
-
GPUTextureDimension
dimension -
GPUTextureDimension
size
6.1.3. テクスチャの作成
createTexture(descriptor)
-
GPUTexture
を作成します。呼び出し元:GPUDevice
this.引数:
GPUDevice.createTexture(descriptor)メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUTextureDescriptor
✘ ✘ 作成する GPUTexture
の説明。戻り値:
GPUTexture
コンテンツタイムライン手順:
-
? GPUExtent3D形状の検証(descriptor.
size
)。 -
? テクスチャフォーマット必要機能の検証( descriptor.
format
、this.[[device]]
)。 -
? 各viewFormats要素のテクスチャフォーマット必要機能の検証( descriptor.
viewFormats
、 this.[[device]]
)。 -
tを! 新しいWebGPUオブジェクトの生成(this,
GPUTexture
, descriptor)とする。 -
t.
depthOrArrayLayers
にdescriptor.size
.depthOrArrayLayersを設定。 -
t.
mipLevelCount
にdescriptor.mipLevelCount
を設定。 -
t.
sampleCount
にdescriptor.sampleCount
を設定。 -
thisのデバイスタイムラインでinitialization stepsを発行。
-
tを返す。
デバイスタイムライン initialization steps:-
以下の条件が満たされない場合検証エラーの生成、tの無効化、return。
-
GPUTextureDescriptorの検証(this, descriptor) が
true
を返す。
-
-
t.
[[viewFormats]]
にdescriptor.viewFormats
を設定。 -
各ブロックがゼロのビット表現と等価な等価テクセル表現になるよう、tのデバイス割り当てを作成。
割り当てが副作用なしに失敗した場合、 メモリ不足エラー生成、tの無効化、return。
-
引数:
-
GPUDevice
this -
GPUTextureDescriptor
descriptor
デバイスタイムライン手順:
-
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テクスチャ対応。
-
-
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
が 最大ミップレベル数(descriptor.dimension
, descriptor.size
)以下。 -
descriptor.
usage
にRENDER_ATTACHMENT
ビット含む場合:-
descriptor.
format
がレンダー可能フォーマット。
-
-
descriptor.
usage
にSTORAGE_BINDING
ビット含む場合:-
descriptor.
format
が§ 26.1.1 プレーンカラーフォーマット表でSTORAGE_BINDING
機能を持つアクセスモード少なくとも1つを持つこと。
-
-
各viewFormatについて、descriptor.
viewFormats
、 descriptor.format
とviewFormatが テクスチャビュー・フォーマット互換であること。注: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()
を"2d"
テクスチャ(レイヤー複数)に対して呼ぶと、"2d-array"
GPUTextureView
が作られます(たとえarrayLayerCount
が1でも)。レイヤー数が開発時に不明なソース由来テクスチャの場合は、
createView()
呼び出し時に明示的なdimension
を指定してシェーダ互換性を確保するのが推奨されます。呼び出し元:GPUTexture
this.引数:
GPUTexture.createView(descriptor)メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUTextureViewDescriptor
✘ ✔ 作成する GPUTextureView
の説明。戻り値: view(型
GPUTextureView
)現行標準タイムライン手順:
-
? テクスチャフォーマット必要機能の検証( descriptor.
format
、 this.[[device]]
)。 -
? スウィズル文字列の検証 を descriptor.
swizzle
に対して行う。 -
viewを! 新しいWebGPUオブジェクト生成(this,
GPUTextureView
, descriptor)とする。 -
thisのデバイスタイムラインでinitialization stepsを発行。
-
viewを返す。
デバイスタイムライン initialization steps:-
descriptorにGPUTextureViewDescriptor既定値の解決(this, descriptor)の結果を設定。
-
以下の条件が満たされない場合検証エラー生成、viewの無効化、return。
-
thisがthis.
[[device]]
で有効利用可能であること。 -
もしdescriptor.
aspect
が"all"
の場合:-
descriptor.
format
はthis.format
またはthis.[[viewFormats]]
のいずれかに等しいこと。
それ以外の場合:
-
descriptor.
format
がGPUTextureAspectの解決( this.format
、 descriptor.aspect
)に等しいこと。
-
-
もし descriptor.
swizzle
が"rgba"
でない場合、"texture-component-swizzle"
は 有効化されていなければならない this.[[device]]
に対して。 -
もしdescriptor.
usage
にRENDER_ATTACHMENT
ビットを含む場合:-
descriptor.
format
がレンダー可能フォーマットであること。
-
-
もしdescriptor.
usage
にSTORAGE_BINDING
ビットを含む場合:-
descriptor.
format
が§ 26.1.1 プレーンカラーフォーマット表でSTORAGE_BINDING
の機能を持つアクセスモード少なくとも1つに含まれること。
-
-
descriptor.
mipLevelCount
が0超であること。 -
descriptor.
baseMipLevel
+ descriptor.mipLevelCount
がthis.mipLevelCount
以下。 -
descriptor.
arrayLayerCount
が0超であること。 -
descriptor.
baseArrayLayer
+ descriptor.arrayLayerCount
が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 に対して行う場合、以下のデバイスタイムライン手順を実行する:
-
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(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 formats
GPUTextureFormat ,
"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 テクスチャフォーマットの機能参照。
引数:
-
GPUTextureFormat
format -
GPUTextureAspect
aspect
戻り値: 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
を作成します。呼び出し元:GPUDevice
this.引数:
GPUDevice.importExternalTexture(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUExternalTextureDescriptor
✘ ✘ 外部画像ソースオブジェクト(および作成オプション)を指定。 戻り値:
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
を作成します。呼び出し元:GPUDevice
this.引数:
GPUDevice.createSampler(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUSamplerDescriptor
✘ ✔ 作成する 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-
GPUBindGroupLayout
内でリソースバインディングを一意に識別するID。GPUBindGroupEntry.binding
およびGPUShaderModule
の@binding属性に対応。 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 memberは、
どのGPUBindGroupLayoutEntry
メンバーが定義されているかによって決まります:
buffer
、
sampler
、
texture
、
storageTexture
、
または
externalTexture
。
いずれか1つだけが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
»)について:-
stageを含むentry.
visibility
の各entryについて、以下の場合:- entry.
buffer
?.type
が"uniform"
の場合 -
maxUniformBuffersPerShaderStage
スロットを1個使用したとみなす。 - entry.
buffer
?.type
が"storage"
または"read-only-storage"
の場合 -
maxStorageBuffersPerShaderStage
スロットを1個使用したとみなす。 - entry.
sampler
が存在する場合 -
maxSamplersPerShaderStage
スロットを1個使用したとみなす。 - entry.
texture
が存在する場合 -
maxSampledTexturesPerShaderStage
スロットを1個使用したとみなす。 - entry.
storageTexture
が存在する場合 -
maxStorageTexturesPerShaderStage
スロットを1個使用したとみなす。 - entry.
externalTexture
が存在する場合 -
maxSampledTexturesPerShaderStage
スロット4個、maxSamplersPerShaderStage
スロット1個、maxUniformBuffersPerShaderStage
スロット1個 を使用したとみなす。注: この挙動の説明は
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
>、読み取り専用-
この
GPUBindGroupLayout
が記述する、バインディングインデックス→GPUBindGroupLayoutEntry
のマップ。 [[dynamicOffsetCount]]
, 型GPUSize32
、読み取り専用-
この
GPUBindGroupLayout
に動的オフセット付きバッファバインディング数。 [[exclusivePipeline]]
, 型GPUPipelineBase
?、読み取り専用-
この
GPUBindGroupLayout
を作成したパイプライン(デフォルトパイプラインレイアウトの一部として作成された場合)。null
でない場合、これを使って作成したGPUBindGroup
は指定GPUPipelineBase
でのみ使用可能。
createBindGroupLayout(descriptor)
-
GPUBindGroupLayout
を作成します。呼び出し元:GPUDevice
this.引数:
GPUDevice.createBindGroupLayout(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUBindGroupLayoutDescriptor
✘ ✘ 作成する GPUBindGroupLayout
の説明。戻り値:
GPUBindGroupLayout
現行標準タイムライン手順:
-
descriptor.
entries
内の各GPUBindGroupLayoutEntry
entryについて:-
entry.
storageTexture
が存在する場合:-
? テクスチャフォーマット必須機能の検証を entry.
storageTexture
.format
とthis.[[device]]
で行う。
-
-
-
layoutを! 新しいWebGPUオブジェクトの生成(this,
GPUBindGroupLayout
, descriptor)とする。 -
thisのデバイスタイムラインでinitialization stepsを発行。
-
layoutを返す。
デバイスタイムライン initialization steps:-
以下の条件が満たされない場合検証エラー生成、layoutの無効化、return。
-
thisが失われていないこと。
-
limitsをthis.
[[device]]
.[[limits]]
とする。 -
descriptor内の各エントリの
binding
が一意。 -
descriptor内の各エントリの
binding
が limits.maxBindingsPerBindGroup
未満。 -
descriptor.
entries
がバインディングスロット制限超過でない。 -
descriptor.
entries
内の各GPUBindGroupLayoutEntry
entryについて:-
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
は、entry.storageTexture
.access
に対し§ 26.1.1 プレーンカラー形式表に従いストレージ用途対応のフォーマットであること。
-
-
-
-
layout.
[[descriptor]]
にdescriptorを設定。 -
layout.
[[dynamicOffsetCount]]
に、descriptor内でbuffer
が存在するかつbuffer
.hasDynamicOffset
がtrue
なエントリ数を設定。 -
layout.
[[exclusivePipeline]]
にnull
を設定。 -
descriptor.
entries
内の各GPUBindGroupLayoutEntry
entryについて:-
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]]
内の各GPUBindGroupEntry
bindGroupEntry(bindGroupEntry.binding
でソート済み)について:-
bindGroupLayoutEntryを bindGroup.
[[layout]]
.[[entryMap]]
[bindGroupEntry.binding
]とする。 -
boundをget as buffer binding(bindGroupEntry.
resource
)とする。 -
bindGroupLayoutEntry.
buffer
.hasDynamicOffset
の場合:-
bound.
offset
に dynamicOffsets[dynamicOffsetIndex]を加算。 -
dynamicOffsetIndexを1増やす。
-
-
追加 (bindGroupLayoutEntry, bound) を result に。
-
-
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
を作成します。呼び出し元:GPUDevice
this.引数:
GPUDevice.createBindGroup(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUBindGroupDescriptor
✘ ✘ 作成する GPUBindGroup
の説明。戻り値:
GPUBindGroup
現行標準タイムライン手順:
-
bindGroupを! 新しいWebGPUオブジェクトの生成(this,
GPUBindGroup
, descriptor)とする。 -
thisのデバイスタイムラインでinitialization stepsを発行。
-
bindGroupを返す。
デバイスタイムライン initialization steps:-
limitsをthis.
[[device]]
.[[limits]]
とする。 -
以下の条件が満たされない場合検証エラー生成、bindGroupの無効化、return。
descriptor.
entries
内の各GPUBindGroupEntry
bindingDescriptorについて:-
resourceをbindingDescriptor.
resource
とする。 -
descriptor.
layout
.entries
内に bindingDescriptor.binding
と等しいGPUBindGroupLayoutEntry
layoutBindingが正確に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がthisで有効利用可能であること。
-
textureViewをget as texture view(resource)とする。
-
textureをtextureView.
[[texture]]
とする。 -
layoutBinding.
texture
.viewDimension
がtextureViewのdimension
と等しい。 -
layoutBinding.
texture
.sampleType
がtextureViewのformat
と互換。 -
textureView.
[[descriptor]]
.usage
がTEXTURE_BINDING
を含む。 -
layoutBinding.
texture
.multisampled
がtrue
ならtextureのsampleCount
>1
、そうでなければ1
。
-
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であること。
-
-
-
-
bindGroup.
[[layout]]
= descriptor.layout
。 -
bindGroup.
[[entries]]
= descriptor.entries
。 -
bindGroup.
[[usedResources]]
= {}。 -
descriptor.
entries
内の各GPUBindGroupEntry
bindingDescriptorについて:-
internalUsageをlayoutBindingのバインディング用途とする。
-
resourceが参照する各サブリソースを
[[usedResources]]
にinternalUsageとして追加。 -
定義されたbinding memberが
buffer
かつ layoutBinding.buffer
.minBindingSize
が0
なら bindingDescriptor.[[prevalidatedSize]]
をfalse
、それ以外ならtrue
とする。
-
-
引数:
-
GPUBindingResource
resource
戻り値: GPUTextureView
-
Assert resourceが
GPUTexture
またはGPUTextureView
である。 -
もしresourceが:
GPUTexture
-
-
resource.
createView()
を返す。
-
GPUTextureView
-
-
resourceを返す。
-
引数:
-
GPUBindingResource
resource
戻り値: GPUBufferBinding
-
Assert resourceが
GPUBuffer
またはGPUBufferBinding
である。 -
もしresourceが:
GPUBuffer
-
-
bufferBindingを新しい
GPUBufferBinding
として用意。 -
bufferBinding.
buffer
をresourceに設定。 -
bufferBindingを返す。
-
GPUBufferBinding
-
-
resourceを返す。
-
GPUBufferBinding
オブジェクトaとbは、以下すべての条件を満たした場合のみバッファバインディングのエイリアスとみなされます。
注: この計算を行う際、動的オフセットはすでに範囲に適用されています。
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
を作成します。呼び出し元:GPUDevice
this.引数:
GPUDevice.createPipelineLayout(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUPipelineLayoutDescriptor
✘ ✘ 作成する GPUPipelineLayout
の説明。戻り値:
GPUPipelineLayout
現行標準タイムライン手順:
-
plを! 新しいWebGPUオブジェクトの生成(this,
GPUPipelineLayout
, descriptor)とする。 -
thisのデバイスタイムラインでinitialization stepsを発行。
-
plを返す。
デバイスタイムライン initialization steps:-
limitsをthis.
[[device]]
.[[limits]]
とする。 -
bindGroupLayoutsを
null
のGPUBindGroupLayout
で構成されたlistとして用意し、サイズはlimits.maxBindGroups
とする。 -
各bindGroupLayout(インデックスi)についてdescriptor.
bindGroupLayouts
内で:-
bindGroupLayoutが
null
でなく、かつbindGroupLayout.[[descriptor]]
.entries
が空でない場合:-
bindGroupLayouts[i]にbindGroupLayoutを設定。
-
-
-
非
null
なbglについて、bgl.[[descriptor]]
.entries
を連結した結果をallEntriesとする。 -
以下の条件が満たされない場合検証エラー生成、plの無効化、return。
-
bindGroupLayouts内の非
null
なGPUBindGroupLayout
はすべて、thisで有効利用可能であり、かつ[[exclusivePipeline]]
がnull
であること。 -
descriptor.
bindGroupLayouts
のサイズはlimits.maxBindGroups
以下であること。 -
allEntriesがlimitsのバインディングスロット制限超過でないこと。
-
-
pl.
[[bindGroupLayouts]]
にbindGroupLayoutsを設定。
-
注: 2つのGPUPipelineLayout
オブジェクトは、内部の[[bindGroupLayouts]]
シーケンスが
GPUBindGroupLayout
でグループ同等であれば、いかなる用途でも等価とみなされます。
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
を生成します。呼び出し元:GPUDevice
this。引数:
GPUDevice.createShaderModule(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUShaderModuleDescriptor
✘ ✘ 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
で順序付けされるとは限りません。呼び出し元:GPUShaderModule
this戻り値:
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 説明 message
DOMString
✘ ✔ 基底 DOMException
のエラーメッセージoptions
GPUPipelineErrorInit
✘ ✘ 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
で取得します。呼び出し元:GPUPipelineBase
this引数:
GPUPipelineBase.getBindGroupLayout(index) メソッドの引数。 パラメータ 型 Nullable Optional 説明 index
unsigned 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インターフェースで返すのと同じです。 毎回新しいGPUBindGroupLayout
WebGPUインターフェースが返されるので、 コンテンツタイムラインとデバイスタイムライン間の往復を避けることができます。
-
10.1.1. デフォルトパイプラインレイアウト
GPUPipelineBase
オブジェクトが layout
に
"auto"
を設定して作成された場合、デフォルトレイアウトが生成されて使用されます。
注: デフォルトレイアウトは簡単なパイプライン向けの便宜で提供されていますが、ほとんどの場合は明示的なレイアウトの利用が推奨されます。デフォルトレイアウトで作成したバインドグループは他のパイプラインと共有できず、シェーダーを変更するとデフォルトレイアウトの構造も変化し、予期しないバインドグループ生成エラーが発生することがあります。
デフォルトパイプラインレイアウトを GPUPipelineBase
pipeline に対して生成するには、
以下のデバイスタイムライン手順を実行する:
-
groupCount を 0 にする。
-
groupDescs を device.
[[limits]]
.maxBindGroups
個の新しいGPUBindGroupLayoutDescriptor
オブジェクトの配列とする。 -
groupDescs の各 groupDesc について:
-
pipeline を生成したディスクリプタ内の各
GPUProgrammableStage
stageDesc について:-
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
を返す。
-
引数:
-
GPUShaderStage
stage -
GPUProgrammableStage
descriptor -
GPUPipelineLayout
layout -
GPUDevice
device
以下の手順のすべての要件が満たされていなければならない。
どれかが満たされない場合はfalse
を返し、すべて満たされていればtrue
を返す。
-
entryPoint を get the entry point(stage, descriptor) とする。
-
entryPoint は
null
であってはならない。 -
entryPoint が静的に使用する各bindingについて:
-
validating shader binding(binding, layout)が
true
を返さなければならない。
-
-
entryPointをルートとするシェーダーステージ内の関数における各テクスチャ組み込み関数呼び出しについて、 それが sampled texture型またはdepth texture型のtextureBindingと
sampler
型(sampler_comparison
を除く)のsamplerBindingを使う場合:-
texture を textureBindingに対応する
GPUBindGroupLayoutEntry
とする。 -
sampler を samplerBindingに対応する
GPUBindGroupLayoutEntry
とする。 -
もし sampler.
type
が"filtering"
なら、 texture.sampleType
は"float"
でなければならない。
注:
"comparison"
サンプラーは"depth"
テクスチャにのみ使用可能です。これはWGSLのtexture_depth_*
バインディングにバインドできる唯一のテクスチャ型です。 -
-
descriptor.
constants
内の各key → valueについて:-
keyはパイプラインオーバーライド定数識別子文字列 と一致しなければならず、 その定数はシェーダーモジュールdescriptor.
module
内でパイプラインオーバーライド可能定数として定義されていなければならない。 比較はWGSL識別子比較の規則に従う。 この定数がentryPointに静的に使用されている必要はない。 型をTとする。
-
-
entryPointがパイプラインオーバーライド定数識別子文字列 keyを静的に使用している場合、
-
その定数がデフォルト値を持たない場合は、 descriptor.
constants
にkeyが含まれていなければならない。
-
引数:
-
シェーダーバインディング宣言 variable(シェーダーモジュールから反映されたモジュールスコープ変数宣言)
-
GPUPipelineLayout
layout
bindGroup をシェーダーバインディング宣言 variable のバインドグループインデックス、 bindIndex をバインディングインデックスとする。
以下すべての条件を満たせばtrue
を返す:
-
layout.
[[bindGroupLayouts]]
[bindGroup] がGPUBindGroupLayoutEntry
entry を含み、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
を作成します。呼び出し元:GPUDevice
this.引数:
GPUDevice.createComputePipeline(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUComputePipelineDescriptor
✘ ✘ 作成する 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されません。)注: このメソッドは、可能な限り利用するのが推奨されます。パイプラインのコンパイルによる キュータイムライン のブロックを防ぐためです。
呼び出し元:GPUDevice
this.引数:
GPUDevice.createComputePipelineAsync(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUComputePipelineDescriptor
✘ ✘ 作成する 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
を作成します。呼び出し元:GPUDevice
this.引数:
GPUDevice.createRenderPipeline(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPURenderPipelineDescriptor
✘ ✘ 作成する GPURenderPipeline
の説明。戻り値:
GPURenderPipeline
コンテンツタイムラインの手順:
-
descriptor.
fragment
が指定されている場合:-
各非
null
colorStateについて descriptor.fragment
.targets
:-
? テクスチャフォーマット必須機能の検証を colorState.
format
と this.[[device]]
で行う。
-
-
-
descriptor.
depthStencil
が指定されている場合:-
? テクスチャフォーマット必須機能の検証を descriptor.
depthStencil
.format
と this.[[device]]
で行う。
-
-
pipeline を ! 新しいWebGPUオブジェクトの作成(this,
GPURenderPipeline
, descriptor) とする。 -
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されません。)注: このメソッドは、可能な限り利用するのが推奨されます。パイプラインのコンパイルによる キュータイムライン のブロックを防ぐためです。
呼び出し元:GPUDevice
this.引数:
GPUDevice.createRenderPipelineAsync(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPURenderPipelineDescriptor
✘ ✘ 作成する 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 する。
-
-
引数:
-
GPURenderPipelineDescriptor
descriptor -
GPUPipelineLayout
layout -
GPUDevice
device
デバイスタイムラインの手順:
-
以下すべての条件を満たせば
true
を返す:-
GPUVertexStateの検証(device, descriptor.
vertex
, layout) が成功すること。 -
descriptor.
fragment
が指定されている場合:-
GPUFragmentStateの検証(device, descriptor.
fragment
, layout) が成功すること。 -
sample_mask 組み込み値が descriptor.
fragment
の シェーダーステージ出力である場合:-
descriptor.
multisample
.alphaToCoverageEnabled
がfalse
であること。
-
-
frag_depth 組み込み値が descriptor.
fragment
の シェーダーステージ出力である場合:-
descriptor.
depthStencil
が指定されていること、かつ descriptor.depthStencil
.format
がdepthアスペクトを持つこと。
-
-
-
GPUPrimitiveStateの検証(descriptor.
primitive
, device) が成功すること。 -
descriptor.
depthStencil
が指定されている場合:-
GPUDepthStencilStateの検証(descriptor.
depthStencil
, descriptor.primitive
.topology
) が成功すること。
-
-
GPUMultisampleStateの検証(descriptor.
multisample
) が成功すること。 -
descriptor.
multisample
.alphaToCoverageEnabled
が true の場合: -
少なくとも1つのアタッチメントが存在しなければならない。以下のいずれか:
-
descriptor.
depthStencil
-
ステージ間インターフェースの検証(device, descriptor) が
true
を返すこと。
-
引数:
-
GPUDevice
device -
GPURenderPipelineDescriptor
descriptor
戻り値: boolean
デバイスタイムラインの手順:
-
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
を返す: -
descriptor.
fragment
が指定されている場合:-
maxFragmentShaderInputVariables を device.limits.
maxInterStageShaderVariables
に設定する。 -
descriptor.
fragment
の入力となるインターステージ組み込み値それぞれについて:-
maxFragmentShaderInputVariables を 1 減算する。
-
-
次のいずれかの要件を満たさない場合は
false
を返す: -
descriptor.
fragment
の各ユーザー定義入力のlocationが、device.limits.maxInterStageShaderVariables
未満であることを確認する(これは上記のルールから導かれる)。
-
-
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"
機能が有効化されている必要があります。
-
GPUPrimitiveState
descriptor -
GPUDevice
device
デバイスタイムラインの手順:
-
以下すべての条件を満たせば
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
の場合、フラグメントのアルファチャンネルでサンプルカバレッジマスクを生成することを示します。
-
GPUMultisampleState
descriptor
デバイスタイムラインの手順:
-
以下すべての条件を満たせば
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
のリスト。
引数:
-
GPUDevice
device -
GPUFragmentState
descriptor -
GPUPipelineLayout
layout
デバイスタイムラインの手順:
-
以下の要件全てを満たす場合、
true
を返す:-
validating 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 について、indices のうち、descriptor.
targets
に非null
の値 colorState が含まれる場合:-
colorState.
format
は § 26.1.1 プレーンカラー形式 に記載されているRENDER_ATTACHMENT
の機能を持つ必要がある。 -
colorState.
writeMask
は 16 未満であること。 -
-
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 と等しい場合、 entryPoint 内で:
-
colorState.
format
の各成分について、 output に対応する成分がなければならない。 (つまり RGBA は vec4、RGB は vec3 または vec4、RG は vec2/vec3/vec4 が必要。) -
もし
GPUTextureSampleType
が colorState.format
用に (§ 26.1 テクスチャ形式の機能で定義):"float"
または"unfilterable-float"
-
output は浮動小数点スカラー型であること。
"sint"
-
output は符号付き整数スカラー型であること。
"uint"
-
output は符号なし整数スカラー型であること。
-
もし colorState.
blend
が 指定されていて colorState.blend
.color
.srcFactor
または .dstFactor
がソースアルファを使用する場合 ("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 を使用する必要がある。
-
Validating GPUFragmentState’s color attachment bytes per sample(device, descriptor.
targets
) が成功すること。
-
引数:
-
GPUDevice
device -
sequence<
GPUColorTargetState
?> targets
デバイスタイムラインの手順:
-
formats を空のlist<
GPUTextureFormat
?>とする。 -
targets の各 target について:
-
カラ―アタッチメントのバイト/サンプルの計算(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
を設定する。
-
引数:
-
GPUDepthStencilState
descriptor -
GPUPrimitiveTopology
topology
デバイスタイムラインの手順:
-
以下のすべての条件を満たした場合に限り、
true
を返す:-
descriptor.
format
がdepth-or-stencil フォーマットである。 -
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 でなければならない。
-
-
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" 属性 に対応します。
引数:
-
GPUDevice
device -
GPUVertexBufferLayout
descriptor
デバイスタイムラインの手順:
-
以下のすべての条件を満たした場合に限り、
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.
shaderLocation
が device.[[device]]
.[[limits]]
.maxVertexAttributes
未満である。
-
-
引数:
-
GPUDevice
device -
GPUVertexState
descriptor -
GPUPipelineLayout
layout
デバイスタイムラインの手順:
-
entryPoint を get the entry point(
VERTEX
, descriptor) とする。 -
Assert entryPoint が
null
でないこと。 -
以下の手順のすべての要件を満たさなければならない。
-
GPUProgrammableStageの検証(
VERTEX
, descriptor, layout, device) が成功すること。 -
descriptor.
buffers
.size が device.[[device]]
.[[limits]]
.maxVertexBuffers
以下であること。 -
リスト descriptor.
buffers
の各 vertexBuffer レイアウト記述子が GPUVertexBufferLayoutの検証(device, vertexBuffer) をパスすること。 -
すべての vertexBuffer.
attributes
.size の合計が descriptor.buffers
全体で device.[[device]]
.[[limits]]
.maxVertexAttributes
以下であること。 -
エントリポイント entryPoint で静的に使用される各バーテックス属性宣言 (location location、型 T) について、 descriptor.
buffers
[i]? .attributes
[j] .shaderLocation
== location となる組がちょうど1つ存在しなければならない。その
GPUVertexAttribute
を attrib とする。 -
T が attrib.
format
の バーテックスデータ型と互換性があること:- "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-
コピーされるテクセルデータを保持する、またはコピー後のテクセルデータが格納されるバッファ(メソッドにより異なる)。
引数:
-
GPUTexelCopyBufferInfo
imageCopyBuffer
戻り値: 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のdepth sliceまたはarray layerindexに対して、以下の手順で決定されます:
GPUTexelCopyBufferLayout
bufferLayoutで記述されるデータの、GPUTexture
textureのdepth sliceまたはarray layerzのテクセルブロック
x, yに対して以下の手順で決定されます:
-
blockBytes を texture.
format
のテクセルブロックコピーのフットプリントとする。 -
imageOffset を (z × bufferLayout.
rowsPerImage
× bufferLayout.bytesPerRow
) + bufferLayout.offset
とする。 -
rowOffset を (y × bufferLayout.
bytesPerRow
) + imageOffsetとする。 -
blockOffset を (x × blockBytes) + rowOffsetとする。
-
blockOffsetを返す。
引数:
-
GPUTexelCopyTextureInfo
texelCopyTextureInfo -
GPUExtent3D
copySize
戻り値: boolean
デバイスタイムラインの手順:
-
blockWidth を texelCopyTextureInfo.
texture
.format
のテクセルブロック幅とする。 -
blockHeight を texelCopyTextureInfo.
texture
.format
のテクセルブロック高さとする。 -
以下すべての条件を満たした場合に限り
true
を返す:-
テクスチャコピー範囲の検証(texelCopyTextureInfo, copySize) が
true
を返すこと。 -
texelCopyTextureInfo.
texture
が有効なGPUTexture
であること。 -
texelCopyTextureInfo.
mipLevel
が texelCopyTextureInfo.texture
.mipLevelCount
未満であること。 -
GPUTexelCopyTextureInfo物理サブリソースサイズがtexelCopyTextureInfoに対して copySizeと等しい場合、以下のいずれかの条件が真でなければならない:
-
texelCopyTextureInfo.
texture
.sampleCount
> 1 の場合。
-
引数:
-
GPUTexelCopyTextureInfo
texelCopyTextureInfo -
GPUTexelCopyBufferLayout
bufferLayout -
GPUSize64Out
dataLength -
GPUExtent3D
copySize -
GPUTextureUsage
textureUsage -
boolean
aligned
戻り値: boolean
デバイスタイムラインの手順:
-
texture を texelCopyTextureInfo.
texture
とする -
aspectSpecificFormat = texture.
format
とする -
offsetAlignment = texture.
format
のテクセルブロックコピーのフットプリントとする。 -
以下すべての条件を満たした場合に限り
true
を返す:-
GPUTexelCopyTextureInfoの検証(texelCopyTextureInfo, copySize) が
true
を返すこと。 -
texture.
sampleCount
が1であること。 -
texture.
usage
にtextureUsageが含まれていること。 -
texture.
format
がdepth-or-stencil formatの場合:-
texelCopyTextureInfo.
aspect
がtexture.format
の単一アスペクトを参照していること。 -
textureUsageが以下の場合:
COPY_SRC
-
そのアスペクトがテクセルコピーの有効なソースである必要があります(§ 26.1.2 デプスステンシルフォーマット参照)。
COPY_DST
-
そのアスペクトがテクセルコピーの有効なデスティネーションである必要があります(§ 26.1.2 デプスステンシルフォーマット参照)。
-
aspectSpecificFormatをアスペクト固有フォーマットに設定(§ 26.1.2 デプスステンシルフォーマット参照)。
-
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. サブルーチン
引数:
-
GPUTexelCopyTextureInfo
texelCopyTextureInfo
戻り値: GPUExtent3D
texelCopyTextureInfoのGPUTexelCopyTextureInfo物理サブリソースサイズは以下のように算出されます:
そのwidth、height、depthOrArrayLayersはそれぞれ、
texelCopyTextureInfo.texture
のサブリソースの
物理ミップレベル固有テクスチャ範囲の
幅、高さ、深さ(ミップマップレベル
texelCopyTextureInfo.mipLevel
)。
引数:
GPUTexelCopyBufferLayout
layout-
リニアテクスチャデータのレイアウト。
GPUSize64
byteSize-
リニアデータの合計サイズ(バイト単位)。
GPUTextureFormat
format-
テクスチャのフォーマット。
GPUExtent3D
copyExtent-
コピーするテクスチャの範囲。
デバイスタイムラインの手順:
-
以下を定義:
-
widthInBlocks = copyExtent.width ÷ formatのテクセルブロック幅。 Assert これは整数であること。
-
heightInBlocks = copyExtent.height ÷ formatのテクセルブロック高さ。 Assert これは整数であること。
-
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
-
引数:
GPUTexelCopyTextureInfo
texelCopyTextureInfo-
コピー先のテクスチャサブリソースとコピー原点。
GPUExtent3D
copySize-
テクスチャのサイズ。
デバイスタイムラインの手順:
-
blockWidth = texelCopyTextureInfo.
texture
.format
のテクセルブロック幅とする。 -
blockHeight = texelCopyTextureInfo.
texture
.format
のテクセルブロック高さとする。 -
subresourceSize = texelCopyTextureInfoのGPUTexelCopyTextureInfo物理サブリソースサイズとする。
-
以下すべての条件が満たされているか判定して返す:
-
(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]]
, 型 list<GPU command>, readonly[[renderState]]
, 型 RenderState, 初期値null
-
実行中のレンダーパスコマンドで使用される現在の状態。
12.1.1. コマンドバッファ生成
dictionary :
GPUCommandBufferDescriptor GPUObjectDescriptorBase { };
13. コマンドエンコード
13.1. GPUCommandsMixin
GPUCommandsMixin
は、コマンドをエンコードするすべてのインターフェイスに共通する状態を定義します。
メソッドはありません。
interface mixin GPUCommandsMixin { };
GPUCommandsMixin
には以下のデバイスタイムラインプロパティがあります:
[[state]]
, 型 エンコーダ状態, 初期値 "open"-
エンコーダの現在の状態。
[[commands]]
, 型 list<GPUコマンド>, 初期値[]
-
このコマンドを含む
GPUCommandBuffer
が送信されたとき キュータイムラインで実行されるリストのGPUコマンドです。
エンコーダ状態は以下のいずれかです:
- "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
を生成します。呼び出し対象:GPUDevice
this.引数:
GPUDevice.createCommandEncoder(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUCommandEncoderDescriptor
✘ ✔ 作成する 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で記述されたレンダーパスのエンコードを開始します。
呼び出し対象:GPUCommandEncoder
this。引数:
GPUCommandEncoder.beginRenderPass(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPURenderPassDescriptor
✘ ✘ 生成する GPURenderPassEncoder
の記述。戻り値:
GPURenderPassEncoder
コンテンツタイムライン手順:
-
descriptor.
colorAttachments
の各非nullなcolorAttachmentについて:-
colorAttachment.
clearValue
が提供されていれば:-
? GPUColor の形状を検証する(colorAttachment.
clearValue
)。
-
-
-
新しい
GPURenderPassEncoder
オブジェクトpassを生成する。 -
thisのデバイスタイムラインで初期化手順を実行。
-
passを返す。
デバイスタイムライン 初期化手順:-
エンコーダ状態の検証をthisに対して実行。falseならpassを無効化して返す。
-
attachmentRegionsを空のリストとして用意。3Dテクスチャ用にdepthSliceも含む。
-
descriptor.
colorAttachments
の各非nullなcolorAttachmentについて:-
[colorAttachment.
view
, colorAttachment.depthSlice
?? null] をattachmentRegionsに追加。 -
colorAttachment.
resolveTarget
がnullでない場合:-
[colorAttachment.
resolveTarget
, undefined] をattachmentRegionsに追加。
-
-
-
次の要件を満たしていなければpassを無効化して返す。
-
descriptor は、デバイス this.
[[device]]
に対して、 有効な使用の規則を満たしていなければならない。 -
attachmentRegions 内のテクスチャ領域の集合は、互いに重なり合わない(ペアワイズで非重複)でなければならない。 すなわち、2つのテクスチャ領域が重なることは許されない。
-
-
attachmentRegions内の各texture subresourceをpass.
[[usage scope]]
にusage=attachmentで追加。 -
depthStencilAttachment = descriptor.
depthStencilAttachment
とする。 -
depthStencilAttachmentがnullでなければ:
-
depthStencilView = depthStencilAttachment.
view
とする。 -
depthのみのsubresourceをpass.
[[usage scope]]
にdepthReadOnlyならattachment-read、それ以外はattachmentで追加。 -
stencilのみのsubresourceをpass.
[[usage scope]]
にstencilReadOnlyならattachment-read、それ以外はattachmentで追加。 -
pass.
[[depthReadOnly]]
= depthStencilAttachment.depthReadOnly
とする。 -
pass.
[[stencilReadOnly]]
= depthStencilAttachment.stencilReadOnly
とする。
-
-
pass.
[[layout]]
= パスからレンダーターゲットのレイアウトを導出(descriptor)。 -
descriptor.
timestampWrites
が提供されていれば:-
timestampWrites = descriptor.
timestampWrites
とする。 -
timestampWrites.
beginningOfPassWriteIndex
が提供されていれば、this.[[commands]]
に以下のGPUコマンドを追加:-
パスコマンドの実行前に、現在のキュータイムスタンプを timestampWrites.
beginningOfPassWriteIndex
に書き込む。
-
-
timestampWrites.
endOfPassWriteIndex
が提供されていれば、pass.[[endTimestampWrite]]
に以下のGPUコマンドを設定:-
パスコマンドの実行後に、現在のキュータイムスタンプを timestampWrites.
endOfPassWriteIndex
に書き込む。
-
-
-
pass.
[[drawCount]]
= 0に設定。 -
pass.
[[maxDrawCount]]
= descriptor.maxDrawCount
に設定。 -
pass.
[[maxDrawCount]]
= descriptor.maxDrawCount
に設定。 -
thisにコマンドのエンキューを行い、以降の手順をキュータイムラインで実行する。
キュータイムライン手順:-
現在実行中の
[[renderState]]
を新しいRenderStateにする。 -
[[renderState]]
.[[colorAttachments]]
= descriptor.colorAttachments
に設定。 -
[[renderState]]
.[[depthStencilAttachment]]
= descriptor.depthStencilAttachment
に設定。 -
descriptor.
colorAttachments
の各非nullなcolorAttachmentについて:-
colorView = colorAttachment.
view
とする。 -
colorView.
[[descriptor]]
.dimension
が"3d"ならcolorSubregion = colorAttachment.depthSlice
、それ以外はcolorView。 -
colorAttachment.
loadOp
が"load"ならcolorSubregionの内容をframebuffer memoryにロードする。"clear"ならframebuffer memoryのすべてのtexelをcolorAttachment.
clearValue
で初期化する。
-
-
depthStencilAttachmentがnullでなければ:
-
depthStencilAttachment.
depthLoadOp
が未指定ならdepthReadOnlyがtrueであることをAssertし、depthのsubresource内容をframebuffer memoryにロードする。"load"ならdepthのsubresource内容をframebuffer memoryにロードする。
"clear"ならframebuffer memoryの全texelをdepthClearValueで初期化する。
-
depthStencilAttachment.
stencilLoadOp
が未指定ならstencilReadOnlyがtrueであることをAssertし、stencilのsubresource内容をframebuffer memoryにロードする。"load"ならstencilのsubresource内容をframebuffer memoryにロードする。
"clear"ならframebuffer memoryの全texelをstencilClearValueで初期化する。
-
注: Read-only depth-stencilアタッチメントは暗黙的に"load"操作として扱われます。read-onlyアタッチメントにはloadOp未指定である必要があるという検証はGPURenderPassDepthStencilAttachment Valid Usageで行われます。
-
beginComputePass(descriptor)
-
descriptorで記述されたコンピュートパスのエンコードを開始します。
呼び出し対象:GPUCommandEncoder
this。引数:
GPUCommandEncoder.beginComputePass(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUComputePassDescriptor
✘ ✔ コンテンツタイムライン手順:
-
新しい
GPUComputePassEncoder
オブジェクトpassを生成する。 -
thisのデバイスタイムラインで初期化手順を実行。
-
passを返す。
デバイスタイムライン 初期化手順:-
エンコーダ状態の検証をthisに対して実行。falseならpassを無効化して返す。
-
次の要件を満たしていなければpassを無効化して返す。
-
descriptor.
timestampWrites
が提供されていれば:timestampWritesの検証(this.[[device]]
, descriptor.timestampWrites
) がtrueを返すこと。
-
-
descriptor.
timestampWrites
が提供されていれば:-
timestampWrites = descriptor.
timestampWrites
とする。 -
timestampWrites.
beginningOfPassWriteIndex
が提供されていれば、this.[[commands]]
に以下のGPUコマンドを追加:-
パスコマンドの実行前に、現在のキュータイムスタンプを timestampWrites.
beginningOfPassWriteIndex
に書き込む。
-
-
timestampWrites.
endOfPassWriteIndex
が提供されていれば、pass.[[endTimestampWrite]]
に以下のGPUコマンドを設定:-
パスコマンドの実行後に、現在のキュータイムスタンプを timestampWrites.
endOfPassWriteIndex
に書き込む。
-
-
-
13.4. バッファコピーコマンド
copyBufferToBuffer() は2つのオーバーロードがあります:
copyBufferToBuffer(source, destination, size)
-
省略記法であり、
copyBufferToBuffer(source, 0, destination, 0, size)
と同等です。 copyBufferToBuffer(source, sourceOffset, destination, destinationOffset, size)
-
GPUCommandEncoder
に、あるGPUBuffer
のサブ領域から別のGPUBuffer
のサブ領域へデータをコピーするコマンドをエンコードします。呼び出し対象:GPUCommandEncoder
this。引数:
GPUCommandEncoder.copyBufferToBuffer(source, sourceOffset, destination, destinationOffset, size) メソッドの引数。 パラメータ 型 Nullable Optional 説明 source
GPUBuffer
✘ ✘ コピー元の GPUBuffer
。sourceOffset
GPUSize64
✘ ✘ コピー開始位置(コピー元バッファのバイトオフセット)。 destination
GPUBuffer
✘ ✘ コピー先の GPUBuffer
。destinationOffset
GPUSize64
✘ ✘ コピー先バッファのバイトオフセット。 size
GPUSize64
✘ ✔ コピーするバイト数。 戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
sizeが
undefined
なら、source.size
− sourceOffsetに設定。 -
次の条件を満たしていなければ、thisを無効化して返す。
-
thisにコマンドのエンキューを行い、以降の手順を
キュータイムライン
で実行。
キュータイムライン手順:-
sourceOffsetから始まるsourceのsizeバイトを、destinationOffsetから始まるdestinationにコピーする。
-
clearBuffer(buffer, offset, size)
-
GPUCommandEncoder
に、GPUBuffer
のサブ領域をゼロ埋めするコマンドをエンコードします。呼び出し対象:GPUCommandEncoder
this。引数:
GPUCommandEncoder.clearBuffer(buffer, offset, size) メソッドの引数。 パラメータ 型 Nullable Optional 説明 buffer
GPUBuffer
✘ ✘ クリアする GPUBuffer
。offset
GPUSize64
✘ ✔ クリア領域の開始バイトオフセット。 size
GPUSize64
✘ ✔ クリアするバイト数。デフォルトは buffer のサイズ - offset。 戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
sizeが未指定の場合、
max(0, buffer.
に設定。size
- offset) -
次の条件を満たしていなければ、thisを無効化して返す。
-
thisにコマンドのエンキューを行い、以降の手順を
キュータイムライン
で実行。
キュータイムライン手順:-
offsetから始まるbufferのsizeバイトを0に初期化する。
-
13.5. テクセルコピーコマンド
copyBufferToTexture(source, destination, copySize)
-
GPUCommandEncoder
に、GPUBuffer
のサブ領域から1つまたは複数の連続したテクスチャサブリソースのサブ領域へデータをコピーするコマンドをエンコードします。呼び出し対象:GPUCommandEncoder
this。引数:
GPUCommandEncoder.copyBufferToTexture(source, destination, copySize) メソッドの引数。 パラメータ 型 Nullable Optional 説明 source
GPUTexelCopyBufferInfo
✘ ✘ copySizeと組み合わせて、コピー元バッファの領域を定義します。 destination
GPUTexelCopyTextureInfo
✘ ✘ copySizeと組み合わせて、コピー先テクスチャサブリソースの領域を定義します。 copySize
GPUExtent3D
✘ ✘ 戻り値:
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にコマンドのエンキューを行い、以降の手順を
キュータイムライン
で実行。
キュータイムライン手順:-
blockWidth = destination.
texture
のテクセルブロック幅。 -
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が整数であることをAssert。
-
z = 0 から copySize.depthOrArrayLayers - 1 まで繰り返し:
-
dstSubregion = テクスチャコピーサブ領域(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
のサブ領域へデータをコピーするコマンドをエンコードします。呼び出し対象:GPUCommandEncoder
this。引数:
GPUCommandEncoder.copyTextureToBuffer(source, destination, copySize) メソッドの引数。 パラメータ 型 Nullable Optional 説明 source
GPUTexelCopyTextureInfo
✘ ✘ copySizeと組み合わせて、コピー元テクスチャサブリソースの領域を定義します。 destination
GPUTexelCopyBufferInfo
✘ ✘ copySizeと組み合わせて、コピー先バッファの領域を定義します。 copySize
GPUExtent3D
✘ ✘ 戻り値:
undefined
コンテンツタイムライン手順:
-
? GPUOrigin3D の形状を検証する(source.
origin
)。 -
? GPUExtent3D の形状を検証する(copySize)。
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する:
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
aligned = trueとする。
-
次の条件を満たしていなければ、thisを無効化して返す。
-
GPUTexelCopyBufferInfoの検証(destination) がtrueを返すこと。
-
テクスチャバッファコピーの検証(source, destination, dataLength, copySize,
COPY_SRC
, aligned) がtrueを返すこと。
-
-
thisにコマンドのエンキューを行い、以降の手順を
キュータイムライン
で実行。
キュータイムライン手順:-
blockWidth = source.
texture
のテクセルブロック幅。 -
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が整数であることをAssert。
-
z = 0 から copySize.depthOrArrayLayers - 1 まで繰り返し:
-
srcSubregion = テクスチャコピーサブ領域(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つまたは複数の連続したテクスチャサブリソースのサブ領域へデータをコピーするコマンドをエンコードします。呼び出し対象:GPUCommandEncoder
this。引数:
GPUCommandEncoder.copyTextureToTexture(source, destination, copySize) メソッドの引数。 パラメータ 型 Nullable Optional 説明 source
GPUTexelCopyTextureInfo
✘ ✘ copySizeと組み合わせて、コピー元テクスチャサブリソースの領域を定義します。 destination
GPUTexelCopyTextureInfo
✘ ✘ copySizeと組み合わせて、コピー先テクスチャサブリソースの領域を定義します。 copySize
GPUExtent3D
✘ ✘ 戻り値:
undefined
Content timeline の手順:
-
? GPUOrigin3D の形状を検証する(source.
origin
)。 -
? GPUOrigin3D の形状を検証する(destination.
origin
)。 -
? GPUExtent3D の形状を検証する(copySize)。
-
以降の手順は this.
[[device]]
の Device timeline 上で実行する:
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
次の条件を満たしていなければ、thisを無効化して返す。
-
srcTexture = source.
texture
とする。 -
dstTexture = destination.
texture
とする。 -
GPUTexelCopyTextureInfoの検証(source, copySize) がtrueを返すこと。
-
GPUTexelCopyTextureInfoの検証(destination, copySize) がtrueを返すこと。
-
srcTexture.
sampleCount
がdstTexture.sampleCount
と等しいこと。 -
srcTexture.
format
がデプスステンシルフォーマットの場合: -
テクスチャコピーのサブリソース集合(source, copySize)と テクスチャコピーのサブリソース集合(destination, copySize)が互いに重ならないこと。
-
-
thisにコマンドのエンキューを行い、以降の手順を
キュータイムライン
で実行。
キュータイムライン手順:-
blockWidth = source.
texture
のテクセルブロック幅。 -
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が整数であることをAssert。
-
z = 0 から copySize.depthOrArrayLayers - 1 まで繰り返し:
-
srcSubregion = テクスチャコピーサブ領域(z + srcOrigin.z) of source。
-
dstSubregion = テクスチャコピーサブ領域(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
の範囲に出力します。呼び出し対象:GPUCommandEncoder
this。引数:
GPUCommandEncoder.resolveQuerySet(querySet, firstQuery, queryCount, destination, destinationOffset) メソッドの引数。 パラメータ 型 Nullable Optional 説明 querySet
GPUQuerySet
✘ ✘ firstQuery
GPUSize32
✘ ✘ queryCount
GPUSize32
✘ ✘ destination
GPUBuffer
✘ ✘ destinationOffset
GPUSize64
✘ ✘ 戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
次の条件を満たしていなければ、thisを無効化して返す。
-
querySetがthisで有効に使用可能であること。
-
destinationがthisで有効に使用可能であること。
-
destination.
usage
にQUERY_RESOLVE
が含まれること。 -
firstQuery < querySetのクエリ数。
-
(firstQuery + queryCount) ≤ querySetのクエリ数。
-
destinationOffsetが256の倍数であること。
-
destinationOffset + 8 × queryCount ≤ destination.
size
であること。
-
-
thisにコマンドのエンキューを行い、以降の手順を
キュータイムライン
で実行。
キュータイムライン手順:-
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
を返します。呼び出し対象:GPUCommandEncoder
this。引数:
GPUCommandEncoder.finish(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUCommandBufferDescriptor
✘ ✔ 戻り値:
GPUCommandBuffer
コンテンツタイムライン手順:
-
commandBufferを新しい
GPUCommandBuffer
として定義。 -
this.
[[device]]
のデバイスタイムラインでfinish手順を実行。 -
commandBufferを返す。
デバイスタイムライン finish手順:-
以下すべての条件が満たされていればvalidationSucceeded=true、そうでなければfalse。
-
thisが有効であること。
-
this.
[[debug_group_stack]]
が空であること。
-
-
validationSucceededがfalseなら:
-
無効化された
GPUCommandBuffer
を返す。
-
commandBuffer.
[[command_list]]
にthis.[[commands]]
を設定。
-
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]]
, 型 ordered map<GPUIndex32
,GPUBindGroup
>, 初期値は空-
各インデックスに対する現在の
GPUBindGroup
。 [[dynamic_offsets]]
, 型 ordered map<GPUIndex32
, list<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
がtrueとなっている各エントリのバイト単位オフセット配列。順序はGPUBindGroupLayoutEntry
.binding
で決まる。詳細は注参照。
戻り値:
undefined
Content timeline の手順:
-
以降の手順は this.
[[device]]
の Device timeline 上で実行する。
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
bindGroupがnullならdynamicOffsetCountは0、nullでなければbindGroup.
[[layout]]
.[[dynamicOffsetCount]]
。 -
次の要件を満たしていなければthisを無効化して返す。
-
index < this.
[[device]]
.[[limits]]
.maxBindGroups
であること。 -
dynamicOffsets.sizeがdynamicOffsetCountと等しいこと。
-
-
bindGroupがnullの場合:
-
除去 this.
[[bind_groups]]
[index]。 -
除去 this.
[[dynamic_offsets]]
[index]。
それ以外の場合:
-
次の要件を満たしていなければthisを無効化して返す。
-
bindGroupがthisで有効に使用可能であること。
-
各ダイナミックバインディング (bufferBinding, bufferLayout, dynamicOffsetIndex) in 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 のコピーを設定する。 -
thisが
GPURenderCommandsMixin
の場合:-
this.
[[bind_groups]]
内の各bindGroupについて、bindGroup.[[usedResources]]
をthis.[[usage scope]]
にマージする。
-
-
setBindGroup(index, bindGroup, dynamicOffsetsData, dynamicOffsetsDataStart, dynamicOffsetsDataLength)
-
指定したインデックスに対して現在の
GPUBindGroup
を設定し、 ダイナミックオフセットをUint32Array
の部分集合として指定します。呼び出し対象:GPUBindingCommandsMixin
this。引数:
GPUBindingCommandsMixin.setBindGroup(index, bindGroup, dynamicOffsetsData, dynamicOffsetsDataStart, dynamicOffsetsDataLength) メソッドの引数。 パラメータ 型 Nullable Optional 説明 index
GPUIndex32
✘ ✘ バインドグループを設定するインデックス。 bindGroup
GPUBindGroup?
✔ ✘ 以降のレンダー/コンピュートコマンドで使用するバインドグループ。 dynamicOffsetsData
Uint32Array
✘ ✘ bindGroup内で buffer
.hasDynamicOffset
がtrueとなっている各エントリのバイト単位オフセット配列。順序はGPUBindGroupLayoutEntry
.binding
による。詳細は注参照。dynamicOffsetsDataStart
GPUSize64
✘ ✘ dynamicOffsetsDataの要素オフセット(バイトオフセットではない)。 dynamicOffsetsDataLength
GPUSize32
✘ ✘ dynamicOffsetsDataから読み込むバッファオフセット数。 戻り値:
undefined
コンテンツタイムライン手順:
-
次の要件を満たしていなければ、
RangeError
をthrowして返す。-
dynamicOffsetsDataStart >= 0であること。
-
dynamicOffsetsDataStart + dynamicOffsetsDataLength ≤ dynamicOffsetsData.
length
であること。
-
-
dynamicOffsetsをdynamicOffsetsDataのdynamicOffsetsDataStart番目からdynamicOffsetsDataLength要素分、コピーしたリストとする。
-
this.
setBindGroup
(index, bindGroup, dynamicOffsets)を呼び出す。
-
GPUBindGroupLayoutEntry
.binding
の順序で適用されます。
つまり、dynamic bindings
が GPUBindGroupLayoutEntry
のうち GPUBindGroupLayout
内で buffer
?.hasDynamicOffset
が true
となっているものを GPUBindGroupLayoutEntry
.binding
順にソートしたリストとすると、
setBindGroup()に渡す
dynamic offset[i]
は
dynamic bindings[i]
に対応します。
GPUBindGroupLayout
の場合:
// 配列内のbindingsは順序が異なっていますが、 // binding indexでソートされるため順序は問題ありません。 let layout= gpuDevice. createBindGroupLayout({ entries: [{ binding: 1 , buffer: {}, }, { binding: 2 , buffer: { dynamicOffset: true }, }, { binding: 0 , buffer: { dynamicOffset: true }, }] });
次の呼び出しで生成されたGPUBindGroup
を使用する場合:
// 上記同様、配列順序はここでも関係ありません。 // レイアウトで使われた順序と一致する必要もありません。 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]]
内の各GPUBindGroupEntry
entryについて、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とする。
-
-
引数:
GPUBindingCommandsMixin
encoder-
検証対象のバインドグループを持つエンコーダ。
GPUPipelineBase
pipeline-
encoderのバインドグループが互換性を持つべきパイプライン。
デバイスタイムライン手順:
-
以下のいずれかの条件が満たされていなければ、falseを返す:
-
pipelineはnullでないこと。
-
パイプラインで使用される全てのバインドグループが設定され、かつパイプラインレイアウトと互換性があること: pipeline.
[[layout]]
.[[bindGroupLayouts]]
内の各(index, bindGroupLayout)について:-
bindGroupLayoutがnullの場合、continue。
-
bindGroup = encoder.
[[bind_groups]]
[index]。 -
dynamicOffsets = encoder.
[[dynamic_offsets]]
[index]。 -
bindGroupはnullでないこと。
-
bindGroup.
[[layout]]
がbindGroupLayoutとgroup-equivalentであること。 -
dynamicOffsetIndex = 0とする。
-
bindGroup.
[[entries]]
の各bindGroupEntryについて、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)が、パイプラインのシェーダ内でbindGroupEntryに対応するバインディング変数のminimum buffer binding size以上であること。
-
-
-
-
エンコーダのバインドグループが書き込み可能なリソースとエイリアスしていないこと(encoder, pipeline)がfalseであること。
-
それ以外の場合はtrueを返す。
GPUTextureView
オブジェクトの可能性あり)。
注: このアルゴリズムはusage scope storage exceptionの使用を制限します。
引数:
GPUBindingCommandsMixin
encoder-
検証対象のバインドグループを持つエンコーダ。
GPUPipelineBase
pipeline-
encoderのバインドグループが互換性を持つべきパイプライン。
デバイスタイムライン手順:
-
stage in [
VERTEX
,FRAGMENT
,COMPUTE
]について:-
bufferBindings = (
GPUBufferBinding
,boolean
)のリストとする。booleanはリソースが書き込み可能かどうか。 -
textureViews = (
GPUTextureView
,boolean
)のリストとする。booleanはリソースが書き込み可能かどうか。 -
pipeline.
[[layout]]
.[[bindGroupLayouts]]
内の各(bindGroupIndex, bindGroupLayout)について:-
bindGroup = encoder.
[[bind_groups]]
[bindGroupIndex]。 -
bindGroupLayoutEntries = bindGroupLayout.
[[descriptor]]
.entries
。 -
bufferRanges = bindGroupのバッファ範囲(ダイナミックオフセットはencoder.
[[dynamic_offsets]]
[bindGroupIndex]を使用) -
bufferRanges内の各(bindGroupLayoutEntry, resource)で、bindGroupLayoutEntry.
visibility
がstageを含む場合:-
resourceWritable = (bindGroupLayoutEntry.
buffer
.type
== "storage")。 -
bufferBindings内の各(pastResource, pastResourceWritable)について:
-
resourceWritableまたはpastResourceWritableがtrueで、pastResourceとresourceがbuffer-binding-aliasingならtrueを返す。
-
-
(resource, resourceWritable)をbufferBindingsに追加。
-
-
bindGroupLayoutEntries内の各bindGroupLayoutEntryと対応するbindGroup内のresource(GPUTextureView)で、bindGroupLayoutEntry.
visibility
がstageを含む場合:-
bindGroupLayoutEntry.
storageTexture
が提供されていなければcontinue。 -
resourceWritable = bindGroupLayoutEntry.
storageTexture
.access
が書き込み可能なアクセスモードかどうか。 -
textureViews内の各(pastResource, pastResourceWritable)について:
-
resourceWritableまたはpastResourceWritableがtrueで、pastResourceとresourceがtexture-view-aliasingならtrueを返す。
-
-
(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)
-
以降のコマンドを含むラベル付きデバッググループを開始します。
呼び出し対象:GPUDebugCommandsMixin
this。引数:
GPUDebugCommandsMixin.pushDebugGroup(groupLabel) メソッドの引数。 パラメータ 型 Nullable Optional 説明 groupLabel
USVString
✘ ✘ コマンドグループのラベル。 戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
groupLabelをthis.
[[debug_group_stack]]
にpushする。
-
popDebugGroup()
-
直近に
pushDebugGroup()
で開始したラベル付きデバッググループを終了します。呼び出し対象:GPUDebugCommandsMixin
this。戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
次の要件を満たしていなければthisを無効化して返す。
-
this.
[[debug_group_stack]]
が空でないこと。
-
-
スタックのエントリを this.
[[debug_group_stack]]
からポップする。
-
insertDebugMarker(markerLabel)
-
コマンドストリームの任意の位置にラベルを挿入します。
呼び出し対象:GPUDebugCommandsMixin
this。引数:
GPUDebugCommandsMixin.insertDebugMarker(markerLabel) メソッドの引数。 パラメータ 型 Nullable Optional 説明 markerLabel
USVString
✘ ✘ 挿入するラベル。 戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
エンコーダ状態の検証を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-
指定された場合、computeパス開始時のタイムスタンプを書き込む
querySet
内のクエリインデックス。 endOfPassWriteIndex
, 型 GPUSize32-
指定された場合、computeパス終了時のタイムスタンプを書き込む
querySet
内のクエリインデックス。
注: タイムスタンプクエリーの値はナノ秒単位で書き込まれますが、その値がどのように決定されるかは 実装依存です。詳細は § 20.4 タイムスタンプクエリー を参照してください。
dictionary :
GPUComputePassDescriptor GPUObjectDescriptorBase {GPUComputePassTimestampWrites timestampWrites ; };
timestampWrites
, 型 GPUComputePassTimestampWrites-
このパスでどのタイムスタンプ値を書き込み、どこに書き込むかを定義します。
16.1.2. ディスパッチ
setPipeline(pipeline)
-
現在の
GPUComputePipeline
を設定します。呼び出し対象:GPUComputePassEncoder
this。引数:
GPUComputePassEncoder.setPipeline(pipeline) メソッドの引数。 パラメータ 型 Nullable Optional 説明 pipeline
GPUComputePipeline
✘ ✘ 以降のディスパッチコマンドで使用するコンピュートパイプライン。 戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
次の条件を満たしていなければthisを無効化して返す。
-
pipelineがthisで有効に使用可能であること。
-
-
this.
[[pipeline]]
にpipelineをセットする。
-
dispatchWorkgroups(workgroupCountX, workgroupCountY, workgroupCountZ)
-
現在の
GPUComputePipeline
で実行する作業をディスパッチします。 詳細な仕様は§ 23.1 コンピューティングを参照。呼び出し対象:GPUComputePassEncoder
this。引数:
GPUComputePassEncoder.dispatchWorkgroups(workgroupCountX, workgroupCountY, workgroupCountZ) メソッドの引数。 パラメータ 型 Nullable Optional 説明 workgroupCountX
GPUSize32
✘ ✘ ディスパッチするワークグループのX次元。 workgroupCountY
GPUSize32
✘ ✔ ディスパッチするワークグループのY次元。 workgroupCountZ
GPUSize32
✘ ✔ ディスパッチするワークグループのZ次元。 注:x
,y
,z
の値はdispatchWorkgroups()
およびdispatchWorkgroupsIndirect()
に渡すものであり、各次元でディスパッチするワークグループ数であって、各次元で実行するシェーダ呼び出しの数ではありません。これは現代のネイティブGPU APIの挙動と一致していますが、OpenCLとは異なります。例えば
GPUShaderModule
のエントリポイントが@workgroup_size(4, 4)
で、computePass.dispatchWorkgroups(8, 8);
を呼び出した場合、エントリポイントは合計1024回呼ばれます。X軸・Y軸両方で4x4のワークグループを8回ずつディスパッチするためです(4*4*8*8=1024
)。戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
usageScopeを空のusage scopeとする。
-
this.
[[bind_groups]]
内の各bindGroupについて、bindGroup.[[usedResources]]
をusageScopeにマージする。 -
次の条件を満たしていなければ、thisを無効化して返す。
-
usageScopeがusage scope validationを満たすこと。
-
エンコーダのバインドグループの検証(this, this.
[[pipeline]]
)がtrueであること。 -
workgroupCountX, workgroupCountY, workgroupCountZのすべてがthis.device.limits.
maxComputeWorkgroupsPerDimension
以下であること。
-
-
bindingStateをthisの現在の状態のスナップショットとする。
-
thisにコマンドのエンキューを行い、以降の手順をキュータイムラインで実行。
キュータイムライン手順:-
[workgroupCountX, workgroupCountY, workgroupCountZ]次元のワークグループグリッドを、bindingState.
[[pipeline]]
とbindingState.[[bind_groups]]
を用いて実行する。
-
dispatchWorkgroupsIndirect(indirectBuffer, indirectOffset)
-
現在の
GPUComputePipeline
で、GPUBuffer
からパラメータを読み取って作業をディスパッチします。 詳細な仕様は§ 23.1 コンピューティング参照。バッファ内のindirect dispatch parametersは、32ビット符号なし整数3つ(合計12バイト)を引数順(
dispatchWorkgroups()
の引数順)に詰めて格納します。例:let dispatchIndirectParameters= new Uint32Array( 3 ); dispatchIndirectParameters[ 0 ] = workgroupCountX; dispatchIndirectParameters[ 1 ] = workgroupCountY; dispatchIndirectParameters[ 2 ] = workgroupCountZ; 呼び出し対象:GPUComputePassEncoder
this。引数:
GPUComputePassEncoder.dispatchWorkgroupsIndirect(indirectBuffer, indirectOffset) メソッドの引数。 パラメータ 型 Nullable Optional 説明 indirectBuffer
GPUBuffer
✘ ✘ indirect dispatch parametersを格納するバッファ。 indirectOffset
GPUSize64
✘ ✘ indirectBuffer内でディスパッチデータが始まるバイトオフセット。 戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
usageScopeを空のusage scopeとする。
-
this.
[[bind_groups]]
内の各bindGroupについて、bindGroup.[[usedResources]]
をusageScopeにマージする。 -
indirectBufferをusageScopeにusageで追加する。
-
次の条件を満たしていなければ、thisを無効化して返す。
-
usageScopeがusage scope validationを満たすこと。
-
エンコーダのバインドグループの検証(this, this.
[[pipeline]]
)がtrueであること。 -
indirectBufferがthisで有効に使用可能であること。
-
indirectOffset + sizeof(indirect dispatch parameters) ≤ indirectBuffer.
size
であること。 -
indirectOffsetが4の倍数であること。
-
-
bindingStateをthisの現在の状態のスナップショットとする。
-
thisにコマンドのエンキューを行い、以降の手順をキュータイムラインで実行。
キュータイムライン手順:-
workgroupCountX = indirectBufferのindirectOffsetバイト目から符号なし32ビット整数値として読み取る。
-
workgroupCountY = indirectBufferの(indirectOffset + 4)バイト目から符号なし32ビット整数値として読み取る。
-
workgroupCountZ = indirectBufferの(indirectOffset + 8)バイト目から符号なし32ビット整数値として読み取る。
-
workgroupCountX, workgroupCountY, workgroupCountZのいずれかがthis.device.limits.
maxComputeWorkgroupsPerDimension
を超えていればreturn。 -
[workgroupCountX, workgroupCountY, workgroupCountZ]次元のワークグループグリッドを、bindingState.
[[pipeline]]
とbindingState.[[bind_groups]]
を用いて実行する。
-
16.1.3. ファイナライズ
ユーザーがパスのコマンド記録を完了したら end()
を呼び出すことでコンピュートパスエンコーダを終了できます。end()
が呼び出されると、コンピュートパスエンコーダはそれ以降使用できません。
end()
-
コンピュートパスコマンド列の記録を完了します。
呼び出し対象:GPUComputePassEncoder
this。戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
parentEncoder = this.
[[command_encoder]]
とする。 -
次の要件を満たしていなければ検証エラーを生成してreturn。
-
次の要件を満たしていなければparentEncoderを無効化してreturn。
-
thisが有効であること。
-
this.
[[debug_group_stack]]
が空であること。
-
-
parentEncoder.
[[commands]]
にthis.[[commands]]
をExtend
する。 -
this.
[[endTimestampWrite]]
がnullでない場合:-
parentEncoder.
[[commands]]
にthis.[[endTimestampWrite]]
をExtend
する。
-
-
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コマンド?、読み取り専用、 デフォルトはnull
-
パス終了時にタイムスタンプを書き込むGPUコマンド(ある場合)。
[[maxDrawCount]]
型GPUSize64
, 読み取り専用-
このパスで許可される最大ドロー数。
[[occlusion_query_active]]
, 型boolean
-
パスの
[[occlusion_query_set]]
が書き込まれているかどうか。
エンコードされたレンダーパスコマンドがGPUCommandBuffer
の一部として実行されるとき、
内部的にRenderStateオブジェクトがレンダリングに必要な現在の状態を管理するために使用されます。
RenderStateには以下のキュータイムラインプロパティがあります:
[[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.
resolveTarget
が提供されている場合:-
colorAttachment.
resolveTarget
はdeviceで有効に使用可能でなければならない。
-
-
colorAttachmentはGPURenderPassColorAttachment 有効な使用方法のルールを満たす必要がある。
-
this.
depthStencilAttachment
が提供されている場合:-
this.
depthStencilAttachment
.view
はdeviceで有効に使用可能でなければならない。 -
this.
depthStencilAttachment
はGPURenderPassDepthStencilAttachment 有効な使用方法のルールを満たす必要がある。
-
-
少なくとも1つのアタッチメントが存在しなければならない。以下のいずれか:
-
this.
colorAttachments
内に非null値がある、または -
this.
depthStencilAttachment
が存在する。
-
-
GPURenderPassDescriptorのカラ―アタッチメントbytes per sampleの検証(device, this.
colorAttachments
) が成功すること。 -
this.
colorAttachments
内の非nullメンバーのview
および this.depthStencilAttachment
.view
(あれば)は、同じsampleCount
でなければならない。 -
this.
colorAttachments
内の非nullメンバーのview
および this.depthStencilAttachment
.view
(あれば)は、[[renderExtent]]
が一致していなければならない。 -
this.
occlusionQuerySet
が提供されている場合:-
this.
occlusionQuerySet
はdeviceで有効に使用可能でなければならない。 -
this.
occlusionQuerySet
.type
はocclusion
でなければならない。
-
-
this.
timestampWrites
が提供されている場合:-
timestampWritesの検証(device, this.
timestampWrites
) がtrueを返すこと。
-
引数:
-
GPUDevice
device -
sequence<
GPURenderPassColorAttachment
?> colorAttachments
デバイスタイムライン手順:
-
formatsを空のlist<
GPUTextureFormat
?>とする。 -
colorAttachments内のcolorAttachmentごとに:
-
colorAttachmentがundefinedならcontinue。
-
formatsに追加 colorAttachment.
view
.[[descriptor]]
.format
を。
-
-
formatsのカラ―アタッチメントbytes per sampleの計算が 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)
-
このカラ―アタッチメントがマルチサンプルの場合、解決された出力を受け取るテクスチャサブリソースを記述します。 サブリソースは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
は 提供されている必要があり、は 現行標準のdepthOrArrayLayers より小さい必要があります。また、現行標準の論理miplevel固有のテクスチャ範囲 のrenderTexture 現行標準のsubresourceのmipmapレベル 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 プレーンカラーフォーマットに従いresolve可能でなければならない。
-
-
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内の非nullformatごとに
-
Assert: formatはカラ―レンダラブルフォーマットである。
-
renderTargetPixelByteCost = formatのレンダーターゲットピクセルバイトコスト。
-
renderTargetComponentAlignment = formatのレンダーターゲットコンポーネントアライメント。
-
totalをrenderTargetComponentAlignmentの倍数になるように切り上げる。
-
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を無視して等しいこと。
引数:
-
GPURenderPassDescriptor
descriptor
戻り値: GPURenderPassLayout
デバイスタイムライン手順:
-
layoutを新しい
GPURenderPassLayout
オブジェクトとする。 -
descriptor.
colorAttachments
内のcolorAttachmentごとに:-
colorAttachmentがnullでない場合:
-
layout.
sampleCount
にcolorAttachment.view
.[[texture]]
.sampleCount
をセットする。 -
layout.
colorFormats
にcolorAttachment.view
.[[descriptor]]
.format
を追加する。
それ以外の場合:
-
layout.
colorFormats
にnullを追加する。
-
-
-
depthStencilAttachment = descriptor.
depthStencilAttachment
とする。 -
depthStencilAttachmentがnullでない場合:
-
view = depthStencilAttachment.
view
とする。 -
layout.
sampleCount
にview.[[texture]]
.sampleCount
をセットする。 -
layout.
depthStencilFormat
にview.[[descriptor]]
.format
をセットする。
-
-
layoutを返す。
引数:
-
GPURenderPipelineDescriptor
descriptor
戻り値: GPURenderPassLayout
デバイスタイムライン手順:
-
layoutを新しい
GPURenderPassLayout
オブジェクトとする。 -
layout.
sampleCount
にdescriptor.multisample
.count
をセットする。 -
descriptor.
depthStencil
が指定されている場合:-
layout.
depthStencilFormat
にdescriptor.depthStencil
.format
をセットする。
-
-
descriptor.
fragment
が指定されている場合:-
descriptor.
fragment
.targets
内のcolorTargetごとに:-
colorTargetがnullでなければlayout.
colorFormats
にcolorTarget.format
を追加、nullであればnullを追加。
-
-
-
layoutを返す。
17.1.2. ファイナライズ
レンダーパスのコマンド記録が完了したら、end()
を呼び出すことでレンダーパスエンコーダを終了できます。end()
が呼び出された後は、このレンダーパスエンコーダは使用できません。
end()
-
レンダーパスコマンド列の記録を完了します。
呼び出し対象:GPURenderPassEncoder
this。戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
parentEncoder = this.
[[command_encoder]]
とする。 -
以下の要件が満たされていなければ、バリデーションエラーを生成してreturn。
-
次の要件が満たされていなければparentEncoderを無効化してreturn。
-
thisが有効であること。
-
this.
[[usage scope]]
がusage scope validationを満たすこと。 -
this.
[[debug_group_stack]]
が空であること。 -
this.
[[occlusion_query_active]]
がfalse
であること。 -
this.
[[drawCount]]
がthis.[[maxDrawCount]]
以下であること。
-
-
parentEncoder.
[[commands]]
にthis.[[commands]]
をExtend
する。 -
this.
[[endTimestampWrite]]
がnullでない場合:-
parentEncoder.
[[commands]]
にthis.[[endTimestampWrite]]
をExtend
する。
-
-
thisにレンダーコマンドのエンキューを行い、以降の手順をrenderState付きでキュータイムラインで実行。
キュータイムライン手順:-
renderState.
[[colorAttachments]]
内の非nullcolorAttachmentごとに:-
colorView = colorAttachment.
view
とする。 -
colorView.
[[descriptor]]
.dimension
が:"3d"
-
colorSubregion = colorAttachment.
depthSlice
of 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"
の注を参照してください。注: 読み取り専用デプス・ステンシルアタッチメントは暗黙的に
"store"
操作を使うものと考えられますが、パス中に内容が変更されないため実装はアタッチメントを更新する必要はありません。ストア操作を指定してはならないというバリデーションは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付きで実行するには、以下のデバイスタイムライン手順を実行します:
-
commandをencoder.
[[commands]]
に追加する。 -
commandが
GPUCommandBuffer
commandBufferの一部として実行される場合:-
commandBuffer.
[[renderState]]
をrenderStateとしてcommandの手順を実行する。
-
17.2.1. 描画
setPipeline(pipeline)
-
現在の
GPURenderPipeline
を設定します。呼び出し対象:GPURenderCommandsMixin
this。引数:
GPURenderCommandsMixin.setPipeline(pipeline) メソッドの引数。 パラメータ 型 Nullable Optional 説明 pipeline
GPURenderPipeline
✘ ✘ 以降の描画コマンドで使用するレンダーパイプライン。 戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
pipelineTargetsLayout = パイプラインからレンダーターゲットレイアウトを導出(pipeline.
[[descriptor]]
)とする。 -
以下の条件を満たさなければthisを無効化して返す。
-
pipelineがthisで有効に使用可能であること。
-
this.
[[layout]]
がpipelineTargetsLayoutと等しいこと。 -
pipeline.
[[writesDepth]]
がtrueの場合、this.[[depthReadOnly]]
がfalseでなければならない。 -
pipeline.
[[writesStencil]]
がtrueの場合、this.[[stencilReadOnly]]
がfalseでなければならない。
-
-
this.
[[pipeline]]
にpipelineをセットする。
-
setIndexBuffer(buffer, indexFormat, offset, size)
-
現在のインデックスバッファを設定します。
呼び出し対象:GPURenderCommandsMixin
this。引数:
GPURenderCommandsMixin.setIndexBuffer(buffer, indexFormat, offset, size) メソッドの引数。 パラメータ 型 Nullable Optional 説明 buffer
GPUBuffer
✘ ✘ 以降の描画コマンドで使用するインデックスデータを含むバッファ。 indexFormat
GPUIndexFormat
✘ ✘ buffer内インデックスデータのフォーマット。 offset
GPUSize64
✘ ✔ buffer内でインデックスデータが開始するバイトオフセット。デフォルトは 0
。size
GPUSize64
✘ ✔ buffer内インデックスデータのバイトサイズ。デフォルトはバッファサイズからオフセットを引いた値。 戻り値:
undefined
コンテンツタイムライン手順:
-
this.
[[device]]
のデバイスタイムラインで以降の手順を実行。
デバイスタイムライン手順:-
エンコーダ状態の検証をthisに対して実行。falseなら返す。
-
sizeが未指定の場合は、size = max(0, buffer.
size
- offset)とする。 -
以下の条件を満たさなければthisを無効化して返す。
-
bufferを
[[usage scope]]
にusageとして追加する。 -
this.
[[index_buffer]]
にbufferをセットする。 -
this.
[[index_format]]
にindexFormatをセットする。 -
this.
[[index_buffer_offset]]
にoffsetをセットする。 -
this.
[[index_buffer_size]]
にsizeをセットする。
-
setVertexBuffer(slot, buffer, offset, size)
-
指定したスロットの現在の頂点バッファを設定します。
呼び出し対象:GPURenderCommandsMixin
this.引数:
GPURenderCommandsMixin.setVertexBuffer(slot, buffer, offset, size) メソッドの引数。 パラメータ 型 Nullable Optional 説明 slot
GPUIndex32
✘ ✘ 頂点バッファを設定する頂点バッファスロット。 buffer
GPUBuffer?
✔ ✘ 後続の描画コマンドに使用される頂点データを含むバッファ。 offset
GPUSize64
✘ ✔ buffer の頂点データの開始位置(バイト単位のオフセット)。デフォルトは 0
。size
GPUSize64
✘ ✔ buffer 内の頂点データのバイト数。デフォルトはバッファのサイズからオフセットを引いた値。 返り値:
undefined
コンテンツタイムラインのステップ:
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する。
デバイスタイムラインのステップ:-
this の エンコーダ状態の検証を行う。false を返した場合は return。
-
buffer が
null
の場合は bufferSize を 0、そうでない場合は buffer.size
とする。 -
size が指定されていない場合、size に max(0, bufferSize - offset) を設定する。
-
次のいずれかの条件に違反する場合は、this を無効化して return。
-
slot は this.
[[device]]
.[[limits]]
.maxVertexBuffers
より小さい必要がある。 -
offset は 4 の倍数である必要がある。
-
offset + size は bufferSize 以下である必要がある。
-
-
buffer が
null
の場合:-
this.
[[vertex_buffers]]
[slot] を 削除する。 -
this.
[[vertex_buffer_sizes]]
[slot] を 削除する。
それ以外の場合:
-
次のいずれかの条件に違反する場合は、this を無効化して return。
-
buffer は this と一緒に使用可能である必要がある。
-
-
buffer を
[[usage scope]]
に input 用として追加する。 -
this.
[[vertex_buffers]]
[slot] に buffer を設定する。 -
this.
[[vertex_buffer_sizes]]
[slot] に size を設定する。
-
-
draw(vertexCount, instanceCount, firstVertex, firstInstance)
-
プリミティブを描画します。 詳細な仕様は § 23.2 レンダリング を参照してください。
呼び出し対象:GPURenderCommandsMixin
this.引数:
GPURenderCommandsMixin.draw(vertexCount, instanceCount, firstVertex, firstInstance) メソッドの引数。 パラメータ 型 Nullable Optional 説明 vertexCount
GPUSize32
✘ ✘ 描画する頂点数。 instanceCount
GPUSize32
✘ ✔ 描画するインスタンス数。 firstVertex
GPUSize32
✘ ✔ 描画開始位置(頂点バッファのオフセット、頂点単位)。 firstInstance
GPUSize32
✘ ✔ 描画する最初のインスタンス。 返り値:
undefined
コンテンツタイムラインのステップ:
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する。
デバイスタイムラインのステップ:-
this の エンコーダ状態の検証を行う。false を返した場合は return。
-
以下のステップの要件は すべて満たされなければならない。 いずれかを満たさない場合は this を無効化して return。
-
this で 描画可能である必要がある。
-
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 は、各 attribute について (attribute.
offset
+ byteSize(attribute.format
)) の最大値、attributes が 空の場合は 0。 -
strideCount は buffers[slot].
stepMode
に応じて計算する:"vertex"
-
firstVertex + vertexCount
"instance"
-
firstInstance + instanceCount
-
strideCount ≠
0
の場合:-
(strideCount −
1
) × stride + lastStride は bufferSize 以下でなければならない。
-
-
-
-
this.
[[drawCount]]
を 1 増加させる。 -
this の現在の状態のスナップショットを bindingState とする。
-
this で レンダーコマンドをエンキューし、実行時に キュータイムラインで renderState を使用して後続のステップを実行する。
キュータイムラインのステップ:-
instanceCount 個のインスタンスを、firstInstance から開始して描画する。 各プリミティブは vertexCount 頂点から成り、firstVertex から開始する。 bindingState と renderState の状態で描画する。
-
drawIndexed(indexCount, instanceCount, firstIndex, baseVertex, firstInstance)
-
インデックス付きプリミティブを描画します。 詳細な仕様については § 23.2 レンダリング を参照してください。
呼び出し対象:GPURenderCommandsMixin
this.引数:
GPURenderCommandsMixin.drawIndexed(indexCount, instanceCount, firstIndex, baseVertex, firstInstance) メソッドの引数。 パラメータ 型 Nullable Optional 説明 indexCount
GPUSize32
✘ ✘ 描画するインデックス数。 instanceCount
GPUSize32
✘ ✔ 描画するインスタンス数。 firstIndex
GPUSize32
✘ ✔ インデックスバッファ内の描画開始位置(インデックス単位のオフセット)。 baseVertex
GPUSignedOffset32
✘ ✔ 各インデックス値に頂点バッファへのインデックス時に加算する値。 firstInstance
GPUSize32
✘ ✔ 描画する最初のインスタンス。 返り値:
undefined
コンテンツタイムラインのステップ:
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する。
デバイスタイムラインのステップ:-
this の エンコーダ状態の検証を行う。false を返した場合は return。
-
次の条件のいずれかを満たさない場合は、this を無効化して return。
-
this で インデックス付き描画可能である必要がある。
-
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 は各 attribute について (attribute.
offset
+ byteSize(attribute.format
)) の最大値、各 attribute は buffers[slot].attributes
である。 -
strideCount は firstInstance + instanceCount である。
-
buffers[slot].
stepMode
が"instance"
かつ strideCount ≠0
の場合:-
(strideCount −
1
) × stride + lastStride は bufferSize 以下でなければならない。
-
-
-
-
this.
[[drawCount]]
を 1 増加する。 -
this の現在の状態のスナップショットを bindingState とする。
-
this に レンダーコマンドをエンキューし、実行時に キュータイムラインで renderState を使用して後続のステップを実行する。
キュータイムラインのステップ:-
instanceCount 個のインスタンスを firstInstance から開始して描画する。 各プリミティブは indexCount 個のインデックス付き頂点から成り、firstIndex から baseVertex の頂点で開始する。 bindingState と renderState の状態で描画する。
注: WebGPUアプリケーションは、
GPUVertexStepMode
"vertex"
を持つバインド済み頂点バッファの範囲外のインデックスデータを使用すべきではありません。 WebGPU実装ごとにこの扱いは異なり、幅広い挙動が許容されます。 描画呼び出し全体が破棄される場合や、範囲外属性へのアクセスは WGSL の 不正なメモリ参照として扱われます。 -
drawIndirect(indirectBuffer, indirectOffset)
-
GPUBuffer
から読み取ったパラメータを使ってプリミティブを描画します。 詳細な仕様は § 23.2 レンダリング を参照してください。バッファにエンコードされる 間接描画パラメータ は 32ビット符号なし整数値を4つ(合計16バイト) 連続で格納したブロックであり、
draw()
の引数と同じ順序です。 例:let drawIndirectParameters= new Uint32Array( 4 ); drawIndirectParameters[ 0 ] = vertexCount; drawIndirectParameters[ 1 ] = instanceCount; drawIndirectParameters[ 2 ] = firstVertex; drawIndirectParameters[ 3 ] = firstInstance; firstInstance
に対応する値は、"indirect-first-instance"
feature が有効の場合を除き、0でなければなりません。"indirect-first-instance"
feature が有効でない場合、firstInstance
が0以外だとdrawIndirect()
の呼び出しは何も行いません(no-op)。呼び出し対象:GPURenderCommandsMixin
this.引数:
GPURenderCommandsMixin.drawIndirect(indirectBuffer, indirectOffset) メソッドの引数。 パラメータ 型 Nullable Optional 説明 indirectBuffer
GPUBuffer
✘ ✘ 間接描画パラメータを含むバッファ。 indirectOffset
GPUSize64
✘ ✘ indirectBuffer 内の描画データの開始位置(バイト単位のオフセット)。 返り値:
undefined
コンテンツタイムラインのステップ:
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する。
デバイスタイムラインのステップ:-
this の エンコーダ状態の検証を行う。false を返した場合は return。
-
次の条件のいずれかを満たさない場合は、this を無効化して return。
-
indirectBuffer を
[[usage scope]]
に input 用として追加する。 -
this.
[[drawCount]]
を 1 増加する。 -
this の現在の状態のスナップショットを bindingState とする。
-
this に レンダーコマンドをエンキューし、実行時に キュータイムラインで renderState を使用して後続のステップを実行する。
キュータイムラインのステップ:-
vertexCount を indirectBuffer の indirectOffset バイトから符号なし32ビット整数として読み取る。
-
instanceCount を indirectBuffer の (indirectOffset + 4) バイトから符号なし32ビット整数として読み取る。
-
firstVertex を indirectBuffer の (indirectOffset + 8) バイトから符号なし32ビット整数として読み取る。
-
firstInstance を indirectBuffer の (indirectOffset + 12) バイトから符号なし32ビット整数として読み取る。
-
instanceCount 個のインスタンスを firstInstance から開始して描画する。 各プリミティブは vertexCount 頂点から成り、firstVertex から開始する。 bindingState と renderState の状態で描画する。
-
drawIndexedIndirect(indirectBuffer, indirectOffset)
-
GPUBuffer
から読み取ったパラメータでインデックス付きプリミティブを描画します。 詳細な仕様は § 23.2 レンダリング を参照してください。バッファにエンコードされる 間接drawIndexedパラメータ は 32ビット値5個(合計20バイト) を順に詰めたブロックであり、
drawIndexed()
の引数と同じ順序です。baseVertex
に対応する値は符号付き32ビット整数、それ以外は符号なし32ビット整数です。 例:let drawIndexedIndirectParameters= new Uint32Array( 5 ); let drawIndexedIndirectParametersSigned= new Int32Array( drawIndexedIndirectParameters. buffer); drawIndexedIndirectParameters[ 0 ] = indexCount; drawIndexedIndirectParameters[ 1 ] = instanceCount; drawIndexedIndirectParameters[ 2 ] = firstIndex; // baseVertex は符号付き値。 drawIndexedIndirectParametersSigned[ 3 ] = baseVertex; drawIndexedIndirectParameters[ 4 ] = firstInstance; firstInstance
に対応する値は"indirect-first-instance"
feature が有効の場合を除き、0でなければなりません。"indirect-first-instance"
feature が有効でない場合、firstInstance
が0以外だとdrawIndexedIndirect()
の呼び出しは何も行いません(no-op)。呼び出し対象:GPURenderCommandsMixin
this.引数:
GPURenderCommandsMixin.drawIndexedIndirect(indirectBuffer, indirectOffset) メソッドの引数。 パラメータ 型 Nullable Optional 説明 indirectBuffer
GPUBuffer
✘ ✘ 間接drawIndexedパラメータを含むバッファ。 indirectOffset
GPUSize64
✘ ✘ indirectBuffer 内の描画データの開始位置(バイト単位のオフセット)。 返り値:
undefined
コンテンツタイムラインのステップ:
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する。
デバイスタイムラインのステップ:-
this の エンコーダ状態の検証を行う。false を返した場合は return。
-
次の条件のいずれかを満たさない場合は、this を無効化して return。
-
this で インデックス付き描画可能である必要がある。
-
indirectBuffer は this と一緒に使用可能である必要がある。
-
indirectOffset + sizeof(間接drawIndexedパラメータ) ≤ indirectBuffer.
size
である必要がある。 -
indirectOffset は 4 の倍数である必要がある。
-
-
indirectBuffer を
[[usage scope]]
に input 用として追加する。 -
this.
[[drawCount]]
を 1 増加する。 -
this の現在の状態のスナップショットを bindingState とする。
-
this に レンダーコマンドをエンキューし、実行時に キュータイムラインで renderState を使用して後続のステップを実行する。
キュータイムラインのステップ:-
indexCount を indirectBuffer の indirectOffset バイトから符号なし32ビット整数として読み取る。
-
instanceCount を indirectBuffer の (indirectOffset + 4) バイトから符号なし32ビット整数として読み取る。
-
firstIndex を indirectBuffer の (indirectOffset + 8) バイトから符号なし32ビット整数として読み取る。
-
baseVertex を indirectBuffer の (indirectOffset + 12) バイトから符号付き32ビット整数として読み取る。
-
firstInstance を indirectBuffer の (indirectOffset + 16) バイトから符号なし32ビット整数として読み取る。
-
instanceCount 個のインスタンスを firstInstance から開始して描画する。 各プリミティブは indexCount インデックス付き頂点から成り、firstIndex から baseVertex の頂点で開始する。 bindingState と renderState の状態で描画する。
-
GPURenderCommandsMixin
encoder で 描画可能かどうかを判定するには、
以下の デバイスタイムライン
のステップを実行します:
-
以下の条件のいずれかを満たさない場合は、
false
を返す:-
エンコーダのバインドグループの検証(encoder, encoder.
[[pipeline]]
) がtrue
でなければならない。 -
pipelineDescriptor を encoder.
[[pipeline]]
.[[descriptor]]
とする。 -
各
GPUIndex32
slot について、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
を返す。 -
GPURenderCommandsMixin
encoder で インデックス付き描画が可能かどうかを判定するには、
以下の デバイスタイムライン
のステップを実行します:
-
以下の条件のいずれかを満たさない場合は、
false
を返す:-
描画可能 である必要がある。 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)
-
ラスタライズ段階で使用されるビューポートを設定し、正規化デバイス座標からビューポート座標へ線形マッピングします。
呼び出し対象:GPURenderPassEncoder
this.引数:
GPURenderPassEncoder.setViewport(x, y, width, height, minDepth, maxDepth) メソッドの引数。 パラメータ 型 Nullable Optional 説明 x
float
✘ ✘ ビューポートの最小X値(ピクセル単位)。 y
float
✘ ✘ ビューポートの最小Y値(ピクセル単位)。 width
float
✘ ✘ ビューポートの幅(ピクセル単位)。 height
float
✘ ✘ ビューポートの高さ(ピクセル単位)。 minDepth
float
✘ ✘ ビューポートの最小深度値。 maxDepth
float
✘ ✘ ビューポートの最大深度値。 返り値:
undefined
コンテンツタイムラインのステップ:
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する。
デバイスタイムラインのステップ:-
maxViewportRange を this.
limits
.maxTextureDimension2D
×2
とする。 -
以下の条件のいずれかを満たさない場合は、this を無効化して return。
-
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
-
-
レンダーコマンドをエンキューし、実行時に キュータイムラインで renderState を使用して後続のステップを実行する。
キュータイムラインのステップ:-
x, y, width, height を一様な精度(少なくとも整数丸め以上)で丸める。
-
renderState.
[[viewport]]
に x, y, width, height, minDepth, maxDepth の範囲を設定する。
-
setScissorRect(x, y, width, height)
-
ラスタライズ段階で使用するシザー矩形を設定します。 ビューポート座標へ変換された後、シザー矩形外に該当するフラグメントは破棄されます。
呼び出し対象:GPURenderPassEncoder
this.引数:
GPURenderPassEncoder.setScissorRect(x, y, width, height) メソッドの引数。 パラメータ 型 Nullable Optional 説明 x
GPUIntegerCoordinate
✘ ✘ シザー矩形の最小X値(ピクセル単位)。 y
GPUIntegerCoordinate
✘ ✘ シザー矩形の最小Y値(ピクセル単位)。 width
GPUIntegerCoordinate
✘ ✘ シザー矩形の幅(ピクセル単位)。 height
GPUIntegerCoordinate
✘ ✘ シザー矩形の高さ(ピクセル単位)。 返り値:
undefined
コンテンツタイムラインのステップ:
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する。
デバイスタイムラインのステップ:-
this のエンコーダ状態を検証し、false を返した場合は return。
-
以下の条件のいずれかを満たさない場合は、this を無効化して return。
-
x+width ≤ this.
[[attachment_size]]
.width。 -
y+height ≤ this.
[[attachment_size]]
.height。
-
-
レンダーコマンドをエンキューし、実行時に キュータイムラインで renderState を使用して後続のステップを実行する。
キュータイムラインのステップ:-
renderState.
[[scissorRect]]
に x, y, width, height の範囲を設定する。
-
setBlendConstant(color)
-
"constant"
や"one-minus-constant"
GPUBlendFactor
で使用される定数ブレンドカラーおよびアルファ値を設定します。呼び出し対象:GPURenderPassEncoder
this.引数:
GPURenderPassEncoder.setBlendConstant(color) メソッドの引数。 パラメータ 型 Nullable Optional 説明 color
GPUColor
✘ ✘ ブレンド時に使用する色。 返り値:
undefined
コンテンツタイムラインのステップ:
-
? GPUColor の形状を検証する(color)。
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する。
デバイスタイムラインのステップ:-
this のエンコーダ状態を検証し、false を返した場合は return。
-
レンダーコマンドをエンキューし、実行時に キュータイムラインで renderState を使用して後続のステップを実行する。
キュータイムラインのステップ:-
renderState.
[[blendConstant]]
に color を設定する。
-
setStencilReference(reference)
-
[[stencilReference]]
の値を、"replace"
GPUStencilOperation
のステンシルテストで使用する値に設定します。呼び出し対象:GPURenderPassEncoder
this.引数:
GPURenderPassEncoder.setStencilReference(reference) メソッドの引数。 パラメータ 型 Nullable Optional 説明 reference
GPUStencilValue
✘ ✘ 新しいステンシルリファレンス値。 返り値:
undefined
コンテンツタイムラインのステップ:
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する。
デバイスタイムラインのステップ:-
this のエンコーダ状態を検証し、false を返した場合は return。
-
レンダーコマンドをエンキューし、実行時に キュータイムラインで renderState を使用して後続のステップを実行する。
キュータイムラインのステップ:-
renderState.
[[stencilReference]]
に reference を設定する。
-
17.2.3. クエリ
beginOcclusionQuery(queryIndex)
-
呼び出し対象:
GPURenderPassEncoder
this.引数:
GPURenderPassEncoder.beginOcclusionQuery(queryIndex) メソッドの引数。 パラメータ 型 Nullable Optional 説明 queryIndex
GPUSize32
✘ ✘ クエリセット内のクエリのインデックス。 返り値:
undefined
コンテンツタイムラインのステップ:
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する。
デバイスタイムラインのステップ:-
thisのエンコーダ状態を検証する。 もしfalseを返した場合は、returnする。
-
以下の条件のいずれかを満たさない場合は、this を無効化して return。
-
this.
[[occlusion_query_set]]
はnull
でない。 -
queryIndex < this.
[[occlusion_query_set]]
.count
。 -
同じ queryIndex のクエリは、このパス内で以前に書き込みされていないこと。
-
this.
[[occlusion_query_active]]
がfalse
である。
-
-
this.
[[occlusion_query_active]]
をtrue
に設定する。 -
レンダーコマンドをエンキューし、実行時に キュータイムラインで renderState を使用して後続のステップを実行する。
キュータイムラインのステップ:-
renderState.
[[occlusionQueryIndex]]
に queryIndex を設定する。
-
endOcclusionQuery()
-
呼び出し対象:
GPURenderPassEncoder
this.返り値:
undefined
コンテンツタイムラインのステップ:
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する。
デバイスタイムラインのステップ:-
thisのエンコーダ状態を検証する。 もしfalseを返した場合は、returnする。
-
以下の条件のいずれかを満たさない場合は、this を無効化して return。
-
this.
[[occlusion_query_active]]
がtrue
である。
-
-
this.
[[occlusion_query_active]]
をfalse
に設定する。 -
レンダーコマンドをエンキューし、実行時に キュータイムラインで renderState を使用して後続のステップを実行する。
キュータイムラインのステップ:-
passingFragments を、対応する
beginOcclusionQuery()
コマンドの実行以降、全てのフラグメントテストを通過したフラグメントサンプルが1つでもあれば非ゼロ、なければゼロとする。注: 描画呼び出しが行われなかった場合、passingFragments はゼロになる。
-
passingFragments を this.
[[occlusion_query_set]]
のインデックス renderState.[[occlusionQueryIndex]]
に書き込む。
-
17.2.4. バンドル
executeBundles(bundles)
-
指定した
GPURenderBundle
に事前に記録されたコマンドを、このレンダーパスの一部として実行します。GPURenderBundle
を実行すると、レンダーパスのパイプライン、バインドグループ、頂点・インデックスバッファを継承しません。GPURenderBundle
の実行後、レンダーパスのパイプライン、バインドグループ、頂点/インデックスバッファ状態は初期値(空の値)にクリアされます。注: 状態はクリアされ、以前の状態に戻るのではありません。 これは、
GPURenderBundle
の実行数がゼロの場合でも発生します。呼び出し対象:GPURenderPassEncoder
this.引数:
GPURenderPassEncoder.executeBundles(bundles) メソッドの引数。 パラメータ 型 Nullable Optional 説明 bundles
sequence<GPURenderBundle>
✘ ✘ 実行するレンダーバンドルのリスト。 返り値:
undefined
コンテンツタイムラインのステップ:
-
以降の手順は this.
[[device]]
の デバイスタイムライン 上で実行する。
デバイスタイムラインのステップ:-
エンコーダー状態を検証する this の。false を返した場合は、return する。
-
以下の条件のいずれかを満たさない場合は、this を無効化して return。
-
各 bundle について:
-
bundle は this と一緒に使用可能でなければならない。
-
this.
[[layout]]
は bundle.[[layout]]
と等しくなければならない。 -
this.
[[depthReadOnly]]
が true の場合、bundle.[[depthReadOnly]]
も true でなければならない。 -
this.
[[stencilReadOnly]]
が true の場合、bundle.[[stencilReadOnly]]
も true でなければならない。
-
-
-
各 bundle について:
-
this.
[[drawCount]]
を bundle.[[drawCount]]
だけ増やす。 -
マージする bundle.
[[usage scope]]
を this.[[usage scope]]
に。 -
レンダーコマンドをエンキューする this 上で、実行時に renderState を使って Queue timeline に以下の手順を発行する:
Queue timeline の手順:-
bundle.
[[command_list]]
の各コマンドを renderState で実行する。注: renderState はレンダーバンドルの実行では変更できない。バインディング状態は バンドルのエンコード時にすでにキャプチャされており、バンドルの実行時には使用されない。
-
-
-
GPURenderPassEncoder
encoder の レンダーパスのバインディング状態をリセットするには、
以下の デバイスタイムラインのステップを実行します:
-
クリアする 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>-
リスト( GPUコマンドの)であり、
GPURenderPassEncoder
に提出される。GPURenderBundle
が実行される時に。 [[usage scope]]
, of type usage scope, initially empty-
このレンダーバンドルの使用スコープで、後に
GPURenderPassEncoder
の[[usage scope]]
にexecuteBundles()
でマージされます。 [[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
を作成します。呼び出し対象:GPUDevice
this.引数:
GPUDevice.createRenderBundleEncoder(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPURenderBundleEncoderDescriptor
✘ ✘ 作成する GPURenderBundleEncoder
の記述。コンテンツタイムラインのステップ:
-
? テクスチャフォーマット必須機能の検証をdescriptor.
colorFormats
の各非null
要素についてthis.[[device]]
で実行する。 -
descriptor.
depthStencilFormat
が指定されている場合:-
? テクスチャフォーマットの必須機能を検証する( descriptor.
depthStencilFormat
、 this.[[device]]
)。
-
-
eを! 新しいWebGPUオブジェクトの作成(this,
GPURenderBundleEncoder
, descriptor)とする。 -
thisのデバイスタイムラインで初期化ステップを実行する。
-
eを返す。
デバイスタイムライン 初期化ステップ:-
以下の条件のいずれかを満たさない場合、 バリデーションエラーを生成し、eを無効化してreturn。
-
thisはlostであってはならない。
-
descriptor.
colorFormats
.sizeは this.[[limits]]
.maxColorAttachments
以下であること。 -
各非
null
のcolorFormatについて descriptor.colorFormats
内:-
colorFormatはカラー描画可能フォーマットであること。
-
-
color attachment bytes per sampleの計算(descriptor.
colorFormats
) は this.[[limits]]
.maxColorAttachmentBytesPerSample
以下であること。 -
descriptor.
depthStencilFormat
が指定されている場合:-
descriptor.
depthStencilFormat
は深度またはステンシルフォーマットであること。
-
-
少なくとも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
の深度成分を変更しないことを示します。 stencilReadOnly
, 型 boolean、デフォルトはfalse
-
true
の場合、レンダーバンドルが実行されるレンダーパスのGPURenderPassDepthStencilAttachment
のステンシル成分を変更しないことを示します。
18.1.3. ファイナライズ
finish(descriptor)
-
レンダーバンドルコマンドシーケンスの記録を完了します。
呼び出し対象:GPURenderBundleEncoder
this.引数:
GPURenderBundleEncoder.finish(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPURenderBundleDescriptor
✘ ✔ 返り値:
GPURenderBundle
コンテンツタイムラインのステップ:
-
renderBundle を新しい
GPURenderBundle
とする。 -
this.
[[device]]
の デバイスタイムラインで finish steps を実行する。 -
renderBundle を返す。
デバイスタイムラインの finish steps:-
次の要件をすべて満たしていれば validationSucceeded を
true
、満たさない場合はfalse
。-
this は valid でなければならない。
-
this.
[[usage scope]]
は usage scope validation を満たす必要がある。 -
this.
[[debug_group_stack]]
は 空でなければならない。
-
-
validationSucceeded が
false
の場合: -
renderBundle.
[[command_list]]
に this.[[commands]]
を設定する。 -
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
に書き込む操作を発行します。呼び出し対象:GPUQueue
this.引数:
GPUQueue.writeBuffer(buffer, bufferOffset, data, dataOffset, size) メソッドの引数。 パラメータ 型 Nullable Optional 説明 buffer
GPUBuffer
✘ ✘ 書き込み先のバッファ。 bufferOffset
GPUSize64
✘ ✘ buffer の書き込み開始位置(バイト単位のオフセット)。 data
AllowSharedBufferSource
✘ ✘ buffer に書き込むデータ。 dataOffset
GPUSize64
✘ ✔ data の書き込み開始位置。data が TypedArray
の場合は要素単位、それ以外はバイト単位。size
GPUSize64
✘ ✔ 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
に書き込む操作を発行します。呼び出し対象:GPUQueue
this.引数:
GPUQueue.writeTexture(destination, data, dataLayout, size) メソッドの引数。 パラメータ 型 Nullable Optional 説明 destination
GPUTexelCopyTextureInfo
✘ ✘ 書き込み先のテクスチャサブリソースと原点。 data
AllowSharedBufferSource
✘ ✘ destination に書き込むデータ。 dataLayout
GPUTexelCopyBufferLayout
✘ ✘ data の内容のレイアウト。 size
GPUExtent3D
✘ ✘ data から destination に書き込む内容の範囲。 返り値:
undefined
コンテンツタイムラインのステップ:
-
? GPUOrigin3D 形状を検証(destination.
origin
)。 -
? GPUExtent3D 形状を検証(size)。
-
dataBytes を buffer source のコピーとして data から取得する。
注: これは data の全てをデバイスタイムラインへコピーするよう記述されているが、実際には必要な分だけコピーされるよう最適化されるべきです。
-
後続のステップを this の デバイスタイムラインで実行する。
デバイスタイムラインのステップ:-
aligned を
false
とする。 -
dataLength を dataBytes.length とする。
-
次の条件のいずれかを満たさない場合、 バリデーションエラー生成して return。
-
destination.
texture
.[[destroyed]]
がfalse
である。 -
texture buffer copy の検証(destination, dataLayout, dataLength, size,
COPY_DST
, aligned) がtrue
であること。
注:
GPUCommandEncoder
.copyBufferToTexture()
とは異なり、dataLayout.bytesPerRow
および dataLayout.offset
にアライメント要件はない。 -
-
後続のステップを this の キュータイムラインで実行する。
キュータイムラインのステップ:-
blockHeight を destination.
texture
の テクセルブロック高さ とする。 -
dstOrigin を destination.
origin
とする。 -
dstBlockOriginX を (dstOrigin.x ÷ blockWidth) とする。
-
dstBlockOriginY を (dstOrigin.y ÷ blockHeight) とする。
-
blockColumns を (copySize.width ÷ blockWidth) とする。
-
blockRows を (copySize.height ÷ blockHeight) とする。
-
Assert により 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
) とする。 -
テクセルブロック (dstBlockOriginX + x, dstBlockOriginY + y) の dstSubregion を 等価テクセル表現で dataBytes の blockOffset から記述されるものにする。
-
-
-
-
copyExternalImageToTexture(source, destination, copySize)
-
プラットフォーム画像/キャンバスの内容を宛先テクスチャにコピーします。
この操作は
GPUCopyExternalImageDestInfo
のパラメータに従って 色空間エンコード を行います。-srgb
テクスチャへのコピーは、対応する非-srgb
フォーマットへのコピーとは、同じテクスチャバイトになり、デコード値は異なります。 コピー操作後、宛先テクスチャのサンプリング結果は、フォーマットが-srgb
かどうかで異なります(他が同じ場合)。注:"webgl"
/"webgl2"
コンテキストキャンバスからコピーする場合、 WebGL 描画バッファはフレーム提示サイクルの一部タイミング(画像が表示のため合成器に移動された後)に存在しないことがあります。 これを避けるには、以下のいずれかを行います:-
WebGLレンダリング操作と同じタスク内で
copyExternalImageToTexture()
を発行し、コピーがWebGLキャンバス提示前に行われるようにする。 -
それができない場合は、
preserveDrawingBuffer
オプションをWebGLContextAttributes
でtrue
に設定することで、提示後も描画バッファにフレーム内容のコピーが残ります。 ただし、この追加コピーにはパフォーマンスコストが発生する可能性があります。
呼び出し対象:GPUQueue
this.引数:
GPUQueue.copyExternalImageToTexture(source, destination, copySize) メソッドの引数。 パラメータ 型 Nullable Optional 説明 source
GPUCopyExternalImageSourceInfo
✘ ✘ コピー元画像および destination への原点情報。 destination
GPUCopyExternalImageDestInfo
✘ ✘ 書き込み先のテクスチャサブリソース、原点、エンコードメタデータ。 copySize
GPUExtent3D
✘ ✘ 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 のデバイスタイムラインで実行する。
デバイスタイムラインの手順:-
texture を destination.
texture
とする。 -
以下のいずれかの要件が満たされない場合、バリデーションエラーを生成してリターンする。
-
usability は
good
でなければならない。 -
texture.
[[destroyed]]
はfalse
でなければならない。 -
texture は 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より大きい場合、以降の手順を this のキュータイムライン上で実行する。
キュータイムラインのステップ:-
destination.
texture
の テクセルブロック幅 が 1 であり、 テクセルブロック高さ も 1 であり、 copySize.depthOrArrayLayers が 1 であることをアサートする。 -
srcOrigin を source.
origin
とする。 -
dstOrigin を destination.
origin
とする。 -
dstSubregion を texture copy sub-region (dstOrigin.z) of destination とする。
-
各 y について [0, copySize.height − 1] の範囲で:
-
srcY を source.
flipY
がfalse
の場合 y、 そうでなければ (copySize.height − 1 − y) とする。 -
各 x について [0, copySize.width − 1] の範囲で:
-
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 の texel block (dstOrigin.x + x, dstOrigin.y + y) に dstColor の 等価なテクセル表現を設定する。
-
-
-
submit(commandBuffers)
-
このキュー上でGPUによるコマンドバッファの実行をスケジュールします。
提出されたコマンドバッファは再利用できません。
呼び出し対象:GPUQueue
this.引数:
GPUQueue.submit(commandBuffers) メソッドの引数。 パラメータ 型 Nullable Optional 説明 commandBuffers
sequence<GPUCommandBuffer>
✘ ✘ 返り値:
undefined
コンテンツタイムラインのステップ:
-
後続のステップを this のデバイスタイムラインで実行する:
デバイスタイムラインのステップ:-
以下の要件のいずれかが満たされていない場合、バリデーションエラーを生成する、 各
GPUCommandBuffer
を commandBuffers 内で無効化し、returnする。-
すべての
GPUCommandBuffer
は this で 使用可能でなければならない。 -
すべての
GPUCommandBuffer
はユニークでなければならない。 -
commandBuffersのいずれかのコマンドで使用される各種リソースについて:
GPUBuffer
b-
b.
[[internal state]]
が "available" でなければならない。 GPUTexture
t-
t.
[[destroyed]]
がfalse
でなければならない。 GPUExternalTexture
et-
et.
[[expired]]
がfalse
でなければならない。 GPUQuerySet
qs-
qs.
[[destroyed]]
がfalse
でなければならない。
注: オクルージョンクエリについては、
occlusionQuerySet
はbeginRenderPass()
で指定しただけでは「使用済み」とはならず、beginOcclusionQuery()
で利用された場合のみ「使用済み」とみなされます。
-
-
すべての commandBuffer について:
-
後続のステップを this のキュータイムラインで実行する:
キュータイムラインのステップ:-
すべての commandBuffer について:
-
commandBuffer.
[[command_list]]
の各コマンドを実行する。
-
-
onSubmittedWorkDone()
-
このキューが現時点までに提出されたすべての処理を終了したときに resolve される
Promise
を返します。この
Promise
の resolve は、当該呼び出し以前にmapAsync()
を呼び出し、その後このキューでのみ利用されたGPUBuffer
の mapAsync の完了も意味します。呼び出し対象:GPUQueue
this.コンテンツタイムラインのステップ:
-
contentTimeline を現在の コンテンツタイムラインとする。
-
promise を 新しいPromiseとする。
-
this の デバイスタイムラインで synchronization steps を実行する。
-
promise を返す。
デバイスタイムラインの synchronization steps:-
event を 現在キューに入っているすべての処理が完了したときに発生させる。
-
タイムラインイベント event をリッスン し、this.
[[device]]
で contentTimeline 上で後続のステップを処理する。
コンテンツタイムラインのステップ:-
解決する promise。
-
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
を作成します。呼び出し対象:GPUDevice
this.引数:
GPUDevice.createQuerySet(descriptor) メソッドの引数。 パラメータ 型 Nullable Optional 説明 descriptor
GPUQuerySetDescriptor
✘ ✘ 作成する GPUQuerySet
の記述。返り値:
GPUQuerySet
コンテンツタイムラインのステップ:
-
descriptor.
type
が"timestamp"
の場合、"timestamp-query"
が this で有効でなければ:-
TypeError
を throw する。
-
-
q を ! 新しい WebGPU オブジェクトの作成(this,
GPUQuerySet
, descriptor)とする。 -
this の デバイスタイムラインで 初期化ステップ を実行する。
-
q を返す。
デバイスタイムラインの 初期化ステップ:-
次のいずれかの要件を満たさない場合、バリデーションエラーを生成し、 q を無効化して return。
-
クエリセットの各エントリがゼロとなるようにデバイス領域を確保する。
もし副作用なしに確保に失敗した場合は、 メモリ不足エラーを生成し、q を無効化して return。
-
GPUQuerySet
の作成例。
const querySet= gpuDevice. createQuerySet({ type: 'occlusion' , count: 32 });
20.1.2. クエリセットの破棄
アプリケーションが GPUQuerySet
を不要と判断した場合、destroy()
を呼び出すことでガベージコレクション前にアクセスを失うことができます。
GPUQuerySet
には以下のメソッドがあります:
destroy()
-
GPUQuerySet
を破棄します。デバイスタイムラインのステップ:-
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
になることはありません。
引数:
-
GPUDevice
device -
(
timestampWritesGPUComputePassTimestampWrites
またはGPURenderPassTimestampWrites
)
デバイスタイムラインのステップ:
-
以下の要件をすべて満たしていれば
true
、そうでなければfalse
を返す:-
"timestamp-query"
が device で有効になっていること。 -
timestampWrites.
querySet
が device と一緒に使用可能であること。 -
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)
, readonly-
このコンテキストが作成されたキャンバス。
[[configuration]]
, 型GPUCanvasConfiguration
?, 初期値null
-
このコンテキストが現在構成されているオプション。
まだ構成されていない場合や
unconfigure
された場合はnull
。 [[textureDescriptor]]
, 型GPUTextureDescriptor
?, 初期値null
-
現在構成されているテクスチャ記述子。
[[configuration]]
とキャンバスから導出。まだ構成されていない場合や
unconfigure
された場合はnull
。 [[drawingBuffer]]
, 画像、初期値は キャンバスと同じサイズの透明黒画像-
描画バッファはキャンバスの作業用イメージデータです。
[[currentTexture]]
(getCurrentTexture()
で返される)を介して書き込み可能として公開されます。描画バッファは コンテキストの画像内容のコピー取得で使用されます。 (キャンバスが表示されたり、読み込まれたときに発生)。透明となる場合があり、
[[configuration]]
.alphaMode
が"opaque"
でも同様です。alphaMode
は "コンテキストの画像内容のコピー取得"アルゴリズムの結果のみに影響します。描画バッファは
[[currentTexture]]
より長く保持され、キャンバスが提示された後も以前の描画内容を含みます。 描画バッファを置き換えるでのみクリアされます。描画バッファが読み込まれるたび、実装はすべての以前の作業(キューへのサブミット等)が
[[currentTexture]]
経由で書き込まれたことを保証しなければなりません。 [[currentTexture]]
, 型GPUTexture
?, 初期値null
-
現在のフレームで描画する
GPUTexture
。 下層の[[drawingBuffer]]
への書き込み可能なビューを公開します。getCurrentTexture()
はnull
の場合このスロットを生成して返します。表示可能なキャンバスの定常状態では、currentTextureを通じて描画バッファに行われた変更は WebGPUキャンバスの描画更新時に提示されます。 このタイミングまたはそれ以前に、テクスチャは破棄され
[[currentTexture]]
はnull
になり、次回getCurrentTexture()
で新しく生成されます。currentTexture の破棄
は描画バッファの内容に影響せず、書き込みアクセスのみ早期終了します。 同じフレーム内ではgetCurrentTexture()
は破棄済みでも同じテクスチャを返します。Expire the current texture は currentTexture を
null
にします。 これはconfigure()
、 キャンバスのリサイズ、提示、transferToImageBitmap()
等で呼ばれます。 [[lastPresentedImage]]
, 型(readonly image)?
, 初期値null
-
このキャンバスで直近に提示された画像("WebGPUキャンバスの描画更新" で提示)。 デバイスが lost や destroy された場合、"コンテキストの画像内容のコピー取得" のフォールバックとして使われることがあります。
注: このプロパティはフォールバックを実装する場合のみ必要です(任意実装)。
GPUCanvasContext
には以下のメソッドがあります:
configure(configuration)
-
このキャンバスのコンテキストを構成します。 この操作は描画バッファを透明黒にクリアします(描画バッファを置き換える)。
getConfiguration()
による機能検出の情報を参照してください。呼び出し対象:GPUCanvasContext
this.引数:
GPUCanvasContext.configure(configuration) メソッドの引数。 パラメータ 型 Nullable Optional 説明 configuration
GPUCanvasConfiguration
✘ ✘ コンテキストの希望構成。 返り値: undefined
コンテンツタイムラインのステップ:
-
device を configuration.
device
とする。 -
? テクスチャフォーマット必須機能の検証を configuration.
format
および device.[[device]]
で実行する。 -
? テクスチャフォーマット必須機能の検証を configuration.
viewFormats
の各要素について device.[[device]]
で実行する。 -
もし サポートされているコンテキストフォーマット が configuration.
format
を 含まない場合、TypeError
を throw する。 -
descriptor を キャンバスと構成に対する GPUTextureDescriptor (this.
canvas
, configuration) とする。 -
this.
[[configuration]]
に configuration を設定する。注: これは実装定義の
GPUCanvasConfiguration
に定義されたメンバーのみを公開します。 各メンバーの仕様に機能検出 機能検出 に関する注記がありますので参照してください。 -
this.
[[textureDescriptor]]
に descriptor を設定する。 -
this の 描画バッファを置き換える。
-
device の デバイスタイムラインで後続のステップを実行する。
デバイスタイムラインのステップ:-
以下の要件を満たさない場合、バリデーションエラーを生成して return。
-
validating GPUTextureDescriptor(device, descriptor) が true を返す必要がある。
注: この早期バリデーションは次回
configure()
まで有効ですが、size
のバリデーションのみはキャンバスのリサイズ時に変化します。 -
-
unconfigure()
-
コンテキストの構成を解除します。構成中に生成されたテクスチャはすべて破棄されます。
呼び出し対象:GPUCanvasContext
this.返り値: undefined
コンテンツタイムラインのステップ:
-
this.
[[configuration]]
にnull
を設定する。 -
this.
[[textureDescriptor]]
にnull
を設定する。 -
this の 描画バッファを置き換える。
-
getConfiguration()
-
コンテキストの構成を返します。未構成の場合は
null
を返します。注: このメソッドは主に 機能検出 のために存在します(
GPUCanvasConfiguration
のメンバーやサブメンバー)。詳細は各メンバーの仕様を参照してください。 サポートされているメンバーについては、元々指定された値を返します。呼び出し対象:GPUCanvasContext
this.返り値:
GPUCanvasConfiguration
またはnull
コンテンツタイムラインのステップ:
-
configuration を this.
[[configuration]]
のコピーとする。 -
configuration を返す。
-
getCurrentTexture()
-
GPUTexture
を取得します。これはGPUCanvasContext
によって次にドキュメント上に合成されるテクスチャです。注:アプリケーションは 同じタスク内でgetCurrentTexture()
を呼び出してキャンバステクスチャにレンダリングすべきです。 そうしないと、レンダリングが完了する前に、これらの手順でテクスチャが破棄されてしまう可能性があります。有効期限タスク(下記定義)は実装が任意です。 実装されている場合でも、タスクソースの優先順位は規定されていないため、次のタスクで早期に起こる場合もあれば、すべての他のタスクソースが空になるまで遅延する場合もあります (自動有効期限タスクソース参照)。 有効期限発生は、表示されるキャンバスが可視状態のとき (WebGPUキャンバスの描画の更新) および "現在のテクスチャの期限切れ処理" の呼び出し元のみ保証されます。
呼び出し対象:GPUCanvasContext
this.返り値:
GPUTexture
コンテンツタイムラインのステップ:
-
this.
[[configuration]]
がnull
の場合、InvalidStateError
を throw して return。 -
this.
[[textureDescriptor]]
がnull
でないことを アサートする。 -
device を this.
[[configuration]]
.device
とする。 -
this.
[[currentTexture]]
がnull
の場合:-
this.
[[currentTexture]]
に device.createTexture()
を呼び出し、引数に this.[[textureDescriptor]]
を渡す。ただし、GPUTexture
の 基礎ストレージは this.[[drawingBuffer]]
を指すものとする。注: テクスチャの作成に失敗した場合(例: バリデーション失敗やメモリ不足)、 エラーが発生し、無効化された
GPUTexture
を返します。 一部のバリデーションはconfigure()
でも実行されますが、 実装はこの重複したバリデーションを必ず省略せず行うこと。
-
任意で、自動期限切れタスクをキューに追加(device device を指定し、以下のステップを実行):
-
現在のテクスチャの期限切れ処理を this に対して実行。
注: すでに WebGPUキャンバスの描画の更新時などに 実行済みの場合は効果なし。
-
-
this.
[[currentTexture]]
を返す。
注: 同じ
GPUTexture
オブジェクトは、「現在のテクスチャの有効期限切れ」が実行されるまで、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()
で返されるテクスチャのフォーマットです。 サポートされるコンテキストフォーマットのいずれかでなければなりません。 usage
, 型 GPUTextureUsageFlags, デフォルトは0x10
-
getCurrentTexture()
で返されるテクスチャのusageです。RENDER_ATTACHMENT
がデフォルトですが、usageを明示的に設定した場合は自動付与されません。RENDER_ATTACHMENT
を使いたい場合は、自分でusageに追加してください。 viewFormats
, 型 sequence<GPUTextureFormat>, デフォルトは[]
-
getCurrentTexture()
で返されるテクスチャからビューを作成するときに使えるフォーマットです。 colorSpace
, 型 PredefinedColorSpace, デフォルトは"srgb"
-
getCurrentTexture()
に書き込まれた値を表示する色空間です。 toneMapping
, 型 GPUCanvasToneMapping, デフォルトは{}
-
トーンマッピングは
getCurrentTexture()
で返されるテクスチャの内容がどのように表示されるかを決定します。注:これは必須機能ですが、ユーザーエージェントがまだ未実装の場合、 実質的にデフォルトのGPUCanvasToneMapping
のみをサポートすることになります。 その場合、このメンバーはGPUCanvasConfiguration
の実装に含めないべきです。 これにより 機能検出 がgetConfiguration()
で可能になります。これは、HDR機能を持つ実装(dynamic-range が high で公開される場合)では特に重要です。
もし実装がこのメンバーと
high
dynamic range を公開する場合、 キャンバスはHDR要素としてレンダリングすべきであり、HDRディスプレイのSDR範囲に値をクランプしてはなりません。 alphaMode
, 型 GPUCanvasAlphaMode, デフォルトは"opaque"
-
getCurrentTexture()
で返されるテクスチャのアルファ値が、読み取り・表示・画像ソース利用時にどのように影響するかを決定します。
GPUDevice
用にGPUCanvasContext
を設定し、
このコンテキストの推奨フォーマットを使う例:
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 に対して、以下の手順を実行します:
デバイスタイムライン の手順:
-
error を、適切なエラーメッセージ付きの新しい
GPUValidationError
とする。 -
dispatch error で error を device に送る。
[Exposed =(Window ,Worker ),SecureContext ]interface :
GPUOutOfMemoryError GPUError {(
constructor DOMString ); };
message
GPUOutOfMemoryError
は
GPUError
のサブタイプであり、
要求された操作を完了するための十分な空きメモリがなかったことを示します。より低いメモリ要件(例えば、より小さいテクスチャ寸法)で再試行したり、他のリソースが使用するメモリを先に解放することで、操作が成功する場合もあります。
GPUDevice
device に対して、以下の手順を実行します:
デバイスタイムライン の手順:
-
error を、適切なエラーメッセージ付きの新しい
GPUOutOfMemoryError
とする。 -
dispatch error で error を device に送る。
[Exposed =(Window ,Worker ),SecureContext ]interface :
GPUInternalError GPUError {(
constructor DOMString ); };
message
GPUInternalError
は
GPUError
のサブタイプであり、
操作が全てのバリデーション要件を満たしているにもかかわらず、システムや実装固有の理由で失敗したことを示します。
例えば、実装の上限値を超えた場合など、サポートされる上限で簡単に表現できないケースもあります。同じ操作でも、他のデバイスや状況下では成功する場合があります。
GPUDevice
device に対して、以下の手順を実行します:
デバイスタイムライン の手順:
-
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エラースコープ>-
GPUDevice
に push された GPUエラースコープ の スタックです。
GPUError
error と GPUDevice
device について、デバイスタイムラインに以下の手順を発行することで決定されます:
デバイスタイムラインの手順:
-
もし 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 が 失われた 状態で呼び出された場合、アプリケーションには観測されません。 § 22 エラーとデバッグ を参照してください。
-
scope を 現在のエラースコープで error と device について取得する。
-
scope が
undefined
でない場合:-
追加 error を scope.
[[errors]]
に。 -
returnする。
それ以外の場合は コンテンツタイムラインに以下の手順を発行する:
-
-
ユーザーエージェントが選択した場合、GPUDevice用のグローバルタスクをキューする deviceに対して、以下の手順を実行する:
-
GPUUncapturedErrorEvent
を "uncapturederror
" という名称で device 上で発火し、error
を error とする。
-
注: イベントをディスパッチした後、ユーザーエージェントは
開発者向けに未捕捉エラーを表示するべきです。例えば、ブラウザのデベロッパーツールの警告として表示しますが、イベントの
defaultPrevented
が true の場合は警告を抑制します。つまり preventDefault()
を呼ぶことで警告が消えます。
注: ユーザーエージェントは
GPUUncapturedErrorEvent
の発生数を制限・調整して、過剰なエラーハンドリングやロギングがパフォーマンスに影響しないようにする場合があります。
pushErrorScope(filter)
-
新しい GPUエラースコープ を
[[errorScopeStack]]
に push します(this用)。呼び出し元:GPUDevice
this.引数:
GPUDevice.pushErrorScope(filter) メソッドの引数 パラメータ 型 Nullable Optional 説明 filter
GPUErrorFilter
✘ ✘ このエラースコープが観測するエラーのクラス 戻り値:
undefined
コンテンツタイムラインの手順:
-
以降の手順を デバイスタイムライン(this)で発行する。
デバイスタイムラインの手順:-
scope を新しい GPUエラースコープとする。
-
scope.
[[filter]]
を filter に設定する。 -
push scopeを this.
[[errorScopeStack]]
に追加する。
-
popErrorScope()
-
GPUエラースコープを
[[errorScopeStack]]
からpopし、 このスコープで観測された いずれか のGPUError
を返します。エラーがない場合はnull
を返します。promise解決の順序は保証されません。
呼び出し元:GPUDevice
this.コンテンツタイムラインの手順:
-
現在の コンテンツタイムライン を contentTimeline とする。
-
promise を 新しいpromiseとする。
-
this の デバイスタイムラインに check steps を発行する。
-
promise を返す。
デバイスタイムライン check steps:-
もし this が 失われた状態なら:
-
contentTimeline で以下の手順を発行:
コンテンツタイムラインの手順:-
resolveする promise を
null
で。
-
-
returnする。
注: 失われたデバイスからはエラーは生成されません。 § 22 エラーとデバッグ を参照してください。
-
-
以下の要件が満たされない場合:
-
this.
[[errorScopeStack]]
.size が > 0 でなければならない。
以下の手順を contentTimeline で発行し、returnする:
コンテンツタイムラインの手順:-
rejectする promise を
OperationError
で。
-
-
scope を pop で this.
[[errorScopeStack]]
からアイテムを取得する。 -
error を scope.
[[errors]]
の中の いずれか のアイテムとし、なければnull
とする。エラーE1とE2があり、E2がE1によって引き起こされた場合、E2は選ばれるべきではない。
注: 例えば、E1 が
t
=createTexture()
から来ていて、 E2 がt
.createView()
から来ている場合(t
が invalid だったため)、 E1 の方が優先されるべきです。なぜなら、開発者にとって何が問題だったのか理解しやすくなるからです。 どちらもGPUValidationError
ですが、 唯一の違いはmessage
フィールドのみであり、これは人間が読むためだけのものです。 -
現時点または将来の不特定のタイミングで、contentTimeline 上で以下の手順を実行する。
注:
popErrorScope()
の呼び出しが任意の順序で、 スコープで検出された任意のエラーで解決できるようにすることで、この現行標準は、状態の観測が適切なタイミングで行われる限り、バリデーションが順不同で完了することを許容しています。 例えば、非状態入力のみに依存するシェーダーコンパイルを他のデバイスタイムラインの作業と並行してバックグラウンドスレッドで実行し、結果のエラーを後で報告することが可能になります。
コンテンツタイムライン の手順:-
解決する promise を error で。
-
GPUDevice
の操作からバリデーションエラーを捕捉するためにエラースコープを使う例:
gpuDevice. pushErrorScope( 'validation' ); let sampler= gpuDevice. createSampler({ maxAnisotropy: 0 , // 不正: maxAnisotropy は最低でも 1 でなければならない。 }); gpuDevice. popErrorScope(). then(( error) => { if ( error) { // サンプラー作成時にエラーが発生したので、破棄する。 sampler= null ; console. error( `サンプラー作成中にエラーが発生しました: ${ error. message} ` ); } });
例えば: テクスチャやバッファなど、単一リソースの作成のみを含むエラースコープは、メモリ不足などの失敗を検出するために使えます。その場合、アプリケーションは一部リソースを解放し、再度割り当てを試みることができます。
ただし、エラースコープはどのコマンドが失敗したかを特定できません。例えば、モデル読み込み中に実行される全てのコマンドを一つのエラースコープでラップした場合、そのスコープの失敗がメモリ不足によるものかどうかの粒度は十分ではありません。そのため、リソース解放による対応は通常有効な解決策とはなりません。より適切な対応として、アプリケーションが他のモデルにフォールバックするか、モデルが読み込めなかった旨の警告を出すことになります。メモリ不足への対応が必要な場合は、メモリを割り当てる操作のみをより小さな入れ子エラースコープでラップすることができます。
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
-
flat補間は影響を受けず、プロボーキング頂点(シェーダーで宣言された補間サンプリングモードで決定)に基づきます。出力値はプリミティブ全体で同じで、プロボーキング頂点の頂点出力と一致します。
- linear
-
補間比率はクリップ位置の遠近座標に応じて調整され、画面空間で線形になるように補間されます。
- 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を空リストとする。
-
クリップ済み頂点番号i(1から)について、ラスタライズポリゴンのn頂点それぞれのフレームバッファ座標をv(i)とする。
注: このセクションでは「三角形」でなく「多角形」という用語を使っています。 これは§ 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
に基づきます:- 無効
-
フラグメントはピクセル中心に関連付けられます。つまり、座標Cでfract(C) = ベクトル2(0.5, 0.5)となるフレームバッファ空間内でポリゴンに含まれる点全てが対象です。 ピクセル中心がポリゴンのエッジ上にある場合、含めるかどうかは未定義です。
注: この点はラスタライザの精度に依存します。
- 有効
-
各ピクセルはdescriptor.
multisample
.count
個の位置に関連付けられ、これらの位置は実装依存です。 位置は順序付きで、フレームバッファの各ピクセルで同一のリストとなります。各位置はマルチサンプルフレームバッファ内の1つのフラグメントに対応します。ラスタライザは、各ピクセル内でヒットした位置のマスクを構築し、フラグメントシェーダーの「sample-mask」組み込み値として提供します。
-
生成された各FragmentDestination型フラグメントについて:
-
rpを新しいRasterizationPointオブジェクトとする
-
そのフラグメントの§ 23.2.5.3 バリセントリック座標リストbを計算し、rp.barycentricCoordinatesに設定する。
-
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_index
sample_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
またはシーケンスの1番目の要素(その要素が存在することを保証)を参照します。 -
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機能および制限が利用可能になります。
注: これは現行すべてのアダプターで利用可能であり、要求しなくてもすべてのデバイスで自動的に有効化されます。
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. 深度・ステンシルテクスチャの読み取りとサンプリング
可能で、depthアスペクトの GPUTextureView
を texture_depth_*
バインディング、またはその他の非depth 2D/キューブテクスチャタイプのバインディングに結び付けることができます。
stencilアスペクトの GPUTextureView
は通常のテクスチャバインディングタイプへバインドしなければなりません。
sampleType
は GPUBindGroupLayout
内で "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を超える任意の形式を指します。
注: これらの形式それぞれのテクセルブロックのメモリコストは、 テクセルブロックのコピーのフットプリントと同じです。