@lightningtv/renderer 2.16.1 → 3.2.3

package/dist/src/core/lib/WebGlContextWrapper.d.ts

@@ -1,3 +1,4 @@
+import type { Vec2, Vec3, Vec4 } from '../renderers/webgl/internal/ShaderUtils.js';
 /**
  * Optimized WebGL Context Wrapper
  *
@@ -35,40 +36,42 @@ export declare class WebGlContextWrapper {
     private boundArrayBuffer;
     private boundElementArrayBuffer;
     private curProgram;
-    readonly canvas: HTMLCanvasElement | OffscreenCanvas;
-    readonly MAX_RENDERBUFFER_SIZE: 34024;
-    readonly MAX_TEXTURE_SIZE: 3379;
-    readonly MAX_VIEWPORT_DIMS: 3386;
-    readonly MAX_VERTEX_TEXTURE_IMAGE_UNITS: 35660;
-    readonly MAX_TEXTURE_IMAGE_UNITS: 34930;
-    readonly MAX_COMBINED_TEXTURE_IMAGE_UNITS: 35661;
-    readonly MAX_VERTEX_ATTRIBS: 34921;
-    readonly MAX_VARYING_VECTORS: 36348;
-    readonly MAX_VERTEX_UNIFORM_VECTORS: 36347;
-    readonly MAX_FRAGMENT_UNIFORM_VECTORS: 36349;
-    readonly TEXTURE_MAG_FILTER: 10240;
-    readonly TEXTURE_MIN_FILTER: 10241;
-    readonly TEXTURE_WRAP_S: 10242;
-    readonly TEXTURE_WRAP_T: 10243;
-    readonly LINEAR: 9729;
-    readonly CLAMP_TO_EDGE: 33071;
-    readonly RGB: 6407;
-    readonly RGBA: 6408;
-    readonly UNSIGNED_BYTE: 5121;
-    readonly UNPACK_PREMULTIPLY_ALPHA_WEBGL: 37441;
-    readonly UNPACK_FLIP_Y_WEBGL: 37440;
-    readonly FLOAT: 5126;
-    readonly TRIANGLES: 4;
-    readonly UNSIGNED_SHORT: 5123;
-    readonly ONE: 1;
-    readonly ONE_MINUS_SRC_ALPHA: 771;
-    readonly VERTEX_SHADER: 35633;
-    readonly FRAGMENT_SHADER: 35632;
-    readonly STATIC_DRAW: 35044;
-    readonly COMPILE_STATUS: 35713;
-    readonly LINK_STATUS: 35714;
-    readonly DYNAMIC_DRAW: 35048;
-    readonly COLOR_ATTACHMENT0: 36064;
+    private curUniformLocations;
+    readonly canvas: any;
+    readonly MAX_RENDERBUFFER_SIZE: any;
+    readonly MAX_TEXTURE_SIZE: any;
+    readonly MAX_VIEWPORT_DIMS: any;
+    readonly MAX_VERTEX_TEXTURE_IMAGE_UNITS: any;
+    readonly MAX_TEXTURE_IMAGE_UNITS: any;
+    readonly MAX_COMBINED_TEXTURE_IMAGE_UNITS: any;
+    readonly MAX_VERTEX_ATTRIBS: any;
+    readonly MAX_VARYING_VECTORS: any;
+    readonly MAX_VERTEX_UNIFORM_VECTORS: any;
+    readonly MAX_FRAGMENT_UNIFORM_VECTORS: any;
+    readonly TEXTURE_MAG_FILTER: any;
+    readonly TEXTURE_MIN_FILTER: any;
+    readonly TEXTURE_WRAP_S: any;
+    readonly TEXTURE_WRAP_T: any;
+    readonly LINEAR: any;
+    readonly LINEAR_MIPMAP_LINEAR: any;
+    readonly CLAMP_TO_EDGE: any;
+    readonly RGB: any;
+    readonly RGBA: any;
+    readonly UNSIGNED_BYTE: any;
+    readonly UNPACK_PREMULTIPLY_ALPHA_WEBGL: any;
+    readonly UNPACK_FLIP_Y_WEBGL: any;
+    readonly FLOAT: any;
+    readonly TRIANGLES: any;
+    readonly UNSIGNED_SHORT: any;
+    readonly ONE: any;
+    readonly ONE_MINUS_SRC_ALPHA: any;
+    readonly VERTEX_SHADER: any;
+    readonly FRAGMENT_SHADER: any;
+    readonly STATIC_DRAW: any;
+    readonly COMPILE_STATUS: any;
+    readonly LINK_STATUS: any;
+    readonly DYNAMIC_DRAW: any;
+    readonly COLOR_ATTACHMENT0: any;
     readonly INVALID_ENUM: number;
     readonly INVALID_OPERATION: number;
     constructor(gl: WebGLRenderingContext | WebGL2RenderingContext);
@@ -174,7 +177,7 @@ export declare class WebGlContextWrapper {
      *
      * @returns
      */
-    createTexture(): WebGLTexture | null;
+    createTexture(): WebGLTexture;
     /**
      * ```
      * gl.deleteTexture(texture);
@@ -250,14 +253,14 @@ export declare class WebGlContextWrapper {
      *
      * @returns
      */
-    createBuffer(): WebGLBuffer | null;
+    createBuffer(): WebGLBuffer;
     /**
      * ```
      * gl.createFramebuffer();
      * ```
      * @returns
      */
-    createFramebuffer(): WebGLFramebuffer | null;
+    createFramebuffer(): WebGLFramebuffer;
     /**
      * ```
      * gl.bindFramebuffer(gl.FRAMEBUFFER, framebuffer);
@@ -297,6 +300,21 @@ export declare class WebGlContextWrapper {
      * @param usage
      */
     arrayBufferData(buffer: WebGLBuffer | null, data: ArrayBufferView, usage: GLenum): void;
+    /**
+     * ```
+     * gl.bindBuffer(gl.ARRAY_BUFFER, buffer);  // if needed
+     * gl.bufferSubData(gl.ARRAY_BUFFER, dstByteOffset, data);
+     * ```
+     *
+     * @remarks
+     * **WebGL Combo**: `gl.bindBuffer` is only called when the buffer changes.
+     * Used to surgically update a subset of the GPU buffer without reallocating it.
+     *
+     * @param buffer
+     * @param dstByteOffset - Byte offset into the GPU buffer where `data` will be written
+     * @param data
+     */
+    arrayBufferSubData(buffer: WebGLBuffer | null, dstByteOffset: number, data: ArrayBufferView): void;
     /**
      * ```
      * gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, buffer);
@@ -328,6 +346,19 @@ export declare class WebGlContextWrapper {
      * @param offset
      */
     vertexAttribPointer(buffer: WebGLBuffer, index: GLuint, size: GLint, type: GLenum, normalized: GLboolean, stride: GLsizei, offset: GLintptr): void;
+    /**
+     * Returns object with Attribute names as key and numbers as location values
+     *
+     * @param program
+     * @returns object with numbers
+     */
+    getUniformLocations(program: WebGLProgram): Record<string, WebGLUniformLocation>;
+    /**
+     * Returns object with Attribute names as key and numbers as location values
+     * @param program
+     * @returns object with numbers
+     */
+    getAttributeLocations(program: WebGLProgram): string[];
     /**
      * ```
      * gl.useProgram(program);
@@ -336,35 +367,35 @@ export declare class WebGlContextWrapper {
      * @param program
      * @returns
      */
-    useProgram(program: WebGLProgram | null): void;
+    useProgram(program: WebGLProgram | null, uniformLocations: Record<string, WebGLUniformLocation>): void;
     /**
      * Sets the value of a single float uniform variable.
      *
      * @param location - The location of the uniform variable.
      * @param v0 - The value to set.
      */
-    uniform1f(location: WebGLUniformLocation | null, v0: number): void;
+    uniform1f(location: string, v0: number): void;
     /**
      * Sets the value of a float array uniform variable.
      *
      * @param location - The location of the uniform variable.
      * @param value - The array of values to set.
      */
-    uniform1fv(location: WebGLUniformLocation | null, value: Float32Array | number[]): void;
+    uniform1fv(location: string, value: Float32Array): void;
     /**
      * Sets the value of a single integer uniform variable.
      *
      * @param location - The location of the uniform variable.
      * @param v0 - The value to set.
      */
-    uniform1i(location: WebGLUniformLocation | null, v0: number): void;
+    uniform1i(location: string, v0: number): void;
     /**
      * Sets the value of an integer array uniform variable.
      *
      * @param location - The location of the uniform variable.
      * @param value - The array of values to set.
      */
-    uniform1iv(location: WebGLUniformLocation | null, value: Int32Array | number[]): void;
+    uniform1iv(location: string, value: Int32Array): void;
     /**
      * Sets the value of a vec2 uniform variable.
      *
@@ -372,14 +403,21 @@ export declare class WebGlContextWrapper {
      * @param v0 - The first component of the vector.
      * @param v1 - The second component of the vector.
      */
-    uniform2f(location: WebGLUniformLocation | null, v0: number, v1: number): void;
+    uniform2f(location: string, v0: number, v1: number): void;
+    /**
+     * Sets the value of a vec3 uniform variable.
+     *
+     * @param location - The location of the uniform variable.
+     * @param v - array of 4 numbers.
+     */
+    uniform2fa(location: string, value: Vec2): void;
     /**
      * Sets the value of a vec2 array uniform variable.
      *
      * @param location - The location of the uniform variable.
      * @param value - The array of vec2 values to set.
      */
-    uniform2fv(location: WebGLUniformLocation | null, value: Float32Array | number[]): void;
+    uniform2fv(location: string, value: Float32Array): void;
     /**
      * Sets the value of a ivec2 uniform variable.
      *
@@ -387,14 +425,14 @@ export declare class WebGlContextWrapper {
      * @param v0 - The first component of the vector.
      * @param v1 - The second component of the vector.
      */
-    uniform2i(location: WebGLUniformLocation | null, v0: number, v1: number): void;
+    uniform2i(location: string, v0: number, v1: number): void;
     /**
      * Sets the value of an ivec2 array uniform variable.
      *
      * @param location - The location of the uniform variable.
      * @param value - The array of ivec2 values to set.
      */
-    uniform2iv(location: WebGLUniformLocation | null, value: Int32Array | number[]): void;
+    uniform2iv(location: string, value: Int32Array): void;
     /**
      * Sets the value of a vec3 uniform variable.
      *
@@ -403,14 +441,21 @@ export declare class WebGlContextWrapper {
      * @param v1 - The second component of the vector.
      * @param v2 - The third component of the vector.
      */
-    uniform3f(location: WebGLUniformLocation | null, v0: number, v1: number, v2: number): void;
+    uniform3f(location: string, v0: number, v1: number, v2: number): void;
+    /**
+     * Sets the value of a vec3 uniform variable.
+     *
+     * @param location - The location of the uniform variable.
+     * @param v - array of 4 numbers.
+     */
+    uniform3fa(location: string, value: Vec3): void;
     /**
      * Sets the value of a vec3 array uniform variable.
      *
      * @param location - The location of the uniform variable.
      * @param value - The array of vec3 values to set.
      */
-    uniform3fv(location: WebGLUniformLocation | null, value: Float32Array | number[]): void;
+    uniform3fv(location: string, value: Float32Array): void;
     /**
      * Sets the value of a ivec3 uniform variable.
      *
@@ -419,14 +464,14 @@ export declare class WebGlContextWrapper {
      * @param v1 - The second component of the vector.
      * @param v2 - The third component of the vector.
      */
-    uniform3i(location: WebGLUniformLocation | null, v0: number, v1: number, v2: number): void;
+    uniform3i(location: string, v0: number, v1: number, v2: number): void;
     /**
      * Sets the value of an ivec3 array uniform variable.
      *
      * @param location - The location of the uniform variable.
      * @param value - The array of ivec3 values to set.
      */
-    uniform3iv(location: WebGLUniformLocation | null, value: Int32Array | number[]): void;
+    uniform3iv(location: string, value: Int32Array): void;
     /**
      * Sets the value of a vec4 uniform variable.
      *
@@ -436,14 +481,21 @@ export declare class WebGlContextWrapper {
      * @param v2 - The third component of the vector.
      * @param v3 - The fourth component of the vector.
      */
-    uniform4f(location: WebGLUniformLocation | null, v0: number, v1: number, v2: number, v3: number): void;
+    uniform4f(location: string, v0: number, v1: number, v2: number, v3: number): void;
+    /**
+     * Sets the value of a vec4 uniform variable.
+     *
+     * @param location - The location of the uniform variable.
+     * @param v - array of 4 numbers.
+     */
+    uniform4fa(location: string, value: Vec4): void;
     /**
      * Sets the value of a vec4 array uniform variable.
      *
      * @param location - The location of the uniform variable.
      * @param value - The array of vec4 values to set.
      */
-    uniform4fv(location: WebGLUniformLocation | null, value: Float32Array | number[]): void;
+    uniform4fv(location: string, value: Float32Array): void;
     /**
      * Sets the value of a ivec4 uniform variable.
      *
@@ -453,14 +505,14 @@ export declare class WebGlContextWrapper {
      * @param v2 - The third component of the vector.
      * @param v3 - The fourth component of the vector.
      */
-    uniform4i(location: WebGLUniformLocation | null, v0: number, v1: number, v2: number, v3: number): void;
+    uniform4i(location: string, v0: number, v1: number, v2: number, v3: number): void;
     /**
      * Sets the value of an ivec4 array uniform variable.
      *
      * @param location - The location of the uniform variable.
      * @param value - The array of ivec4 values to set.
      */
-    uniform4iv(location: WebGLUniformLocation | null, value: Int32Array | number[]): void;
+    uniform4iv(location: string, value: Int32Array): void;
     /**
      * Sets the value of a mat2 uniform variable.
      *
@@ -468,19 +520,19 @@ export declare class WebGlContextWrapper {
      * @param transpose - Whether to transpose the matrix.
      * @param value - The array of mat2 values to set.
      */
-    uniformMatrix2fv(location: WebGLUniformLocation | null, value: Float32Array | number[]): void;
+    uniformMatrix2fv(location: string, value: Float32Array): void;
     /**
      * Sets the value of a mat2 uniform variable.
      * @param location - The location of the uniform variable.
      * @param value - The array of mat2 values to set.
      */
-    uniformMatrix3fv(location: WebGLUniformLocation | null, value: Float32Array | number[]): void;
+    uniformMatrix3fv(location: string, value: Float32Array): void;
     /**
      * Sets the value of a mat4 uniform variable.
      * @param location - The location of the uniform variable.
      * @param value - The array of mat4 values to set.
      */
-    uniformMatrix4fv(location: WebGLUniformLocation | null, value: Float32Array | number[]): void;
+    uniformMatrix4fv(location: string, value: Float32Array): void;
     /**
      * ```
      * gl.getParameter(pname);
@@ -501,6 +553,16 @@ export declare class WebGlContextWrapper {
      * @param offset
      */
     drawElements(mode: GLenum, count: GLsizei, type: GLenum, offset: GLintptr): void;
+    /**
+     * ```
+     * gl.drawArrays(mode, first, count);
+     * ```
+     *
+     * @param mode
+     * @param first
+     * @param count
+     */
+    drawArrays(mode: GLenum, first: GLint, count: GLsizei): void;
     /**
      * ```
      * gl.drawArrays(mode, first, count);
@@ -525,7 +587,7 @@ export declare class WebGlContextWrapper {
      *
      * @returns
      */
-    createVertexArray(): WebGLVertexArrayObject | null;
+    createVertexArray(): WebGLVertexArrayObject | undefined;
     /**
      * ```
      * gl.bindVertexArray(vertexArray);
@@ -637,7 +699,7 @@ export declare class WebGlContextWrapper {
      *
      * @returns
      */
-    createProgram(): WebGLProgram | null;
+    createProgram(): WebGLProgram;
     /**
      * ```
      * gl.getProgramParameter(program, pname);
@@ -674,6 +736,32 @@ export declare class WebGlContextWrapper {
      * @param shader
      */
     deleteShader(shader: WebGLShader): void;
+    /**
+     * ```
+     * gl.deleteBuffer(buffer);
+     * ```
+     *
+     * @param buffer - The buffer to delete
+     */
+    deleteBuffer(buffer: WebGLBuffer): void;
+    /**
+     * ```
+     * gl.deleteVertexArray(vertexArray);
+     * ```
+     *
+     * @param vertexArray - The vertex array object to delete
+     */
+    deleteVertexArray(vertexArray: WebGLVertexArrayObject): void;
+    /**
+     * Check for WebGL errors and return error information
+     * @param operation Description of the operation for error reporting
+     * @returns Object with error information or null if no error
+     */
+    checkError(operation: string): {
+        error: number;
+        errorName: string;
+        message: string;
+    } | null;
 }
 type IsUniformMethod<MethodName, MethodType> = MethodName extends `uniform${string}` ? MethodType extends (location: WebGLUniformLocation | null, ...args: any[]) => void ? true : false : false;
 export type UniformMethodMap = {