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

package/src/foundry/client/pixi/webgl/shaders/samplers/baseline-illumination.d.mts

@@ -1,39 +0,0 @@
-import type { Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * Compute baseline illumination according to darkness level encoded texture.
-   */
-  class BaselineIlluminationSamplerShader extends BaseSamplerShader {
-    /**
-     * @defaultValue `null`
-     */
-    static override classPluginName: string | null;
-
-    static override fragmentShader: string;
-
-    /**
-     * @defaultValue
-     * ```js
-     * {
-     *   tintAlpha: [1, 1, 1, 1],
-     *   ambientDarkness: [0, 0, 0],
-     *   ambientDaylight: [1, 1, 1],
-     *   sampler: null
-     * }
-     * ```
-     */
-    static override defaultUniforms: AbstractBaseShader.Uniforms;
-
-    protected override _preRender: AbstractBaseShader.PreRenderFunction;
-  }
-
-  namespace BaselineIlluminationSamplerShader {
-    interface Any extends AnyBaselineIlluminationSamplerShader {}
-    interface AnyConstructor extends Identity<typeof AnyBaselineIlluminationSamplerShader> {}
-  }
-}
-
-declare abstract class AnyBaselineIlluminationSamplerShader extends BaselineIlluminationSamplerShader {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/webgl/shaders/samplers/color-adjustment.d.mts

@@ -1,118 +0,0 @@
-import type { Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A color adjustment shader.
-   */
-  class ColorAdjustmentsSamplerShader extends BaseSamplerShader {
-    /**
-     * @defaultValue `null`
-     */
-    static override classPluginName: string | null;
-
-    static override vertexShader: string;
-
-    static override fragmentShader: string;
-
-    /**
-     * @defaultValue
-     * ```js
-     * {
-     *   tintAlpha: [1, 1, 1, 1],
-     *   tint: [1, 1, 1],
-     *   contrast: 0,
-     *   saturation: 0,
-     *   exposure: 0,
-     *   sampler: null,
-     *   linkedToDarknessLevel: false,
-     *   darknessLevelTexture: null,
-     *   screenDimensions: [1, 1]
-     * }
-     * ```
-     */
-    static override defaultUniforms: AbstractBaseShader.Uniforms;
-
-    /** @privateRemarks Inferred from defaultUniforms */
-    get linkedToDarknessLevel(): boolean;
-
-    set linkedToDarknessLevel(link);
-
-    /** @privateRemarks Inferred from defaultUniforms */
-    get contrast(): number;
-
-    set contrast(contrast);
-
-    /** @privateRemarks Inferred from defaultUniforms */
-    get exposure(): number;
-
-    set exposure(exposure);
-
-    /** @privateRemarks Inferred from defaultUniforms */
-    get saturation(): number;
-
-    set saturation(saturation);
-  }
-
-  namespace ColorAdjustmentsSamplerShader {
-    interface Any extends AnyColorAdjustmentsSamplerShader {}
-    interface AnyConstructor extends Identity<typeof AnyColorAdjustmentsSamplerShader> {}
-  }
-
-  /**
-   * A light amplification shader.
-   */
-  class AmplificationSamplerShader extends ColorAdjustmentsSamplerShader {
-    /**
-     * @defaultValue `null`
-     */
-    static override classPluginName: string | null;
-
-    static override vertexShader: string;
-
-    static override fragmentShader: string;
-
-    /**
-     * @defaultValue
-     * ```js
-     * {
-     *   tintAlpha: [1, 1, 1, 1],
-     *   tint: [0.38, 0.8, 0.38],
-     *   brightness: 0,
-     *   darknessLevelTexture: null,
-     *   screenDimensions: [1, 1],
-     *   enable: true
-     * }
-     * ```
-     */
-    static override defaultUniforms: AbstractBaseShader.Uniforms;
-
-    /**
-     * Brightness controls the luminosity.
-     */
-    get brightness(): number;
-
-    set brightness(brightness);
-
-    /**
-     * Tint color applied to Light Amplification.
-     * Light Amplification tint
-     * @defaultValue `[0.48, 1.0, 0.48]`
-     */
-    get colorTint(): Color.RGBColorVector;
-
-    set colorTint(color);
-  }
-
-  namespace AmplificationSamplerShader {
-    interface Any extends AnyAmplificationSamplerShader {}
-    interface AnyConstructor extends Identity<typeof AnyAmplificationSamplerShader> {}
-  }
-}
-
-declare abstract class AnyColorAdjustmentsSamplerShader extends ColorAdjustmentsSamplerShader {
-  constructor(...args: never);
-}
-
-declare abstract class AnyAmplificationSamplerShader extends AmplificationSamplerShader {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/webgl/shaders/samplers/depth.d.mts

@@ -1,107 +0,0 @@
-import type { Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The depth sampler shader.
-   */
-  class DepthSamplerShader extends BaseSamplerShader {
-    /**
-     * @defaultValue `"batchDepth"`
-     */
-    static override classPluginName: string | null;
-
-    static override batchGeometry: BaseSamplerShader.BatchGeometry;
-
-    /**
-     * @defaultValue `6`
-     */
-    static override batchVertexSize: number;
-
-    /**
-     * @defaultValue `1`
-     */
-    static override reservedTextureUnits: number;
-
-    /**
-     * @defaultValue
-     * ```js
-     * {
-     *   screenDimensions: [1, 1],
-     *   sampler: null,
-     *   occlusionTexture: null,
-     *   textureAlphaThreshold: 0,
-     *   depthElevation: 0,
-     *   occlusionElevation: 0,
-     *   fadeOcclusion: 0,
-     *   radialOcclusion: 0,
-     *   visionOcclusion: 0,
-     *   restrictsLight: false,
-     *   restrictsWeather: false
-     * }
-     * ```
-     */
-    static override defaultUniforms: AbstractBaseShader.Uniforms;
-
-    static override batchDefaultUniforms: BatchRenderer.BatchDefaultUniformsFunction;
-
-    static override _preRenderBatch: BatchRenderer.PreRenderBatchFunction;
-
-    protected static override _packInterleavedGeometry(
-      element: DepthSamplerShader.DepthBatchData,
-      attributeBuffer: PIXI.ViewableBuffer,
-      indexBuffer: Uint16Array,
-      aIndex: number,
-      iIndex: number,
-    ): void;
-
-    static override get batchVertexShader(): string;
-
-    /**
-     * The batch vertex shader source. Subclasses can override it.
-     */
-    protected static _batchVertexShader: string;
-
-    static override get batchFragmentShader(): string;
-
-    /**
-     * The batch fragment shader source. Subclasses can override it.
-     */
-    protected static _batchFragmentShader: string;
-
-    static override get vertexShader(): string;
-
-    /**
-     * The vertex shader source. Subclasses can override it.
-     */
-    protected static _vertexShader: string;
-
-    static override get fragmentShader(): string;
-
-    /**
-     * The fragment shader source. Subclasses can override it.
-     */
-    protected static _fragmentShader: string;
-
-    protected override _preRender: AbstractBaseShader.PreRenderFunction;
-  }
-
-  namespace DepthSamplerShader {
-    interface Any extends AnyDepthSamplerShader {}
-    interface AnyConstructor extends Identity<typeof AnyDepthSamplerShader> {}
-
-    /** @internal */
-    type PartialPIXIBatchable = Pick<PIXI.IBatchableElement, "_texture" | "vertexData" | "indices" | "uvs">;
-
-    interface DepthBatchData extends PartialPIXIBatchable {
-      elevation: number;
-      textureAlphaThreshold: number;
-      fadeOcclusion: number;
-      radialOcclusion: number;
-      visionOcclusion: number;
-    }
-  }
-}
-
-declare abstract class AnyDepthSamplerShader extends DepthSamplerShader {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/webgl/shaders/samplers/fog-of-war.d.mts

@@ -1,25 +0,0 @@
-import type { Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A simple shader which purpose is to make the original texture red channel the alpha channel,
-   * and still keeping channel informations. Used in cunjunction with the AlphaBlurFilterPass and Fog of War.
-   */
-  class FogSamplerShader extends BaseSamplerShader {
-    /**
-     * @defaultValue `null`
-     */
-    static override classPluginName: string | null;
-
-    static override fragmentShader: string;
-  }
-
-  namespace FogSamplerShader {
-    interface Any extends AnyFogSamplerShader {}
-    interface AnyConstructor extends Identity<typeof AnyFogSamplerShader> {}
-  }
-}
-
-declare abstract class AnyFogSamplerShader extends FogSamplerShader {
-  constructor(...args: never);
-}

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

@@ -1,8 +0,0 @@
-import "./base-sampler.d.mts";
-import "./baseline-illumination.d.mts";
-import "./color-adjustment.d.mts";
-import "./depth.d.mts";
-import "./fog-of-war.d.mts";
-import "./occlusion.d.mts";
-import "./primary.d.mts";
-import "./token-ring.d.mts";

package/src/foundry/client/pixi/webgl/shaders/samplers/occlusion.d.mts

@@ -1,106 +0,0 @@
-import type { Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * An occlusion shader to reveal certain area with elevation comparisons.
-   * This shader is also working as a batched plugin.
-   */
-  class OccludableSamplerShader extends BaseSamplerShader {
-    /**
-     * @defaultValue `"batchOcclusion"`
-     */
-    static override classPluginName: string;
-
-    static override batchGeometry: BaseSamplerShader.BatchGeometry;
-
-    /**
-     * @defaultValue `7`
-     */
-    static override batchVertexSize: number;
-
-    /**
-     * @defaultValue `1`
-     */
-    static reservedTextureUnits: number;
-
-    /**
-     * @defaultValue
-     * ```js
-     * {
-     *   screenDimensions: [1, 1],
-     *   sampler: null,
-     *   tintAlpha: [1, 1, 1, 1],
-     *   occlusionTexture: null,
-     *   unoccludedAlpha: 1,
-     *   occludedAlpha: 0,
-     *   occlusionElevation: 0,
-     *   fadeOcclusion: 0,
-     *   radialOcclusion: 0,
-     *   visionOcclusion: 0
-     * }
-     * ```
-     */
-    static override batchDefaultUniforms: BatchRenderer.BatchDefaultUniformsFunction;
-
-    protected static override _preRenderBatch: BatchRenderer.PreRenderBatchFunction;
-
-    protected static override _packInterleavedGeometry(
-      element: OccludableSamplerShader.OccludableBatchData,
-      attributeBuffer: PIXI.ViewableBuffer,
-      indexBuffer: Uint16Array,
-      aIndex: number,
-      iIndex: number,
-    ): void;
-
-    static override get batchVertexShader(): string;
-
-    /**
-     * The batch vertex shader source. Subclasses can override it.
-     */
-    protected static _batchVertexShader: string;
-
-    static override get batchFragmentShader(): string;
-
-    /**
-     * The batch fragment shader source. Subclasses can override it.
-     */
-    protected static _batchFragmentShader: string;
-
-    static override get vertexShader(): string;
-
-    /**
-     * The vertex shader source. Subclasses can override it.
-     */
-    protected static _vertexShader: string;
-
-    static override get fragmentShader(): string;
-
-    /**
-     * The fragment shader source. Subclasses can override it.
-     */
-    protected static _fragmentShader: string;
-
-    static override defaultUniforms: AbstractBaseShader.Uniforms;
-
-    protected override _preRender: AbstractBaseShader.PreRenderFunction;
-  }
-
-  namespace OccludableSamplerShader {
-    interface Any extends AnyOccludableSamplerShader {}
-    interface AnyConstructor extends Identity<typeof AnyOccludableSamplerShader> {}
-
-    /** @privateRemarks Unlike `DepthSamplerShader`, this class uses every `IBatchableElement` key */
-    interface OccludableBatchData extends PIXI.IBatchableElement {
-      elevation: number;
-      unoccludedAlpha: number;
-      occludedAlpha: number;
-      fadeOcclusion: number;
-      radialOcclusion: number;
-      visionOcclusion: number;
-    }
-  }
-}
-
-declare abstract class AnyOccludableSamplerShader extends OccludableSamplerShader {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/webgl/shaders/samplers/primary.d.mts

@@ -1,35 +0,0 @@
-import type { Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The base shader class of {@link PrimarySpriteMesh | `PrimarySpriteMesh`}.
-   */
-  class PrimaryBaseSamplerShader extends OccludableSamplerShader {
-    /**
-     * The depth shader class associated with this shader.
-     * @defaultValue `DepthSampleShader`
-     */
-    static depthShaderClass: typeof DepthSamplerShader;
-
-    /**
-     * The depth shader associated with this shader.
-     * The depth shader is lazily constructed.
-     */
-    get depthShader(): DepthSamplerShader;
-
-    /**
-     * One-time configuration that is called when the depth shader is created.
-     * @param depthShader - The depth shader
-     */
-    protected _configureDepthShader(depthShader: DepthSamplerShader): void;
-  }
-
-  namespace PrimaryBaseSamplerShader {
-    interface Any extends AnyPrimaryBaseSamplerShader {}
-    interface AnyConstructor extends Identity<typeof AnyPrimaryBaseSamplerShader> {}
-  }
-}
-
-declare abstract class AnyPrimaryBaseSamplerShader extends PrimaryBaseSamplerShader {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/webgl/shaders/samplers/token-ring.d.mts

@@ -1,73 +0,0 @@
-import type { Identity, NullishProps } from "fvtt-types/utils";
-import type TokenRing from "#client-esm/canvas/tokens/ring.d.mts";
-
-declare global {
-  /**
-   * The shader definition which powers the TokenRing.
-   */
-  class TokenRingSamplerShader extends PrimaryBaseSamplerShader {
-    /**
-     * @defaultValue `"tokenRingBatch"`
-     */
-    static override classPluginName: string;
-
-    static override batchGeometry: typeof PIXI.BatchGeometry;
-
-    /**
-     * @defaultValue `super.batchVertexSize + 11`
-     */
-    static override batchVertexSize: number;
-
-    /**
-     * @defaultValue `super.reservedTextureUnits + 1`
-     */
-    static override reservedTextureUnits: number;
-
-    /**
-     * A null UVs array used for nulled texture position.
-     * @defaultValue `[0, 0, 0, 0, 0, 0, 0, 0]`
-     */
-    static nullUvs: Float32Array;
-
-    static override batchDefaultUniforms: BatchRenderer.BatchDefaultUniformsFunction;
-
-    protected static override _preRenderBatch: BatchRenderer.PreRenderBatchFunction;
-
-    protected static override _packInterleavedGeometry(
-      /** @privateRemarks Calls super, which is the grandparent class in this case, with no new keys */
-      element: TokenRingSamplerShader.BatchData,
-      attributeBuffer: PIXI.ViewableBuffer,
-      indexBuffer: Uint16Array,
-      aIndex: number,
-      iIndex: number,
-    ): void;
-
-    protected static override _batchVertexShader: string;
-
-    protected static override _batchFragmentShader: string;
-  }
-
-  namespace TokenRingSamplerShader {
-    interface Any extends AnyTokenRingSamplerShader {}
-    interface AnyConstructor extends Identity<typeof AnyTokenRingSamplerShader> {}
-
-    /** @internal */
-    type RingContainerObject = NullishProps<{
-      object: NullishProps<{
-        ring: TokenRing;
-      }>;
-    }>;
-
-    interface BatchData extends OccludableSamplerShader.OccludableBatchData {
-      /**
-       * @remarks This key is required to be an object as `TokenRingSamplerShader._packInterleavedGeometry` does `element.object.object || {}`.
-       * All `TokenRing` keys are then accessed via optional chaining with `??` defaults.
-       */
-      object: RingContainerObject;
-    }
-  }
-}
-
-declare abstract class AnyTokenRingSamplerShader extends TokenRingSamplerShader {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/webgl/shaders/vision/background-vision.d.mts

@@ -1,43 +0,0 @@
-import type { Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The default background shader used for vision sources
-   */
-  class BackgroundVisionShader extends AdaptiveVisionShader {
-    static override FRAGMENT_END: string;
-
-    /**
-     * Adjust the intensity according to the difference between the pixel darkness level and the scene darkness level.
-     * Used to see the difference of intensity when computing the background shader which is completeley overlapping
-     * The surface texture.
-     */
-    static ADJUST_INTENSITY: string;
-
-    static override ADJUSTMENTS: string;
-
-    /**
-     * Memory allocations for the Adaptive Background Shader
-     */
-    static SHADER_HEADER: string;
-
-    static override fragmentShader: string;
-
-    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;
-  }
-
-  namespace BackgroundVisionShader {
-    interface Any extends AnyBackgroundVisionShader {}
-    interface AnyConstructor extends Identity<typeof AnyBackgroundVisionShader> {}
-  }
-}
-
-declare abstract class AnyBackgroundVisionShader extends BackgroundVisionShader {
-  constructor(...args: never);
-}

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

@@ -1,33 +0,0 @@
-import type { Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * This class defines an interface which all adaptive vision shaders extend.
-   */
-  class AdaptiveVisionShader extends AdaptiveLightingShader {
-    static override FRAGMENT_FUNCTIONS: string;
-
-    static override EXPOSURE: string;
-
-    static override COMPUTE_ILLUMINATION: string;
-
-    static override SHADOW: string;
-
-    static override FRAGMENT_BEGIN: string;
-
-    /**
-     * A mapping of available shader techniques
-     * @remarks Removes all parent techniques other than `LEGACY`
-     */
-    static override SHADER_TECHNIQUES: Record<string, AdaptiveLightingShader.ShaderTechnique>;
-  }
-
-  namespace AdaptiveVisionShader {
-    interface Any extends AnyAdaptiveVisionShader {}
-    interface AnyConstructor extends Identity<typeof AnyAdaptiveVisionShader> {}
-  }
-}
-
-declare abstract class AnyAdaptiveVisionShader extends AdaptiveVisionShader {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/webgl/shaders/vision/coloration-vision.d.mts

@@ -1,42 +0,0 @@
-import type { Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The default coloration shader used for vision sources.
-   */
-  class ColorationVisionShader extends AdaptiveVisionShader {
-    /**
-     * @defaultValue `""`
-     */
-    static override EXPOSURE: string;
-
-    /**
-     * @defaultValue `""`
-     */
-    static override CONTRAST: string;
-
-    /**
-     * Memory allocations for the Adaptive Coloration Shader
-     */
-    static SHADER_HEADER: string;
-
-    static override fragmentShader: string;
-
-    static override defaultUniforms: AbstractBaseShader.Uniforms;
-
-    /**
-     * Flag whether the coloration shader is currently required.
-     * If key uniforms are at their default values, we don't need to render the coloration container.
-     */
-    get isRequired(): boolean;
-  }
-
-  namespace ColorationVisionShader {
-    interface Any extends AnyColorationVisionShader {}
-    interface AnyConstructor extends Identity<typeof AnyColorationVisionShader> {}
-  }
-}
-
-declare abstract class AnyColorationVisionShader extends ColorationVisionShader {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/webgl/shaders/vision/effects/amplification.d.mts

@@ -1,33 +0,0 @@
-import type { Identity } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * Shader specialized in light amplification
-   */
-  class AmplificationBackgroundVisionShader extends BackgroundVisionShader {
-    static override fragmentShader: string;
-
-    /**
-     * @defaultValue
-     * ```js
-     * {
-     *   ...super.defaultUniforms,
-     *   colorTint: [0.38, 0.8, 0.38],
-     *   brightness: 0.5
-     * }
-     * ```
-     */
-    static override defaultUniforms: AbstractBaseShader.Uniforms;
-
-    override get isRequired(): boolean;
-  }
-
-  namespace AmplificationBackgroundVisionShader {
-    interface Any extends AnyAmplificationBackgroundVisionShader {}
-    interface AnyConstructor extends Identity<typeof AnyAmplificationBackgroundVisionShader> {}
-  }
-}
-
-declare abstract class AnyAmplificationBackgroundVisionShader extends AmplificationBackgroundVisionShader {
-  constructor(...args: never);
-}

package/src/foundry/client/pixi/webgl/shaders/vision/effects/index.d.mts

@@ -1,2 +0,0 @@
-import "./amplification.d.mts";
-import "./wave.d.mts";