@next2d/webgpu 3.0.5 → 3.1.0

package/src/WebGPUUtil.d.ts

@@ -4,99 +4,144 @@
  *
  * @type {number}
  * @default 4
- * @protected
- *
- * @note WebGL版と同じくMSAA 4xをデフォルトで有効化
- *       曲線のアンチエイリアス品質向上のため
  */
-export declare let $samples: number;
+export declare const $samples: number;
 /**
- * @description 描画のサンプリング数を変更
- *              Change the number of samples for drawing
- *
- * @param  {number} samples
- * @return {void}
- * @method
- * @protected
+ * @description WebGPU描画ユーティリティクラス
+ *              Utility class for WebGPU rendering operations
  */
-export declare const $setSamples: (samples: number) => void;
 export declare class WebGPUUtil {
+    /**
+     * @description GPUデバイスインスタンス
+     *              GPU device instance
+     *
+     * @type {GPUDevice | null}
+     */
     private static device;
+    /**
+     * @description デバイスピクセル比率
+     *              Device pixel ratio for high-DPI rendering
+     *
+     * @type {number}
+     */
     private static devicePixelRatio;
+    /**
+     * @description レンダリング最大サイズ（テクスチャアトラス用）
+     *              Maximum render size for texture atlas
+     *
+     * @type {number}
+     */
     private static renderMaxSize;
+    /**
+     * @description Float32Array(4) のオブジェクトプール
+     *              Object pool for Float32Array(4) instances
+     *
+     * @type {Float32Array[]}
+     */
     private static float32Array4Pool;
     /**
-     * @description Set GPUDevice
-     * @param {GPUDevice} gpu_device
+     * @description GPUデバイスを設定する
+     *              Set the GPUDevice instance
+     *
+     * @param {GPUDevice} gpu_device - GPUデバイス / GPU device
      * @return {void}
      */
     static setDevice(gpu_device: GPUDevice): void;
     /**
-     * @description Get GPUDevice
+     * @description GPUデバイスを取得する
+     *              Get the GPUDevice instance
+     *
      * @return {GPUDevice}
      */
     static getDevice(): GPUDevice;
     /**
-     * @description Set device pixel ratio
-     * @param {number} ratio
+     * @description デバイスピクセル比率を設定する
+     *              Set the device pixel ratio
+     *
+     * @param {number} ratio - ピクセル比率 / pixel ratio
      * @return {void}
      */
     static setDevicePixelRatio(ratio: number): void;
     /**
-     * @description Get device pixel ratio
+     * @description デバイスピクセル比率を取得する
+     *              Get the device pixel ratio
+     *
      * @return {number}
      */
     static getDevicePixelRatio(): number;
     /**
-     * @description Set render max size
-     * @param {number} size
+     * @description レンダリング最大サイズを設定する
+     *              Set the maximum render size
+     *
+     * @param {number} size - 最大サイズ / maximum size in pixels
      * @return {void}
      */
     static setRenderMaxSize(size: number): void;
     /**
-     * @description Get render max size (for atlas)
+     * @description レンダリング最大サイズを取得する（アトラス用）
+     *              Get the maximum render size (for texture atlas)
+     *
      * @return {number}
      */
     static getRenderMaxSize(): number;
     /**
-     * @description Create Float32Array
-     * @param {number} length
+     * @description 指定長のFloat32Arrayを生成する
+     *              Create a new Float32Array with the specified length
+     *
+     * @param {number} length - 配列の長さ / array length
      * @return {Float32Array}
      */
     static createFloat32Array(length: number): Float32Array;
     /**
-     * @description Create generic array
-     * @return {Array}
+     * @description 汎用の空配列を生成する
+     *              Create a new empty generic array
+     *
+     * @return {T[]}
      */
     static createArray<T>(): T[];
     /**
-     * @description Get Float32Array(4) from pool
+     * @description Float32Array(4) をプールから取得する（なければ新規作成）
+     *              Get a Float32Array(4) from the pool, or create a new one
+     *
      * @return {Float32Array}
      */
     static getFloat32Array4(): Float32Array;
     /**
-     * @description Return Float32Array(4) to pool
-     * @param {Float32Array} array
+     * @description Float32Array(4) をプールに返却する
+     *              Return a Float32Array(4) to the pool for reuse
+     *
+     * @param {Float32Array} array - 返却する配列 / array to return
      * @return {void}
      */
     static poolFloat32Array4(array: Float32Array): void;
 }
 /**
  * @description グローバルコンテキスト（WebGLUtilの$contextに相当）
+ *              Global context instance (equivalent to $context in WebGLUtil)
+ *
+ * @type {any}
  */
 export declare let $context: any;
 /**
- * @description コンテキストを設定
- * @param {any} context
+ * @description グローバルコンテキストを設定する
+ *              Set the global context instance
+ *
+ * @param {any} context - コンテキスト / context instance
+ * @return {void}
  */
 export declare const $setContext: (context: any) => void;
 /**
- * @description Float32Array(4) をプールから取得
+ * @description Float32Array(4) をプールから取得する
+ *              Get a Float32Array(4) from the pool
+ *
  * @return {Float32Array}
  */
 export declare const $getFloat32Array4: () => Float32Array;
 /**
- * @description Float32Array(4) をプールに返却
- * @param {Float32Array} array
+ * @description Float32Array(4) をプールに返却する
+ *              Return a Float32Array(4) to the pool
+ *
+ * @param {Float32Array} array - 返却する配列 / array to return
+ * @return {void}
  */
 export declare const $poolFloat32Array4: (array: Float32Array) => void;

package/src/WebGPUUtil.js

@@ -4,35 +4,27 @@
  *
  * @type {number}
  * @default 4
- * @protected
- *
- * @note WebGL版と同じくMSAA 4xをデフォルトで有効化
- *       曲線のアンチエイリアス品質向上のため
  */
-export let $samples = 4;
+export const $samples = 4;
 /**
- * @description 描画のサンプリング数を変更
- *              Change the number of samples for drawing
- *
- * @param  {number} samples
- * @return {void}
- * @method
- * @protected
+ * @description WebGPU描画ユーティリティクラス
+ *              Utility class for WebGPU rendering operations
  */
-export const $setSamples = (samples) => {
-    $samples = samples;
-};
 export class WebGPUUtil {
     /**
-     * @description Set GPUDevice
-     * @param {GPUDevice} gpu_device
+     * @description GPUデバイスを設定する
+     *              Set the GPUDevice instance
+     *
+     * @param {GPUDevice} gpu_device - GPUデバイス / GPU device
      * @return {void}
      */
     static setDevice(gpu_device) {
         WebGPUUtil.device = gpu_device;
     }
     /**
-     * @description Get GPUDevice
+     * @description GPUデバイスを取得する
+     *              Get the GPUDevice instance
+     *
      * @return {GPUDevice}
      */
     static getDevice() {
@@ -42,52 +34,66 @@ export class WebGPUUtil {
         return WebGPUUtil.device;
     }
     /**
-     * @description Set device pixel ratio
-     * @param {number} ratio
+     * @description デバイスピクセル比率を設定する
+     *              Set the device pixel ratio
+     *
+     * @param {number} ratio - ピクセル比率 / pixel ratio
      * @return {void}
      */
     static setDevicePixelRatio(ratio) {
         WebGPUUtil.devicePixelRatio = ratio;
     }
     /**
-     * @description Get device pixel ratio
+     * @description デバイスピクセル比率を取得する
+     *              Get the device pixel ratio
+     *
      * @return {number}
      */
     static getDevicePixelRatio() {
         return WebGPUUtil.devicePixelRatio;
     }
     /**
-     * @description Set render max size
-     * @param {number} size
+     * @description レンダリング最大サイズを設定する
+     *              Set the maximum render size
+     *
+     * @param {number} size - 最大サイズ / maximum size in pixels
      * @return {void}
      */
     static setRenderMaxSize(size) {
         WebGPUUtil.renderMaxSize = size;
     }
     /**
-     * @description Get render max size (for atlas)
+     * @description レンダリング最大サイズを取得する（アトラス用）
+     *              Get the maximum render size (for texture atlas)
+     *
      * @return {number}
      */
     static getRenderMaxSize() {
         return WebGPUUtil.renderMaxSize;
     }
     /**
-     * @description Create Float32Array
-     * @param {number} length
+     * @description 指定長のFloat32Arrayを生成する
+     *              Create a new Float32Array with the specified length
+     *
+     * @param {number} length - 配列の長さ / array length
      * @return {Float32Array}
      */
     static createFloat32Array(length) {
         return new Float32Array(length);
     }
     /**
-     * @description Create generic array
-     * @return {Array}
+     * @description 汎用の空配列を生成する
+     *              Create a new empty generic array
+     *
+     * @return {T[]}
      */
     static createArray() {
         return [];
     }
     /**
-     * @description Get Float32Array(4) from pool
+     * @description Float32Array(4) をプールから取得する（なければ新規作成）
+     *              Get a Float32Array(4) from the pool, or create a new one
+     *
      * @return {Float32Array}
      */
     static getFloat32Array4() {
@@ -96,8 +102,10 @@ export class WebGPUUtil {
             : new Float32Array(4);
     }
     /**
-     * @description Return Float32Array(4) to pool
-     * @param {Float32Array} array
+     * @description Float32Array(4) をプールに返却する
+     *              Return a Float32Array(4) to the pool for reuse
+     *
+     * @param {Float32Array} array - 返却する配列 / array to return
      * @return {void}
      */
     static poolFloat32Array4(array) {
@@ -106,24 +114,48 @@ export class WebGPUUtil {
         }
     }
 }
+/**
+ * @description GPUデバイスインスタンス
+ *              GPU device instance
+ *
+ * @type {GPUDevice | null}
+ */
 Object.defineProperty(WebGPUUtil, "device", {
     enumerable: true,
     configurable: true,
     writable: true,
     value: null
 });
+/**
+ * @description デバイスピクセル比率
+ *              Device pixel ratio for high-DPI rendering
+ *
+ * @type {number}
+ */
 Object.defineProperty(WebGPUUtil, "devicePixelRatio", {
     enumerable: true,
     configurable: true,
     writable: true,
     value: 1
 });
+/**
+ * @description レンダリング最大サイズ（テクスチャアトラス用）
+ *              Maximum render size for texture atlas
+ *
+ * @type {number}
+ */
 Object.defineProperty(WebGPUUtil, "renderMaxSize", {
     enumerable: true,
     configurable: true,
     writable: true,
     value: 8192
 });
+/**
+ * @description Float32Array(4) のオブジェクトプール
+ *              Object pool for Float32Array(4) instances
+ *
+ * @type {Float32Array[]}
+ */
 Object.defineProperty(WebGPUUtil, "float32Array4Pool", {
     enumerable: true,
     configurable: true,
@@ -132,25 +164,36 @@ Object.defineProperty(WebGPUUtil, "float32Array4Pool", {
 });
 /**
  * @description グローバルコンテキスト（WebGLUtilの$contextに相当）
+ *              Global context instance (equivalent to $context in WebGLUtil)
+ *
+ * @type {any}
  */
 export let $context = null;
 /**
- * @description コンテキストを設定
- * @param {any} context
+ * @description グローバルコンテキストを設定する
+ *              Set the global context instance
+ *
+ * @param {any} context - コンテキスト / context instance
+ * @return {void}
  */
 export const $setContext = (context) => {
     $context = context;
 };
 /**
- * @description Float32Array(4) をプールから取得
+ * @description Float32Array(4) をプールから取得する
+ *              Get a Float32Array(4) from the pool
+ *
  * @return {Float32Array}
  */
 export const $getFloat32Array4 = () => {
     return WebGPUUtil.getFloat32Array4();
 };
 /**
- * @description Float32Array(4) をプールに返却
- * @param {Float32Array} array
+ * @description Float32Array(4) をプールに返却する
+ *              Return a Float32Array(4) to the pool
+ *
+ * @param {Float32Array} array - 返却する配列 / array to return
+ * @return {void}
  */
 export const $poolFloat32Array4 = (array) => {
     WebGPUUtil.poolFloat32Array4(array);

package/src/interface/IAttachmentObject.d.ts

@@ -9,14 +9,50 @@ import type { IStencilBufferObject } from "./IStencilBufferObject";
  * 同じように扱うことができます。
  */
 export interface IAttachmentObject {
+    /**
+     * @description アタッチメントの一意な識別子
+     *              Unique identifier for the attachment
+     */
     id: number;
+    /**
+     * @description アタッチメントの幅（ピクセル）
+     *              Width of the attachment in pixels
+     */
     width: number;
+    /**
+     * @description アタッチメントの高さ（ピクセル）
+     *              Height of the attachment in pixels
+     */
     height: number;
+    /**
+     * @description 現在のクリップ（マスク）ネストレベル
+     *              Current clip (mask) nesting level
+     */
     clipLevel: number;
+    /**
+     * @description MSAAが有効かどうか
+     *              Whether MSAA is enabled
+     */
     msaa: boolean;
+    /**
+     * @description マスクモードが有効かどうか
+     *              Whether mask mode is enabled
+     */
     mask: boolean;
+    /**
+     * @description カラーバッファオブジェクト
+     *              Color buffer object
+     */
     color: IColorBufferObject | null;
+    /**
+     * @description テクスチャオブジェクト
+     *              Texture object
+     */
     texture: ITextureObject | null;
+    /**
+     * @description ステンシルバッファオブジェクト
+     *              Stencil buffer object
+     */
     stencil: IStencilBufferObject | null;
     /**
      * @description MSAAテクスチャ（sampleCount > 1 の場合に使用）

package/src/interface/IBlendMode.d.ts

@@ -1 +1,8 @@
+/**
+ * @description ブレンドモードの型定義
+ *              Blend mode type definition
+ *
+ * 描画オブジェクトに適用可能なブレンドモードを定義します。
+ * Defines the blend modes that can be applied to display objects.
+ */
 export type IBlendMode = "normal" | "layer" | "multiply" | "screen" | "lighten" | "darken" | "difference" | "add" | "subtract" | "invert" | "alpha" | "erase" | "overlay" | "hardlight" | "copy";

package/src/interface/IBlendState.d.ts

@@ -3,6 +3,14 @@
  *              WebGPU blend state definitions
  */
 export interface IBlendState {
+    /**
+     * @description カラーチャンネルのブレンド設定
+     *              Blend component configuration for the color channel
+     */
     color: GPUBlendComponent;
+    /**
+     * @description アルファチャンネルのブレンド設定
+     *              Blend component configuration for the alpha channel
+     */
     alpha: GPUBlendComponent;
 }

package/src/interface/IBounds.d.ts

@@ -1,6 +1,29 @@
+/**
+ * @description バウンディングボックスのインターフェース
+ *              Bounding box interface
+ *
+ * 描画オブジェクトの矩形領域を最小・最大座標で定義します。
+ * Defines a rectangular area of a display object using min/max coordinates.
+ */
 export interface IBounds {
+    /**
+     * @description X軸の最小値
+     *              Minimum value on the X axis
+     */
     xMin: number;
+    /**
+     * @description Y軸の最小値
+     *              Minimum value on the Y axis
+     */
     yMin: number;
+    /**
+     * @description X軸の最大値
+     *              Maximum value on the X axis
+     */
     xMax: number;
+    /**
+     * @description Y軸の最大値
+     *              Maximum value on the Y axis
+     */
     yMax: number;
 }

package/src/interface/IColorBufferObject.d.ts

@@ -7,11 +7,39 @@ import type { IStencilBufferObject } from "./IStencilBufferObject";
  * リソースはGPUTextureを使用します。
  */
 export interface IColorBufferObject {
+    /**
+     * @description GPUテクスチャリソース
+     *              GPU texture resource
+     */
     resource: GPUTexture;
+    /**
+     * @description テクスチャビュー（レンダーパスへのアタッチ用）
+     *              Texture view for attaching to render passes
+     */
     view: GPUTextureView;
+    /**
+     * @description 対応するステンシルバッファオブジェクト
+     *              Associated stencil buffer object
+     */
     stencil: IStencilBufferObject;
+    /**
+     * @description カラーバッファの幅（ピクセル）
+     *              Width of the color buffer in pixels
+     */
     width: number;
+    /**
+     * @description カラーバッファの高さ（ピクセル）
+     *              Height of the color buffer in pixels
+     */
     height: number;
+    /**
+     * @description バッファの面積（width × height）
+     *              Area of the buffer (width × height)
+     */
     area: number;
+    /**
+     * @description バッファが変更されたかどうか
+     *              Whether the buffer has been modified
+     */
     dirty: boolean;
 }

package/src/interface/IComplexBlendItem.d.ts

@@ -4,16 +4,64 @@ import type { Node } from "@next2d/texture-packer";
  *              Complex blend mode rendering queue
  */
 export interface IComplexBlendItem {
+    /**
+     * @description テクスチャアトラスのノード
+     *              Texture atlas node
+     */
     node: Node;
+    /**
+     * @description 描画領域のX最小座標
+     *              Minimum X coordinate of the rendering area
+     */
     x_min: number;
+    /**
+     * @description 描画領域のY最小座標
+     *              Minimum Y coordinate of the rendering area
+     */
     y_min: number;
+    /**
+     * @description 描画領域のX最大座標
+     *              Maximum X coordinate of the rendering area
+     */
     x_max: number;
+    /**
+     * @description 描画領域のY最大座標
+     *              Maximum Y coordinate of the rendering area
+     */
     y_max: number;
+    /**
+     * @description カラー変換配列
+     *              Color transform array
+     */
     color_transform: Float32Array;
+    /**
+     * @description 変換行列
+     *              Transformation matrix
+     */
     matrix: Float32Array;
+    /**
+     * @description ブレンドモード名
+     *              Blend mode name
+     */
     blend_mode: string;
+    /**
+     * @description ビューポートの幅
+     *              Viewport width
+     */
     viewport_width: number;
+    /**
+     * @description ビューポートの高さ
+     *              Viewport height
+     */
     viewport_height: number;
+    /**
+     * @description レンダリング最大サイズ
+     *              Maximum render size
+     */
     render_max_size: number;
+    /**
+     * @description グローバル透明度
+     *              Global alpha transparency
+     */
     global_alpha: number;
 }

package/src/interface/IFilterConfig.d.ts

@@ -1,29 +1,55 @@
 import type { IAttachmentObject } from "./IAttachmentObject";
-import type { ComputePipelineManager } from "../Compute/ComputePipelineManager";
 /**
  * @description フィルター処理の共通設定
  *              Common filter processing configuration
  */
 export interface IFilterConfig {
+    /**
+     * @description GPUデバイス
+     *              GPU device instance
+     */
     device: GPUDevice;
+    /**
+     * @description GPUコマンドエンコーダー
+     *              GPU command encoder
+     */
     commandEncoder: GPUCommandEncoder;
+    /**
+     * @description ユニフォームバッファの管理インターフェース
+     *              Uniform buffer management interface
+     */
     bufferManager?: {
         acquireUniformBuffer(requiredSize: number): GPUBuffer;
         acquireAndWriteUniformBuffer(data: Float32Array, byteLength?: number): GPUBuffer;
     };
+    /**
+     * @description フレームバッファの管理インターフェース
+     *              Frame buffer management interface
+     */
     frameBufferManager: {
         createTemporaryAttachment(width: number, height: number): IAttachmentObject;
         releaseTemporaryAttachment(attachment: IAttachmentObject): void;
         createRenderPassDescriptor(view: GPUTextureView, r: number, g: number, b: number, a: number, loadOp: GPULoadOp): GPURenderPassDescriptor;
     };
+    /**
+     * @description パイプラインの管理インターフェース
+     *              Pipeline management interface
+     */
     pipelineManager: {
         getPipeline(name: string): GPURenderPipeline | undefined;
         getFilterPipeline(baseName: string, constants: Record<string, number>): GPURenderPipeline | undefined;
         getBindGroupLayout(name: string): GPUBindGroupLayout | undefined;
     };
+    /**
+     * @description テクスチャの管理インターフェース
+     *              Texture management interface
+     */
     textureManager: {
         createSampler(name: string, smooth: boolean): GPUSampler;
     };
-    computePipelineManager?: ComputePipelineManager;
+    /**
+     * @description フレームテクスチャの配列
+     *              Array of frame textures
+     */
     frameTextures: GPUTexture[];
 }