@pirireis/webglobeplugins 0.17.1 → 1.0.2

package/util/account/single-attribute-buffer-management/{buffer-manager.js → buffer-manager.ts}

@@ -1,117 +1,151 @@
-/**
- * BufferOffsetManager
- * Purpose: To manage the offset of the buffer. Plus extend and defrag the buffer.
- * ------------------------------------------------------------------------------------------------------------------------------------------- * Functions:
- * 1. getOffet(key) : return the offset of the key if not found return false.
- * 2. setOffset(key, offset) : set the offset of the key.
- * 3. nextOffset() : return the next available offset if not return false.
- * 4. delete(key) : delete the key and return true if not found return false.
- * 5. defragBuffer(gl, buffer, bufferType, newCapacity = null) : defrag the buffer. if newCapacity is not provided the buffer is vacumed.
- * 6. extendBuffer(gl, buffer, bufferType, newCapacity) : extend the buffer.
- * -------------------------------------------------------------------------------------------------------------------------------------------
- * What this class does NOT do:
- * ADD, DELETE, READ
- * ADD, inputs needs to be turn into a block and put into buffer. Bulk will be more performant.
- * DELETE, might be a set to single byte to indicate the tombstone.
- * READ, most of the time is not needed to be read, unless for defraging.
- * This unpredicatable behavior is not handled by this class.
- */
-export class BufferManager {
-    gl;
-    buffer;
-    itemSize;
-    bufferType;
-    isFreed = false;
-    constructor(gl, itemSize, { bufferType = "STATIC_DRAW", buffer = null, initialCapacity = 10 } = {}) {
-        this.gl = gl;
-        this.itemSize = itemSize;
-        this.bufferType = bufferType;
-        this.buffer = buffer === null ? gl.createBuffer() : buffer;
-        this.resetWithCapacity(initialCapacity);
-    }
-    resetWithCapacity(capacity) {
-        const { gl, buffer, bufferType, itemSize } = this;
-        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
-        // @ts-ignore
-        gl.bufferData(gl.ARRAY_BUFFER, capacity * itemSize * 4, gl[bufferType]);
-        gl.bindBuffer(gl.ARRAY_BUFFER, null);
-    }
-    deleteBulk(offsets) {
-        const { gl, buffer, itemSize } = this;
-        const emptyBlock = new Float32Array(this.itemSize).fill(NaN);
-        const offsetMultiplier = itemSize * 4;
-        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
-        for (let offset of offsets) {
-            if (offset !== undefined) {
-                gl.bufferSubData(gl.ARRAY_BUFFER, offset * offsetMultiplier, emptyBlock);
-            }
-        }
-        gl.bindBuffer(gl.ARRAY_BUFFER, null);
-    }
-    insertBulk(blocks, offsets) {
-        const { gl, buffer, itemSize } = this;
-        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
-        const offsetMultiplier = itemSize * 4;
-        for (let i = 0; i < blocks.length; i++) {
-            const block = blocks[i];
-            const offset = offsets[i] * offsetMultiplier;
-            if (offset !== undefined)
-                gl.bufferSubData(gl.ARRAY_BUFFER, offset, block);
-        }
-        gl.bindBuffer(gl.ARRAY_BUFFER, null);
-    }
-    insertBlock(items, offset, adapter, Constructor = Float32Array) {
-        const { gl, buffer, itemSize } = this;
-        const cpuBuffer = new Constructor(itemSize * items.length);
-        for (let i = 0; i < items.length; i++) {
-            cpuBuffer.set(adapter(items[i]), i * itemSize);
-        }
-        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
-        gl.bufferSubData(gl.ARRAY_BUFFER, offset * itemSize * 4, cpuBuffer);
-        gl.bindBuffer(gl.ARRAY_BUFFER, null);
-    }
-    // TODO: this is broken
-    defrag(offsetValues, occupiedCapacity, newCapacity) {
-        const { gl, buffer, bufferType, itemSize } = this;
-        const newArray = new Float32Array(newCapacity * itemSize);
-        const bufferData = this._getBufferData(occupiedCapacity);
-        let newOffset = 0;
-        for (const offset of offsetValues) {
-            const itemOffset = offset * itemSize;
-            newArray.set(bufferData.slice(itemOffset, itemOffset + itemSize), newOffset);
-            newOffset += itemSize;
-        }
-        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
-        // @ts-ignore
-        gl.bufferData(gl.ARRAY_BUFFER, newCapacity * itemSize * 4, gl[bufferType]);
-        gl.bufferSubData(gl.ARRAY_BUFFER, 0, newArray);
-        gl.bindBuffer(gl.ARRAY_BUFFER, null);
-    }
-    extendBuffer(occupiedCapacity, newCapacity) {
-        const { gl, buffer, bufferType } = this;
-        const itemSize = this.itemSize;
-        const bufferData = this._getBufferData(occupiedCapacity);
-        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
-        // @ts-ignore
-        gl.bufferData(gl.ARRAY_BUFFER, newCapacity * itemSize * 4, gl[bufferType]);
-        gl.bufferSubData(gl.ARRAY_BUFFER, 0, bufferData);
-        gl.bindBuffer(gl.ARRAY_BUFFER, null);
-    }
-    _getBufferData(occupiedCapacity) {
-        const { gl, buffer } = this;
-        const size = occupiedCapacity * this.itemSize;
-        const bufferData = new Float32Array(size);
-        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
-        gl.getBufferSubData(gl.ARRAY_BUFFER, 0, bufferData);
-        gl.bindBuffer(gl.ARRAY_BUFFER, null);
-        return bufferData;
-    }
-    free() {
-        if (this.isFreed)
-            return;
-        this.gl.deleteBuffer(this.buffer);
-        // this.buffer = null;
-        // this.gl = null;
-        this.isFreed = true;
-    }
-}
+/**
+ * BufferOffsetManager
+ * Purpose: To manage the offset of the buffer. Plus extend and defrag the buffer. 
+ * ------------------------------------------------------------------------------------------------------------------------------------------- * Functions:
+ * 1. getOffet(key) : return the offset of the key if not found return false.
+ * 2. setOffset(key, offset) : set the offset of the key.
+ * 3. nextOffset() : return the next available offset if not return false.
+ * 4. delete(key) : delete the key and return true if not found return false.
+ * 5. defragBuffer(gl, buffer, bufferType, newCapacity = null) : defrag the buffer. if newCapacity is not provided the buffer is vacumed.
+ * 6. extendBuffer(gl, buffer, bufferType, newCapacity) : extend the buffer.
+ * -------------------------------------------------------------------------------------------------------------------------------------------
+ * What this class does NOT do:
+ * ADD, DELETE, READ
+ * ADD, inputs needs to be turn into a block and put into buffer. Bulk will be more performant.
+ * DELETE, might be a set to single byte to indicate the tombstone.
+ * READ, most of the time is not needed to be read, unless for defraging.
+ * This unpredicatable behavior is not handled by this class.
+ */
+
+
+import { TypedArray } from "../../../types"
+
+
+
+type BufferManagerOptions = {
+    bufferType?: string;
+    buffer?: WebGLBuffer | null;
+    initialCapacity?: number;
+    typedArrayConstructor?: { new(length: number): TypedArray };
+};
+
+
+export class BufferManager {
+    gl: WebGL2RenderingContext;
+    buffer: WebGLBuffer;
+    itemSize: number;
+    bufferType: string;
+    typedArrayConstructor: { new(length: number): TypedArray };
+    isFreed: boolean = false;
+
+    constructor(gl: WebGL2RenderingContext, itemSize: number, { bufferType = "STATIC_DRAW", buffer = null, initialCapacity = 10, typedArrayConstructor = Float32Array }: BufferManagerOptions = {}) {
+        this.gl = gl;
+        this.itemSize = itemSize;
+        this.bufferType = bufferType;
+        this.buffer = buffer === null ? gl.createBuffer() : buffer;
+        this.resetWithCapacity(initialCapacity);
+        this.typedArrayConstructor = typedArrayConstructor;
+    }
+
+    resetWithCapacity(capacity: number) {
+        const { gl, buffer, bufferType, itemSize } = this;
+        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
+        // @ts-ignore
+        gl.bufferData(gl.ARRAY_BUFFER, capacity * itemSize * 4, gl[bufferType]);
+        gl.bindBuffer(gl.ARRAY_BUFFER, null);
+    }
+
+    deleteBulk(offsets: number[]) {
+        const { gl, buffer, itemSize } = this;
+        const emptyBlock = new Float32Array(this.itemSize).fill(NaN)
+        const offsetMultiplier = itemSize * 4;
+        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
+        for (let offset of offsets) {
+            if (offset !== undefined) {
+                gl.bufferSubData(gl.ARRAY_BUFFER, offset * offsetMultiplier, emptyBlock);
+            }
+        }
+        gl.bindBuffer(gl.ARRAY_BUFFER, null);
+    }
+
+
+    insertBulk(blocks: any[], offsets: number[]) {
+        const { gl, buffer, itemSize } = this;
+        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
+        const offsetMultiplier = itemSize * 4;
+        for (let i = 0; i < blocks.length; i++) {
+            const block = blocks[i];
+            const offset = offsets[i] * offsetMultiplier;
+            if (offset !== undefined) gl.bufferSubData(gl.ARRAY_BUFFER, offset, block);
+        }
+        gl.bindBuffer(gl.ARRAY_BUFFER, null);
+    }
+
+
+
+    insertBlock(
+        items: any[],
+        offset: number,
+        adapter: (item: any) => ArrayLike<number>,
+    ) {
+        const { gl, buffer, itemSize, typedArrayConstructor: Constructor } = this;
+        const cpuBuffer = new Constructor(itemSize * items.length);
+        for (let i = 0; i < items.length; i++) {
+            cpuBuffer.set(adapter(items[i]), i * itemSize);
+        }
+        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
+        gl.bufferSubData(gl.ARRAY_BUFFER, offset * itemSize * 4, cpuBuffer as ArrayBufferView);
+        gl.bindBuffer(gl.ARRAY_BUFFER, null);
+    }
+
+
+    // TODO: this is broken
+    defrag(offsetValues: MapIterator<number> | number[], occupiedCapacity: number, newCapacity: number) {
+        const { gl, buffer, bufferType, itemSize } = this;
+
+        const newArray = new Float32Array(newCapacity * itemSize);
+        const bufferData = this._getBufferData(occupiedCapacity);
+        let newOffset = 0;
+        for (const offset of offsetValues) {
+            const itemOffset = offset * itemSize;
+            newArray.set(bufferData.slice(itemOffset, itemOffset + itemSize), newOffset);
+            newOffset += itemSize;
+        }
+
+        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
+        // @ts-ignore
+        gl.bufferData(gl.ARRAY_BUFFER, newCapacity * itemSize * 4, gl[bufferType]);
+        gl.bufferSubData(gl.ARRAY_BUFFER, 0, newArray);
+        gl.bindBuffer(gl.ARRAY_BUFFER, null);
+
+    }
+
+    extendBuffer(occupiedCapacity: number, newCapacity: number) {
+        const { gl, buffer, bufferType } = this;
+        const itemSize = this.itemSize;
+        const bufferData = this._getBufferData(occupiedCapacity);
+        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
+        // @ts-ignore
+        gl.bufferData(gl.ARRAY_BUFFER, newCapacity * itemSize * 4, gl[bufferType]);
+        gl.bufferSubData(gl.ARRAY_BUFFER, 0, bufferData);
+        gl.bindBuffer(gl.ARRAY_BUFFER, null);
+    }
+
+    _getBufferData(occupiedCapacity: number): Float32Array {
+        const { gl, buffer } = this;
+        const size = occupiedCapacity * this.itemSize;
+        const bufferData = new Float32Array(size);
+        gl.bindBuffer(gl.ARRAY_BUFFER, buffer);
+        gl.getBufferSubData(gl.ARRAY_BUFFER, 0, bufferData);
+        gl.bindBuffer(gl.ARRAY_BUFFER, null);
+        return bufferData;
+    }
+
+    free() {
+        if (this.isFreed) return;
+        this.gl.deleteBuffer(this.buffer);
+        // this.buffer = null;
+        // this.gl = null;
+        this.isFreed = true;
+    }
+}