@openglobus/og 0.11.5 → 0.12.0

package/types/webgl/Handler.d.ts

@@ -1,388 +0,0 @@
-export namespace createTexture {
-    import NEAREST = Handler.createTexture_n;
-    export { NEAREST };
-    import LINEAR = Handler.createTexture_l;
-    export { LINEAR };
-    import MIPMAP = Handler.createTexture_mm;
-    export { MIPMAP };
-    import ANISOTROPHIC = Handler.createTexture_a;
-    export { ANISOTROPHIC };
-}
-/**
- * A WebGL handler for accessing low-level WebGL capabilities.
- * @class
- * @param {string} id - Canvas element id that WebGL handler assing with. If it's null
- * or undefined creates hidden canvas and handler bacomes hidden.
- * @param {Object} [params] - Handler options:
- * @param {number} [params.anisotropy] - Anisitropy filter degree. 8 is default.
- * @param {number} [params.width] - Hidden handler width. 256 is default.
- * @param {number} [params.height] - Hidden handler height. 256 is default.
- * @param {Object} [param.scontext] - Native WebGL context attributes. See https://www.khronos.org/registry/webgl/specs/latest/1.0/#WEBGLCONTEXTATTRIBUTES
- * @param {Array.<string>} [params.extensions] - Additional WebGL extension list. Available by default: EXT_texture_filter_anisotropic.
- */
-export class Handler {
-    /**
-     * The return value is null if the extension is not supported, or an extension object otherwise.
-     * @param {Object} gl - WebGl context pointer.
-     * @param {String} name - Extension name.
-     * @returns {Object} -
-     */
-    static getExtension(gl: any, name: string): any;
-    /**
-     * Returns a drawing context on the canvas, or null if the context identifier is not supported.
-     * @param {Object} canvas - HTML canvas object.
-     * @param {Object} [contextAttributes] - See canvas.getContext contextAttributes.
-     * @returns {Object} -
-     */
-    static getContext(canvas: any, contextAttributes?: any): any;
-    /**
-     * Creates NEAREST filter texture.
-     * @public
-     * @param {Object} image - Image or Canvas object.
-     * @returns {Object} - WebGL texture object.
-     */
-    public static createTexture_n(handler: any, image: any): any;
-    /**
-     * Creates LINEAR filter texture.
-     * @public
-     * @param {Object} image - Image or Canvas object.
-     * @returns {Object} - WebGL texture object.
-     */
-    public static createTexture_l(handler: any, image: any): any;
-    /**
-     * Creates MIPMAP filter texture.
-     * @public
-     * @param {Object} image - Image or Canvas object.
-     * @returns {Object} - WebGL texture object.
-     */
-    public static createTexture_mm(handler: any, image: any): any;
-    /**
-     * Creates ANISOTROPY filter texture.
-     * @public
-     * @param {Object} image - Image or Canvas object.
-     * @returns {Object} - WebGL texture object.
-     */
-    public static createTexture_a(handler: any, image: any): any;
-    constructor(id: any, params: any);
-    /**
-     * Application default timer.
-     * @public
-     * @type {Clock}
-     */
-    public defaultClock: Clock;
-    /**
-     * Custom timers.
-     * @protected
-     * @type{Clock[]}
-     */
-    protected _clocks: Clock[];
-    /**
-     * Draw frame time in milliseconds.
-     * @public
-     * @readonly
-     * @type {number}
-     */
-    public readonly deltaTime: number;
-    /**
-     * WebGL rendering canvas element.
-     * @public
-     * @type {Object}
-     */
-    public canvas: any;
-    /**
-     * WebGL context.
-     * @public
-     * @type {Object}
-     */
-    public gl: any;
-    /**
-     * Shader program controller list.
-     * @public
-     * @type {Object.<og.webgl.ProgramController>}
-     */
-    public programs: any;
-    /**
-     * Current active shader program controller.
-     * @public
-     * @type {ProgramController}
-     */
-    public activeProgram: ProgramController;
-    /**
-     * Handler parameters.
-     * @private
-     * @type {Object}
-     */
-    private _params;
-    _oneByHeight: number;
-    /**
-     * Current WebGL extensions. Becomes here after context initialization.
-     * @public
-     * @type {Object}
-     */
-    public extensions: any;
-    /**
-     * HTML Canvas object id.
-     * @private
-     * @type {Object}
-     */
-    private _id;
-    _lastAnimationFrameTime: number;
-    _initialized: boolean;
-    /**
-     * Animation frame function assigned from outside(Ex. from Renderer).
-     * @private
-     * @type {frameCallback}
-     */
-    private _frameCallback;
-    transparentTexture: any;
-    framebufferStack: Stack;
-    /**
-     * Sets animation frame function.
-     * @public
-     * @param {callback} callback - Frame callback.
-     */
-    public setFrameCallback(callback: any): void;
-    /**
-     * Creates empty texture.
-     * @public
-     * @param {Number} [width=1] - Specifies the width of the texture image..
-     * @param {Number} [height=1] - Specifies the width of the texture image..
-     * @param {String} [filter="NEAREST"] - Specifies GL_TEXTURE_MIN(MAX)_FILTER texture value.
-     * @param {String} [internalFormat="RGBA"] - Specifies the color components in the texture.
-     * @param {String} [format="RGBA"] - Specifies the format of the texel data.
-     * @param {String} [type="UNSIGNED_BYTE"] - Specifies the data type of the texel data.
-     * @param {Number} [levels=0] - Specifies the level-of-detail number. Level 0 is the base image level. Level n is the nth mipmap reduction image.
-     * @returns {Object} - WebGL texture object.
-     */
-    public createEmptyTexture2DExt(width?: number, height?: number, filter?: string, internalFormat?: string, format?: string, type?: string, level?: number): any;
-    /**
-     * Creates Empty NEAREST filtered texture.
-     * @public
-     * @param {number} width - Empty texture width.
-     * @param {number} height - Empty texture height.
-     * @returns {Object} - WebGL texture object.
-     */
-    public createEmptyTexture_n(width: number, height: number): any;
-    /**
-     * Creates empty LINEAR filtered texture.
-     * @public
-     * @param {number} width - Empty texture width.
-     * @param {number} height - Empty texture height.
-     * @returns {Object} - WebGL texture object.
-     */
-    public createEmptyTexture_l(width: number, height: number): any;
-    /**
-     * Creates DEFAULT filter texture, ANISOTROPY is default.
-     * @public
-     * @param {Object} image - Image or Canvas object.
-     * @returns {Object} - WebGL texture object.
-     */
-    public createTexture(image: any): any;
-    createTexture_n(image: any): any;
-    createTexture_l(image: any): any;
-    createTexture_mm(image: any): any;
-    createTexture_a(image: any): any;
-    /**
-     * Creates cube texture.
-     * @public
-     * @param {Object.<string>} params - Face image urls:
-     * @param {string} params.px - Positive X or right image url.
-     * @param {string} params.nx - Negative X or left image url.
-     * @param {string} params.py - Positive Y or up image url.
-     * @param {string} params.ny - Negative Y or bottom image url.
-     * @param {string} params.pz - Positive Z or face image url.
-     * @param {string} params.nz - Negative Z or back image url.
-     * @returns {Object} - WebGL texture object.
-     */
-    public loadCubeMapTexture(params: any): any;
-    /**
-     * Adds shader program to the handler.
-     * @public
-     * @param {Program} program - Shader program.
-     * @param {boolean} [notActivate] - If it's true program will not compile.
-     * @return {Program} -
-     */
-    public addProgram(program: any, notActivate?: boolean): any;
-    /**
-     * Removes shader program from handler.
-     * @public
-     * @param {String} name - Shader program name.
-     */
-    public removeProgram(name: string): void;
-    /**
-     * Adds shader programs to the handler.
-     * @public
-     * @param {Array.<Program>} programsArr - Shader program array.
-     */
-    public addPrograms(programsArr: Array<any>): void;
-    /**
-     * Used in addProgram
-     * @private
-     * @param {ProgramController} sc - Program controller
-     */
-    private _initProgramController;
-    /**
-     * Used in init function.
-     * @private
-     */
-    private _initPrograms;
-    /**
-     * Initialize additional WebGL extensions.
-     * @public
-     * @param {string} extensionStr - Extension name.
-     * @param {boolean} showLog - Show logging.
-     * @return {Object} -
-     */
-    public initializeExtension(extensionStr: string, showLog: boolean): any;
-    /**
-     * Main function that initialize handler.
-     * @public
-     */
-    public initialize(): void;
-    /**
-     * Sets default gl render parameters. Used in init function.
-     * @private
-     */
-    private _setDefaults;
-    /**
-     * Activate depth test.
-     * @public
-     */
-    public activateDepthTest(): void;
-    /**
-     * Deactivate depth test.
-     * @public
-     */
-    public deactivateDepthTest(): void;
-    /**
-     * Activate face culling.
-     * @public
-     */
-    public activateFaceCulling(): void;
-    /**
-     * Deactivate face cullting.
-     * @public
-     */
-    public deactivateFaceCulling(): void;
-    /**
-     * Activate blending.
-     * @public
-     */
-    public activateBlending(): void;
-    /**
-     * Deactivate blending.
-     * @public
-     */
-    public deactivateBlending(): void;
-    /**
-     * Creates STREAM_DRAW ARRAY buffer.
-     * @public
-     * @param {Array.<number>} array - Input array.
-     * @param {number} itemSize - Array item size.
-     * @param {number} numItems - Items quantity.
-     * @param {number} [usage=STATIC_DRAW] - Parameter of the bufferData call can be one of STATIC_DRAW, DYNAMIC_DRAW, or STREAM_DRAW.
-     * @return {Object} -
-     */
-    public createStreamArrayBuffer(itemSize: number, numItems: number, usage?: number, bites?: number): any;
-    /**
-     * Load stream ARRAY buffer.
-     * @public
-     * @param {Array.<number>} array - Input array.
-     * @param {number} itemSize - Array item size.
-     * @param {number} numItems - Items quantity.
-     * @param {number} [usage=STATIC_DRAW] - Parameter of the bufferData call can be one of STATIC_DRAW, DYNAMIC_DRAW, or STREAM_DRAW.
-     * @return {Object} -
-     */
-    public setStreamArrayBuffer(buffer: any, array: Array<number>, offset?: number): any;
-    /**
-     * Creates ARRAY buffer.
-     * @public
-     * @param {Array.<number>} array - Input array.
-     * @param {number} itemSize - Array item size.
-     * @param {number} numItems - Items quantity.
-     * @param {number} [usage=STATIC_DRAW] - Parameter of the bufferData call can be one of STATIC_DRAW, DYNAMIC_DRAW, or STREAM_DRAW.
-     * @return {Object} -
-     */
-    public createArrayBuffer(array: Array<number>, itemSize: number, numItems: number, usage?: number): any;
-    /**
-     * Creates ELEMENT ARRAY buffer.
-     * @public
-     * @param {Array.<number>} array - Input array.
-     * @param {number} itemSize - Array item size.
-     * @param {number} numItems - Items quantity.
-     * @param {number} [usage=STATIC_DRAW] - Parameter of the bufferData call can be one of STATIC_DRAW, DYNAMIC_DRAW, or STREAM_DRAW.
-     * @return {Object} -
-     */
-    public createElementArrayBuffer(array: Array<number>, itemSize: number, numItems: number, usage?: number): any;
-    /**
-     * Sets handler canvas size.
-     * @public
-     * @param {number} w - Canvas width.
-     * @param {number} h - Canvas height.
-     */
-    public setSize(w: number, h: number): void;
-    /**
-     * Returns context screen width.
-     * @public
-     * @returns {number} -
-     */
-    public getWidth(): number;
-    /**
-     * Returns context screen height.
-     * @public
-     * @returns {number} -
-     */
-    public getHeight(): number;
-    /**
-     * Returns canvas aspect ratio.
-     * @public
-     * @returns {number} -
-     */
-    public getClientAspect(): number;
-    /**
-     * Returns screen center coordinates.
-     * @public
-     * @returns {number} -
-     */
-    public getCenter(): number;
-    /**
-     * Draw single frame.
-     * @public
-     * @param {number} now - Frame current time milliseconds.
-     */
-    public drawFrame(): void;
-    /**
-     * Clearing gl frame.
-     * @public
-     */
-    public clearFrame(): void;
-    /**
-     * Starts animation loop.
-     * @public
-     */
-    public start(): void;
-    stop(): void;
-    _requestAnimationFrameId: number;
-    /**
-     * Make animation.
-     * @private
-     */
-    private _animationFrameCallback;
-    /**
-     * Creates default texture object
-     * @public
-     * @param {Object} [params] - Texture parameters:
-     * @param {callback} [success] - Creation callback
-     */
-    public createDefaultTexture(params?: any, success?: any): void;
-    /**
-     * @public
-     */
-    public destroy(): void;
-    addClock(clock: any): void;
-    addClocks(clockArr: any): void;
-    removeClock(clock: any): void;
-}
-import { Clock } from "../Clock.js";
-import { ProgramController } from "./ProgramController.js";
-import { Stack } from "../Stack.js";

package/types/webgl/Multisample.d.ts

@@ -1,89 +0,0 @@
-/**
- * Class represents multisample framebuffer.
- * @class
- * @param {Handler} handler - WebGL handler.
- * @param {Object} [options] - Framebuffer options:
- * @param {number} [options.width] - Framebuffer width. Default is handler canvas width.
- * @param {number} [options.height] - Framebuffer height. Default is handler canvas height.
- * @param {Object} [options.texture] - Texture to render.
- * @param {String} [options.depthComponent="DEPTH_COMPONENT16"] - Specifies depth buffer size.
- * @param {Boolean} [options.useDepth] - Using depth buffer during the rendering.
- */
-export class Multisample {
-    constructor(handler: any, options: any);
-    /**
-     * WebGL handler.
-     * @public
-     * @type {Handler}
-     */
-    public handler: any;
-    _internalFormat: any;
-    /**
-     * Framebuffer object.
-     * @private
-     * @type {Object}
-     */
-    private _fbo;
-    /**
-     * Renderbuffer object.
-     * @private
-     * @type {Object}
-     */
-    private _depthRenderbuffer;
-    /**
-     * Framebuffer width.
-     * @private
-     * @type {number}
-     */
-    private _width;
-    /**
-     * Framebuffer width.
-     * @private
-     * @type {number}
-     */
-    private _height;
-    _msaa: any;
-    _useDepth: any;
-    _depthComponent: any;
-    /**
-     * Framebuffer activity.
-     * @private
-     * @type {boolean}
-     */
-    private _active;
-    _size: any;
-    _filter: any;
-    _glFilter: any;
-    renderbuffers: any[];
-    destroy(): void;
-    /**
-     * Framebuffer initialization.
-     * @private
-     */
-    private init;
-    blitTo(framebuffer: any, attachmentIndex?: number): void;
-    /**
-     * Sets framebuffer viewport size.
-     * @public
-     * @param {number} width - Framebuffer width.
-     * @param {number} height - Framebuffer height.
-     */
-    public setSize(width: number, height: number, forceDestroy: any): void;
-    /**
-     * Returns framebuffer completed.
-     * @public
-     * @returns {boolean} -
-     */
-    public isComplete(): boolean;
-    /**
-     * Activate framebuffer frame to draw.
-     * @public
-     * @returns {Framebuffer} Returns Current framebuffer.
-     */
-    public activate(): any;
-    /**
-     * Deactivate framebuffer frame.
-     * @public
-     */
-    public deactivate(): void;
-}

package/types/webgl/Program.d.ts

@@ -1,155 +0,0 @@
-/**
- * Represents more comfortable using WebGL shader program.
- * @class
- * @param {string} name - Shader program name identificator.
- * @param {object} material - Object stores uniforms, attributes and program codes:
- * @param {object} material.uniforms - Uniforms definition section.
- * @param {object} material.attributes - Attributes definition section.
- * @param {string} material.vertexShader - Vertex glsl code.
- * @param {string} material.fragmentShader - Fragment glsl code.
- */
-export class Program {
-    /**
-     * Bind program buffer.
-     * @function
-     * @param {Program} program - Used program.
-     * @param {Object} variable - Variable represents buffer data.
-     */
-    static bindBuffer(program: Program, variable: any): void;
-    constructor(name: any, material: any);
-    /**
-     * Shader progarm name.
-     * @public
-     * @type {string}
-     */
-    public name: string;
-    attributes: {};
-    uniforms: {};
-    /**
-     * Attributes.
-     * @public
-     * @type {Object}
-     */
-    public _attributes: any;
-    /**
-     * Uniforms.
-     * @public
-     * @type {Object}
-     */
-    public _uniforms: any;
-    /**
-     * Vertex shader.
-     * @public
-     * @type {string}
-     */
-    public vertexShader: string;
-    /**
-     * Fragment shader.
-     * @public
-     * @type {string}
-     */
-    public fragmentShader: string;
-    /**
-     * Webgl context.
-     * @public
-     * @type {Object}
-     */
-    public gl: any;
-    /**
-     * All program variables.
-     * @private
-     * @type {Object}
-     */
-    private _variables;
-    /**
-     * Program pointer.
-     * @private
-     * @type {Object}
-     */
-    private _p;
-    /**
-     * Texture counter.
-     * @prvate
-     * @type {number}
-     */
-    _textureID: number;
-    /**
-     * Program attributes array.
-     * @private
-     * @type {Array.<Object>}
-     */
-    private _attribArrays;
-    /**
-     * Sets the current program frame.
-     * @public
-     */
-    public use(): void;
-    /**
-     * Sets program variables.
-     * @public
-     * @param {Object} material - Variables and values object.
-     */
-    public set(material: any): void;
-    /**
-     * Apply current variables.
-     * @public
-     */
-    public apply(): void;
-    /**
-     * Calls drawElements index buffer function.
-     * @public
-     * @param {number} mode - Draw mode(GL_TRIANGLES, GL_LINESTRING etc.).
-     * @param {Object} buffer - Index buffer.
-     */
-    public drawIndexBuffer(mode: number, buffer: any): void;
-    /**
-     * Calls drawArrays function.
-     * @public
-     * @param {number} mode - Draw mode(GL_TRIANGLES, GL_LINESTRING etc.).
-     * @param {number} numItems - Curent binded buffer drawing items count.
-     */
-    public drawArrays(mode: number, numItems: number): void;
-    /**
-     * Check and log for an shader compile errors and warnings. Returns True - if no errors otherwise returns False.
-     * @private
-     * @param {Object} shader - WebGl shader program.
-     * @param {string} src - Shader program source.
-     * @returns {boolean} -
-     */
-    private _getShaderCompileStatus;
-    /**
-     * Returns compiled vertex shader program pointer.
-     * @private
-     * @param {string} src - Vertex shader source code.
-     * @returns {Object} -
-     */
-    private _createVertexShader;
-    /**
-     * Returns compiled fragment shader program pointer.
-     * @private
-     * @param {string} src - Vertex shader source code.
-     * @returns {Object} -
-     */
-    private _createFragmentShader;
-    /**
-     * Disable current program vertexAttribArrays.
-     * @public
-     */
-    public disableAttribArrays(): void;
-    /**
-     * Enable current program vertexAttribArrays.
-     * @public
-     */
-    public enableAttribArrays(): void;
-    /**
-     * Delete program.
-     * @public
-     */
-    public delete(): void;
-    /**
-     * Creates program.
-     * @public
-     * @param {Object} gl - WebGl context.
-     */
-    public createProgram(gl: any): void;
-}