@7h3laughingman/foundry-types 13.351.0

package/src/client/canvas/rendering/shaders/samplers/primary/depth.d.mts

@@ -0,0 +1,66 @@
+import BaseSamplerShader from "../base-sampler.mjs";
+
+/**
+ * The depth sampler shader.
+ */
+export default class DepthSamplerShader extends BaseSamplerShader {
+    static override classPluginName: string;
+
+    static override batchGeometry: {
+        id: string;
+        size: number;
+        normalized: boolean;
+        type: PIXI.TYPES;
+    }[];
+
+    static override defaultUniforms: {
+        screenDimensions: number[];
+        sampler: null;
+        occlusionTexture: null;
+        textureAlphaThreshold: number;
+        depthElevation: number;
+        occlusionElevation: number;
+        fadeOcclusion: number;
+        radialOcclusion: number;
+        visionOcclusion: number;
+        restrictsLight: boolean;
+        restrictsWeather: boolean;
+    };
+
+    static override batchDefaultUniforms(maxTex: any): {
+        screenDimensions: number[];
+        occlusionTexture: any;
+    };
+
+    static override _preRenderBatch(batchRenderer: any): void;
+
+    static override _packInterleavedGeometry(element: any, attributeBuffer: any, indexBuffer: any, aIndex: any, iIndex: any): 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;
+}

package/src/client/canvas/rendering/shaders/samplers/primary/occlusion.d.mts

@@ -0,0 +1,77 @@
+/**
+ * @import {OccludableBatchData} from "../_types.mjs"
+ */
+/**
+ * The occlusion sampler shader.
+ */
+export default class OccludableSamplerShader extends BaseSamplerShader {
+    /**
+     * The fragment shader code that applies occlusion.
+     * @type {string}
+     */
+    static "__#65@#OCCLUSION": string;
+    /** @override */
+    static override classPluginName: string;
+    /** @override */
+    static override batchGeometry: {
+        id: string;
+        size: number;
+        normalized: boolean;
+        type: PIXI.TYPES;
+    }[];
+    /** @override */
+    static override defaultUniforms: {
+        screenDimensions: number[];
+        sampler: null;
+        tintAlpha: number[];
+        occlusionTexture: null;
+        unoccludedAlpha: number;
+        occludedAlpha: number;
+        occlusionElevation: number;
+        fadeOcclusion: number;
+        radialOcclusion: number;
+        visionOcclusion: number;
+    };
+    /** @override */
+    static override batchDefaultUniforms(maxTex: any): {
+        screenDimensions: number[];
+        occlusionTexture: any;
+    };
+    /** @override */
+    static override _preRenderBatch(batchRenderer: any): void;
+    /** @override */
+    static override _packInterleavedGeometry(element: any, attributeBuffer: any, indexBuffer: any, aIndex: any, iIndex: any): void;
+    /** @override */
+    static override get batchVertexShader(): string;
+    /**
+     * The batch vertex shader source. Subclasses can override it.
+     * @type {string}
+     * @protected
+     */
+    protected static _batchVertexShader: string;
+    /** @override */
+    static override get batchFragmentShader(): string;
+    /**
+     * The batch fragment shader source. Subclasses can override it.
+     * @type {string}
+     * @protected
+     */
+    protected static _batchFragmentShader: string;
+    /** @override */
+    static override get vertexShader(): string;
+    /**
+     * The vertex shader source. Subclasses can override it.
+     * @type {string}
+     * @protected
+     */
+    protected static _vertexShader: string;
+    /** @override */
+    static override get fragmentShader(): string;
+    /**
+     * The fragment shader source. Subclasses can override it.
+     * @type {string}
+     * @protected
+     */
+    protected static _fragmentShader: string;
+}
+import BaseSamplerShader from "../base-sampler.mjs";

package/src/client/canvas/rendering/shaders/samplers/primary/primary.d.mts

@@ -0,0 +1,28 @@
+/**
+ * @import PrimarySpriteMesh from "./../../../../../canvas/primary/primary-sprite-mesh.mjs";
+ */
+/**
+ * The base shader class of {@link PrimarySpriteMesh}.
+ */
+export default class PrimaryBaseSamplerShader extends OccludableSamplerShader {
+    /**
+     * The depth shader class associated with this shader.
+     * @type {typeof DepthSamplerShader}
+     */
+    static depthShaderClass: typeof DepthSamplerShader;
+    /**
+     * The depth shader associated with this shader.
+     * The depth shader is lazily constructed.
+     * @type {DepthSamplerShader}
+     */
+    get depthShader(): DepthSamplerShader;
+    /**
+     * One-time configuration that is called when the depth shader is created.
+     * @param {DepthSamplerShader} depthShader    The depth shader
+     * @protected
+     */
+    protected _configureDepthShader(depthShader: DepthSamplerShader): void;
+    #private;
+}
+import DepthSamplerShader from "./depth.mjs";
+import OccludableSamplerShader from "./occlusion.mjs";

package/src/client/canvas/rendering/shaders/samplers/primary/token-ring.d.mts

@@ -0,0 +1,33 @@
+/**
+ * The shader definition which powers the TokenRing.
+ */
+export default class TokenRingSamplerShader extends PrimaryBaseSamplerShader {
+    /**
+     * A null UVs array used for nulled texture position.
+     * @type {Float32Array}
+     */
+    static nullUvs: Float32Array;
+    /** @inheritdoc */
+    static batchDefaultUniforms(maxTex: any): {
+        tokenRingTexture: any;
+        time: number;
+        screenDimensions: number[];
+        occlusionTexture: any;
+    };
+    /**
+     * The fragment shader header.
+     * @type {string}
+     */
+    static "__#73@#FRAG_HEADER": string;
+    /**
+     * Fragment shader body.
+     * @type {string}
+     */
+    static "__#73@#FRAG_MAIN": string;
+    /**
+     * Fragment shader body for debug code.
+     * @type {string}
+     */
+    static "__#73@#FRAG_MAIN_DEBUG": string;
+}
+import PrimaryBaseSamplerShader from "./primary.mjs";

package/src/client/canvas/rendering/shaders/vision/background-vision.d.mts

@@ -0,0 +1,47 @@
+import AdaptiveVisionShader from "./base-vision.mjs";
+
+/**
+ * The default background shader used for vision sources
+ */
+export default class BackgroundVisionShader extends AdaptiveVisionShader {
+    static override defaultUniforms: {
+        technique: number;
+        saturation: number;
+        contrast: number;
+        attenuation: number;
+        exposure: number;
+        darknessLevel: number;
+        colorVision: number[];
+        colorTint: number[];
+        colorBackground: number[];
+        screenDimensions: number[];
+        time: number;
+        useSampler: boolean;
+        linkedToDarknessLevel: boolean;
+        primaryTexture: null;
+        depthTexture: null;
+        darknessLevelTexture: null;
+        depthElevation: number;
+        ambientBrightest: number[];
+        ambientDarkness: number[];
+        ambientDaylight: number[];
+        weights: number[];
+        dimLevelCorrection: number;
+        brightLevelCorrection: number;
+        globalLight: boolean;
+        globalLightThresholds: number[];
+    };
+
+    static override fragmentShader: string;
+
+    /**
+     * Memory allocations for the Adaptive Background Shader
+     */
+    static SHADER_HEADER: string;
+
+    /**
+     * 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;
+}

package/src/client/canvas/rendering/shaders/vision/base-vision.d.mts

@@ -0,0 +1,11 @@
+import AdaptiveLightingShader, { ShaderTechnique } from "../lighting/base-lighting.mjs";
+
+/**
+ * This class defines an interface which all adaptive vision shaders extend.
+ */
+export default class AdaptiveVisionShader extends AdaptiveLightingShader {
+    /**
+     * A mapping of available shader techniques
+     */
+    static SHADER_TECHNIQUES: Record<string, ShaderTechnique>;
+}

package/src/client/canvas/rendering/shaders/vision/coloration-vision.d.mts

@@ -0,0 +1,43 @@
+/**
+ * The default coloration shader used for vision sources.
+ */
+export default class ColorationVisionShader extends AdaptiveVisionShader {
+    /**
+     * Memory allocations for the Adaptive Coloration Shader
+     * @type {string}
+     */
+    static SHADER_HEADER: string;
+    /** @inheritdoc */
+    static fragmentShader: string;
+    /** @inheritdoc */
+    static defaultUniforms: {
+        technique: number;
+        saturation: number;
+        attenuation: number;
+        colorEffect: number[];
+        colorBackground: number[];
+        colorTint: number[];
+        time: number;
+        screenDimensions: number[];
+        useSampler: boolean;
+        primaryTexture: null;
+        linkedToDarknessLevel: boolean;
+        depthTexture: null;
+        depthElevation: number;
+        ambientBrightest: number[];
+        ambientDarkness: number[];
+        ambientDaylight: number[];
+        weights: number[];
+        dimLevelCorrection: number;
+        brightLevelCorrection: number;
+        globalLight: boolean;
+        globalLightThresholds: number[];
+    };
+    /**
+     * 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.
+     * @type {boolean}
+     */
+    get isRequired(): boolean;
+}
+import AdaptiveVisionShader from "./base-vision.mjs";

package/src/client/canvas/rendering/shaders/vision/effects/amplification.d.mts

@@ -0,0 +1,35 @@
+import BackgroundVisionShader from "../background-vision.mjs";
+
+/**
+ * Shader specialized in light amplification
+ */
+export class AmplificationBackgroundVisionShader extends BackgroundVisionShader {
+    static override defaultUniforms: {
+        colorTint: number[];
+        brightness: number;
+        technique: number;
+        saturation: number;
+        contrast: number;
+        attenuation: number;
+        exposure: number;
+        darknessLevel: number;
+        colorVision: number[];
+        colorBackground: number[];
+        screenDimensions: number[];
+        time: number;
+        useSampler: boolean;
+        linkedToDarknessLevel: boolean;
+        primaryTexture: null;
+        depthTexture: null;
+        darknessLevelTexture: null;
+        depthElevation: number;
+        ambientBrightest: number[];
+        ambientDarkness: number[];
+        ambientDaylight: number[];
+        weights: number[];
+        dimLevelCorrection: number;
+        brightLevelCorrection: number;
+        globalLight: boolean;
+        globalLightThresholds: number[];
+    };
+}

package/src/client/canvas/rendering/shaders/vision/effects/wave.d.mts

@@ -0,0 +1,10 @@
+/**
+ * Shader specialized in wave like senses (tremorsenses)
+ */
+export class WaveBackgroundVisionShader extends BackgroundVisionShader {}
+/**
+ * The wave vision shader, used to create waves emanations (ex: tremorsense)
+ */
+export class WaveColorationVisionShader extends ColorationVisionShader {}
+import BackgroundVisionShader from "../background-vision.mjs";
+import ColorationVisionShader from "../coloration-vision.mjs";

package/src/client/canvas/rendering/shaders/vision/illumination-vision.d.mts

@@ -0,0 +1,45 @@
+/**
+ * The default illumination shader used for vision sources
+ */
+export default class IlluminationVisionShader extends AdaptiveVisionShader {
+    /**
+     * Transition between bright and dim colors, if requested
+     * @type {string}
+     */
+    static VISION_COLOR: string;
+    /**
+     * Memory allocations for the Adaptive Illumination Shader
+     * @type {string}
+     */
+    static SHADER_HEADER: string;
+    /** @inheritdoc */
+    static fragmentShader: string;
+    /** @inheritdoc */
+    static defaultUniforms: {
+        technique: any;
+        attenuation: number;
+        exposure: number;
+        saturation: number;
+        darknessLevel: number;
+        colorVision: number[];
+        colorTint: number[];
+        colorBackground: number[];
+        screenDimensions: number[];
+        time: number;
+        useSampler: boolean;
+        linkedToDarknessLevel: boolean;
+        primaryTexture: null;
+        depthTexture: null;
+        darknessLevelTexture: null;
+        depthElevation: number;
+        ambientBrightest: number[];
+        ambientDarkness: number[];
+        ambientDaylight: number[];
+        weights: number[];
+        dimLevelCorrection: number;
+        brightLevelCorrection: number;
+        globalLight: boolean;
+        globalLightThresholds: number[];
+    };
+}
+import AdaptiveVisionShader from "./base-vision.mjs";

package/src/client/canvas/rendering/shaders/weather/base-weather.d.mts

@@ -0,0 +1,87 @@
+/**
+ * The base shader class for weather shaders.
+ */
+export default class AbstractWeatherShader extends AbstractBaseShader {
+    /**
+     * Compute the weather masking value.
+     * @type {string}
+     */
+    static COMPUTE_MASK: string;
+    /**
+     * Compute the weather masking value.
+     * @type {string}
+     */
+    static FRAGMENT_HEADER: string;
+    /**
+     * Common uniforms for all weather shaders.
+     * @type {{
+     *  useOcclusion: boolean,
+     *  occlusionTexture: PIXI.Texture|null,
+     *  reverseOcclusion: boolean,
+     *  occlusionWeights: number[],
+     *  useTerrain: boolean,
+     *  terrainTexture: PIXI.Texture|null,
+     *  reverseTerrain: boolean,
+     *  terrainWeights: number[],
+     *  alpha: number,
+     *  tint: number[],
+     *  screenDimensions: [number, number],
+     *  effectDimensions: [number, number],
+     *  depthElevation: number,
+     *  time: number
+     * }}
+     */
+    static commonUniforms: {
+        useOcclusion: boolean;
+        occlusionTexture: PIXI.Texture | null;
+        reverseOcclusion: boolean;
+        occlusionWeights: number[];
+        useTerrain: boolean;
+        terrainTexture: PIXI.Texture | null;
+        reverseTerrain: boolean;
+        terrainWeights: number[];
+        alpha: number;
+        tint: number[];
+        screenDimensions: [number, number];
+        effectDimensions: [number, number];
+        depthElevation: number;
+        time: number;
+    };
+    /**
+     * Default uniforms for a specific class
+     * @abstract
+     */
+    static defaultUniforms: any;
+    /** @override */
+    static override create(initialUniforms: any): AbstractWeatherShader;
+    /**
+     * Create the shader program.
+     * @returns {PIXI.Program}
+     */
+    static createProgram(): PIXI.Program;
+    constructor(...args: any[]);
+    /**
+     * Update the scale of this effect with new values
+     * @param {number|{x: number, y: number}} scale    The desired scale
+     */
+    set scale(
+        scale:
+            | number
+            | {
+                  x: number;
+                  y: number;
+              },
+    );
+    set scaleX(x: any);
+    set scaleY(y: any);
+    /**
+     * The speed multiplier applied to animation.
+     * 0 stops animation.
+     * @type {number}
+     */
+    speed: number;
+    /** @override */
+    override _preRender(mesh: any, renderer: any): void;
+    #private;
+}
+import AbstractBaseShader from "../base-shader.mjs";

package/src/client/canvas/rendering/shaders/weather/effect.d.mts

@@ -0,0 +1,27 @@
+/**
+ * An interface for defining shader-based weather effects
+ * @param {object} config   The config object to create the shader effect
+ */
+export default class WeatherShaderEffect extends QuadMesh {
+    constructor(config: any, shaderClass: any);
+    /**
+     * Set shader parameters.
+     * @param {object} [config={}]
+     */
+    configure(config?: object | undefined): void;
+    /**
+     * Begin animation
+     */
+    play(): void;
+    /**
+     * Stop animation
+     */
+    stop(): void;
+    /**
+     * Initialize the weather effect.
+     * @param {object} config        Config object.
+     * @protected
+     */
+    protected _initialize(config: object): void;
+}
+import QuadMesh from "../../../containers/elements/quad-mesh.mjs";

package/src/client/canvas/rendering/shaders/weather/fog.d.mts

@@ -0,0 +1,26 @@
+/**
+ * Fog shader effect.
+ */
+export default class FogShader extends AbstractWeatherShader {
+    /** @inheritdoc */
+    static defaultUniforms: {
+        intensity: number;
+        rotation: number;
+        slope: number;
+    };
+    /**
+     * Configure the number of octaves into the shaders.
+     * @param {number} mode
+     * @returns {string}
+     */
+    static OCTAVES(mode: number): string;
+    /**
+     * Configure the fog complexity according to mode (performance).
+     * @param {number} mode
+     * @returns {string}
+     */
+    static FOG(mode: number): string;
+    /** @inheritdoc */
+    static fragmentShader(mode: any): string;
+}
+import AbstractWeatherShader from "./base-weather.mjs";

package/src/client/canvas/rendering/shaders/weather/rain.d.mts

@@ -0,0 +1,16 @@
+/**
+ * Rain shader effect.
+ */
+export default class RainShader extends AbstractWeatherShader {
+    /** @inheritdoc */
+    static defaultUniforms: {
+        opacity: number;
+        intensity: number;
+        strength: number;
+        rotation: number;
+        resolution: number[];
+    };
+    /** @inheritdoc */
+    static fragmentShader: string;
+}
+import AbstractWeatherShader from "./base-weather.mjs";

package/src/client/canvas/rendering/shaders/weather/snow.d.mts

@@ -0,0 +1,12 @@
+/**
+ * Snow shader effect.
+ */
+export default class SnowShader extends AbstractWeatherShader {
+    /** @inheritdoc */
+    static defaultUniforms: {
+        direction: number;
+    };
+    /** @inheritdoc */
+    static fragmentShader: string;
+}
+import AbstractWeatherShader from "./base-weather.mjs";

package/src/client/canvas/scene-manager.d.mts

@@ -0,0 +1,101 @@
+import Scene from "./../documents/scene.mjs";
+
+/**
+ * A framework for imbuing special scripted behaviors into a single specific Scene.
+ * Managed scenes are registered in CONFIG.Canvas.managedScenes.
+ *
+ * The SceneManager instance is called at various points in the Scene rendering life-cycle.
+ *
+ * This also provides a framework for registering additional hook events which are required only for the life-cycle of
+ * the managed Scene.
+ *
+ * @example Registering a custom SceneManager
+ * ```js
+ * // Define a custom SceneManager subclass
+ * class MyCustomSceneManager extends SceneManager {
+ *   async _onInit() {
+ *     console.log(`Initializing managed Scene "${this.scene.name}"`);
+ *   }
+ *
+ *   async _onDraw() {
+ *     console.log(`Drawing managed Scene "${this.scene.name}"`);
+ *   }
+ *
+ *   async _onReady() {
+ *     console.log(`Readying managed Scene "${this.scene.name}"`);
+ *   }
+ *
+ *   async _onTearDown() {
+ *     console.log(`Deconstructing managed Scene "${this.scene.name}"`);
+ *   }
+ *
+ *   _registerHooks() {
+ *     this.registerHook("updateToken", this.#onUpdateToken.bind(this));
+ *   }
+ *
+ *   #onUpdateToken(document, updateData, options, userId) {
+ *     console.log("Updating a token within the managed Scene");
+ *   }
+ * }
+ *
+ * // Register MyCustomSceneManager to be used for a specific Scene
+ * CONFIG.Canvas.sceneManagers = {
+ *   [sceneId]: MyCustomSceneManager
+ * }
+ * ```
+ */
+export default class SceneManager {
+    /** The SceneManager is constructed by passing a reference to the active Scene document. */
+    constructor(scene: Scene);
+
+    /** The managed Scene. */
+    get scene(): Scene;
+
+    /* -------------------------------------------- */
+    /*  Scene Life-Cycle Methods                    */
+    /* -------------------------------------------- */
+
+    /**
+     * Additional behaviors to perform when the Canvas is first initialized for the Scene.
+     * @internal
+     */
+    _onInit(): Promise<void>;
+
+    /**
+     * Additional behaviors to perform after core groups and layers are drawn to the canvas.
+     * @internal
+     */
+    _onDraw(): Promise<void>;
+
+    /**
+     * Additional behaviors to perform after the Canvas is fully initialized for the Scene.
+     * @internal
+     */
+    _onReady(): Promise<void>;
+
+    /**
+     * Additional behaviors to perform when the Scene is deactivated.
+     * @internal
+     */
+    _onTearDown(): Promise<void>;
+
+    /* -------------------------------------------- */
+    /*  Scene Hooks                                 */
+    /* -------------------------------------------- */
+
+    /**
+     * Register additional hook functions are only used while this Scene is active and is automatically deactivated.
+     * Hooks should be registered in this function by calling this._registerHook(hookName, handler)
+     * @internal
+     */
+    _registerHooks(): void;
+
+    /** Register additional hook functions are only used while this Scene is active and is automatically deactivated. */
+    registerHook(hookName: string, handler: (...args: unknown[]) => number | void): void;
+
+    /**
+     * Deactivate Hook functions that were added specifically for this Scene.
+     * @internal
+     */
+    _deactivateHooks(): void;
+}

package/src/client/canvas/sources/_module.d.mts

@@ -0,0 +1,10 @@
+export { default as BaseEffectSource } from "./base-effect-source.mjs";
+export { default as BaseLightSource } from "./base-light-source.mjs";
+export { default as GlobalLightSource } from "./global-light-source.mjs";
+export { default as PointDarknessSource } from "./point-darkness-source.mjs";
+export { default as PointEffectSourceMixin } from "./point-effect-source.mjs";
+export { default as PointLightSource } from "./point-light-source.mjs";
+export { default as PointMovementSource } from "./point-movement-source.mjs";
+export { default as PointSoundSource } from "./point-sound-source.mjs";
+export { default as PointVisionSource, VisionSourceData } from "./point-vision-source.mjs";
+export { default as RenderedEffectSource } from "./rendered-effect-source.mjs";