@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.345.1-beta.20250704.94554

package/src/foundry/client/pixi/webgl/helpers/texture-extractor.d.mts

@@ -1,119 +0,0 @@
-import type { Brand, InexactPartial } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A class or interface that provide support for WebGL async read pixel/texture data extraction.
-   */
-  class TextureExtractor {
-    constructor(renderer: PIXI.Renderer, options?: TextureExtractor.ConstructorOptions);
-
-    /**
-     * List of compression that could be applied with extraction
-     */
-    static COMPRESSION_MODES: TextureExtractor.CompressionModes;
-
-    /**
-     * Debug flag.
-     */
-    debug: boolean;
-
-    /**
-     * The reference to the pixel buffer.
-     */
-    pixelBuffer: Uint8ClampedArray;
-
-    /**
-     * Extract a rectangular block of pixels from the texture (without un-pre-multiplying).
-     * @param options - Options which configure extraction behavior
-     */
-    extract(options?: TextureExtractor.TextureExtractionOptions): Promise<string | Uint8ClampedArray>;
-
-    /**
-     * Free all the bound objects.
-     */
-    reset(): void;
-
-    /**
-     * Called by the renderer contextChange runner.
-     */
-    contextChange(): void;
-  }
-
-  namespace TextureExtractor {
-    type Any = AnyTextureExtractor;
-    type AnyConstructor = typeof AnyTextureExtractor;
-
-    /** @internal */
-    type _ConstructorOptions = InexactPartial<{
-      /**
-       * The caller name associated with this instance of texture extractor (optional, used for debug)
-       * @defaultValue `"TextureExtractor"`
-       * @remarks Default provided by ?? in function body
-       */
-      callerName: string | null;
-
-      /**
-       * Does the TextureCompressor neeed to control the hash?
-       * @remarks Passed to `new TextureCompressor()`, where it is provided a default of `false` if null
-       */
-      controlHash: boolean | null;
-
-      /**
-       * The PIXI Format this TextureExtractor uses
-       * @defaultValue `PIXI.FORMATS.RED`
-       * @remarks Construction throws if this isn't `.RED` or `.RGBA`, so can't be null
-       */
-      format: PIXI.FORMATS;
-    }>;
-
-    /** Options for the constructor of {@link TextureExtractor} */
-    interface ConstructorOptions extends _ConstructorOptions {}
-
-    /** @internal */
-    type _ExtractOptions = InexactPartial<{
-      /**
-       * The texture the pixels are extracted from.
-       * Otherwise, extract from the renderer.
-       * @remarks Can't be null despite Foundry's typedef claiming it can, as eventually `texture?.baseTexture.resolution` is accessed
-       */
-      texture: PIXI.Texture | PIXI.RenderTexture;
-
-      /** The rectangle which the pixels are extracted from. */
-      frame: PIXI.Rectangle;
-
-      /** The compression mode to apply, or NONE */
-      compression: TextureExtractor.COMPRESSION_MODES;
-
-      /**
-       * The optional image mime type.
-       * @privateRemarks Allowed to be null because it has an `??` default in `TextureExtractor##compressBufferWorker`
-       * via `##compressBuffer`, the only place it is actually used, despite being passed to other functions as well
-       */
-      type: string | null;
-
-      /**
-       * The optional image quality.
-       *  @privateRemarks Foundry types as `string` but is clearly meant to be `number` by usage. Allowing null due to
-       * it having a `??` default in the path any browser someone is realistically using for Foundry will take.
-       */
-      quality: number | null;
-
-      /** The optional debug flag to use. */
-      debug: boolean | null;
-    }>;
-
-    /** Options for {@link TextureExtractor#extract} */
-    interface TextureExtractionOptions extends _ExtractOptions {}
-
-    type COMPRESSION_MODES = Brand<number, "TextureExtractor.COMPRESSION_MODES">;
-
-    interface CompressionModes {
-      NONE: 0 & COMPRESSION_MODES;
-      BASE64: 1 & COMPRESSION_MODES;
-    }
-  }
-}
-
-declare abstract class AnyTextureExtractor extends TextureExtractor {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/webgl/index.d.mts

@@ -1,3 +0,0 @@
-import "./extensions/index.d.mts";
-import "./helpers/index.d.mts";
-import "./shaders/index.d.mts";

package/src/foundry/client/pixi/webgl/shaders/base-shader-mixin.d.mts

@@ -1,119 +0,0 @@
-import type { FixedInstanceType, Mixin } from "fvtt-types/utils";
-
-declare class BaseShader {
-  /** @privateRemarks All mixin classses should accept anything for its constructor. */
-  constructor(...args: any[]);
-
-  /**
-   * Useful constant values computed at compile time
-   */
-  static CONSTANTS: string;
-
-  /**
-   * Fast approximate perceived brightness computation
-   * Using Digital ITU BT.709 : Exact luminance factors
-   */
-  static PERCEIVED_BRIGHTNESS: string;
-
-  /**
-   * Convertion functions for sRGB and Linear RGB.
-   */
-  static COLOR_SPACES: string;
-
-  /**
-   * Fractional Brownian Motion for a given number of octaves
-   * @param octaves - (default: `4`)
-   * @param amp     - (default: `1.0`)
-   */
-  static FBM(octaves: number, amp: number): string;
-
-  /**
-   * High Quality Fractional Brownian Motion
-   * @param octaves - (default: `3`)
-   */
-  static FBMHQ(octaves: number): string;
-
-  /**
-   * Angular constraint working with coordinates on the range [-1, 1]
-   * =\> coord: Coordinates
-   * =\> angle: Angle in radians
-   * =\> smoothness: Smoothness of the pie
-   * =\> l: Length of the pie.
-   */
-  static PIE: string;
-
-  /**
-   * A conventional pseudo-random number generator with the "golden" numbers, based on uv position
-   */
-  static PRNG_LEGACY: string;
-
-  /**
-   * A pseudo-random number generator based on uv position which does not use cos/sin
-   * This PRNG replaces the old PRNG_LEGACY to workaround some driver bugs
-   */
-  static PRNG: string;
-
-  /**
-   * A Vec2 pseudo-random generator, based on uv position
-   */
-  static PRNG2D: string;
-
-  /**
-   * A Vec3 pseudo-random generator, based on uv position
-   */
-  static PRNG3D: string;
-
-  /**
-   * A conventional noise generator
-   */
-  static NOISE: string;
-
-  /**
-   * Convert a Hue-Saturation-Brightness color to RGB - useful to convert polar coordinates to RGB
-   */
-  static HSB2RGB: string;
-
-  /**
-   * Declare a wave function in a shader -\> wcos (default), wsin or wtan.
-   * Wave on the [v1,v2] range with amplitude -\> a and speed -\> speed.
-   * @param func - the math function to use
-   *               (default: `"cos"`)
-   */
-  static WAVE(func?: string): string;
-
-  /**
-   * Rotation function.
-   */
-  static ROTATION: string;
-
-  /**
-   * Voronoi noise function. Needs PRNG2D and CONSTANTS.
-   * @see PRNG2D
-   * @see CONSTANTS
-   */
-  static VORONOI: string;
-
-  /**
-   * Enables GLSL 1.0 backwards compatibility in GLSL 3.00 ES vertex shaders.
-   */
-  static GLSL1_COMPATIBILITY_VERTEX: string;
-
-  /**
-   * Enables GLSL 1.0 backwards compatibility in GLSL 3.00 ES fragment shaders.
-   */
-  static GLSL1_COMPATIBILITY_FRAGMENT: string;
-}
-
-declare global {
-  function BaseShaderMixin<BaseClass extends BaseShaderMixin.BaseClass>(
-    ShaderClass: BaseClass,
-  ): Mixin<typeof BaseShader, BaseClass>;
-
-  namespace BaseShaderMixin {
-    /** @privateRemarks Can't extend `AnyMixedConstructor` if it's using the `BaseClass` union; `PIXI.Shader` is the parent of `Filter`, so it's used instead */
-    type AnyMixedConstructor = ReturnType<typeof BaseShaderMixin<PIXI.Shader.AnyConstructor>>;
-    interface AnyMixed extends FixedInstanceType<AnyMixedConstructor> {}
-
-    type BaseClass = PIXI.Shader.AnyConstructor | PIXI.Filter.AnyConstructor;
-  }
-}

package/src/foundry/client/pixi/webgl/shaders/base-shader.d.mts

@@ -1,111 +0,0 @@
-import type { FixedInstanceType, ToMethod } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * This class defines an interface which all shaders utilize
-   */
-  abstract class AbstractBaseShader extends BaseShaderMixin(PIXI.Shader) {
-    /**
-     * @param program  - The program to use with this shader.
-     * @param uniforms - The current uniforms of the Shader
-     */
-    constructor(
-      program: PIXI.Program,
-      /** @defaultValue `{}` */
-      uniforms?: AbstractBaseShader.Uniforms,
-    );
-
-    /**
-     * The raw vertex shader used by this class.
-     * A subclass of AbstractBaseShader must implement the vertexShader static field.
-     * @defaultValue `""`
-     */
-    static vertexShader: string;
-
-    /**
-     * The raw fragment shader used by this class.
-     * A subclass of AbstractBaseShader must implement the fragmentShader static field.
-     * @defaultValue `""`
-     */
-    static fragmentShader: string | AbstractBaseShader.FragmentShaderFunction;
-
-    /**
-     * The default uniform values for the shader.
-     * A subclass of AbstractBaseShader must implement the defaultUniforms static field.
-     * @defaultValue `{}`
-     */
-    static defaultUniforms: AbstractBaseShader.Uniforms;
-
-    /**
-     * The initial values of the shader uniforms.
-     * @remarks Set during construction
-     */
-    initialUniforms: AbstractBaseShader.Uniforms;
-
-    /**
-     * A factory method for creating the shader using its defined default values
-     */
-    static create<ThisType extends AbstractBaseShader.AnyConstructor>(
-      this: ThisType,
-      initialUniforms?: AbstractBaseShader.Uniforms,
-    ): FixedInstanceType<ThisType>;
-
-    /**
-     * Reset the shader uniforms back to their initial values.
-     */
-    protected reset(): void;
-
-    /**
-     * A one time initialization performed on creation.
-     * @remarks Does nothing without subclass implementation.
-     */
-    protected _configure(): void;
-
-    /**
-     * Perform operations which are required before binding the Shader to the Renderer.
-     * @param mesh - The mesh display object linked to this shader.
-     * @param renderer - The renderer
-     * @privateRemarks Foundry marks this as protected despite it getting called from `QuadMesh#_render`
-     */
-    protected _preRender: AbstractBaseShader.PreRenderFunction;
-
-    /**
-     * The initial default values of shader uniforms
-     * @deprecated since v12, until v14
-     * @remarks AbstractBaseShader#_defaults is deprecated in favor of AbstractBaseShader#initialUniforms.
-     */
-    protected get _defaults(): AbstractBaseShader.Uniforms;
-  }
-
-  namespace AbstractBaseShader {
-    type AnyConstructor = typeof AnyAbstractBaseShader;
-
-    type Coordinates = { x: number; y: number; z?: number } | { x: number; y: number; z: number; w?: number };
-
-    type UniformValue =
-      | boolean
-      | number
-      | null
-      | Int32List
-      | Float32List
-      | Coordinates
-      | Coordinates[]
-      | Color.RGBColorVector
-      | Color.RGBAColorVector
-      | PIXI.Texture
-      | PIXI.Matrix;
-
-    // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-    type Uniforms = {
-      readonly [K: string]: AbstractBaseShader.UniformValue;
-    };
-
-    type FragmentShaderFunction = ToMethod<(arg0: never) => string>;
-
-    type PreRenderFunction = ToMethod<(mesh: PIXI.DisplayObject, renderer: PIXI.Renderer) => void>;
-  }
-}
-
-declare abstract class AnyAbstractBaseShader extends AbstractBaseShader {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/webgl/shaders/filters/base-filter.d.mts

@@ -1,48 +0,0 @@
-import type { FixedInstanceType } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * An abstract filter which provides a framework for reusable definition
-   */
-  class AbstractBaseFilter extends BaseShaderMixin(PIXI.Filter) {
-    /**
-     * The default uniforms used by the filter
-     * @defaultValue `{}`
-     */
-    static defaultUniforms: AbstractBaseShader.Uniforms;
-
-    /**
-     * The fragment shader which renders this filter.
-     * @defaultValue `undefined`
-     */
-    static fragmentShader: AbstractBaseShader.FragmentShaderFunction | string | undefined;
-
-    /**
-     * The vertex shader which renders this filter.
-     * @defaultValue `undefined`
-     */
-    static vertexShader: string | undefined;
-
-    /**
-     * A factory method for creating the filter using its defined default values.
-     * @param initialUniforms - Initial uniform values which override filter defaults
-     * @returns The constructed AbstractFilter[sic] instance.
-     */
-    static create<ThisType extends AbstractBaseFilter.AnyConstructor>(
-      this: ThisType,
-      /**
-       * @defaultValue `{}`
-       */
-      initialUniforms?: AbstractBaseShader.Uniforms,
-    ): FixedInstanceType<ThisType>;
-  }
-
-  namespace AbstractBaseFilter {
-    interface Any extends AnyAbstractBaseFilter {}
-    type AnyConstructor = typeof AnyAbstractBaseFilter;
-  }
-}
-
-declare abstract class AnyAbstractBaseFilter extends AbstractBaseFilter {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/webgl/shaders/filters/base-mask-filter.d.mts

@@ -1,31 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * This class defines an interface for masked custom filters
-   */
-  class AbstractBaseMaskFilter extends AbstractBaseFilter {
-    /**
-     * The default vertex shader used by all instances of AbstractBaseMaskFilter
-     */
-    static vertexShader: string;
-
-    /** @remarks Foundry does not use the `currentState` param */
-    override apply(
-      filterManager: PIXI.FilterSystem,
-      input: PIXI.RenderTexture,
-      output: PIXI.RenderTexture,
-      clear: PIXI.CLEAR_MODES,
-      currentState?: PIXI.FilterState,
-    ): void;
-  }
-
-  namespace AbstractBaseMaskFilter {
-    interface Any extends AnyAbstractBaseMaskFilter {}
-    type AnyConstructor = typeof AnyAbstractBaseMaskFilter;
-  }
-}
-
-declare abstract class AnyAbstractBaseMaskFilter extends AbstractBaseMaskFilter {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/pixi/webgl/shaders/filters/blur.d.mts

@@ -1,187 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * Apply a vertical or horizontal gaussian blur going inward by using alpha as the penetrating channel.
-   */
-  class AlphaBlurFilterPass extends PIXI.Filter {
-    /**
-     * @param horizontal - If the pass is horizontal (true) or vertical (false).
-     * @param strength   - Strength of the blur (distance of sampling).
-     *                     (default: `8`)
-     * @param quality    - Number of passes to generate the blur. More passes = Higher quality = Lower Perf.
-     *                     (default: `4`)
-     * @param resolution - Resolution of the filter.
-     *                     (default: PIXI.Filter.defaultResolution)
-     * @param kernelSize - Number of kernels to use. More kernels = Higher quality = Lower Perf.
-     *                     (default: `5`)
-     */
-    constructor(horizontal: boolean, strength?: number, quality?: number, resolution?: number, kernelSize?: number);
-
-    /**
-     * If the pass is horizontal (true) or vertical (false).
-     */
-    horizontal: boolean;
-
-    /**
-     * Strength of the blur (distance of sampling).
-     */
-    strength: number;
-
-    /**
-     * The number of passes to generate the blur.
-     */
-    passes: number;
-
-    /**
-     * The quality of the filter is defined by its number of passes.
-     */
-    get quality(): number;
-
-    set quality(value);
-
-    /**
-     * The strength of the blur filter in pixels.
-     */
-    get blur(): number;
-
-    set blur(value);
-
-    /**
-     * The kernels containing the gaussian constants.
-     */
-    static GAUSSIAN_VALUES: Record<number, number[]>;
-
-    /**
-     * The fragment template generator
-     * @param kernelSize - The number of kernels to use.
-     * @returns The generated fragment shader.
-     */
-    static fragTemplate(kernelSize: number): string;
-
-    /**
-     * The vertex template generator
-     * @param kernelSize - The number of kernels to use.
-     * @param horizontal - If the vertex should handle horizontal or vertical pass.
-     * @returns The generated vertex shader.
-     */
-    static vertTemplate(kernelSize: number, horizontal: boolean): string;
-
-    /**
-     * Generating the dynamic part of the blur in the fragment
-     * @param kernelSize - The number of kernels to use.
-     * @returns The dynamic blur part.
-     */
-    static generateBlurFragSource(kernelSize: number): string;
-
-    /**
-     * Generating the dynamic part of the blur in the vertex
-     * @param kernelSize - number of kernels to use.
-     * @param horizontal - If the vertex should handle horizontal or vertical pass.
-     * @returns The dynamic blur part.
-     */
-    static generateBlurVertSource(kernelSize: number, horizontal: boolean): string;
-
-    override apply(
-      filterManager: PIXI.FilterSystem,
-      input: PIXI.RenderTexture,
-      output: PIXI.RenderTexture,
-      clearMode?: PIXI.CLEAR_MODES,
-    ): void;
-  }
-
-  namespace AlphaBlurFilterPass {
-    interface Any extends AnyAlphaBlurFilterPass {}
-    type AnyConstructor = typeof AnyAlphaBlurFilterPass;
-  }
-
-  /**
-   * Apply a gaussian blur going inward by using alpha as the penetrating channel.
-   */
-  class AlphaBlurFilter extends PIXI.Filter {
-    /**
-     * @param strength   - Strength of the blur (distance of sampling).
-     *                     (default: `8`)
-     * @param quality    - Number of passes to generate the blur. More passes = Higher quality = Lower Perf.
-     *                     (default: `4`)
-     * @param resolution - Resolution of the filter.
-     *                     (default: PIXI.Filter.defaultResolution)
-     * @param kernelSize - Number of kernels to use. More kernels = Higher quality = Lower Perf.
-     *                     (default: `5`)
-     */
-    constructor(strength?: number, quality?: number, resolution?: number, kernelSize?: number);
-
-    blurXFilter: AlphaBlurFilterPass;
-
-    blurYFilter: AlphaBlurFilterPass;
-
-    _repeatEdgePixels: boolean;
-
-    override apply(
-      filterManager: PIXI.FilterSystem,
-      input: PIXI.RenderTexture,
-      output: PIXI.RenderTexture,
-      clearMode?: PIXI.CLEAR_MODES,
-    ): void;
-
-    /**
-     * Update the filter padding according to the blur strength value (0 if _repeatEdgePixels is active)
-     */
-    updatePadding(): void;
-
-    /**
-     * The amount of blur is forwarded to the X and Y filters.
-     */
-    get blur(): number;
-
-    set blur(value);
-
-    /**
-     * The quality of blur defines the number of passes used by subsidiary filters.
-     */
-    get quality(): number;
-
-    set quality(value);
-
-    /**
-     * Whether to repeat edge pixels, adding padding to the filter area.
-     */
-    get repeatEdgePixels(): boolean;
-
-    set repeatEdgePixels(value);
-
-    /**
-     * Provided for completeness with PIXI.BlurFilter
-     */
-    get blurX(): number;
-
-    set blurX(value);
-
-    /**
-     * Provided for completeness with PIXI.BlurFilter
-     */
-    get blurY(): number;
-
-    set blurY(value);
-
-    /**
-     * Provided for completeness with PIXI.BlurFilter
-     */
-    get blendMode(): PIXI.BLEND_MODES;
-
-    set blendMode(value);
-  }
-
-  namespace AlphaBlurFilter {
-    interface Any extends AnyAlphaBlurFilter {}
-    type AnyConstructor = typeof AnyAlphaBlurFilter;
-  }
-}
-
-declare abstract class AnyAlphaBlurFilterPass extends AlphaBlurFilterPass {
-  constructor(arg0: never, ...args: never[]);
-}
-
-declare abstract class AnyAlphaBlurFilter extends AlphaBlurFilter {
-  constructor(arg0: never, ...args: never[]);
-}