@league-of-foundry-developers/foundry-vtt-types 9.280.0 → 12.331.1-beta

package/src/foundry/client/pixi/webgl/filters.d.ts

@@ -1,182 +0,0 @@
-/**
- * This class defines an interface for masked custom filters
- */
-declare abstract class AbstractBaseMaskFilter extends PIXI.Filter {
-  /**
-   * The default vertex shader used by all instances of AbstractBaseMaskFilter
-   */
-  static vertexShader: string;
-
-  /**
-   * The fragment shader which renders this filter.
-   * A subclass of AbstractBaseMaskFilter must implement the fragmentShader(channel) static field.
-   */
-  static fragmentShader: ((channel: 'r' | 'g' | 'b') => string) | null;
-
-  /**
-   * A factory method for creating the filter using its defined default values
-   * @param defaultUniforms - Initial uniforms provided to the filter
-   *                          (default: `{}`)
-   * @param channel         - A color channel to target for masking.
-   *                          (default: `'r'`)
-   */
-  static create<T extends AbstractBaseMaskFilter>(
-    this: ConstructorOf<T>,
-    defaultUniforms?: ConstructorParameters<typeof PIXI.Filter>[2],
-    channel?: 'r' | 'g' | 'b'
-  ): T;
-
-  override apply(
-    filterManager: PIXI.systems.FilterSystem,
-    input: PIXI.RenderTexture,
-    output: PIXI.RenderTexture,
-    clear: PIXI.CLEAR_MODES,
-    currentState: any
-  ): void;
-}
-
-/**
- * A filter used to control channels intensity using an externally provided mask texture.
- * The mask channel used must be provided at filter creation.
- * Contributed by SecretFire#4843
- */
-declare class InverseOcclusionMaskFilter extends AbstractBaseMaskFilter {
-  static fragmentShader(channel: 'r' | 'g' | 'b'): string;
-
-  /**
-   * @param defaultUniforms - (default: `{}`)
-   * @param channel  - (default `'r'`)
-   */
-  static create<T extends InverseOcclusionMaskFilter>(
-    this: ConstructorOf<T>,
-    defaultUniforms?: ConstructorParameters<typeof PIXI.Filter>[2],
-    channel?: 'r' | 'g' | 'b'
-  ): T;
-}
-
-/**
- * An abstract filter which provides a framework for reusable definition
- */
-declare abstract class AbstractFilter extends PIXI.Filter {
-  /**
-   * The default uniforms used by the filter
-   * @defaultValue `{}`
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-
-  /**
-   * The fragment shader which renders this filter.
-   * @defaultValue `undefined`
-   * @remarks This is a function in {@link GlowFilter}. See https://gitlab.com/foundrynet/foundryvtt/-/issues/6937
-   */
-  static fragmentShader: string | ((quality: number, distance: number) => 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 uniforms - (default: `{}`)
-   */
-  static create(uniforms: AbstractBaseShader.Uniforms): AbstractFilter;
-
-  /**
-   * Always target the resolution of the render texture or renderer
-   */
-  // @ts-expect-error this is a property on PIXI.Filter
-  get resolution(): number;
-  set resolution(value: number);
-
-  /**
-   * Always target the MSAA level of the render texture or renderer
-   */
-  get multisample(): PIXI.MSAA_QUALITY;
-  set multisample(value: PIXI.MSAA_QUALITY);
-}
-
-/**
- * A filter which forces all non-transparent pixels to a specific color and transparency.
- */
-declare class ForceColorFilter extends AbstractFilter {
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   color: [1, 1, 1],
-   *   alpha: 1.0
-   * }
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-
-  static fragmentShader: string;
-}
-
-/**
- * A filter which is rendering explored color according to FoW intensity.
- */
-declare class FogColorFilter extends AbstractFilter {
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   exploredColor: [1, 1, 1]
-   * }
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-
-  static fragmentShader: string;
-}
-
-/**
- * This filter turns pixels with an alpha channel &lt; alphaThreshold in transparent pixels
- * Then, optionally, it can turn the result in the chosen color (default: pure white).
- * The alpha [threshold,1] is re-mapped to [0,1] with an hermite interpolation slope to prevent pixelation.
- */
-declare class RoofMaskFilter extends AbstractFilter {
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   alphaThreshold: 0.75,
-   *   turnToColor: false,
-   *   color: [1, 1, 1]
-   * }
-   * ```
-   */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
-
-  static fragmentShader: string;
-}
-
-/**
- * A filter which implements an inner or outer glow around the source texture.
- * Incorporated from https://github.com/pixijs/filters/tree/main/filters/glow
- */
-declare class GlowFilter extends AbstractFilter {
-  /**
-   * @defaultValue
-   * ```typescript
-   * {
-   *   distance: 10,
-   *   innerStrength: 0,
-   *   glowColor: [1, 1, 1, 1],
-   *   quality: 0.1,
-   * }
-   * ```
-   */
-  static override defaultUniforms: AbstractBaseShader.Uniforms & { distance: number; quality: number };
-
-  /**
-   * @remarks This could change, see https://gitlab.com/foundrynet/foundryvtt/-/issues/6937
-   */
-  static override fragmentShader(quality: number, distance: number): string;
-
-  static override vertexShader: string;
-
-  static override create(uniforms: AbstractBaseShader.Uniforms): GlowFilter;
-}

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

@@ -1,5 +0,0 @@
-import './base';
-import './blend_modes';
-import './filters';
-import './lighting';
-import './sampler';

package/src/foundry/client/pixi/webgl/lighting.d.ts

@@ -1,480 +0,0 @@
-interface LightingTechnique {
-  /** The numeric identifier of the technique */
-  id: number;
-
-  /** The localization string that labels the technique */
-  label: string;
-
-  /** The shader fragment when the technique is used */
-  shader: string;
-}
-
-/**
- * This class defines an interface which all adaptive lighting shaders extend.
- */
-declare class AdaptiveLightingShader extends AbstractBaseShader {
-  static override vertexShader: string;
-
-  /**
-   * Useful constant values computed at compile time
-   */
-  static CONSTANTS: string;
-
-  /**
-   * The coloration technique shader fragment
-   */
-  static get ADAPTIVE_COLORATION(): string;
-
-  /**
-   * Fade easing to use with distance in interval [0,1]
-   * @param amp  - (default: `3`)
-   * @param coef - (default: `0.80`)
-   */
-  static FADE(amp?: number, coef?: number): 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;
-
-  /**
-   * A conventional pseudo-random number generator with the "golden" numbers, based on uv position
-   */
-  static PRNG: 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;
-
-  /**
-   * Fast approximate perceived brightness computation
-   * Using Digital ITU BT.709 : Exact luminance factors
-   */
-  static PERCEIVED_BRIGHTNESS: string;
-
-  /**
-   * Switch between an inner and outer color, by comparing distance from center to ratio
-   * Apply a strong gradient between the two areas if gradual uniform is set to true
-   */
-  static SWITCH_COLOR: string;
-
-  /**
-   * Transition between bright and dim colors, if requested
-   */
-  static TRANSITION: string;
-
-  /**
-   * Constrain light to LOS
-   */
-  static CONSTRAIN_TO_LOS: string;
-
-  /**
-   * Incorporate falloff if a gradual uniform is requested
-   */
-  static FALLOFF: string;
-
-  /**
-   * Compute distance from the light center
-   */
-  static DISTANCE: string;
-
-  /**
-   * A mapping of available coloration techniques
-   */
-  static COLORATION_TECHNIQUES: AdaptiveLightingShader.ColorationTechniques;
-}
-
-declare namespace AdaptiveLightingShader {
-  interface ColorationTechniques extends Record<string, LightingTechnique> {
-    LEGACY: LightingTechnique;
-    LUMINANCE: LightingTechnique;
-    INTERNAL_HALO: LightingTechnique;
-    EXTERNAL_HALO: LightingTechnique;
-    COLOR_BURN: LightingTechnique;
-    INTERNAL_BURN: LightingTechnique;
-    EXTERNAL_BURN: LightingTechnique;
-    LOW_ABSORPTION: LightingTechnique;
-    HIGH_ABSORPTION: LightingTechnique;
-    INVERT_ABSORPTION: LightingTechnique;
-  }
-}
-
-/**
- * The default coloration shader used by standard rendering and animations
- * A fragment shader which creates a solid light source.
- */
-declare class AdaptiveBackgroundShader extends AdaptiveLightingShader {
-  /**
-   * Constrain light to LOS
-   */
-  static CONSTRAIN_TO_LOS: string;
-
-  /**
-   * Color adjustments : exposure, contrast and shadows
-   */
-  static ADJUSTMENTS: string;
-
-  /**
-   * Incorporate falloff if a gradual uniform is requested
-   */
-  static FALLOFF: string;
-
-  /**
-   * Memory allocations for the Adaptive Background Shader
-   */
-  static SHADER_HEADER: string;
-
-  static override fragmentShader: string;
-
-  /**
-   * @defaultValue
-   * ```javascript
-   * {
-   *   shadows: 0.0,
-   *   contrast: 0.0,
-   *   exposure: 0.0,
-   *   saturation: 0.0,
-   *   alpha: 1.0,
-   *   ratio: 0.5,
-   *   time: 0,
-   *   screenDimensions: [1, 1],
-   *   uBkgSampler: 0,
-   *   fovTexture: 0,
-   *   darkness: false,
-   *   gradual: false,
-   *   useFov: true
-   * }
-   * ```
-   */
-  static override defaultUniforms: AbstractBaseShader.Uniforms;
-
-  /**
-   * Flag whether the background shader is currently required.
-   * If key uniforms are at their default values, we don't need to render the background container.
-   */
-  get isRequired(): boolean;
-}
-
-/**
- * The default coloration shader used by standard rendering and animations
- * A fragment shader which creates a solid light source.
- */
-declare class AdaptiveIlluminationShader extends AdaptiveLightingShader {
-  /**
-   * Constrain light to LOS
-   */
-  static CONSTRAIN_TO_LOS: string;
-
-  /**
-   * Incorporate falloff if a gradual uniform is requested
-   */
-  static FALLOFF: string;
-
-  /**
-   * Color adjustments : exposure, contrast and shadows
-   */
-  static ADJUSTMENTS: string;
-
-  /**
-   * Memory allocations for the Adaptive Illumination Shader
-   */
-  static SHADER_HEADER: string;
-
-  static override fragmentShader: string;
-
-  /**
-   * @defaultValue
-   * ```javascript
-   * {
-   *   alpha: 1.0,
-   *   ratio: 0.5,
-   *   color: [0.9333333333333333, 0.9333333333333333, 0.9333333333333333],
-   *   colorDim: [0.5, 0.5, 0.5],
-   *   colorBright: [1.0, 1.0, 1.0],
-   *   colorBackground: [1.0, 1.0, 1.0],
-   *   darkness: false,
-   *   exposure: 0.0,
-   *   fovTexture: 0,
-   *   gradual: false,
-   *   intensity: 5,
-   *   saturation: 0.0,
-   *   screenDimensions: [1, 1],
-   *   shadows: 0.0,
-   *   time: 0,
-   *   uBkgSampler: 0,
-   *   useFov: true
-   * }
-   * ```
-   */
-  static override defaultUniforms: AbstractBaseShader.Uniforms;
-
-  /**
-   * Determine the correct illumination penalty to apply for a given darkness level and luminosity
-   * @param darknessLevel - The current darkness level on [0,1]
-   * @param luminosity    - The light source luminosity on [-1,1]
-   * @returns The amount of penalty to apply on [0,1]
-   */
-  getDarknessPenalty(darknessLevel: number, luminosity: number): number;
-}
-
-/**
- * The default coloration shader used by standard rendering and animations.
- * A fragment shader which creates a light source.
- */
-declare class AdaptiveColorationShader extends AdaptiveLightingShader {
-  /**
-   * Incorporate falloff if a falloff uniform is requested
-   */
-  static FALLOFF: string;
-
-  /**
-   * Color adjustments : exposure, contrast and shadows
-   */
-  static ADJUSTMENTS: string;
-
-  /**
-   * Memory allocations for the Adaptive Coloration Shader
-   */
-  static SHADER_HEADER: string;
-
-  static override fragmentShader: string;
-
-  /**
-   * @defaultValue
-   * ```javascript
-   * {
-   *   technique: 1,
-   *   ratio: 0.0,
-   *   shadows: 0.0,
-   *   saturation: 0.0,
-   *   alpha: 1.0,
-   *   color: [1.0, 1.0, 1.0],
-   *   time: 0,
-   *   intensity: 5,
-   *   darkness: false,
-   *   screenDimensions: [1, 1],
-   *   uBkgSampler: 0,
-   *   fovTexture: 0,
-   *   gradual: true,
-   *   useFov: true
-   * }
-   * ```
-   */
-  static override defaultUniforms: AbstractBaseShader.Uniforms;
-}
-
-/**
- * Allow coloring of illumination
- */
-declare class TorchIlluminationShader extends AdaptiveIlluminationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Torch animation coloration shader
- */
-declare class TorchColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * Object.assign({}, super.defaultUniforms, {
-   *   ratio: 0,
-   *   brightnessPulse: 1
-   * })
-   * ```
-   */
-  static override defaultUniforms: AbstractBaseShader.Uniforms;
-}
-
-/**
- * Pulse animation illumination shader
- */
-declare class PulseIlluminationShader extends AdaptiveIlluminationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Pulse animation coloration shader
- */
-declare class PulseColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * Object.assign({}, super.defaultUniforms, {
-   *   pulse: 0
-   * })
-   * ```
-   */
-  static override defaultUniforms: AbstractBaseShader.Uniforms;
-}
-
-/**
- * Energy field animation coloration shader
- */
-declare class EnergyFieldColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Chroma animation coloration shader
- */
-declare class ChromaColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Wave animation illumination shader
- */
-declare class WaveIlluminationShader extends AdaptiveIlluminationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Wave animation coloration shader
- */
-declare class WaveColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Bewitching Wave animation illumination shader
- */
-declare class BewitchingWaveIlluminationShader extends AdaptiveIlluminationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Bewitching Wave animation coloration shader
- */
-declare class BewitchingWaveColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Fog animation coloration shader
- */
-declare class FogColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Sunburst animation illumination shader
- */
-declare class SunburstIlluminationShader extends AdaptiveIlluminationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Sunburst animation coloration shader
- */
-declare class SunburstColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Light dome animation coloration shader
- */
-declare class LightDomeColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Emanation animation coloration shader
- */
-declare class EmanationColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Ghost light animation illumination shader
- */
-declare class GhostLightIlluminationShader extends AdaptiveIlluminationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Ghost light animation coloration shader
- */
-declare class GhostLightColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Hexagonal dome animation coloration shader
- */
-declare class HexaDomeColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Roiling mass illumination shader - intended primarily for darkness
- */
-declare class RoilingIlluminationShader extends AdaptiveIlluminationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Black Hole animation illumination shader
- */
-declare class BlackHoleIlluminationShader extends AdaptiveIlluminationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Vortex animation coloration shader
- */
-declare class VortexColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Vortex animation coloration shader
- */
-declare class VortexIlluminationShader extends AdaptiveIlluminationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Swirling rainbow animation coloration shader
- */
-declare class SwirlingRainbowColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Radial rainbow animation coloration shader
- */
-declare class RadialRainbowColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Fairy light animation coloration shader
- */
-declare class FairyLightColorationShader extends AdaptiveColorationShader {
-  static fragmentShader: string;
-}
-
-/**
- * Fairy light animation illumination shader
- */
-declare class FairyLightIlluminationShader extends AdaptiveIlluminationShader {
-  static fragmentShader: string;
-}

package/src/foundry/client/pixi/webgl/sampler.d.ts

@@ -1,19 +0,0 @@
-/**
- * A simple shader to emulate a PIXI.Sprite with a PIXI.Mesh (but faster!)
- */
-declare class BaseSamplerShader extends AbstractBaseShader {
-  static override vertexShader: string;
-
-  static override fragmentShader: string;
-
-  /**
-   * @defaultValue
-   * ```javascript
-   * {
-   *   screenDimensions: [1, 1],
-   *   sampler: 0
-   * };
-   * ```
-   */
-  static override defaultUniforms: AbstractBaseShader.Uniforms;
-}