@thi.ng/webgl 6.2.21 → 6.3.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-01-10T15:20:19Z
+- **Last updated**: 2023-02-10T14:03:11Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,16 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [6.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/webgl@6.3.0) (2023-02-05)
+
+#### 🚀 Features
+
+- add Shader.withState() ([8a7a427](https://github.com/thi-ng/umbrella/commit/8a7a427))
+- update WebGLArrayBuffer/IWebGLBuffer ([c1890ce](https://github.com/thi-ng/umbrella/commit/c1890ce))
+  - add optional `retain` ctor arg to retain handle to
+  - add .update() method
+  - update IWebGLBuffer interface
+
 ## [6.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/webgl@6.2.0) (2022-08-08)
 
 #### 🚀 Features

package/README.md

@@ -95,7 +95,7 @@ For Node.js REPL:
 const webgl = await import("@thi.ng/webgl");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 11.23 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 11.30 KB
 
 ## Dependencies
 

package/api/buffers.d.ts

@@ -3,7 +3,8 @@ import type { ITexture } from "./texture.js";
 export type IndexBufferData = Uint16Array | Uint32Array;
 export interface IWebGLBuffer<T> extends IBind<void>, IRelease {
     set(data: T, mode?: GLenum): void;
-    setChunk(data: T, offset: number): void;
+    setChunk(data: T, byteOffset: number): void;
+    update(): void;
 }
 export interface IConfigure<T> {
     configure(opts: T): boolean;

package/buffer.d.ts

@@ -7,12 +7,22 @@ export declare class WebGLArrayBuffer<T extends TypedArray> implements IWebGLBuf
     buffer: WebGLBuffer;
     target: number;
     mode: number;
-    constructor(gl: WebGLRenderingContext, data?: T, target?: number, mode?: number);
+    data?: T;
+    constructor(gl: WebGLRenderingContext, data?: T, target?: number, mode?: number, retain?: boolean);
     bind(): boolean;
     unbind(): boolean;
     release(): boolean;
+    /**
+     * Re-applies retained data (from ctor arg) using
+     * {@link WebGLArrayBuffer.set}. Presumably the underlying data has been
+     * updated elsewhere, but needs to be reflected to WebGL.
+     *
+     * @remarks
+     * If no data is retained, this method is a no-op.
+     */
+    update(): void;
     set(data: T, mode?: number): void;
-    setChunk(data: T, offset?: number): void;
+    setChunk(data: T, byteOffset?: number): void;
 }
 export declare const defBuffer: (gl: WebGLRenderingContext, data?: TypedArray, target?: number, mode?: number) => WebGLArrayBuffer<Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array>;
 export declare const compileModel: (gl: WebGLRenderingContext, spec: ModelSpec, mode?: number) => ModelSpec;

package/buffer.js

@@ -1,14 +1,18 @@
-import { asGLType } from "@thi.ng/api/typedarray";
+import { asGLType, BIT_SHIFTS, typedArrayType, } from "@thi.ng/api/typedarray";
 import { DrawMode, } from "./api/model.js";
 import { isGL2Context } from "./checks.js";
 import { error } from "./error.js";
 export class WebGLArrayBuffer {
-    constructor(gl, data, target = gl.ARRAY_BUFFER, mode = gl.STATIC_DRAW) {
+    constructor(gl, data, target = gl.ARRAY_BUFFER, mode = gl.STATIC_DRAW, retain = false) {
         this.gl = gl;
         this.buffer = gl.createBuffer() || error("error creating WebGL buffer");
         this.target = target;
         this.mode = mode;
-        data && this.set(data);
+        if (data) {
+            this.set(data);
+            if (retain)
+                this.data = data;
+        }
     }
     bind() {
         this.gl.bindBuffer(this.target, this.buffer);
@@ -25,13 +29,30 @@ export class WebGLArrayBuffer {
         }
         return true;
     }
+    /**
+     * Re-applies retained data (from ctor arg) using
+     * {@link WebGLArrayBuffer.set}. Presumably the underlying data has been
+     * updated elsewhere, but needs to be reflected to WebGL.
+     *
+     * @remarks
+     * If no data is retained, this method is a no-op.
+     */
+    update() {
+        if (this.data)
+            this.set(this.data);
+    }
     set(data, mode = this.mode) {
         this.bind();
         this.gl.bufferData(this.target, data, mode);
+        if (this.data)
+            this.data = data;
     }
-    setChunk(data, offset = 0) {
+    setChunk(data, byteOffset = 0) {
         this.bind();
-        this.gl.bufferSubData(this.target, offset, data);
+        this.gl.bufferSubData(this.target, byteOffset, data);
+        if (this.data) {
+            this.data.set(data, byteOffset >>> BIT_SHIFTS[typedArrayType(data)]);
+        }
     }
 }
 export const defBuffer = (gl, data, target = gl.ARRAY_BUFFER, mode = gl.STATIC_DRAW) => new WebGLArrayBuffer(gl, data, target, mode);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/webgl",
-  "version": "6.2.21",
+  "version": "6.3.2",
   "description": "WebGL & GLSL abstraction layer",
   "type": "module",
   "module": "./index.js",
@@ -38,30 +38,30 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/adapt-dpi": "^2.2.6",
-    "@thi.ng/api": "^8.6.3",
-    "@thi.ng/associative": "^6.2.23",
-    "@thi.ng/checks": "^3.3.7",
-    "@thi.ng/equiv": "^2.1.17",
-    "@thi.ng/errors": "^2.2.8",
-    "@thi.ng/logger": "^1.4.7",
-    "@thi.ng/matrices": "^2.1.40",
-    "@thi.ng/memoize": "^3.1.22",
-    "@thi.ng/pixel": "^4.1.0",
-    "@thi.ng/shader-ast": "^0.12.37",
-    "@thi.ng/shader-ast-glsl": "^0.4.37",
-    "@thi.ng/shader-ast-stdlib": "^0.13.0",
-    "@thi.ng/transducers": "^8.3.30",
-    "@thi.ng/vector-pools": "^3.1.41",
-    "@thi.ng/vectors": "^7.5.31"
+    "@thi.ng/adapt-dpi": "^2.2.8",
+    "@thi.ng/api": "^8.7.2",
+    "@thi.ng/associative": "^6.2.26",
+    "@thi.ng/checks": "^3.3.9",
+    "@thi.ng/equiv": "^2.1.19",
+    "@thi.ng/errors": "^2.2.11",
+    "@thi.ng/logger": "^1.4.9",
+    "@thi.ng/matrices": "^2.1.43",
+    "@thi.ng/memoize": "^3.1.25",
+    "@thi.ng/pixel": "^4.1.3",
+    "@thi.ng/shader-ast": "^0.12.40",
+    "@thi.ng/shader-ast-glsl": "^0.4.40",
+    "@thi.ng/shader-ast-stdlib": "^0.13.3",
+    "@thi.ng/transducers": "^8.3.33",
+    "@thi.ng/vector-pools": "^3.1.44",
+    "@thi.ng/vectors": "^7.6.2"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.7",
-    "@thi.ng/testament": "^0.3.9",
-    "rimraf": "^3.0.2",
+    "@microsoft/api-extractor": "^7.34.2",
+    "@thi.ng/testament": "^0.3.11",
+    "rimraf": "^4.1.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.22",
-    "typescript": "^4.9.4"
+    "typedoc": "^0.23.24",
+    "typescript": "^4.9.5"
   },
   "keywords": [
     "2d",
@@ -219,5 +219,5 @@
     ],
     "year": 2014
   },
-  "gitHead": "3f0b3e2a7c82aefc7e46fb4338369836b5e1b8cf\n"
+  "gitHead": "cafa4ecea90fb681949dc3885a5bd6ddefa38b51\n"
 }

package/shader.d.ts

@@ -11,6 +11,14 @@ export declare class Shader implements IShader {
     protected warnAttrib: (x: string) => void;
     protected warnUni: (x: string) => void;
     constructor(gl: WebGLRenderingContext, program: WebGLProgram, attribs: IObjectOf<ShaderAttrib>, uniforms: ShaderUniforms, state?: Partial<ShaderState>);
+    /**
+     * Returns a shallow copy of this shader with its state config merged with
+     * given options (priority). Useful for re-using a shader, but applying
+     * different settings.
+     *
+     * @param state
+     */
+    withState(state: Partial<ShaderState>): Shader;
     bind(spec: ModelSpec): boolean;
     unbind(): boolean;
     release(): boolean;

package/shader.js

@@ -30,6 +30,19 @@ export class Shader {
         this.uniforms = uniforms;
         this.state = state || {};
     }
+    /**
+     * Returns a shallow copy of this shader with its state config merged with
+     * given options (priority). Useful for re-using a shader, but applying
+     * different settings.
+     *
+     * @param state
+     */
+    withState(state) {
+        return new Shader(this.gl, this.program, this.attribs, this.uniforms, {
+            ...this.state,
+            ...state,
+        });
+    }
     bind(spec) {
         if (this.program) {
             this.gl.useProgram(this.program);