@next2d/player 1.14.6 → 1.14.8

package/dist/player/next2d/filters/ConvolutionFilter.js

@@ -0,0 +1,375 @@
+import { BitmapFilter } from "./BitmapFilter";
+import { $Array, $clamp, $getArray, $poolArray, $toColorInt, $intToR, $intToG, $intToB } from "../../util/RenderUtil";
+/**
+ * ConvolutionFilter クラスを使用すると、マトリックス畳み込みフィルター効果を適用できます。
+ * 畳み込みでは、入力イメージ内のピクセルを、隣接するピクセルと組み合わせて、イメージを作成します。
+ * 畳み込みを使用すると、ぼかし、エッジ検出、シャープ、エンボス、ベベルなど、幅広いイメージ効果を実現できます。
+ *
+ * The ConvolutionFilter class applies a matrix convolution filter effect.
+ * A convolution combines pixels in the input image with neighboring pixels to produce an image.
+ * A wide variety of image effects can be achieved through convolutions, including blurring,
+ * edge detection, sharpening, embossing, and beveling.
+ *
+ * @class
+ * @memberOf next2d.filters
+ * @extends  BitmapFilter
+ */
+export class ConvolutionFilter extends BitmapFilter {
+    _$matrixX;
+    _$matrixY;
+    _$matrix;
+    _$divisor;
+    _$bias;
+    _$preserveAlpha;
+    _$clamp;
+    _$color;
+    _$alpha;
+    /**
+     * @param {number}  [matrix_x=0]
+     * @param {number}  [matrix_y=0]
+     * @param {array}   [matrix=null]
+     * @param {number}  [divisor=1.0]
+     * @param {number}  [bias=0.0]
+     * @param {boolean} [preserve_alpha=true]
+     * @param {boolean} [clamp=true]
+     * @param {number}  [color=0]
+     * @param {number}  [alpha=0.0]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(matrix_x = 0, matrix_y = 0, matrix = null, divisor = 1, bias = 0, preserve_alpha = true, clamp = true, color = 0, alpha = 0) {
+        super();
+        /**
+         * @type {number}
+         * @default 0
+         * @private
+         */
+        this._$matrixX = 0;
+        /**
+         * @type {number}
+         * @default 0
+         * @private
+         */
+        this._$matrixY = 0;
+        /**
+         * @type {array}
+         * @default null
+         * @private
+         */
+        this._$matrix = null;
+        /**
+         * @type {number}
+         * @default 1
+         * @private
+         */
+        this._$divisor = 1;
+        /**
+         * @type {number}
+         * @default 0
+         * @private
+         */
+        this._$bias = 0;
+        /**
+         * @type {boolean}
+         * @default true
+         * @private
+         */
+        this._$preserveAlpha = true;
+        /**
+         * @type {boolean}
+         * @default true
+         * @private
+         */
+        this._$clamp = true;
+        /**
+         * @type {number}
+         * @default 0
+         * @private
+         */
+        this._$color = 0;
+        /**
+         * @type {number}
+         * @default 0
+         * @private
+         */
+        this._$alpha = 0;
+        // setup
+        this.matrixX = matrix_x;
+        this.matrixY = matrix_y;
+        this.matrix = matrix;
+        this.divisor = divisor;
+        this.bias = bias;
+        this.preserveAlpha = preserve_alpha;
+        this.clamp = clamp;
+        this.color = color;
+        this.alpha = alpha;
+    }
+    /**
+     * @description 指定されたクラスのストリングを返します。
+     *              Returns the string representation of the specified class.
+     *
+     * @return  {string}
+     * @default [class ConvolutionFilter]
+     * @method
+     * @static
+     */
+    static toString() {
+        return "[class ConvolutionFilter]";
+    }
+    /**
+     * @description 指定されたクラスの空間名を返します。
+     *              Returns the space name of the specified class.
+     *
+     * @return  {string}
+     * @default next2d.filters.ConvolutionFilter
+     * @const
+     * @static
+     */
+    static get namespace() {
+        return "next2d.filters.ConvolutionFilter";
+    }
+    /**
+     * @description 指定されたオブジェクトのストリングを返します。
+     *              Returns the string representation of the specified object.
+     *
+     * @return  {string}
+     * @default [object ConvolutionFilter]
+     * @method
+     * @public
+     */
+    toString() {
+        return "[object ConvolutionFilter]";
+    }
+    /**
+     * @description 指定されたオブジェクトの空間名を返します。
+     *              Returns the space name of the specified object.
+     *
+     * @return  {string}
+     * @default next2d.filters.ConvolutionFilter
+     * @const
+     * @public
+     */
+    get namespace() {
+        return "next2d.filters.ConvolutionFilter";
+    }
+    /**
+     * @description アルファ透明度の値です。
+     *              The alpha transparency value for the color.
+     *
+     * @member  {number}
+     * @default 4
+     * @public
+     */
+    get alpha() {
+        return this._$alpha;
+    }
+    set alpha(alpha) {
+        alpha = $clamp(+alpha, 0, 1, 0);
+        if (alpha !== this._$alpha) {
+            this._$alpha = alpha;
+            this._$doChanged();
+        }
+    }
+    /**
+     * @description マトリックス変換の結果に加算するバイアス量です。
+     *              The amount of bias to add to the result of the matrix transformation.
+     *
+     * @member  {number}
+     * @default 0
+     * @public
+     */
+    get bias() {
+        return this._$bias;
+    }
+    set bias(bias) {
+        if (bias !== this._$bias) {
+            this._$bias = bias | 0;
+            this._$doChanged();
+        }
+    }
+    /**
+     * @description イメージをクランプする必要があるかどうかを示します。
+     *              Indicates whether the image should be clamped.
+     *
+     * @member  {boolean}
+     * @default true
+     * @public
+     */
+    get clamp() {
+        return this._$clamp;
+    }
+    set clamp(clamp) {
+        if (clamp !== this._$clamp) {
+            this._$clamp = !!clamp;
+            this._$doChanged();
+        }
+    }
+    /**
+     * @description ソースイメージの外にあるピクセルを置換する 16 進数のカラー値です。
+     *              The hexadecimal color to substitute for pixels that are off the source image.
+     *
+     * @member  {number}
+     * @default 0
+     * @public
+     */
+    get color() {
+        return this._$color;
+    }
+    set color(color) {
+        color = $clamp($toColorInt(color), 0, 0xffffff, 0);
+        if (color !== this._$color) {
+            this._$color = color;
+            this._$doChanged();
+        }
+    }
+    /**
+     * @description マトリックス変換中に使用する除数です。
+     *              The divisor used during matrix transformation.
+     *
+     * @member  {number}
+     * @default 1
+     * @public
+     */
+    get divisor() {
+        return this._$divisor;
+    }
+    set divisor(divisor) {
+        if (divisor !== this._$divisor) {
+            this._$divisor = divisor | 0;
+            this._$doChanged();
+        }
+    }
+    /**
+     * @description マトリックス変換に使用する値の配列です。
+     *              An array of values used for matrix transformation.
+     *
+     * @member  {array}
+     * @default null
+     * @public
+     */
+    get matrix() {
+        return this._$matrix;
+    }
+    set matrix(matrix) {
+        if ($Array.isArray(this._$matrix)) {
+            $poolArray(this._$matrix);
+        }
+        // default
+        this._$matrix = $Array.isArray(matrix) ? matrix : null;
+        this._$doChanged();
+    }
+    /**
+     * @description マトリックスの x 次元 (マトリックスの列数) です。
+     *              The x dimension of the matrix (the number of columns in the matrix).
+     *
+     * @member  {number}
+     * @default 0
+     * @public
+     */
+    get matrixX() {
+        return this._$matrixX;
+    }
+    set matrixX(matrix_x) {
+        matrix_x = $clamp(matrix_x | 0, 0, 15, 0) | 0;
+        if (matrix_x !== this._$matrixX) {
+            this._$matrixX = matrix_x;
+            this._$doChanged();
+        }
+    }
+    /**
+     * @description マトリックスの y 次元（マトリックスの行数）です。
+     *              The y dimension of the matrix (the number of rows in the matrix).
+     *
+     * @member  {number}
+     * @default 0
+     * @public
+     */
+    get matrixY() {
+        return this._$matrixY;
+    }
+    set matrixY(matrix_y) {
+        matrix_y = $clamp(matrix_y | 0, 0, 15, 0) | 0;
+        if (matrix_y !== this._$matrixY) {
+            this._$matrixY = matrix_y;
+            this._$doChanged();
+        }
+    }
+    /**
+     * @description アルファチャンネルがフィルター効果なしで維持されるかどうか、またはカラーチャンネルだけではなく
+     *              アルファチャンネルにも畳み込みフィルターが適用されるかどうかを示します。
+     *              Indicates if the alpha channel is preserved without the filter effect or
+     *              if the convolution filter is applied to the alpha channel as well as the color channels.
+     *
+     * @member  {boolean}
+     * @default true
+     * @public
+     */
+    get preserveAlpha() {
+        return this._$preserveAlpha;
+    }
+    set preserveAlpha(preserve_alpha) {
+        if (preserve_alpha !== this._$preserveAlpha) {
+            this._$preserveAlpha = !!preserve_alpha;
+            this._$doChanged();
+        }
+    }
+    /**
+     * @description オブジェクトのコピーを返します。
+     *              Returns a copy of this filter object.
+     *
+     * @return {ConvolutionFilter}
+     * @method
+     * @public
+     */
+    clone() {
+        return new ConvolutionFilter(this._$matrixX, this._$matrixY, this._$matrix ? this._$matrix.slice() : null, this._$divisor, this._$bias, this._$preserveAlpha, this._$clamp, this._$color, this._$alpha);
+    }
+    /**
+     * @return {array}
+     * @method
+     * @public
+     */
+    _$toArray() {
+        return $getArray(3, this._$matrixX, this._$matrixY, this._$matrix, this._$divisor, this._$bias, this._$preserveAlpha, this._$clamp, this._$color, this._$alpha);
+    }
+    /**
+     * @param  {Rectangle} rect
+     * @return {Rectangle}
+     * @method
+     * @private
+     */
+    _$generateFilterRect(rect) {
+        return rect;
+    }
+    /**
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$canApply() {
+        return this._$matrix !== null
+            && this._$matrixX * this._$matrixY === this._$matrix.length;
+    }
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @return {WebGLTexture}
+     * @method
+     * @private
+     */
+    _$applyFilter(context) {
+        this._$updated = false;
+        const manager = context.frameBuffer;
+        const currentAttachment = manager.currentAttachment;
+        // reset
+        context.setTransform(1, 0, 0, 1, 0, 0);
+        const texture = manager
+            .getTextureFromCurrentAttachment();
+        if (!this._$canApply() || !this._$matrix) {
+            return texture;
+        }
+        context._$applyConvolutionFilter(texture, this._$matrixX, this._$matrixY, this._$matrix, this._$divisor, this._$bias, this._$preserveAlpha, this._$clamp, $intToR(this._$color, this._$alpha, false), $intToG(this._$color, this._$alpha, false), $intToB(this._$color, this._$alpha, false), this._$alpha);
+        manager.releaseAttachment(currentAttachment, true);
+        return manager.getTextureFromCurrentAttachment();
+    }
+}

package/dist/player/next2d/filters/DisplacementMapFilter.d.ts

@@ -0,0 +1,212 @@
+import { BitmapFilter } from "./BitmapFilter";
+import type { BitmapData } from "../display/BitmapData";
+import type { DisplacementMapFilterModeImpl } from "../../../interface/DisplacementMapFilterModeImpl";
+import type { Point } from "../geom/Point";
+import type { Rectangle } from "../geom/Rectangle";
+import type { CanvasToWebGLContext } from "../../../webgl/CanvasToWebGLContext";
+import type { BitmapDataChannelImpl } from "../../../interface/BitmapDataChannelImpl";
+/**
+ * DisplacementMapFilter クラスは、指定された BitmapData オブジェクト（置き換えマップイメージと言います）
+ * のピクセル値を使用して、オブジェクトの置き換え（変位）を実行します。
+ *
+ * The DisplacementMapFilter class uses the pixel values from the specified
+ * BitmapData object (called the displacement map image) to perform a displacement of an object.
+ *
+ * @class
+ * @memberOf next2d.filters
+ * @extends  BitmapFilter
+ */
+export declare class DisplacementMapFilter extends BitmapFilter {
+    private _$mapBitmap;
+    private _$mapPoint;
+    private _$componentX;
+    private _$componentY;
+    private _$scaleX;
+    private _$scaleY;
+    private _$mode;
+    private _$color;
+    private _$alpha;
+    /**
+     * @param {BitmapData} [map_bitmap = null]
+     * @param {Point}      [map_point = null]
+     * @param {number}     [component_x = 0]
+     * @param {number}     [component_y = 0]
+     * @param {number}     [scale_x = 0.0]
+     * @param {number}     [scale_y = 0.0]
+     * @param {string}     [mode = DisplacementMapFilterMode.WRAP]
+     * @param {number}     [color = 0]
+     * @param {number}     [alpha = 0.0]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(map_bitmap?: BitmapData | null, map_point?: Point | null, component_x?: BitmapDataChannelImpl, component_y?: BitmapDataChannelImpl, scale_x?: number, scale_y?: number, mode?: DisplacementMapFilterModeImpl, color?: number, alpha?: number);
+    /**
+     * @description 指定されたクラスのストリングを返します。
+     *              Returns the string representation of the specified class.
+     *
+     * @return  {string}
+     * @default [class DisplacementMapFilter]
+     * @method
+     * @static
+     */
+    static toString(): string;
+    /**
+     * @description 指定されたクラスの空間名を返します。
+     *              Returns the space name of the specified class.
+     *
+     * @return  {string}
+     * @default next2d.filters.DisplacementMapFilter
+     * @const
+     * @static
+     */
+    static get namespace(): string;
+    /**
+     * @description 指定されたオブジェクトのストリングを返します。
+     *              Returns the string representation of the specified object.
+     *
+     * @return  {string}
+     * @default [object DisplacementMapFilter]
+     * @method
+     * @public
+     */
+    toString(): string;
+    /**
+     * @description 指定されたオブジェクトの空間名を返します。
+     *              Returns the space name of the specified object.
+     *
+     * @return  {string}
+     * @default next2d.filters.DisplacementMapFilter
+     * @const
+     * @public
+     */
+    get namespace(): string;
+    /**
+     * @description アルファ透明度の値です。
+     *              The alpha transparency value for the color.
+     *
+     * @member  {number}
+     * @default 0
+     * @public
+     */
+    get alpha(): number;
+    set alpha(alpha: number);
+    /**
+     * @description 範囲外置き換えの場合に使用する色を指定します。
+     *              Specifies what color to use for out-of-bounds displacements.
+     *
+     * @member  {number}
+     * @default 0
+     * @public
+     */
+    get color(): number;
+    set color(color: number);
+    /**
+     * @description x の結果を変位させる場合にどのカラーチャンネルをマップイメージで使用するかを指定します。
+     *              Describes which color channel to use in the map image to displace the x result.
+     *
+     * @member  {number}
+     * @default 0
+     * @public
+     */
+    get componentX(): BitmapDataChannelImpl;
+    set componentX(component_x: BitmapDataChannelImpl);
+    /**
+     * @description y の結果を変位させる場合にどのカラーチャンネルをマップイメージで使用するかを指定します。
+     *              Describes which color channel to use in the map image to displace the y result.
+     *
+     * @member  {number}
+     * @default 0
+     * @public
+     */
+    get componentY(): BitmapDataChannelImpl;
+    set componentY(component_y: BitmapDataChannelImpl);
+    /**
+     * @description 置き換えマップデータが含まれる BitmapData オブジェクトです。
+     *              A BitmapData object containing the displacement map data.
+     *
+     * @member  {BitmapData}
+     * @default null
+     * @public
+     */
+    get mapBitmap(): BitmapData | null;
+    set mapBitmap(map_bitmap: BitmapData | null);
+    /**
+     * @description マップイメージの左上隅を基準としたターゲット表示オブジェクトの
+     *              左上隅のオフセットが含まれる値です。
+     *              A value that contains the offset of the upper-left corner
+     *              of the target display object from the upper-left corner of the map image.
+     *
+     * @member  {Point}
+     * @default null
+     * @public
+     */
+    get mapPoint(): Point | null;
+    set mapPoint(map_point: Point | null);
+    /**
+     * @description フィルターのモードです。
+     *              The mode for the filter.
+     *
+     * @member  {string}
+     * @default DisplacementMapFilterMode.WRAP
+     * @public
+     */
+    get mode(): DisplacementMapFilterModeImpl;
+    set mode(mode: DisplacementMapFilterModeImpl);
+    /**
+     * @description マップ計算の x 置き換え結果を拡大 / 縮小する場合に使用する乗数です。
+     *              The multiplier to use to scale the x displacement result from the map calculation.
+     *
+     * @member  {number}
+     * @default 0
+     * @public
+     */
+    get scaleX(): number;
+    set scaleX(scale_x: number);
+    /**
+     * @description マップ計算の y 置き換え結果を拡大 / 縮小する場合に使用する乗数です。
+     *              The multiplier to use to scale the y displacement result from the map calculation.
+     *
+     * @member  {number}
+     * @default 0
+     * @public
+     */
+    get scaleY(): number;
+    set scaleY(scale_y: number);
+    /**
+     * @description オブジェクトのコピーを返します。
+     *              Returns a copy of this filter object.
+     *
+     * @return {DisplacementMapFilter}
+     * @method
+     * @public
+     */
+    clone(): DisplacementMapFilter;
+    /**
+     * @return {array}
+     * @method
+     * @public
+     */
+    _$toArray(): any[];
+    /**
+     * @param  {Rectangle} rect
+     * @return {Rectangle}
+     * @method
+     * @private
+     */
+    _$generateFilterRect(rect: Rectangle): Rectangle;
+    /**
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$canApply(): boolean;
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @param  {Float32Array}  matrix
+     * @return {WebGLTexture}
+     * @method
+     * @private
+     */
+    _$applyFilter(context: CanvasToWebGLContext, matrix: Float32Array): WebGLTexture;
+}