@openglobus/og 0.17.2 → 0.18.1

package/lib/js/webgl/Multisample.d.ts

@@ -0,0 +1,27 @@
+import { BaseFramebuffer, IBaseFramebufferParams } from "./BaseFramebuffer";
+import { Handler } from "./Handler";
+interface IMultisampleParams extends IBaseFramebufferParams {
+    msaa?: number;
+    internalFormat?: string;
+}
+/**
+ * Class represents multisample framebuffer.
+ * @class
+ * @param {Handler} handler - WebGL handler.
+ * @param {Object} [options] - Framebuffer options:
+ */
+export declare class Multisample extends BaseFramebuffer {
+    protected _internalFormat: string;
+    protected _msaa: number;
+    protected _glFilter: number;
+    renderbuffers: WebGLRenderbuffer[];
+    constructor(handler: Handler, options?: IMultisampleParams);
+    destroy(): void;
+    /**
+     * Framebuffer initialization.
+     * @public
+     */
+    init(): void;
+    blitTo(framebuffer: BaseFramebuffer, attachmentIndex?: number): void;
+}
+export {};

package/lib/js/webgl/Multisample.js

@@ -0,0 +1,77 @@
+import { BaseFramebuffer } from "./BaseFramebuffer";
+/**
+ * Class represents multisample framebuffer.
+ * @class
+ * @param {Handler} handler - WebGL handler.
+ * @param {Object} [options] - Framebuffer options:
+ */
+export class Multisample extends BaseFramebuffer {
+    constructor(handler, options = {}) {
+        super(handler, options);
+        this._internalFormat = options.internalFormat ? options.internalFormat.toUpperCase() : "RGBA8";
+        this._msaa = options.msaa != undefined ? options.msaa : 4;
+        this._glFilter = 0;
+        this.renderbuffers = new Array(this._size);
+    }
+    destroy() {
+        let gl = this.handler.gl;
+        if (!gl)
+            return;
+        for (let i = 0; i < this.renderbuffers.length; i++) {
+            gl.deleteRenderbuffer(this.renderbuffers[i]);
+        }
+        this.renderbuffers = new Array(this._size);
+        gl.deleteFramebuffer(this._fbo);
+        gl.deleteRenderbuffer(this._depthRenderbuffer);
+        this._depthRenderbuffer = null;
+        this._fbo = null;
+        this._active = false;
+    }
+    /**
+     * Framebuffer initialization.
+     * @public
+     */
+    init() {
+        let gl = this.handler.gl;
+        if (!gl)
+            return;
+        this._glFilter = gl[this._filter];
+        this._fbo = gl.createFramebuffer();
+        gl.bindFramebuffer(gl.FRAMEBUFFER, this._fbo);
+        let colorAttachments = [];
+        for (let i = 0; i < this.renderbuffers.length; i++) {
+            let rb = gl.createRenderbuffer();
+            gl.bindRenderbuffer(gl.RENDERBUFFER, rb);
+            if (this._msaa > 0) {
+                gl.renderbufferStorageMultisample(gl.RENDERBUFFER, this._msaa, gl[this._internalFormat], this._width, this._height);
+            }
+            else {
+                gl.renderbufferStorage(gl.RENDERBUFFER, gl[this._internalFormat], this._width, this._height);
+            }
+            gl.framebufferRenderbuffer(gl.FRAMEBUFFER, gl.COLOR_ATTACHMENT0 + i, gl.RENDERBUFFER, rb);
+            colorAttachments.push(gl.COLOR_ATTACHMENT0 + i);
+            this.renderbuffers[i] = rb;
+            gl.bindRenderbuffer(gl.RENDERBUFFER, null);
+        }
+        gl.drawBuffers(colorAttachments);
+        if (this._useDepth) {
+            this._depthRenderbuffer = gl.createRenderbuffer();
+            gl.bindRenderbuffer(gl.RENDERBUFFER, this._depthRenderbuffer);
+            gl.renderbufferStorageMultisample(gl.RENDERBUFFER, this._msaa, gl[this._depthComponent], this._width, this._height);
+            gl.framebufferRenderbuffer(gl.FRAMEBUFFER, gl.DEPTH_ATTACHMENT, gl.RENDERBUFFER, this._depthRenderbuffer);
+            gl.bindRenderbuffer(gl.RENDERBUFFER, null);
+        }
+        gl.bindFramebuffer(gl.FRAMEBUFFER, null);
+    }
+    blitTo(framebuffer, attachmentIndex = 0) {
+        let gl = this.handler.gl;
+        gl.bindFramebuffer(gl.READ_FRAMEBUFFER, this._fbo);
+        gl.bindFramebuffer(gl.DRAW_FRAMEBUFFER, framebuffer._fbo);
+        gl.readBuffer(gl.COLOR_ATTACHMENT0 + attachmentIndex);
+        gl.clearBufferfv(gl.COLOR, 0, [0.0, 0.0, 0.0, 1.0]);
+        gl.blitFramebuffer(0, 0, this._width, this._height, 0, 0, framebuffer._width, framebuffer._height, gl.COLOR_BUFFER_BIT, this._glFilter);
+        gl.bindFramebuffer(gl.FRAMEBUFFER, null);
+        gl.bindFramebuffer(gl.READ_FRAMEBUFFER, null);
+        gl.bindFramebuffer(gl.DRAW_FRAMEBUFFER, null);
+    }
+}

package/lib/js/webgl/Program.d.ts

@@ -0,0 +1,159 @@
+import { ProgramVariable } from "./variableHandlers";
+import { WebGLBufferExt } from "./Handler";
+type WebGLProgramExt = WebGLProgram & {
+    [id: string]: WebGLUniformLocation;
+};
+type ProgramMaterial = {
+    attributes: Record<string, any>;
+    uniforms: Record<string, any>;
+    vertexShader: string;
+    fragmentShader: string;
+};
+/**
+ * Represents more comfortable using WebGL shader program.
+ * @class
+ * @param {string} name - Program name.
+ * @param {ProgramMaterial} material - Object stores uniforms, attributes and program codes:
+ * @param {Record<string, any>} material.uniforms - Uniforms definition section.
+ * @param {Record<string, any>} material.attributes - Attributes definition section.
+ * @param {string} material.vertexShader - Vertex glsl code.
+ * @param {string} material.fragmentShader - Fragment glsl code.
+ */
+declare class Program {
+    /**
+     * Shader program name.
+     * @public
+     * @type {string}
+     */
+    name: string;
+    attributes: {
+        [id: string]: number;
+    };
+    uniforms: {
+        [id: string]: WebGLUniformLocation;
+    };
+    _attributes: Record<string, ProgramVariable>;
+    _uniforms: Record<string, ProgramVariable>;
+    vertexShader: string;
+    fragmentShader: string;
+    drawElementsInstanced: Function | null;
+    vertexAttribDivisor: Function | null;
+    /**
+     * Webgl context.
+     * @public
+     * @type {WebGL2RenderingContext | null}
+     */
+    gl: WebGL2RenderingContext | null;
+    /**
+     * All program variables.
+     * @private
+     * @type {Record<string, ProgramVariable>}
+     */
+    protected _variables: Record<string, ProgramVariable>;
+    /**
+     * Program pointer.
+     * @private
+     * @type {WebGLProgramExt | null}
+     */
+    _p: WebGLProgramExt | null;
+    /**
+     * Texture counter.
+     * @protected
+     * @type {number}
+     */
+    _textureID: number;
+    /**
+     * Program attributes array.
+     * @private
+     * @type {number[]}
+     */
+    protected _attribArrays: number[];
+    /**
+     * Program attributes divisors.
+     * @protected
+     * @type {number[]}
+     */
+    protected _attribDivisor: number[];
+    constructor(name: string, material: ProgramMaterial);
+    /**
+     * Bind program buffer.
+     * @function
+     * @param {Program} program - Used program.
+     * @param {Object} variable - Variable represents buffer data.
+     */
+    static bindBuffer(program: Program, variable: ProgramVariable): void;
+    /**
+     * Sets the current program frame.
+     * @public
+     */
+    use(): void;
+    /**
+     * Sets program variables.
+     * @public
+     * @param {Object} material - Variables and values object.
+     */
+    set(material: Record<string, any>): void;
+    /**
+     * Apply current variables.
+     * @public
+     */
+    apply(): void;
+    /**
+     * Calls drawElements index buffer function.
+     * @public
+     * @param {number} mode - Draw mode(GL_TRIANGLES, GL_LINESTRING etc.).
+     * @param {Object} buffer - Index buffer.
+     */
+    drawIndexBuffer(mode: number, buffer: WebGLBufferExt): void;
+    /**
+     * Calls drawArrays function.
+     * @public
+     * @param {number} mode - Draw mode GL_TRIANGLES, GL_LINESTRING, etc.
+     * @param {number} numItems - Items to draw
+     */
+    drawArrays(mode: number, numItems: number): void;
+    /**
+     * Check and log for a shader compile errors and warnings. Returns True - if no errors otherwise returns False.
+     * @private
+     * @param {WebGLShader} shader - WebGl shader program.
+     * @param {string} src - Shader program source.
+     * @returns {boolean} -
+     */
+    protected _getShaderCompileStatus(shader: WebGLShader, src: string): boolean;
+    /**
+     * Returns compiled vertex shader program pointer.
+     * @private
+     * @param {string} src - Vertex shader source code.
+     * @returns {Object} -
+     */
+    protected _createVertexShader(src: string): WebGLShader | undefined;
+    /**
+     * Returns compiled fragment shader program pointer.
+     * @private
+     * @param {string} src - Vertex shader source code.
+     * @returns {Object} -
+     */
+    protected _createFragmentShader(src: string): WebGLShader | undefined;
+    /**
+     * Disable current program vertexAttribArrays.
+     * @public
+     */
+    disableAttribArrays(): void;
+    /**
+     * Enable current program vertexAttribArrays.
+     * @public
+     */
+    enableAttribArrays(): void;
+    /**
+     * Delete program.
+     * @public
+     */
+    delete(): void;
+    /**
+     * Creates program.
+     * @public
+     * @param {Object} gl - WebGl context.
+     */
+    createProgram(gl: WebGL2RenderingContext): void;
+}
+export { Program };

package/lib/js/webgl/Program.js

@@ -0,0 +1,314 @@
+import { cons } from "../cons";
+import { variableHandlers } from "./variableHandlers";
+import { types, typeStr } from "./types";
+const itemTypes = ["BYTE", "SHORT", "UNSIGNED_BYTE", "UNSIGNED_SHORT", "FLOAT", "HALF_FLOAT"];
+/**
+ * Represents more comfortable using WebGL shader program.
+ * @class
+ * @param {string} name - Program name.
+ * @param {ProgramMaterial} material - Object stores uniforms, attributes and program codes:
+ * @param {Record<string, any>} material.uniforms - Uniforms definition section.
+ * @param {Record<string, any>} material.attributes - Attributes definition section.
+ * @param {string} material.vertexShader - Vertex glsl code.
+ * @param {string} material.fragmentShader - Fragment glsl code.
+ */
+class Program {
+    constructor(name, material) {
+        this.name = name;
+        this._attributes = {};
+        for (let t in material.attributes) {
+            if (typeof material.attributes[t] === "string" ||
+                typeof material.attributes[t] === "number") {
+                this._attributes[t] = { type: material.attributes[t] };
+            }
+            else {
+                this._attributes[t] = material.attributes[t];
+            }
+        }
+        this._uniforms = {};
+        for (let t in material.uniforms) {
+            if (typeof material.uniforms[t] === "string" ||
+                typeof material.uniforms[t] === "number") {
+                this._uniforms[t] = { type: material.uniforms[t] };
+            }
+            else {
+                this._uniforms[t] = material.uniforms[t];
+            }
+        }
+        this.vertexShader = material.vertexShader;
+        this.fragmentShader = material.fragmentShader;
+        this.gl = null;
+        this._variables = {};
+        this._p = null;
+        this._textureID = 0;
+        this._attribArrays = [];
+        this._attribDivisor = [];
+        this.attributes = {};
+        this.uniforms = {};
+        this.vertexAttribDivisor = null;
+        this.drawElementsInstanced = null;
+    }
+    /**
+     * Bind program buffer.
+     * @function
+     * @param {Program} program - Used program.
+     * @param {Object} variable - Variable represents buffer data.
+     */
+    static bindBuffer(program, variable) {
+        let gl = program.gl;
+        if (gl) {
+            gl.bindBuffer(gl.ARRAY_BUFFER, variable.value);
+            gl.vertexAttribPointer(variable._pName, variable.value.itemSize, variable.itemType, variable.normalized, 0, 0);
+        }
+    }
+    /**
+     * Sets the current program frame.
+     * @public
+     */
+    use() {
+        this.gl && this.gl.useProgram(this._p);
+    }
+    /**
+     * Sets program variables.
+     * @public
+     * @param {Object} material - Variables and values object.
+     */
+    set(material) {
+        this._textureID = 0;
+        for (let i in material) {
+            this._variables[i].value = material[i];
+            this._variables[i].func(this, this._variables[i]);
+        }
+    }
+    /**
+     * Apply current variables.
+     * @public
+     */
+    apply() {
+        this._textureID = 0;
+        let v = this._variables;
+        for (let i in v) {
+            v[i].func(this, v[i]);
+        }
+    }
+    /**
+     * Calls drawElements index buffer function.
+     * @public
+     * @param {number} mode - Draw mode(GL_TRIANGLES, GL_LINESTRING etc.).
+     * @param {Object} buffer - Index buffer.
+     */
+    drawIndexBuffer(mode, buffer) {
+        let gl = this.gl;
+        gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, buffer);
+        gl.drawElements(mode, buffer.numItems, gl.UNSIGNED_SHORT, 0);
+    }
+    /**
+     * Calls drawArrays function.
+     * @public
+     * @param {number} mode - Draw mode GL_TRIANGLES, GL_LINESTRING, etc.
+     * @param {number} numItems - Items to draw
+     */
+    drawArrays(mode, numItems) {
+        this.gl.drawArrays(mode, 0, numItems);
+    }
+    /**
+     * Check and log for a shader compile errors and warnings. Returns True - if no errors otherwise returns False.
+     * @private
+     * @param {WebGLShader} shader - WebGl shader program.
+     * @param {string} src - Shader program source.
+     * @returns {boolean} -
+     */
+    _getShaderCompileStatus(shader, src) {
+        if (!this.gl)
+            return false;
+        this.gl.shaderSource(shader, src);
+        this.gl.compileShader(shader);
+        if (!this.gl.getShaderParameter(shader, this.gl.COMPILE_STATUS)) {
+            cons.logErr(`Shader program "${this.name}":${this.gl.getShaderInfoLog(shader)}.`);
+            return false;
+        }
+        return true;
+    }
+    /**
+     * Returns compiled vertex shader program pointer.
+     * @private
+     * @param {string} src - Vertex shader source code.
+     * @returns {Object} -
+     */
+    _createVertexShader(src) {
+        if (!this.gl)
+            return;
+        let shader = this.gl.createShader(this.gl.VERTEX_SHADER);
+        if (shader && this._getShaderCompileStatus(shader, src)) {
+            return shader;
+        }
+    }
+    /**
+     * Returns compiled fragment shader program pointer.
+     * @private
+     * @param {string} src - Vertex shader source code.
+     * @returns {Object} -
+     */
+    _createFragmentShader(src) {
+        if (!this.gl)
+            return;
+        let shader = this.gl.createShader(this.gl.FRAGMENT_SHADER);
+        if (shader && this._getShaderCompileStatus(shader, src)) {
+            return shader;
+        }
+    }
+    /**
+     * Disable current program vertexAttribArrays.
+     * @public
+     */
+    disableAttribArrays() {
+        let gl = this.gl;
+        let a = this._attribArrays;
+        for (let i = 0, len = a.length; i < len; i++) {
+            gl.disableVertexAttribArray(a[i]);
+            this.vertexAttribDivisor(a[i], 0);
+        }
+    }
+    /**
+     * Enable current program vertexAttribArrays.
+     * @public
+     */
+    enableAttribArrays() {
+        let gl = this.gl;
+        let a = this._attribArrays;
+        let d = this._attribDivisor;
+        for (let i = 0, len = a.length; i < len; i++) {
+            gl.enableVertexAttribArray(a[i]);
+            this.vertexAttribDivisor(a[i], d[i]);
+        }
+    }
+    // public vertexAttribDivisor(index: number, divisor: number) {
+    //     const gl = this.gl!;
+    //     gl.vertexAttribDivisor ?
+    //         gl.vertexAttribDivisor(index, divisor) :
+    //         gl.getExtension('ANGLE_instanced_arrays').vertexAttribDivisorANGLE(index, divisor);
+    // }
+    /**
+     * Delete program.
+     * @public
+     */
+    delete() {
+        this.gl && this.gl.deleteProgram(this._p);
+    }
+    /**
+     * Creates program.
+     * @public
+     * @param {Object} gl - WebGl context.
+     */
+    createProgram(gl) {
+        this.gl = gl;
+        this._p = this.gl.createProgram();
+        if (!this._p)
+            return;
+        let fs = this._createFragmentShader(this.fragmentShader);
+        let vs = this._createVertexShader(this.vertexShader);
+        if (!fs || !vs)
+            return;
+        gl.attachShader(this._p, fs);
+        gl.attachShader(this._p, vs);
+        gl.linkProgram(this._p);
+        if (!this.drawElementsInstanced) {
+            if (gl.drawElementsInstanced) {
+                this.drawElementsInstanced = gl.drawElementsInstanced.bind(gl);
+            }
+            else {
+                let ext = gl.getExtension('ANGLE_instanced_arrays');
+                if (ext) {
+                    this.drawElementsInstanced = ext.drawElementsInstancedANGLE.bind(ext);
+                }
+            }
+            // this.drawElementsInstanced =
+            //     gl.drawElementsInstanced ?
+            //         gl.drawElementsInstanced.bind(gl) :
+            //         gl.getExtension('ANGLE_instanced_arrays').drawElementsInstancedANGLE.bind(gl.getExtension('ANGLE_instanced_arrays'));
+        }
+        if (!this.vertexAttribDivisor) {
+            if (gl.vertexAttribDivisor) {
+                this.vertexAttribDivisor = gl.vertexAttribDivisor.bind(gl);
+            }
+            else {
+                let ext = gl.getExtension('ANGLE_instanced_arrays');
+                if (ext) {
+                    this.vertexAttribDivisor = ext.vertexAttribDivisorANGLE.bind(ext);
+                }
+            }
+            // this.vertexAttribDivisor =
+            //     gl.vertexAttribDivisor ?
+            //         gl.vertexAttribDivisor.bind(gl) :
+            //         gl.getExtension('ANGLE_instanced_arrays').vertexAttribDivisorANGLE.bind(gl.getExtension('ANGLE_instanced_arrays'));
+        }
+        if (!gl.getProgramParameter(this._p, gl.LINK_STATUS)) {
+            cons.logErr(`Shader program "${this.name}": initialization failed. ${gl.getProgramInfoLog(this._p)}.`);
+            gl.deleteProgram(this._p);
+            return;
+        }
+        this.use();
+        for (let a in this._attributes) {
+            //this.attributes[a]._name = a;
+            this._variables[a] = this._attributes[a];
+            this._attributes[a].func = Program.bindBuffer;
+            let t = this._attributes[a].itemType;
+            let itemTypeStr = t ? t.trim().toUpperCase() : "FLOAT";
+            if (itemTypes.indexOf(itemTypeStr) == -1) {
+                cons.logErr(`Shader program "${this.name}": attribute '${a}', item type '${this._attributes[a].itemType}' not exists.`);
+                this._attributes[a].itemType = gl.FLOAT;
+            }
+            else {
+                this._attributes[a].itemType = gl[itemTypeStr];
+            }
+            this._attributes[a].normalized = this._attributes[a].normalized || false;
+            this._attributes[a].divisor = this._attributes[a].divisor || 0;
+            this._p[a] = gl.getAttribLocation(this._p, a);
+            if (this._p[a] == undefined) {
+                cons.logErr(`Shader program "${this.name}":  attribute '${a}' not exists.`);
+                gl.deleteProgram(this._p);
+                return;
+            }
+            let type = this._attributes[a].type;
+            if (typeof type === "string") {
+                type = typeStr[type.trim().toLowerCase()];
+            }
+            let d = this._attributes[a].divisor;
+            if (type === types.MAT4) {
+                let loc = this._p[a];
+                this._attribArrays.push(loc, loc + 1, loc + 2, loc + 3);
+                this._attribDivisor.push(d, d, d, d);
+            }
+            else {
+                this._attribArrays.push(this._p[a]);
+                this._attribDivisor.push(d);
+            }
+            gl.enableVertexAttribArray(this._p[a]);
+            this._attributes[a]._pName = this._p[a];
+            this.attributes[a] = this._p[a];
+        }
+        for (let u in this._uniforms) {
+            if (typeof this._uniforms[u].type === "string") {
+                let t = this._uniforms[u].type;
+                this._uniforms[u].func = variableHandlers.u[typeStr[t.trim().toLowerCase()]];
+            }
+            else {
+                this._uniforms[u].func = variableHandlers.u[this._uniforms[u].type];
+            }
+            this._variables[u] = this._uniforms[u];
+            this._p[u] = gl.getUniformLocation(this._p, u);
+            if (this._p[u] == undefined) {
+                cons.logErr(`Shader program "${this.name}": uniform '${u}' not exists.`);
+                gl.deleteProgram(this._p);
+                return;
+            }
+            this._uniforms[u]._pName = this._p[u];
+            this.uniforms[u] = this._p[u];
+        }
+        gl.detachShader(this._p, fs);
+        gl.detachShader(this._p, vs);
+        gl.deleteShader(fs);
+        gl.deleteShader(vs);
+    }
+}
+export { Program };

package/lib/js/webgl/ProgramController.d.ts

@@ -0,0 +1,86 @@
+import { Handler, WebGLBufferExt } from "./Handler";
+import { Program } from "./Program";
+/**
+ * This is shader program controller that used by handler object to access the shader
+ * program capabilities, like switching program during the rendering.
+ * Get access to the program from ...handler.programs.<program name> etc.
+ * @class
+ * @param {Handler} handler - Handler.
+ * @param {Program} program - Shader program.
+ */
+export declare class ProgramController {
+    /**
+     * Handler.
+     * @protected
+     * @type {Handler}
+     */
+    protected _handler: Handler;
+    /**
+     * Shader program.
+     * @public
+     * @type {Program}
+     */
+    _program: Program;
+    /**
+     * Program current frame activation flag.
+     * @public
+     * @type {boolean}
+     */
+    _activated: boolean;
+    constructor(handler: Handler, program: Program);
+    /**
+     * Lazy create program call.
+     * @public
+     */
+    initialize(): void;
+    /**
+     * Returns controller's shader program.
+     * @public
+     * @return {Program} -
+     */
+    getProgram(): Program;
+    /**
+     * Activates current shader program.
+     * @public
+     * @returns {ProgramController} -
+     */
+    activate(): this;
+    /**
+     * Remove program from handler
+     * @public
+     */
+    remove(): void;
+    /**
+     * Deactivate shader program. This is not necessary while activate function used.
+     * @public
+     */
+    deactivate(): void;
+    /**
+     * Returns program activity.
+     * @public
+     * @return {boolean} -
+     */
+    isActive(): boolean;
+    /**
+     * Sets program uniforms and attributes values and return controller instance.
+     * @public
+     * @param {Record<string, any>} params - Object with variable name and value like { value: 12, someArray:[1,2,3], uSampler: texture,... }
+     * @return {ProgramController} -
+     */
+    set(params: Record<string, any>): this;
+    /**
+     * Draw index buffer with this program.
+     * @public
+     * @param {number} mode - Gl draw mode
+     * @param {WebGLBuffer} buffer - Buffer to draw.
+     * @return {ProgramController} Returns current shader controller instance.
+     */
+    drawIndexBuffer(mode: number, buffer: WebGLBufferExt): ProgramController;
+    /**
+     * Calls Gl drawArray function.
+     * @param {number} mode - Gl draw mode.
+     * @param {number} numItems - draw items count.
+     * @return {ProgramController} Returns current shader controller instance.
+     */
+    drawArrays(mode: number, numItems: number): ProgramController;
+}