From c92302cec5a93f7cea1ddf7d45888111c06047b3 Mon Sep 17 00:00:00 2001 From: Matt Karl Date: Wed, 6 Mar 2024 20:38:40 -0500 Subject: [PATCH] Chore: Cleanup constructor and options docs --- package-lock.json | 82 +++++++++++++++++-- package.json | 2 +- src/adjustment/AdjustmentFilter.ts | 5 +- src/advanced-bloom/AdvancedBloomFilter.ts | 5 +- src/ascii/AsciiFilter.ts | 7 +- src/backdrop-blur/BackdropBlurFilter.ts | 11 +-- src/bevel/BevelFilter.ts | 5 +- src/bloom/BloomFilter.ts | 9 +- src/bulge-pinch/BulgePinchFilter.ts | 5 +- src/color-gradient/ColorGradientFilter.ts | 59 ++++++++++--- src/color-map/ColorMapFilter.ts | 6 +- src/color-overlay/ColorOverlayFilter.ts | 6 +- src/color-replace/ColorReplaceFilter.ts | 8 +- src/convolution/ConvolutionFilter.ts | 6 +- src/cross-hatch/CrossHatchFilter.ts | 1 - src/crt/CRTFilter.ts | 5 +- src/dot/DotFilter.ts | 6 +- src/drop-shadow/DropShadowFilter.ts | 5 +- src/emboss/EmbossFilter.ts | 1 - src/glitch/GlitchFilter.ts | 5 +- src/glow/GlowFilter.ts | 16 ++-- src/godray/GodrayFilter.ts | 5 +- src/grayscale/GrayscaleFilter.ts | 1 - src/hsl-adjustment/HslAdjustmentFilter.ts | 11 ++- src/kawase-blur/KawaseBlurFilter.ts | 6 +- src/motion-blur/MotionBlurFilter.ts | 6 +- .../MultiColorReplaceFilter.ts | 6 +- src/old-film/OldFilmFilter.ts | 5 +- src/outline/OutlineFilter.ts | 8 +- src/pixelate/PixelateFilter.ts | 1 - src/radial-blur/RadialBlurFilter.ts | 6 +- src/reflection/ReflectionFilter.ts | 11 ++- src/rgb-split/RGBSplitFilter.ts | 6 +- src/shockwave/ShockwaveFilter.ts | 6 +- src/simple-lightmap/SimpleLightmapFilter.ts | 9 +- src/tilt-shift/TiltShiftFilter.ts | 13 +-- src/twist/TwistFilter.ts | 5 +- src/zoom-blur/ZoomBlurFilter.ts | 5 +- 38 files changed, 284 insertions(+), 81 deletions(-) diff --git a/package-lock.json b/package-lock.json index 58eb7704a..21368b7ac 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "devDependencies": { "@pixi/eslint-config": "^4.0.1", "@pixi/extension-scripts": "^2.4.0", - "@pixi/webdoc-template": "^1.5.5", + "@pixi/webdoc-template": "^2.2.3", "@types/gradient-parser": "^0.1.2", "@webdoc/cli": "^2.2.0", "base64-to-image": "^1.0.2", @@ -2561,6 +2561,35 @@ "rollup": "^3.2.5" } }, + "node_modules/@pixi/extension-scripts/node_modules/@pixi/webdoc-template": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@pixi/webdoc-template/-/webdoc-template-1.5.5.tgz", + "integrity": "sha512-li38YBDw4/GYWDksT5xDrZEZfsC8sPtS+no3OuNFmqPNoi4/64ZTEnTM8XByrtt/NLljDLlpySANATFbLjSPEg==", + "dev": true, + "dependencies": { + "code-prettify": "^0.1.0", + "color-themes-for-google-code-prettify": "^2.0.4", + "common-path-prefix": "^3.0.0", + "fs-extra": "^9.0.1", + "klaw-sync": "^6.0.0", + "lodash": "*", + "markdown-it": "^12.3.2", + "markdown-it-highlightjs": "^3.6.0", + "missionlog": "^1.6.0", + "open-sans-fonts": "^1.6.2", + "taffydb": "^2.7.3" + }, + "engines": { + "node": ">= 12", + "npm": ">= 6", + "pnpm": "please-use-npm", + "yarn": "please-use-npm" + }, + "peerDependencies": { + "@webdoc/model": "^1.2.1", + "@webdoc/template-library": "^1.2.1" + } + }, "node_modules/@pixi/extension-scripts/node_modules/@typescript-eslint/eslint-plugin": { "version": "6.19.0", "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-6.19.0.tgz", @@ -2781,6 +2810,21 @@ "eslint": ">=5.0.0" } }, + "node_modules/@pixi/extension-scripts/node_modules/fs-extra": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz", + "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==", + "dev": true, + "dependencies": { + "at-least-node": "^1.0.0", + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/@pixi/extension-scripts/node_modules/glob": { "version": "10.3.10", "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.10.tgz", @@ -2803,6 +2847,18 @@ "url": "https://github.com/sponsors/isaacs" } }, + "node_modules/@pixi/extension-scripts/node_modules/jsonfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", + "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "dev": true, + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, "node_modules/@pixi/extension-scripts/node_modules/lru-cache": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", @@ -2927,6 +2983,15 @@ "node": ">=10" } }, + "node_modules/@pixi/extension-scripts/node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "dev": true, + "engines": { + "node": ">= 10.0.0" + } + }, "node_modules/@pixi/extension-scripts/node_modules/yallist": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", @@ -2934,15 +2999,16 @@ "dev": true }, "node_modules/@pixi/webdoc-template": { - "version": "1.5.5", - "resolved": "https://registry.npmjs.org/@pixi/webdoc-template/-/webdoc-template-1.5.5.tgz", - "integrity": "sha512-li38YBDw4/GYWDksT5xDrZEZfsC8sPtS+no3OuNFmqPNoi4/64ZTEnTM8XByrtt/NLljDLlpySANATFbLjSPEg==", + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/@pixi/webdoc-template/-/webdoc-template-2.2.3.tgz", + "integrity": "sha512-Rt+iiw1DUoWc4hzpHJGC486MVCdq9EPCfRPbop0oW8vbllvJPZcDMUx0WvC1Gb1KsFGgBRrkpoEi2c8SekrUZg==", "dev": true, "dependencies": { "code-prettify": "^0.1.0", "color-themes-for-google-code-prettify": "^2.0.4", "common-path-prefix": "^3.0.0", "fs-extra": "^9.0.1", + "jquery": "^3.7.1", "klaw-sync": "^6.0.0", "lodash": "*", "markdown-it": "^12.3.2", @@ -2958,7 +3024,7 @@ "yarn": "please-use-npm" }, "peerDependencies": { - "@webdoc/model": "^1.2.1", + "@webdoc/model": "^1.6.6", "@webdoc/template-library": "^1.2.1" } }, @@ -12449,6 +12515,12 @@ "node": ">=10" } }, + "node_modules/jquery": { + "version": "3.7.1", + "resolved": "https://registry.npmjs.org/jquery/-/jquery-3.7.1.tgz", + "integrity": "sha512-m4avr8yL8kmFN8psrbFFFmB/If14iN5o9nw/NgnnM+kybDJpRsAynV2BsfpTYrTRysYUdADVD7CkUUizgkpLfg==", + "dev": true + }, "node_modules/js-message": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/js-message/-/js-message-1.0.7.tgz", diff --git a/package.json b/package.json index 9130c9361..a20201a8e 100644 --- a/package.json +++ b/package.json @@ -225,7 +225,7 @@ "devDependencies": { "@pixi/eslint-config": "^4.0.1", "@pixi/extension-scripts": "^2.4.0", - "@pixi/webdoc-template": "^1.5.5", + "@pixi/webdoc-template": "^2.2.3", "@types/gradient-parser": "^0.1.2", "@webdoc/cli": "^2.2.0", "base64-to-image": "^1.0.2", diff --git a/src/adjustment/AdjustmentFilter.ts b/src/adjustment/AdjustmentFilter.ts index a9378dfd0..3ee420a85 100644 --- a/src/adjustment/AdjustmentFilter.ts +++ b/src/adjustment/AdjustmentFilter.ts @@ -3,6 +3,7 @@ import { vertex, wgslVertex } from '../defaults'; import fragment from './adjustment.frag'; import source from './adjustment.wgsl'; +/** Options for the AdjustmentFilter constructor */ export interface AdjustmentFilterOptions { /** @@ -56,7 +57,6 @@ export interface AdjustmentFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class AdjustmentFilter extends Filter { @@ -80,6 +80,9 @@ export class AdjustmentFilter extends Filter uColor: Float32Array; }; + /** + * @param options - The options of the adjustment filter. + */ constructor(options?: AdjustmentFilterOptions) { options = { ...AdjustmentFilter.DEFAULT_OPTIONS, ...options }; diff --git a/src/advanced-bloom/AdvancedBloomFilter.ts b/src/advanced-bloom/AdvancedBloomFilter.ts index 556de1250..c277bca34 100644 --- a/src/advanced-bloom/AdvancedBloomFilter.ts +++ b/src/advanced-bloom/AdvancedBloomFilter.ts @@ -14,6 +14,7 @@ import fragment from './advanced-bloom.frag'; import source from './advanced-bloom.wgsl'; import { ExtractBrightnessFilter } from './ExtractBrightnessFilter'; +/** Options for the AdvancedBloomFilter constructor. */ export interface AdvancedBloomFilterOptions { /** @@ -54,7 +55,6 @@ export interface AdvancedBloomFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class AdvancedBloomFilter extends Filter { @@ -82,6 +82,9 @@ export class AdvancedBloomFilter extends Filter private _extractFilter: ExtractBrightnessFilter; private _blurFilter: KawaseBlurFilter; + /** + * @param options - Options for the AdvancedBloomFilter constructor. + */ constructor(options?: AdvancedBloomFilterOptions) { options = { ...AdvancedBloomFilter.DEFAULT_OPTIONS, ...options }; diff --git a/src/ascii/AsciiFilter.ts b/src/ascii/AsciiFilter.ts index da63f5315..b485855f5 100644 --- a/src/ascii/AsciiFilter.ts +++ b/src/ascii/AsciiFilter.ts @@ -5,6 +5,7 @@ import source from './ascii.wgsl'; // This WebGPU filter has been ported from the WebGL renderer that was originally created by Vico (@vicocotea) +/** Options for AsciiFilter constructor. */ export interface AsciiFilterOptions { /** @@ -34,7 +35,6 @@ export interface AsciiFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class AsciiFilter extends Filter { @@ -53,6 +53,10 @@ export class AsciiFilter extends Filter private _color!: Color; + /** + * Constructor. + * @param {AsciiFilterOptions} options - The options of the ASCII filter. + */ constructor(options?: AsciiFilterOptions); /** * @deprecated since 6.0.0 @@ -60,6 +64,7 @@ export class AsciiFilter extends Filter * @param {number} [size=8] - Size of the font */ constructor(size: number); + /** @ignore */ constructor(...args: [AsciiFilterOptions?] | [number]) { let options = args[0] ?? {}; diff --git a/src/backdrop-blur/BackdropBlurFilter.ts b/src/backdrop-blur/BackdropBlurFilter.ts index 4997433df..52153ef20 100644 --- a/src/backdrop-blur/BackdropBlurFilter.ts +++ b/src/backdrop-blur/BackdropBlurFilter.ts @@ -13,14 +13,12 @@ import { vertex, wgslVertex } from '../defaults'; import fragment from './backdrop-blur-blend.frag'; import wgslFragment from './backdrop-blur-blend.wgsl'; -export type BackdropBlurFilterOptions = BlurFilterOptions; - /** - * The BackdropBlurFilter applies a Gaussian blur to everything behind an object, and then draws the object on top of it. + * The BackdropBlurFilter applies a Gaussian blur to everything behind an object, and then draws the object on top of it.
+ * ![original](../screenshots/original.png)![filter](../screenshots/backdrop-blur.png) * * @class * @extends BlurFilter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class BackdropBlurFilter extends BlurFilter { @@ -28,11 +26,8 @@ export class BackdropBlurFilter extends BlurFilter /** * @param options - The options of the blur filter. - * @param options.strength - The strength of the blur filter. - * @param options.quality - The quality of the blur filter. - * @param options.kernelSize - The kernelSize of the blur filter.Options: 5, 7, 9, 11, 13, 15. */ - constructor(options?: BackdropBlurFilterOptions) + constructor(options?: BlurFilterOptions) { super(options); diff --git a/src/bevel/BevelFilter.ts b/src/bevel/BevelFilter.ts index b99d04f89..26ac82303 100644 --- a/src/bevel/BevelFilter.ts +++ b/src/bevel/BevelFilter.ts @@ -3,6 +3,7 @@ import { vertex, wgslVertex } from '../defaults'; import fragment from './bevel.frag'; import source from './bevel.wgsl'; +/** Options for the BevelFilter constructor. */ export interface BevelFilterOptions { /** @@ -45,7 +46,6 @@ export interface BevelFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class BevelFilter extends Filter { @@ -72,6 +72,9 @@ export class BevelFilter extends Filter private _lightColor: Color; private _shadowColor: Color; + /** + * @param options - Options for the BevelFilter constructor. + */ constructor(options?: BevelFilterOptions) { options = { ...BevelFilter.DEFAULT_OPTIONS, ...options }; diff --git a/src/bloom/BloomFilter.ts b/src/bloom/BloomFilter.ts index 2614df85a..61cafe98c 100644 --- a/src/bloom/BloomFilter.ts +++ b/src/bloom/BloomFilter.ts @@ -12,6 +12,7 @@ import { type DeprecatedBlurValue = number | PointData | number[]; +/** Options for the BloomFilter constructor. */ export interface BloomFilterOptions { /** @@ -43,7 +44,6 @@ export interface BloomFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class BloomFilter extends AlphaFilter { @@ -59,6 +59,9 @@ export class BloomFilter extends AlphaFilter private _blurYFilter: BlurFilterPass; private _strength: PointData; + /** + * @param {BloomFilterOptions} options - Options for the BloomFilter constructor. + */ constructor(options?: BloomFilterOptions); /** * @deprecated since 6.0.0 @@ -69,6 +72,7 @@ export class BloomFilter extends AlphaFilter * @param {number} [kernelSize=5] - The kernelSize of the blurX & blurY filter.Options: 5, 7, 9, 11, 13, 15. */ constructor(blur?: DeprecatedBlurValue, quality?: number, resolution?: number, kernelSize?: number); + /** @ignore */ constructor(...args: [BloomFilterOptions?] | [DeprecatedBlurValue?, number?, number?, number?]) { let options = args[0] ?? {}; @@ -191,6 +195,7 @@ export class BloomFilter extends AlphaFilter * * The strength of both the blurX and blurY properties simultaneously * @default 2 + * @see BloomFilter#strength */ get blur(): number { @@ -210,6 +215,7 @@ export class BloomFilter extends AlphaFilter * * The strength of the blurX property * @default 2 + * @see BloomFilter#strengthX */ get blurX(): number { @@ -229,6 +235,7 @@ export class BloomFilter extends AlphaFilter * * The strength of the blurY property * @default 2 + * @see BloomFilter#strengthY */ get blurY(): number { diff --git a/src/bulge-pinch/BulgePinchFilter.ts b/src/bulge-pinch/BulgePinchFilter.ts index bbedebae5..e5699827e 100644 --- a/src/bulge-pinch/BulgePinchFilter.ts +++ b/src/bulge-pinch/BulgePinchFilter.ts @@ -7,6 +7,7 @@ import type { FilterSystem, PointData, RenderSurface, Texture } from 'pixi.js'; // This WebGPU filter has been ported from the WebGL renderer that was originally created by Julien CLEREL (@JuloxRox) +/** Options for the BulgePinchFilter constructor. */ export interface BulgePinchFilterOptions { /** @@ -32,7 +33,6 @@ export interface BulgePinchFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class BulgePinchFilter extends Filter { @@ -50,6 +50,9 @@ export class BulgePinchFilter extends Filter uStrength: number; }; + /** + * @param options - Options for the BulgePinchFilter constructor. + */ constructor(options?: BulgePinchFilterOptions) { options = { ...BulgePinchFilter.DEFAULT_OPTIONS, ...options }; diff --git a/src/color-gradient/ColorGradientFilter.ts b/src/color-gradient/ColorGradientFilter.ts index 88ac5ffcf..5cb75e264 100644 --- a/src/color-gradient/ColorGradientFilter.ts +++ b/src/color-gradient/ColorGradientFilter.ts @@ -4,26 +4,62 @@ import vertex from './color-gradient.vert'; import source from './color-gradient.wgsl'; import { parseCssGradient } from './CssGradientParser'; -export type ColorStop = { +/** Color stop object. */ +export interface ColorStop +{ offset: number; color: ColorSource; alpha: number; -}; +} -export type DefaultOptions = { +/** Options for ColorGradientFilter constructor. */ +export interface ColorGradientFilterOptions +{ + /** + * Linear = 0, Radial = 1, Conic = 2 + * @default ColorGradientFilter.LINEAR + */ type: number; + /** Collection of stops, must be 2+ */ stops: ColorStop[]; + /** + * Angle for linear gradients, in degrees. + * @default 90 + */ angle?: number; + /** + * Alpha value for the gradient. + * @default 1 + */ alpha?: number; + /** + * Maximum number of colors to render (0 = no limit) + * @default 0 + */ maxColors?: number; + /** + * If true, the gradient will replace the existing color, otherwise it will be multiplied with it + * @default false + */ replace?: boolean; -}; +} -export type CssOptions = { +/** Options for CSS-style gradient for use with constructor. */ +export interface ColorGradientFilterCSSOptions +{ + /** CSS-style gradient string */ css: string; + /** + * Alpha value for the gradient. + * @default 1 + */ alpha?: number; + /** + * Maximum number of colors to render (0 = no limit) + * @default 0 + */ maxColors?: number; -}; +} const ANGLE_OFFSET = 90; // align degrees with CSS @@ -38,7 +74,6 @@ function sortColorStops(stops: ColorStop[]): ColorStop[] * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class ColorGradientFilter extends Filter { @@ -48,7 +83,7 @@ export class ColorGradientFilter extends Filter static readonly CONIC = 2; /** Default constructor options */ - public static readonly defaults: DefaultOptions = { + public static readonly defaults: ColorGradientFilterOptions = { type: ColorGradientFilter.LINEAR, stops: [ { offset: 0.0, color: 0xff0000, alpha: 1.0 }, @@ -73,11 +108,9 @@ export class ColorGradientFilter extends Filter private _stops: ColorStop[] = []; /** - * @param {DefaultOptions | CssOptions} [options] - * @param {number} [options.alpha=1.0] - Alpha value - * @param {number} [options.maxColors=0] - Maximum number of colors to render (0 = disabled) - */ - constructor(options?: DefaultOptions | CssOptions) + * @param options - Options for the ColorGradientFilter constructor. + */ + constructor(options?: ColorGradientFilterOptions | ColorGradientFilterCSSOptions) { if (options && 'css' in options) { diff --git a/src/color-map/ColorMapFilter.ts b/src/color-map/ColorMapFilter.ts index d8d7a5b2e..744f28402 100644 --- a/src/color-map/ColorMapFilter.ts +++ b/src/color-map/ColorMapFilter.ts @@ -5,6 +5,7 @@ import source from './color-map.wgsl'; type ColorMapTexture = TextureSource | Texture; +/** Options for the ColorMapFilter constructor. */ export interface ColorMapFilterOptions { /** The colorMap texture of the filter. */ @@ -27,7 +28,6 @@ export interface ColorMapFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class ColorMapFilter extends Filter { @@ -54,6 +54,9 @@ export class ColorMapFilter extends Filter private _scaleMode: SCALE_MODE = 'linear'; private _colorMap!: ColorMapTexture; + /** + * @param options - Options for the ColorMapFilter constructor. + */ constructor(options: ColorMapFilterOptions); /** * @deprecated since 6.0.0 @@ -64,6 +67,7 @@ export class ColorMapFilter extends Filter * @param {number} [mix=1] - The mix from 0 to 1, where 0 is the original image and 1 is the color mapped image. */ constructor(colorMap: ColorMapTexture, nearest?: boolean, mix?: number); + /** @ignore */ constructor(...args: [ColorMapFilterOptions] | [ColorMapTexture, boolean?, number?]) { let options = args[0] ?? {}; diff --git a/src/color-overlay/ColorOverlayFilter.ts b/src/color-overlay/ColorOverlayFilter.ts index 060df06ed..d041271e8 100644 --- a/src/color-overlay/ColorOverlayFilter.ts +++ b/src/color-overlay/ColorOverlayFilter.ts @@ -5,6 +5,7 @@ import source from './color-overlay.wgsl'; type DeprecatedColor = number | number[] | Float32Array; +/** Options for the ColorOverlayFilter constructor. */ export interface ColorOverlayFilterOptions { /** @@ -24,7 +25,6 @@ export interface ColorOverlayFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class ColorOverlayFilter extends Filter { @@ -43,6 +43,9 @@ export class ColorOverlayFilter extends Filter private _color: Color; + /** + * @param options - Options for the ColorOverlayFilter constructor. + */ constructor(options?: ColorOverlayFilterOptions); /** * @deprecated since 6.0.0 @@ -51,6 +54,7 @@ export class ColorOverlayFilter extends Filter * @param {number} [alpha=1] - The alpha value of the color */ constructor(color?: DeprecatedColor, alpha?: number); + /** @ignore */ constructor(...args: [ColorOverlayFilterOptions?] | [DeprecatedColor?, number?]) { let options = args[0] ?? {}; diff --git a/src/color-replace/ColorReplaceFilter.ts b/src/color-replace/ColorReplaceFilter.ts index 940bd7fad..894afa730 100644 --- a/src/color-replace/ColorReplaceFilter.ts +++ b/src/color-replace/ColorReplaceFilter.ts @@ -10,6 +10,7 @@ import source from './color-replace.wgsl'; type DeprecatedColor = number | number[] | Float32Array; +/** Options for the ColorReplaceFilter constructor. */ export interface ColorReplaceFilterOptions { /** @@ -38,7 +39,6 @@ export interface ColorReplaceFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} * * @example * // replaces true red with true blue @@ -75,6 +75,9 @@ export class ColorReplaceFilter extends Filter private _originalColor: Color; private _targetColor: Color; + /** + * @param options - Options for the ColorReplaceFilter constructor. + */ constructor(options?: ColorReplaceFilterOptions); /** * @deprecated since 6.0.0 @@ -87,6 +90,7 @@ export class ColorReplaceFilter extends Filter * (lower = more exact, higher = more inclusive) */ constructor(originalColor?: number, newColor?: number, epsilon?: number); + /** @ignore */ constructor(...args: [ColorReplaceFilterOptions?] | [DeprecatedColor?, DeprecatedColor?, number?]) { let options = args[0] ?? {}; @@ -188,6 +192,7 @@ export class ColorReplaceFilter extends Filter * The resulting color, as a 3 component RGB e.g. [1.0, 0.5, 1.0] * @member {number|Array|Float32Array} * @default 0x000000 + * @see ColorReplaceFilter#targetColor */ set newColor(value: DeprecatedColor) { @@ -207,6 +212,7 @@ export class ColorReplaceFilter extends Filter * * Tolerance/sensitivity of the floating-point comparison between colors (lower = more exact, higher = more inclusive) * @default 0.4 + * @see ColorReplaceFilter#tolerance */ set epsilon(value: number) { diff --git a/src/convolution/ConvolutionFilter.ts b/src/convolution/ConvolutionFilter.ts index 6a492f0bb..991e6920a 100644 --- a/src/convolution/ConvolutionFilter.ts +++ b/src/convolution/ConvolutionFilter.ts @@ -7,6 +7,7 @@ type FixedArray = [ T, ...Array ] & { length: L }; export type ConvolutionMatrix = Float32Array | FixedArray; +/** Options for the ConvolutionFilter constructor. */ export interface ConvolutionFilterOptions { /** @@ -39,7 +40,6 @@ export interface ConvolutionFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class ConvolutionFilter extends Filter { @@ -55,6 +55,9 @@ export class ConvolutionFilter extends Filter uTexelSize: PointData; }; + /** + * @param options - Options for the ConvolutionFilter constructor. + */ constructor(options?: ConvolutionFilterOptions); /** * @deprecated since 6.0.0 @@ -65,6 +68,7 @@ export class ConvolutionFilter extends Filter * @param {number} [height=200] - Height of the object you are transforming */ constructor(matrix: number[], width?: number, height?: number); + /** @ignore */ constructor(...args: [ConvolutionFilterOptions?] | [number[], number?, number?]) { let options = args[0] ?? {}; diff --git a/src/cross-hatch/CrossHatchFilter.ts b/src/cross-hatch/CrossHatchFilter.ts index 5369ddef7..0453a4b05 100644 --- a/src/cross-hatch/CrossHatchFilter.ts +++ b/src/cross-hatch/CrossHatchFilter.ts @@ -9,7 +9,6 @@ import source from './crosshatch.wgsl'; * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class CrossHatchFilter extends Filter { diff --git a/src/crt/CRTFilter.ts b/src/crt/CRTFilter.ts index bad27d434..43ed994e1 100644 --- a/src/crt/CRTFilter.ts +++ b/src/crt/CRTFilter.ts @@ -5,6 +5,7 @@ import source from './crt.wgsl'; import type { FilterSystem, RenderSurface, Texture } from 'pixi.js'; +/** Options for the CRTFilter constructor. */ export interface CRTFilterOptions { /** @@ -72,7 +73,6 @@ export interface CRTFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class CRTFilter extends Filter { @@ -112,6 +112,9 @@ export class CRTFilter extends Filter */ public time!: number; + /** + * @param options - Options for the CRTFilter constructor. + */ constructor(options?: CRTFilterOptions) { options = { ...CRTFilter.DEFAULT_OPTIONS, ...options }; diff --git a/src/dot/DotFilter.ts b/src/dot/DotFilter.ts index 68c79e211..9109a0adf 100644 --- a/src/dot/DotFilter.ts +++ b/src/dot/DotFilter.ts @@ -11,6 +11,7 @@ import source from './dot.wgsl'; * Original filter: https://github.com/evanw/glfx.js/blob/master/src/filters/fun/dotscreen.js */ +/** Options for the DotFilter constructor. */ export interface DotFilterOptions { /** @@ -37,7 +38,6 @@ export interface DotFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class DotFilter extends Filter { @@ -48,6 +48,9 @@ export class DotFilter extends Filter grayscale: true }; + /** + * @param options - Options for the DotFilter constructor. + */ constructor(options?: DotFilterOptions); /** * @deprecated since 6.0.0 @@ -57,6 +60,7 @@ export class DotFilter extends Filter * @param {boolean} [grayscale=true] - Render as grayscale. */ constructor(scale?: number, angle?: number, grayscale?: boolean); + /** @ignore */ constructor(...args: [DotFilterOptions?] | [number?, number?, boolean?]) { let options = args[0] ?? {}; diff --git a/src/drop-shadow/DropShadowFilter.ts b/src/drop-shadow/DropShadowFilter.ts index 16f2b25f4..27425cf79 100644 --- a/src/drop-shadow/DropShadowFilter.ts +++ b/src/drop-shadow/DropShadowFilter.ts @@ -15,6 +15,7 @@ import { KawaseBlurFilter } from '../kawase-blur/KawaseBlurFilter'; import fragment from './drop-shadow.frag'; import source from './drop-shadow.wgsl'; +/** Options for the DropShadowFilter constructor. */ export interface DropShadowFilterOptions { /** @@ -70,7 +71,6 @@ export interface DropShadowFilterOptions * ![original](../screenshots/original.png)![filter](../screenshots/drop-shadow.png) * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class DropShadowFilter extends Filter { @@ -103,6 +103,9 @@ export class DropShadowFilter extends Filter private _blurFilter: KawaseBlurFilter; private _basePass: Filter; + /** + * @param options - Options for the DropShadowFilter constructor. + */ constructor(options?: DropShadowFilterOptions) { options = { ...DropShadowFilter.DEFAULT_OPTIONS, ...options }; diff --git a/src/emboss/EmbossFilter.ts b/src/emboss/EmbossFilter.ts index 0de52b293..d1bfe36b2 100644 --- a/src/emboss/EmbossFilter.ts +++ b/src/emboss/EmbossFilter.ts @@ -9,7 +9,6 @@ import source from './emboss.wgsl'; * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class EmbossFilter extends Filter { diff --git a/src/glitch/GlitchFilter.ts b/src/glitch/GlitchFilter.ts index 807f16100..4442ed314 100644 --- a/src/glitch/GlitchFilter.ts +++ b/src/glitch/GlitchFilter.ts @@ -14,6 +14,7 @@ enum FILL_MODES MIRROR = 4, } +/** Options for the GlitchFilter constructor. */ export interface GlitchFilterOptions { /** @@ -80,7 +81,6 @@ export interface GlitchFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class GlitchFilter extends Filter { @@ -141,6 +141,9 @@ export class GlitchFilter extends Filter private _sizes: Float32Array = new Float32Array(1); private _offsets: Float32Array = new Float32Array(1); + /** + * @param options - Options for the GlitchFilter constructor. + */ constructor(options?: GlitchFilterOptions) { options = { ...GlitchFilter.defaults, ...options }; diff --git a/src/glow/GlowFilter.ts b/src/glow/GlowFilter.ts index d81e5ad0d..8b07eaac8 100644 --- a/src/glow/GlowFilter.ts +++ b/src/glow/GlowFilter.ts @@ -4,10 +4,8 @@ import fragment from './glow.frag'; import source from './glow.wgsl'; /** - * This WebGPU filter has been ported from the WebGL renderer that was originally created by mishaa - * http://codepen.io/mishaa/pen/raKzrm + * Options for the GlowFilter constructor. */ - export interface GlowFilterOptions { /** @@ -54,7 +52,6 @@ export interface GlowFilterOptions * @class * * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} * * @example * someSprite.filters = [ @@ -85,6 +82,9 @@ export class GlowFilter extends Filter private _color!: Color; + /** + * @param options - Options for the GlowFilter constructor. + */ constructor(options?: GlowFilterOptions) { options = { ...GlowFilter.DEFAULT_OPTIONS, ...options }; @@ -103,11 +103,9 @@ export class GlowFilter extends Filter }, }); - /** - * Altering uDistance and uQuality won't have any affect on WebGL - * since we hard-assign them during creation to allow - * for the values to be used in GLSL loops - */ + // Altering uDistance and uQuality won't have any affect on WebGL + // since we hard-assign them during creation to allow + // for the values to be used in GLSL loops const glProgram = GlProgram.from({ vertex, fragment: fragment diff --git a/src/godray/GodrayFilter.ts b/src/godray/GodrayFilter.ts index fd5a9e7de..5095c611b 100644 --- a/src/godray/GodrayFilter.ts +++ b/src/godray/GodrayFilter.ts @@ -7,6 +7,7 @@ import sourcePerlin from './perlin.wgsl'; import type { FilterSystem, PointData, RenderSurface, Texture } from 'pixi.js'; +/** Options for the GodrayFilter constructor. */ export interface GodrayFilterOptions { /** @@ -58,7 +59,6 @@ export interface GodrayFilterOptions * ![original](../screenshots/original.png)![filter](../screenshots/godray.gif) * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} * * @example * displayObject.filters = [new GodrayFilter()]; @@ -95,6 +95,9 @@ export class GodrayFilter extends Filter private _angle = 0; private _center!: PointData; + /** + * @param options - Options for the GodrayFilter constructor. + */ constructor(options?: GodrayFilterOptions) { options = { ...GodrayFilter.DEFAULT_OPTIONS, ...options }; diff --git a/src/grayscale/GrayscaleFilter.ts b/src/grayscale/GrayscaleFilter.ts index 9d90eaedf..0cd6496bb 100644 --- a/src/grayscale/GrayscaleFilter.ts +++ b/src/grayscale/GrayscaleFilter.ts @@ -9,7 +9,6 @@ import source from './grayscale.wgsl'; * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class GrayscaleFilter extends Filter { diff --git a/src/hsl-adjustment/HslAdjustmentFilter.ts b/src/hsl-adjustment/HslAdjustmentFilter.ts index 15fc953bc..a1ac2a65d 100644 --- a/src/hsl-adjustment/HslAdjustmentFilter.ts +++ b/src/hsl-adjustment/HslAdjustmentFilter.ts @@ -3,8 +3,9 @@ import { vertex, wgslVertex } from '../defaults'; import fragment from './hsladjustment.frag'; import source from './hsladjustment.wgsl'; -// This WebGPU filter has been ported from the WebGL renderer that was originally created by Viktor Persson (@vikpe) - +/** + * Options for the HslAdjustmentFilter constructor. + */ export interface HslAdjustmentFilterOptions { /** @@ -37,9 +38,10 @@ export interface HslAdjustmentFilterOptions /** * ![original](../screenshots/original.png)![filter](../screenshots/hsl-adjustment.png) * + * This WebGPU filter has been ported from the WebGL renderer that was originally created by Viktor Persson (@vikpe) + * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class HslAdjustmentFilter extends Filter { @@ -60,6 +62,9 @@ export class HslAdjustmentFilter extends Filter private _hue!: number; + /** + * @param options - Options for the HslAdjustmentFilter constructor. + */ constructor(options?: HslAdjustmentFilterOptions) { options = { ...HslAdjustmentFilter.DEFAULT_OPTIONS, ...options }; diff --git a/src/kawase-blur/KawaseBlurFilter.ts b/src/kawase-blur/KawaseBlurFilter.ts index 8f89d23b7..d009abdff 100644 --- a/src/kawase-blur/KawaseBlurFilter.ts +++ b/src/kawase-blur/KawaseBlurFilter.ts @@ -7,6 +7,7 @@ import sourceClamp from './kawase-blur-clamp.wgsl'; import type { FilterSystem, PointData, RenderSurface, Texture } from 'pixi.js'; +/** Options for the KawaseBlurFilter constructor. */ export interface KawaseBlurFilterOptions { /** @@ -39,7 +40,6 @@ export interface KawaseBlurFilterOptions * @see https://software.intel.com/en-us/blogs/2014/07/15/an-investigation-of-fast-real-time-gpu-based-image-blur-algorithms * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class KawaseBlurFilter extends Filter { @@ -61,6 +61,9 @@ export class KawaseBlurFilter extends Filter private _blur!: number; private _quality!: number; + /** + * @param options - Options for the KawaseBlurFilter constructor. + */ constructor(options?: KawaseBlurFilterOptions); /** * @deprecated since 6.0.0 @@ -72,6 +75,7 @@ export class KawaseBlurFilter extends Filter * from fullscreen filters or bleeding to the edge of filterArea. */ constructor(blur?: number | number[], quality?: number, clamp?: boolean); + /** @ignore */ constructor(...args: [KawaseBlurFilterOptions?] | [(number | number[])?, number?, boolean?]) { let options = args[0] ?? {}; diff --git a/src/motion-blur/MotionBlurFilter.ts b/src/motion-blur/MotionBlurFilter.ts index aa829a19c..02e07eeeb 100644 --- a/src/motion-blur/MotionBlurFilter.ts +++ b/src/motion-blur/MotionBlurFilter.ts @@ -4,6 +4,7 @@ import { vertex, wgslVertex } from '../defaults'; import fragment from './motion-blur.frag'; import source from './motion-blur.wgsl'; +/** Options for the MotionBlurFilter constructor. */ export interface MotionBlurFilterOptions { /** @@ -31,7 +32,6 @@ export interface MotionBlurFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class MotionBlurFilter extends Filter { @@ -50,6 +50,9 @@ export class MotionBlurFilter extends Filter private _kernelSize!: number; + /** + * @param options - Options for the MotionBlurFilter constructor. + */ constructor(options?: MotionBlurFilterOptions); /** * @deprecated since 8.0.0 @@ -59,6 +62,7 @@ export class MotionBlurFilter extends Filter * @param {number} [offset=0] - The offset of the blur filter. */ constructor(velocity?: number[] | PointData | ObservablePoint, kernelSize?: number, offset?: number); + /** @ignore */ constructor(...args: [MotionBlurFilterOptions?] | [(number[] | PointData | ObservablePoint)?, number?, number?]) { let options = args[0] ?? {}; diff --git a/src/multi-color-replace/MultiColorReplaceFilter.ts b/src/multi-color-replace/MultiColorReplaceFilter.ts index 7dbea5a87..449526bb2 100644 --- a/src/multi-color-replace/MultiColorReplaceFilter.ts +++ b/src/multi-color-replace/MultiColorReplaceFilter.ts @@ -5,6 +5,7 @@ import source from './multi-color-replace.wgsl'; type DeprecatedColor = number | number[] | Float32Array; +/** Options for the MultiColorReplaceFilter constructor. */ export interface MultiColorReplaceFilterOptions { /** @@ -34,7 +35,6 @@ export interface MultiColorReplaceFilterOptions * ![original](../screenshots/original.png)![filter](../screenshots/multi-color-replace.png) * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} * * @example * // replaces pure red with pure blue, and replaces pure green with pure white @@ -74,6 +74,9 @@ export class MultiColorReplaceFilter extends Filter private _replacements: Array<[ColorSource, ColorSource]> = []; private _maxColors: number; + /** + * @param options - Options for the MultiColorReplaceFilter constructor. + */ constructor(options?: MultiColorReplaceFilterOptions); /** * @deprecated since 6.0.0 @@ -88,6 +91,7 @@ export class MultiColorReplaceFilter extends Filter * If omitted, the default value is the length of `replacements`. */ constructor(replacements: Array<[DeprecatedColor, DeprecatedColor]>, epsilon?: number, maxColors?: number); + /** @ignore */ constructor(...args: [MultiColorReplaceFilterOptions?] | [Array<[DeprecatedColor, DeprecatedColor]>, number?, number?]) { let options = args[0] ?? {} as MultiColorReplaceFilterOptions; diff --git a/src/old-film/OldFilmFilter.ts b/src/old-film/OldFilmFilter.ts index 5e5ceedb0..57ee066f8 100644 --- a/src/old-film/OldFilmFilter.ts +++ b/src/old-film/OldFilmFilter.ts @@ -5,6 +5,7 @@ import source from './old-film.wgsl'; import type { FilterSystem, RenderSurface, Texture } from 'pixi.js'; +/** Options for the OldFilmFilter constructor. */ export interface OldFilmFilterOptions { /** @@ -66,7 +67,6 @@ export interface OldFilmFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class OldFilmFilter extends Filter { @@ -99,6 +99,9 @@ export class OldFilmFilter extends Filter */ public seed!: number; + /** + * @param options - Options for the OldFilmFilter constructor. + */ constructor(options?: OldFilmFilterOptions) { options = { ...OldFilmFilter.DEFAULT_OPTIONS, ...options }; diff --git a/src/outline/OutlineFilter.ts b/src/outline/OutlineFilter.ts index 6e6fb03ab..6ba00044d 100644 --- a/src/outline/OutlineFilter.ts +++ b/src/outline/OutlineFilter.ts @@ -5,6 +5,7 @@ import source from './outline.wgsl'; import type { ColorSource, FilterSystem, RenderSurface, Texture } from 'pixi.js'; +/** Options for the OutlineFilter constructor. */ export interface OutlineFilterOptions { /** @@ -43,8 +44,7 @@ export interface OutlineFilterOptions * ![original](../screenshots/original.png)![filter](../screenshots/outline.png) * * @class - * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} * + * @extends Filter * * @example * someSprite.filters = [new OutlineFilter(2, 0x99ff99)]; */ @@ -77,6 +77,9 @@ export class OutlineFilter extends Filter private _quality!: number; private _color!: Color; + /** + * @param options - Options for the OutlineFilter constructor. + */ constructor(options?: OutlineFilterOptions); /** * @deprecated since 6.0.0 @@ -89,6 +92,7 @@ export class OutlineFilter extends Filter * @param {boolean} [knockout=false] - Only render outline, not the contents. */ constructor(thickness?: number, color?: number, quality?: number, alpha?: number, knockout?: boolean); + /** @ignore */ constructor(...args: [OutlineFilterOptions?] | [number?, number?, number?, number?, boolean?]) { let options = args[0] ?? {}; diff --git a/src/pixelate/PixelateFilter.ts b/src/pixelate/PixelateFilter.ts index 8b5a13e7c..518e1392a 100644 --- a/src/pixelate/PixelateFilter.ts +++ b/src/pixelate/PixelateFilter.ts @@ -11,7 +11,6 @@ type Size = number | number[] | Point; * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class PixelateFilter extends Filter { diff --git a/src/radial-blur/RadialBlurFilter.ts b/src/radial-blur/RadialBlurFilter.ts index 6ab26cef7..7d8c681d2 100644 --- a/src/radial-blur/RadialBlurFilter.ts +++ b/src/radial-blur/RadialBlurFilter.ts @@ -5,6 +5,7 @@ import source from './radial-blur.wgsl'; import type { PointData } from 'pixi.js'; +/** Options for the RadialBlurFilter constructor. */ export interface RadialBlurFilterOptions { /** @@ -37,7 +38,6 @@ export interface RadialBlurFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class RadialBlurFilter extends Filter { @@ -59,6 +59,9 @@ export class RadialBlurFilter extends Filter private _angle!: number; private _kernelSize!: number; + /** + * @param options - Options for the RadialBlurFilter constructor. + */ constructor(options?: RadialBlurFilterOptions); /** * @deprecated since 6.0.0 @@ -69,6 +72,7 @@ export class RadialBlurFilter extends Filter * @param {number} [radius=-1] - The maximum size of the blur radius, `-1` is infinite */ constructor(angle?: number, center?: PointData | number[], kernelSize?: number, radius?: number); + /** @ignore */ constructor(...args: [RadialBlurFilterOptions?] | [number?, (PointData | number[])?, number?, number?]) { let options = args[0] ?? {}; diff --git a/src/reflection/ReflectionFilter.ts b/src/reflection/ReflectionFilter.ts index e70fd3f08..faf57910c 100644 --- a/src/reflection/ReflectionFilter.ts +++ b/src/reflection/ReflectionFilter.ts @@ -8,6 +8,7 @@ import type { FilterSystem, RenderSurface, Texture } from 'pixi.js'; /** [MIN, MAX] */ type Range = [number, number] | Float32Array; +/** Options for the ReflectionFilter constructor. */ export interface ReflectionFilterOptions { /** @@ -49,7 +50,6 @@ export interface ReflectionFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class ReflectionFilter extends Filter { @@ -74,11 +74,14 @@ export class ReflectionFilter extends Filter }; /** - * Time for animating position of waves - * @default 0 - */ + * Time for animating position of waves + * @default 0 + */ public time = 0; + /** + * @param options - Options for the ReflectionFilter constructor. + */ constructor(options?: ReflectionFilterOptions) { options = { ...ReflectionFilter.DEFAULT_OPTIONS, ...options }; diff --git a/src/rgb-split/RGBSplitFilter.ts b/src/rgb-split/RGBSplitFilter.ts index bab6879f5..9ec659383 100644 --- a/src/rgb-split/RGBSplitFilter.ts +++ b/src/rgb-split/RGBSplitFilter.ts @@ -5,6 +5,7 @@ import source from './rgb-split.wgsl'; type OffsetType = PointData | [number, number]; +/** Options for the RGBSplitFilter constructor. */ export interface RGBSplitFilterOptions { /** @@ -30,7 +31,6 @@ export interface RGBSplitFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class RGBSplitFilter extends Filter { @@ -47,6 +47,9 @@ export class RGBSplitFilter extends Filter uBlue: PointData; }; + /** + * @param options - Options for the RGBSplitFilter constructor. + */ constructor(options?: RGBSplitFilterOptions); /** * @deprecated since 6.0.0 @@ -56,6 +59,7 @@ export class RGBSplitFilter extends Filter * @param {PIXI.PointData | number[]} [blue=[0, 0]] - Blue channel offset */ constructor(red?: OffsetType, green?: OffsetType, blue?: OffsetType); + /** @ignore */ constructor(...args: [RGBSplitFilterOptions?] | [OffsetType?, OffsetType?, OffsetType?]) { let options = args[0] ?? {}; diff --git a/src/shockwave/ShockwaveFilter.ts b/src/shockwave/ShockwaveFilter.ts index d405ab308..aa3559580 100644 --- a/src/shockwave/ShockwaveFilter.ts +++ b/src/shockwave/ShockwaveFilter.ts @@ -12,6 +12,7 @@ import { vertex, wgslVertex } from '../defaults'; import fragment from './shockwave.frag'; import source from './shockwave.wgsl'; +/** Options for the ShockwaveFilter constructor. */ export interface ShockwaveFilterOptions { /** @@ -54,7 +55,7 @@ export interface ShockwaveFilterOptions /** * A Noise effect filter. * - * original filter: https://github.com/evanw/glfx.js/blob/master/src/filters/adjust/noise.js + * {@link https://github.com/evanw/glfx.js/blob/master/src/filters/adjust/noise.js original filter} * @author Vico @vicocotea */ export class ShockwaveFilter extends Filter @@ -86,7 +87,7 @@ export class ShockwaveFilter extends Filter public time: number; /** - * @param options + * @param options - Options for the ShockwaveFilter constructor. */ constructor(options?: ShockwaveFilterOptions); /** @@ -102,6 +103,7 @@ export class ShockwaveFilter extends Filter * @param {number} [time=0] - See `time` property. */ constructor(center?: PointData | number[], options?: Omit, time?: number); + /** @ignore */ // eslint-disable-next-line max-len constructor(...args: [ShockwaveFilterOptions?] | [(PointData | number[])?, Omit?, number?]) { diff --git a/src/simple-lightmap/SimpleLightmapFilter.ts b/src/simple-lightmap/SimpleLightmapFilter.ts index 2ae494e1f..b46c0f7c9 100644 --- a/src/simple-lightmap/SimpleLightmapFilter.ts +++ b/src/simple-lightmap/SimpleLightmapFilter.ts @@ -15,6 +15,7 @@ import source from './simple-lightmap.wgsl'; type DeprecatedColor = number | number[]; +/** Options for the SimpleLightmapFilter constructor. */ export interface SimpleLightmapFilterOptions { /** A texture where your lightmap is rendered */ @@ -34,8 +35,8 @@ export interface SimpleLightmapFilterOptions /** * SimpleLightmap, originally by Oza94 -* http://www.html5gamedevs.com/topic/20027-pixijs-simple-lightmapping/ -* http://codepen.io/Oza94/pen/EPoRxj +* {@link http://www.html5gamedevs.com/topic/20027-pixijs-simple-lightmapping/} +* {@link http://codepen.io/Oza94/pen/EPoRxj} * * You have to specify filterArea, or suffer consequences. * You may have to use it with `filter.dontFit = true`, @@ -67,6 +68,9 @@ export class SimpleLightmapFilter extends Filter private _color!: Color; private _lightMap!: Texture; + /** + * @param options - Options for the SimpleLightmapFilter constructor. + */ constructor(options: SimpleLightmapFilterOptions); /** * @deprecated since 6.0.0 @@ -76,6 +80,7 @@ export class SimpleLightmapFilter extends Filter * @param {number} [alpha=1] - Default alpha set independent of color (if it's a number, not array). */ constructor(texture: Texture, color?: DeprecatedColor, alpha?: number); + /** @ignore */ constructor(...args: [SimpleLightmapFilterOptions] | [Texture, DeprecatedColor?, number?]) { let options = args[0] ?? {}; diff --git a/src/tilt-shift/TiltShiftFilter.ts b/src/tilt-shift/TiltShiftFilter.ts index 83f216e41..d33a9b670 100644 --- a/src/tilt-shift/TiltShiftFilter.ts +++ b/src/tilt-shift/TiltShiftFilter.ts @@ -3,10 +3,7 @@ import { TiltShiftAxisFilter } from './TiltShiftAxisFilter'; import type { PointData, RenderSurface, Texture } from 'pixi.js'; -// @author Vico @vicocotea -// original filter https://github.com/evanw/glfx.js/blob/master/src/filters/blur/tiltshift.js -// by Evan Wallace : http://madebyevan.com/ - +/** Options for the TiltShiftFilter constructor. */ export interface TiltShiftFilterOptions { /** The strength of the blur. */ @@ -23,14 +20,20 @@ export interface TiltShiftFilterOptions * A TiltShift Filter. Manages the pass of both a TiltShiftXFilter and TiltShiftYFilter.
* ![original](../screenshots/original.png)![filter](../screenshots/tilt-shift.png) * + * author Vico @vicocotea + * {@link https://github.com/evanw/glfx.js/blob/master/src/filters/blur/tiltshift.js original filter } + * by {@link http://madebyevan.com/ Evan Wallace } + * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class TiltShiftFilter extends TiltShiftAxisFilter { private _tiltShiftYFilter: TiltShiftAxisFilter; + /** + * @param options - Options for the TiltShiftFilter constructor. + */ constructor(options?: TiltShiftFilterOptions) { options = { ...TiltShiftAxisFilter.DEFAULT_OPTIONS, ...options }; diff --git a/src/twist/TwistFilter.ts b/src/twist/TwistFilter.ts index c96314bb7..c40c53a93 100644 --- a/src/twist/TwistFilter.ts +++ b/src/twist/TwistFilter.ts @@ -3,6 +3,7 @@ import { vertex, wgslVertex } from '../defaults'; import fragment from './twist.frag'; import source from './twist.wgsl'; +/** Options for the TwistFilter constructor. */ export interface TwistFilterOptions { /** @@ -35,7 +36,6 @@ export interface TwistFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class TwistFilter extends Filter { @@ -52,6 +52,9 @@ export class TwistFilter extends Filter uOffset: PointData; }; + /** + * @param options - Options for the TwistFilter constructor. + */ constructor(options?: Partial) { options = { ...TwistFilter.DEFAULT_OPTIONS, ...options }; diff --git a/src/zoom-blur/ZoomBlurFilter.ts b/src/zoom-blur/ZoomBlurFilter.ts index cec993bec..e0946af85 100644 --- a/src/zoom-blur/ZoomBlurFilter.ts +++ b/src/zoom-blur/ZoomBlurFilter.ts @@ -3,6 +3,7 @@ import { vertex, wgslVertex } from '../defaults'; import fragment from './zoom-blur.frag'; import source from './zoom-blur.wgsl'; +/** Options for the ZoomBlurFilter constructor. */ export interface ZoomBlurFilterOptions { /** @@ -41,7 +42,6 @@ export interface ZoomBlurFilterOptions * * @class * @extends Filter - * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters} */ export class ZoomBlurFilter extends Filter { @@ -60,6 +60,9 @@ export class ZoomBlurFilter extends Filter uRadii: Float32Array }; + /** + * @param options - Options for the ZoomBlurFilter constructor. + */ constructor(options?: ZoomBlurFilterOptions) { options = { ...ZoomBlurFilter.DEFAULT_OPTIONS, ...options };