@next2d/webgl 1.18.12 → 2.0.0

package/src/Context.d.ts

@@ -0,0 +1,697 @@
+import type { IAttachmentObject } from "./interface/IAttachmentObject";
+import type { IBlendMode } from "./interface/IBlendMode";
+import type { IBounds } from "./interface/IBounds";
+import type { Node } from "@next2d/texture-packer";
+/**
+ * @description WebGL版、Next2Dのコンテキスト
+ *              WebGL version, Next2D context
+ *
+ * @class
+ */
+export declare class Context {
+    /**
+     * @description matrixのデータを保持するスタック
+     *              Stack to hold matrix data
+     *
+     * @type {Float32Array[]}
+     * @protected
+     */
+    readonly $stack: Float32Array[];
+    /**
+     * @description 2D変換行列
+     *              2D transformation matrix
+     *
+     * @type {Float32Array}
+     * @protected
+     */
+    readonly $matrix: Float32Array;
+    /**
+     * @description 背景色のR
+     *              Background color R
+     *
+     * @type {number}
+     * @protected
+     */
+    $clearColorR: number;
+    /**
+     * @description 背景色のG
+     *              Background color G
+     *
+     * @type {number}
+     * @protected
+     */
+    $clearColorG: number;
+    /**
+     * @description 背景色のB
+     *              Background color B
+     *
+     * @type {number}
+     * @protected
+     */
+    $clearColorB: number;
+    /**
+     * @description 背景色のA
+     *              Background color A
+     *
+     * @type {number}
+     * @protected
+     */
+    $clearColorA: number;
+    /**
+     * @description メインのアタッチメントオブジェクト
+     *              Main attachment object
+     *
+     * @type {IAttachmentObject}
+     * @protected
+     */
+    $mainAttachmentObject: IAttachmentObject | null;
+    /**
+     * @description アタッチメントオブジェクトを保持するスタック
+     *             Stack to hold attachment objects
+     *
+     * @type {IAttachmentObject[]}
+     * @protected
+     */
+    readonly $stackAttachmentObject: IAttachmentObject[];
+    /**
+     * @description グローバルアルファ
+     *              Global alpha
+     *
+     * @type {number}
+     * @default 1
+     * @public
+     */
+    globalAlpha: number;
+    /**
+     * @description 合成モード
+     *              composite mode
+     *
+     * @type {IBlendMode}
+     * @default "normal"
+     * @public
+     */
+    globalCompositeOperation: IBlendMode;
+    /**
+     * @description イメージのスムージング設定
+     *              Image smoothing setting
+     *
+     * @type {boolean}
+     * @default false
+     * @public
+     */
+    imageSmoothingEnabled: boolean;
+    /**
+     * @description 塗りつぶしのRGBAを保持するFloat32Array
+     *              Float32Array that holds the RGBA of the fill
+     *
+     * @type {Float32Array}
+     * @protected
+     */
+    $fillStyle: Float32Array;
+    /**
+     * @description 線のRGBAを保持するFloat32Array
+     *              Float32Array that holds the RGBA of the line
+     *
+     * @type {Float32Array}
+     * @protected
+     */
+    $strokeStyle: Float32Array;
+    /**
+     * @description マスクの描画範囲
+     *              Drawing range of the mask
+     *
+     * @type {IBounds}
+     * @protected
+     */
+    readonly maskBounds: IBounds;
+    /**
+     * @description ストロークの太さ
+     *              Stroke thickness
+     *
+     * @type {number}
+     * @default 1
+     * @public
+     */
+    thickness: number;
+    /**
+     * @description ストロークのキャップ
+     *              Stroke cap
+     *
+     * @type {number}
+     * @default 1
+     * @public
+     */
+    caps: number;
+    /**
+     * @description ストロークのジョイント
+     *              Stroke joint
+     *
+     * @type {number}
+     * @default 2
+     * @public
+     */
+    joints: number;
+    /**
+     * @description ストロークのマイターリミット
+     *              Stroke miter limit
+     *
+     * @type {number}
+     * @default 0
+     * @public
+     */
+    miterLimit: number;
+    /**
+     * @param {WebGL2RenderingContext} gl
+     * @param {number} samples
+     * @param {number} [device_pixel_ratio=1]
+     * @constructor
+     * @public
+     */
+    constructor(gl: WebGL2RenderingContext, samples: number, device_pixel_ratio?: number);
+    /**
+     * @description 転送範囲をリセット
+     *              Reset the transfer range
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    clearTransferBounds(): void;
+    /**
+     * @description 背景色を更新
+     *              Update background color
+     *
+     * @param  {number} red
+     * @param  {number} green
+     * @param  {number} blue
+     * @param  {number} alpha
+     * @return {void}
+     * @method
+     * @public
+     */
+    updateBackgroundColor(red: number, green: number, blue: number, alpha: number): void;
+    /**
+     * @description 背景色を指定カラーで塗りつぶす
+     *              Fill the background color with the specified color
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    fillBackgroundColor(): void;
+    /**
+     * @description メインcanvasのサイズを変更
+     *              Change the size of the main canvas
+     *
+     * @param  {number} width
+     * @param  {number} height
+     * @param  {boolean} [cache_clear=true]
+     * @return {void}
+     * @method
+     * @public
+     */
+    resize(width: number, height: number, cache_clear?: boolean): void;
+    /**
+     * @description 指定範囲をクリアする
+     *              Clear the specified range
+     *
+     * @param  {number} x
+     * @param  {number} y
+     * @param  {number} w
+     * @param  {number} h
+     * @return {void}
+     * @method
+     * @purotected
+     */
+    clearRect(x: number, y: number, w: number, h: number): void;
+    /**
+     * @description アタッチメントオブジェクトをバインド
+     *              Bind the attachment object
+     *
+     * @param {IAttachmentObject} attachment_object
+     * @return {void}
+     * @method
+     * @public
+     */
+    bind(attachment_object: IAttachmentObject): void;
+    /**
+     * @description 現在の2D変換行列を保存
+     *             Save the current 2D transformation matrix
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    save(): void;
+    /**
+     * @description 2D変換行列を復元
+     *              Restore 2D transformation matrix
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    restore(): void;
+    /**
+     * @description 2D変換行列を設定
+     *              Set 2D transformation matrix
+     *
+     * @param  {number} a
+     * @param  {number} b
+     * @param  {number} c
+     * @param  {number} d
+     * @param  {number} e
+     * @param  {number} f
+     * @return {void}
+     * @method
+     * @public
+     */
+    setTransform(a: number, b: number, c: number, d: number, e: number, f: number): void;
+    /**
+     * @description 現在の2D変換行列に対して乗算を行います。
+     *              Multiply the current 2D transformation matrix.
+     *
+     * @param  {number} a
+     * @param  {number} b
+     * @param  {number} c
+     * @param  {number} d
+     * @param  {number} e
+     * @param  {number} f
+     * @return {void}
+     * @method
+     * @public
+     */
+    transform(a: number, b: number, c: number, d: number, e: number, f: number): void;
+    /**
+     * @description コンテキストの値を初期化する
+     *              Initialize the values of the context
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    reset(): void;
+    /**
+     * @description パスを開始
+     *              Start the path
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    beginPath(): void;
+    /**
+     * @description パスを移動
+     *              Move the path
+     *
+     * @param  {number} x
+     * @param  {number} y
+     * @return {void}
+     * @method
+     * @public
+     */
+    moveTo(x: number, y: number): void;
+    /**
+     * @description パスを線で結ぶ
+     *              Connect the path with a line
+     *
+     * @param  {number} x
+     * @param  {number} y
+     * @return {void}
+     * @method
+     * @public
+     */
+    lineTo(x: number, y: number): void;
+    /**
+     * @description 二次ベジェ曲線を描画
+     *              Draw a quadratic Bezier curve
+     *
+     * @param  {number} cx
+     * @param  {number} cy
+     * @param  {number} x
+     * @param  {number} y
+     * @return {void}
+     * @method
+     * @public
+     */
+    quadraticCurveTo(cx: number, cy: number, x: number, y: number): void;
+    /**
+     * @description 塗りつぶしスタイルを設定
+     *              Set fill style
+     *
+     * @param  {number} red
+     * @param  {number} green
+     * @param  {number} blue
+     * @param  {number} alpha
+     * @return {void}
+     * @method
+     * @public
+     */
+    fillStyle(red: number, green: number, blue: number, alpha: number): void;
+    /**
+     * @description 線のスタイルを設定
+     *              Set line style
+     *
+     * @param  {number} red
+     * @param  {number} green
+     * @param  {number} blue
+     * @param  {number} alpha
+     * @return {void}
+     * @method
+     * @public
+     */
+    strokeStyle(red: number, green: number, blue: number, alpha: number): void;
+    /**
+     * @description パスを閉じる
+     *              Close the path
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    closePath(): void;
+    /**
+     * @description 円弧を描画
+     *              Draw an arc
+     *
+     * @param {number} x
+     * @param {number} y
+     * @param {number} radius
+     * @return {void}
+     * @method
+     * @public
+     */
+    arc(x: number, y: number, radius: number): void;
+    /**
+     * @description 3次ベジェ曲線を描画
+     *              Draw a cubic Bezier curve
+     *
+     * @param  {number} cx1
+     * @param  {number} cy1
+     * @param  {number} cx2
+     * @param  {number} cy2
+     * @param  {number} x
+     * @param  {number} y
+     * @return {void}
+     * @method
+     * @public
+     */
+    bezierCurveTo(cx1: number, cy1: number, cx2: number, cy2: number, x: number, y: number): void;
+    /**
+     * @description 塗りつぶしを実行
+     *              Perform fill
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    fill(): void;
+    /**
+     * @description グラデーションの塗りつぶしを実行
+     *              Perform gradient fill
+     *
+     * @param  {number} type
+     * @param  {array} stops
+     * @param  {Float32Array} matrix
+     * @param  {number} spread
+     * @param  {number} interpolation
+     * @param  {number} focal
+     * @return {void}
+     * @method
+     * @public
+     */
+    gradientFill(type: number, stops: number[], matrix: Float32Array, spread: number, interpolation: number, focal: number): void;
+    /**
+     * @description 塗りのピクセルデータを描画
+     *              Draw pixel data of the fill
+     *
+     * @param  {Uint8Array} pixels
+     * @param  {Float32Array} matrix
+     * @param  {number} width
+     * @param  {number} height
+     * @param  {boolean} repeat
+     * @param  {boolean} smooth
+     * @return {void}
+     * @method
+     * @public
+     */
+    bitmapFill(pixels: Uint8Array, matrix: Float32Array, width: number, height: number, repeat: boolean, smooth: boolean): void;
+    /**
+     * @description 線の描画を実行
+     *              Perform line drawing
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    stroke(): void;
+    /**
+     * @description 線のグラデーションを実行
+     *              Perform gradient of the line
+     *
+     * @param  {number} type
+     * @param  {array} stops
+     * @param  {Float32Array} matrix
+     * @param  {number} spread
+     * @param  {number} interpolation
+     * @param  {number} focal
+     * @return {void}
+     * @method
+     * @public
+     */
+    gradientStroke(type: number, stops: number[], matrix: Float32Array, spread: number, interpolation: number, focal: number): void;
+    /**
+     * @description 線のピクセルデータを描画
+     *              Draw pixel data of the line
+     *
+     * @param  {Uint8Array} pixels
+     * @param  {Float32Array} matrix
+     * @param  {number} width
+     * @param  {number} height
+     * @param  {boolean} repeat
+     * @param  {boolean} smooth
+     * @return {void}
+     * @method
+     * @public
+     */
+    bitmapStroke(pixels: Uint8Array, matrix: Float32Array, width: number, height: number, repeat: boolean, smooth: boolean): void;
+    /**
+     * @description マスク処理を実行
+     *              Perform mask processing
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    clip(): void;
+    /**
+     * @description 現在のアタッチメントオブジェクトを取得
+     *              Get the current attachment object
+     *
+     * @return {IAttachmentObject | null}
+     * @readonly
+     * @public
+     */
+    get currentAttachmentObject(): IAttachmentObject | null;
+    /**
+     * @description アトラス専用のアタッチメントオブジェクトを取得
+     *              Get the attachment object for the atlas
+     *
+     * @return {IAttachmentObject}
+     * @readonly
+     * @public
+     */
+    get atlasAttachmentObject(): IAttachmentObject;
+    /**
+     * @description キャッシュするポジションのノードを作成
+     *              Create a node for the position to cache
+     *
+     * @param  {number} width
+     * @param  {number} height
+     * @return {Node}
+     * @method
+     * @public
+     */
+    createNode(width: number, height: number): Node;
+    /**
+     * @description 指定のノードを削除
+     *              Remove the specified node
+     *
+     * @param  {Node} node
+     * @return {void}
+     * @method
+     * @public
+     */
+    removeNode(node: Node): void;
+    /**
+     * @description 指定のノード範囲で描画を開始
+     *              Start drawing in the specified node range
+     *
+     * @param  {Node} node
+     * @return {void}
+     * @method
+     * @public
+     */
+    beginNodeRendering(node: Node): void;
+    /**
+     * @description 指定のノード範囲で描画を終了
+     *              End drawing in the specified node range
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    endNodeRendering(): void;
+    /**
+     * @description 塗りの描画を実行
+     *              Perform fill drawing
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    drawFill(): void;
+    /**
+     * @description インスタンスを描画
+     *              Draw an instance
+     *
+     * @param  {number} x_min
+     * @param  {number} y_min
+     * @param  {number} x_max
+     * @param  {number} y_max
+     * @param  {Float32Array} color_transform
+     * @return {void}
+     * @method
+     * @public
+     */
+    drawDisplayObject(node: Node, x_min: number, y_min: number, x_max: number, y_max: number, color_transform: Float32Array): void;
+    /**
+     * @description インスタンス配列を描画
+     *              Draw an instance array
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    drawArraysInstanced(): void;
+    /**
+     * @description インスタンス配列をクリア
+     *              Clear the instance array
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    clearArraysInstanced(): void;
+    /**
+     * @description フレームバッファの描画情報をキャンバスに転送
+     *              Transfer the drawing information of the frame buffer to the canvas
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    transferMainCanvas(): void;
+    /**
+     * @description ピクセルバッファをNodeの指定箇所に転送
+     *              Transfer the pixel buffer to the specified location of the Node
+     *
+     * @param  {Node} node
+     * @param  {Uint8Array} pixels
+     * @return {void}
+     * @method
+     * @public
+     */
+    drawPixels(node: Node, pixels: Uint8Array): void;
+    /**
+     * @description OffscreenCanvasをNodeの指定箇所に転送
+     *              Transfer the OffscreenCanvas to the specified location of the Node
+     *
+     * @param  {Node} node
+     * @param  {OffscreenCanvas | ImageBitmap} element
+     * @return {void}
+     * @method
+     * @public
+     */
+    drawElement(node: Node, element: OffscreenCanvas | ImageBitmap): void;
+    /**
+     * @description マスクを開始準備
+     *              Prepare to start drawing the mask
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    beginMask(): void;
+    /**
+     * @description マスクの描画を開始
+     *              Start drawing the mask
+     *
+     * @param  {number} x_min
+     * @param  {number} y_min
+     * @param  {number} x_max
+     * @param  {number} y_max
+     * @return {void}
+     * @method
+     * @public
+     */
+    setMaskBounds(x_min: number, y_min: number, x_max: number, y_max: number): void;
+    /**
+     * @description マスクの描画を終了
+     *              End mask drawing
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    endMask(): void;
+    /**
+     * @description マスクの終了処理
+     *              Mask end processing
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    leaveMask(): void;
+    /**
+     * @description グリッドの描画データをセット
+     *              Set the grid drawing data
+     *
+     * @param  {Float32Array} grid_data
+     * @return {void}
+     * @method
+     * @public
+     */
+    useGrid(grid_data: Float32Array | null): void;
+    /**
+     * @description フィルターを適用
+     *              Apply the filter
+     *
+     * @param  {Node} node
+     * @param  {string} unique_key
+     * @param  {boolean} updated
+     * @param  {number} width
+     * @param  {number} height
+     * @param  {Float32Array} matrix
+     * @param  {Float32Array} color_transform
+     * @param  {IBlendMode} blend_mode
+     * @param  {Float32Array} bounds
+     * @param  {Float32Array} params
+     * @return {void}
+     * @method
+     * @public
+     */
+    applyFilter(node: Node, unique_key: string, updated: boolean, width: number, height: number, is_bitmap: boolean, matrix: Float32Array, color_transform: Float32Array, blend_mode: IBlendMode, bounds: Float32Array, params: Float32Array): void;
+    /**
+     * @description 現在のメインのframe bufferからImageBitmapを生成
+     *              Generate an ImageBitmap from the current main frame buffer
+     *
+     * @param  {number} width
+     * @param  {number} height
+     * @return {Promise<ImageBitmap>}
+     * @method
+     * @public
+     */
+    createImageBitmap(width: number, height: number): Promise<ImageBitmap>;
+}