PIXI Web GL (#2476)

Add PIXI Web GL

src/foundry/client/pixi/core/containers/quadtree.d.ts

@@ -160,8 +160,7 @@ declare global {
    * A subclass of Quadtree specifically intended for classifying the location of objects on the game canvas.
    */
   class CanvasQuadtree extends Quadtree<object> {
-    // @ts-expect-error Override monkeypatch executed in class constructor
-    get bounds(): SceneDimensions["rect"];
+    readonly bounds: SceneDimensions["rect"];
   }
 
   namespace Quadtree {

src/foundry/client/pixi/webgl/extensions/batch-renderer.d.ts

@@ -0,0 +1,60 @@
+export {};
+
+declare global {
+  /**
+   * A batch renderer with a customizable data transfer function to packed geometries.
+   */
+  class BatchRenderer extends PIXI.BatchRenderer {
+    /**
+     * The PackInterleavedGeometry function provided by the sampler.
+     */
+    protected _packInterleavedGeometry: (
+      element: PIXI.IBatchableElement,
+      attributeBuffer: PIXI.ViewableBuffer,
+      indexBuffer: Uint16Array,
+      aIndex: number,
+      iIndex: number,
+    ) => void;
+
+    /**
+     * The preRender function provided by the sampler and that is called just before a flush.
+     */
+    protected _preRenderBatch: (...args: any[]) => void;
+
+    get uniforms(): AbstractBaseShader.Uniforms;
+
+    /**
+     * The number of reserved texture units that the shader generator should not use (maximum 4).
+     */
+    protected set reservedTextureUnits(val: number);
+
+    /**
+     * Number of reserved texture units reserved by the batch shader that cannot be used by the batch renderer.
+     */
+    get reservedTextureUnits(): number;
+
+    /**
+     * This override allows to allocate a given number of texture units reserved for a custom batched shader.
+     * These reserved texture units won't be used to batch textures for PIXI.Sprite or SpriteMesh.
+     * @override
+     */
+    override contextChange(): void;
+
+    override start(): void;
+
+    override packInterleavedGeometry(
+      element: PIXI.IBatchableElement,
+      attributeBuffer: PIXI.ViewableBuffer,
+      indexBuffer: Uint16Array,
+      aIndex: number,
+      iIndex: number,
+    ): void;
+
+    /**
+     * Verify if a PIXI plugin exists. Check by name.
+     * @param name - The name of the pixi plugin to check.
+     * @returns True if the plugin exists, false otherwise.
+     */
+    static hasPlugin(name: string): boolean;
+  }
+}

src/foundry/client/pixi/webgl/extensions/batch-shader-generator.d.ts

@@ -0,0 +1,21 @@
+export {};
+
+declare global {
+  /**
+   * A batch shader generator that could handle extra uniforms during initialization.
+   */
+  class BatchShaderGenerator extends PIXI.BatchShaderGenerator {
+    constructor(
+      vertexSrc: string,
+      fragTemplate: string,
+      batchDefaultUniforms?: (maxTextures: AbstractBaseShader.UniformValue) => AbstractBaseShader.Uniforms,
+    );
+
+    /**
+     * Extra uniforms that could be handled by a custom batch shader.
+     */
+    _batchDefaultUniforms: ((maxTextures: AbstractBaseShader.UniformValue) => AbstractBaseShader.Uniforms) | undefined;
+
+    override generateShader(maxTextures: number): PIXI.Shader;
+  }
+}

src/foundry/client/pixi/webgl/blend_modes.d.ts → src/foundry/client/pixi/webgl/extensions/blend-modes.d.ts

@@ -30,4 +30,20 @@ declare const BLEND_MODES: {
    * ```
    */
   MIN_COLOR: [GLenum, GLenum, GLenum, GLenum, GLenum, GLenum];
+
+  /**
+   * A custom blend mode equation which chooses the minimum color for color channels and min alpha from alpha channel.
+   * @defaultValue
+   * ```typescript
+   * [
+   *   WebGL2RenderingContext.ONE,
+   *   WebGL2RenderingContext.ONE,
+   *   WebGL2RenderingContext.ONE,
+   *   WebGL2RenderingContext.ONE,
+   *   WebGL2RenderingContext.MIN,
+   *   WebGL2RenderingContext.MIN,
+   * ]
+   * ```
+   */
+  MIN_ALL: [GLenum, GLenum, GLenum, GLenum, GLenum, GLenum];
 };

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

@@ -0,0 +1,3 @@
+import "./batch-renderer";
+import "./batch-shader-generator";
+import "./blend-modes";

src/foundry/client/pixi/webgl/helpers/framebugger-snapshot.d.ts

@@ -0,0 +1,22 @@
+export {};
+
+declare global {
+  /**
+   * Provide the necessary methods to get a snapshot of the framebuffer into a render texture.
+   * Class meant to be used as a singleton.
+   * Created with the precious advices of dev7355608.
+   */
+  class FramebufferSnapshot {
+    /**
+     * The RenderTexture that is the render destination for the framebuffer snapshot.
+     */
+    framebufferTexture: PIXI.RenderTexture;
+
+    /**
+     * Get the framebuffer texture snapshot.
+     * @param renderer - The renderer for this context.
+     * @returns The framebuffer snapshot.
+     */
+    getFramebufferTexture(renderer: PIXI.Renderer): PIXI.RenderTexture;
+  }
+}

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

@@ -0,0 +1,3 @@
+import "./framebugger-snapshot";
+import "./smooth-noise";
+import "./texture-extractor";