@quake2ts/test-utils 0.0.761 → 0.0.764

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quake2ts/test-utils",
-  "version": "0.0.761",
+  "version": "0.0.764",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -39,10 +39,10 @@
     "pngjs": "^7.0.0",
     "vitest": "^1.6.0",
     "webgpu": "^0.3.8",
-    "@quake2ts/engine": "^0.0.761",
-    "@quake2ts/game": "0.0.761",
-    "@quake2ts/server": "0.0.761",
-    "@quake2ts/shared": "0.0.761"
+    "@quake2ts/engine": "^0.0.764",
+    "@quake2ts/server": "0.0.764",
+    "@quake2ts/game": "0.0.764",
+    "@quake2ts/shared": "0.0.764"
   },
   "peerDependenciesMeta": {
     "@quake2ts/engine": {
@@ -77,13 +77,14 @@
     }
   },
   "devDependencies": {
-    "gl-matrix": "^3.4.4",
     "@napi-rs/canvas": "^0.1.84",
+    "@types/gl": "^6.0.5",
     "@types/jsdom": "^27.0.0",
     "@types/pixelmatch": "^5.2.6",
     "@types/pngjs": "^6.0.5",
     "@webgpu/types": "^0.1.68",
     "fake-indexeddb": "^6.0.0",
+    "gl-matrix": "^3.4.4",
     "jsdom": "^27.3.0",
     "pixelmatch": "^7.1.0",
     "playwright": "^1.57.0",
@@ -92,14 +93,18 @@
     "typescript": "^5.4.5",
     "vitest": "^1.6.0",
     "webgpu": "^0.3.8",
-    "@quake2ts/engine": "^0.0.761",
-    "@quake2ts/shared": "0.0.761",
-    "@quake2ts/server": "0.0.761",
-    "@quake2ts/game": "0.0.761"
+    "@quake2ts/engine": "^0.0.764",
+    "@quake2ts/game": "0.0.764",
+    "@quake2ts/server": "0.0.764",
+    "@quake2ts/shared": "0.0.764"
+  },
+  "optionalDependencies": {
+    "gl": "^8.1.6"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",
     "test": "vitest run --passWithNoTests",
-    "test:webgpu": "cross-env TEST_TYPE=webgpu vitest run"
+    "test:webgpu": "cross-env TEST_TYPE=webgpu vitest run",
+    "test:webgl": "cross-env TEST_TYPE=webgl vitest run"
   }
 }

package/src/index.ts

@@ -29,6 +29,7 @@ export * from './server/helpers/bandwidth.js';
 export * from './setup/browser.js';
 export * from './setup/canvas.js';
 export * from './setup/webgpu.js';
+export * from './setup/headless-webgl.js'; // Added
 export * from './engine/mocks/webgpu.js';
 export * from './setup/timing.js';
 export * from './setup/node.js';
@@ -71,6 +72,7 @@ export type { StorageScenario } from './setup/storage.js';
 export type { NetworkSimulator, NetworkCondition } from './e2e/network.js';
 export type { VisualScenario, VisualDiff } from './e2e/visual.js';
 export type { HeadlessWebGPUSetup, WebGPUContextState } from './setup/webgpu.js';
+export type { HeadlessWebGLContext, HeadlessWebGLOptions } from './setup/headless-webgl.js'; // Added
 export type { RenderTestSetup, ComputeTestSetup } from './engine/helpers/webgpu-rendering.js';
 export type { GeometryBuffers } from './engine/helpers/pipeline-test-template.js';
 

package/src/setup/headless-webgl.ts

@@ -0,0 +1,112 @@
+export interface HeadlessWebGLOptions {
+  width?: number;
+  height?: number;
+  antialias?: boolean;
+  preserveDrawingBuffer?: boolean;
+}
+
+export interface HeadlessWebGLContext {
+  gl: WebGL2RenderingContext;
+  width: number;
+  height: number;
+  cleanup: () => void;
+}
+
+/**
+ * Creates a headless WebGL2 context using the 'gl' package.
+ * Note: 'gl' is lazy-loaded to avoid issues in environments where it's not supported/needed.
+ */
+export async function createHeadlessWebGL(
+  options: HeadlessWebGLOptions = {}
+): Promise<HeadlessWebGLContext> {
+  const width = options.width ?? 256;
+  const height = options.height ?? 256;
+
+  // Dynamically import gl
+  // @ts-ignore - gl package might not be typed correctly for dynamic import or TS config
+  const { default: gl } = await import('gl');
+
+  // The 'gl' function signature is gl(width, height, options)
+  const context = gl(width, height, {
+    antialias: options.antialias ?? false, // Default to false for determinism
+    preserveDrawingBuffer: options.preserveDrawingBuffer ?? true, // Default to true for readback
+    stencil: true,
+    alpha: true,
+    depth: true,
+  });
+
+  if (!context) {
+    throw new Error('Failed to create headless WebGL context');
+  }
+
+  // Cast to WebGL2RenderingContext
+  const glContext = context as unknown as WebGL2RenderingContext;
+
+  return {
+    gl: glContext,
+    width,
+    height,
+    cleanup: () => {
+      // gl package extension to destroy context
+      const ext = glContext.getExtension('STACKGL_destroy_context');
+      if (ext) {
+        ext.destroy();
+      }
+    },
+  };
+}
+
+/**
+ * Captures the current framebuffer content as a Uint8ClampedArray (RGBA).
+ * Flips the pixels vertically to match standard image orientation (top-left origin).
+ */
+export function captureWebGLFramebuffer(
+  glContext: WebGL2RenderingContext,
+  width: number,
+  height: number
+): Uint8ClampedArray {
+  const pixels = new Uint8ClampedArray(width * height * 4);
+
+  // readPixels reads from bottom-left
+  glContext.readPixels(
+    0,
+    0,
+    width,
+    height,
+    glContext.RGBA,
+    glContext.UNSIGNED_BYTE,
+    pixels
+  );
+
+  return flipPixelsVertically(pixels, width, height);
+}
+
+/**
+ * Flips pixel data vertically in-place.
+ */
+export function flipPixelsVertically(
+  pixels: Uint8ClampedArray,
+  width: number,
+  height: number
+): Uint8ClampedArray {
+  const rowSize = width * 4;
+  const halfHeight = Math.floor(height / 2);
+  const tempRow = new Uint8Array(rowSize);
+
+  // Swap rows
+  for (let y = 0; y < halfHeight; y++) {
+    const topOffset = y * rowSize;
+    const bottomOffset = (height - 1 - y) * rowSize;
+
+    // Copy top to temp
+    tempRow.set(pixels.subarray(topOffset, topOffset + rowSize));
+
+    // Copy bottom to top
+    pixels.copyWithin(topOffset, bottomOffset, bottomOffset + rowSize);
+
+    // Copy temp to bottom
+    pixels.set(tempRow, bottomOffset);
+  }
+
+  return pixels;
+}