@cosmos.gl/graph 2.6.2 → 2.7.0-beta.1

package/dist/config.d.ts

@@ -447,8 +447,8 @@ export interface GraphConfigInterface {
      */
     showFPSMonitor?: boolean;
     /**
-     * Canvas pixel ratio.
-     * Default value: `2`
+     * Pixel ratio for the canvas. Higher values use more GPU memory but provide better quality on high-DPI displays.
+     * Default value: `window.devicePixelRatio || 2`
      */
     pixelRatio?: number;
     /**

package/dist/graph/utils/error-message.d.ts

@@ -3,4 +3,4 @@
  * @param container The HTML element to append the error message to
  * @returns The created error div element
  */
-export declare function createWebGLErrorMessage(container: HTMLElement): HTMLDivElement;
+export declare function createWebGLErrorMessage(container: HTMLElement, error: string): HTMLDivElement;

package/dist/helper.d.ts

@@ -1,4 +1,4 @@
-import { default as regl } from 'regl';
+import { Device, Framebuffer } from '@luma.gl/core';
 import { default as DOMPurify } from 'dompurify';
 export declare const isFunction: <T>(a: T) => boolean;
 export declare const isArray: <T>(a: unknown | T[]) => a is T[];
@@ -7,7 +7,44 @@ export declare const isAClassInstance: <T>(a: T) => boolean;
 export declare const isPlainObject: <T>(a: T) => boolean;
 export declare function getRgbaColor(value: string | [number, number, number, number]): [number, number, number, number];
 export declare function rgbToBrightness(r: number, g: number, b: number): number;
-export declare function readPixels(reglInstance: regl.Regl, fbo: regl.Framebuffer2D): Float32Array;
+/**
+ * TODO: Migrate from deprecated `readPixelsToArrayWebGL` to CommandEncoder API
+ *
+ * `readPixelsToArrayWebGL` is deprecated in luma.gl v9. The recommended modern approach is:
+ *
+ * 1. Create a buffer to hold the pixel data:
+ *    const buffer = device.createBuffer({
+ *      byteLength: width * height * 4 * 4, // RGBA, 4 bytes per float
+ *      usage: Buffer.COPY_DST | Buffer.MAP_READ
+ *    });
+ *
+ * 2. Copy texture/framebuffer to buffer using command encoder:
+ *    const commandEncoder = device.createCommandEncoder();
+ *    commandEncoder.copyTextureToBuffer({
+ *      sourceTexture: fbo, // Can be Texture or Framebuffer
+ *      width: sourceWidth ?? fbo.width,
+ *      height: sourceHeight ?? fbo.height,
+ *      origin: [sourceX, sourceY],
+ *      destinationBuffer: buffer
+ *    });
+ *    const commandBuffer = commandEncoder.finish();
+ *    device.submit(commandBuffer);
+ *
+ * 3. Read the data from the buffer (async):
+ *    const pixelData = await buffer.readAsync(); // Returns ArrayBuffer
+ *    return new Float32Array(pixelData);
+ *
+ * Note: The modern approach is asynchronous, so this function signature would need to change
+ * to return Promise<Float32Array> or we'd need to handle async at all call sites (18 locations).
+ *
+ * Migration impact:
+ * - This function is used in 18 places across the codebase
+ * - All call sites would need to be updated to handle async
+ * - Consider batching the migration to avoid inconsistencies
+ *
+ * Current status: Deprecated but still functional. Keeping for now until full migration can be planned.
+ */
+export declare function readPixels(device: Device, fbo: Framebuffer, sourceX?: number, sourceY?: number, sourceWidth?: number, sourceHeight?: number): Float32Array;
 export declare function clamp(num: number, min: number, max: number): number;
 export declare function isNumber(value: number | undefined | null | typeof NaN): boolean;
 /**