melonjs 13.0.0 → 13.2.0

package/src/video/webgl/glshader.js

@@ -42,56 +42,38 @@ class GLShader {
 
         /**
          * the active gl rendering context
-         * @public
          * @type {WebGLRenderingContext}
-         * @name gl
-         * @memberof GLShader
          */
         this.gl = gl;
 
         /**
          * the vertex shader source code
-         * @public
          * @type {string}
-         * @name vertex
-         * @memberof GLShader
          */
         this.vertex = setPrecision(minify(vertex), precision || device.getMaxShaderPrecision(this.gl));
 
         /**
          * the fragment shader source code
-         * @public
          * @type {string}
-         * @name vertex
-         * @memberof GLShader
          */
         this.fragment = setPrecision(minify(fragment), precision || device.getMaxShaderPrecision(this.gl));
 
         /**
          * the location attributes of the shader
-         * @public
          * @type {GLint[]}
-         * @name attributes
-         * @memberof GLShader
          */
         this.attributes = extractAttributes(this.gl, this);
 
 
         /**
          * a reference to the shader program (once compiled)
-         * @public
          * @type {WebGLProgram}
-         * @name program
-         * @memberof GLShader
          */
         this.program = compileProgram(this.gl, this.vertex, this.fragment, this.attributes);
 
         /**
          * the uniforms of the shader
-         * @public
          * @type {object}
-         * @name uniforms
-         * @memberof GLShader
          */
         this.uniforms = extractUniforms(this.gl, this);
 
@@ -101,8 +83,6 @@ class GLShader {
 
     /**
      * Installs this shader program as part of current rendering state
-     * @name bind
-     * @memberof GLShader
      */
     bind() {
         this.gl.useProgram(this.program);
@@ -110,8 +90,6 @@ class GLShader {
 
     /**
      * returns the location of an attribute variable in this shader program
-     * @name getAttribLocation
-     * @memberof GLShader
      * @param {string} name the name of the attribute variable whose location to get.
      * @returns {GLint} number indicating the location of the variable name if found. Returns -1 otherwise
      */
@@ -126,8 +104,6 @@ class GLShader {
 
     /**
      * Set the uniform to the given value
-     * @name setUniform
-     * @memberof GLShader
      * @param {string} name the uniform name
      * @param {object|Float32Array} value the value to assign to that uniform
      * @example
@@ -148,8 +124,6 @@ class GLShader {
 
     /**
      * activate the given vertex attribute for this shader
-     * @name setVertexAttributes
-     * @memberof GLShader
      * @param {WebGLRenderingContext} gl the current WebGL rendering context
      * @param {object[]} attributes an array of vertex attributes
      * @param {number} vertexByteSize the size of a single vertex in bytes
@@ -171,8 +145,6 @@ class GLShader {
 
     /**
      * destroy this shader objects resources (program, attributes, uniforms)
-     * @name destroy
-     * @memberof GLShader
      */
     destroy() {
         this.uniforms = null;

package/src/video/webgl/webgl_compositor.js

@@ -56,44 +56,37 @@ class WebGLCompositor {
 
         /**
          * a reference to the active WebGL shader
-         * @name activeShader
-         * @memberof WebGLCompositor
          * @type {GLShader}
          */
         this.activeShader = null;
 
         /**
          * primitive type to render (gl.POINTS, gl.LINE_STRIP, gl.LINE_LOOP, gl.LINES, gl.TRIANGLE_STRIP, gl.TRIANGLE_FAN, gl.TRIANGLES)
-         * @name mode
-         * @see WebGLCompositor
-         * @memberof WebGLCompositor
+         * @type {number}
          * @default gl.TRIANGLES
          */
         this.mode = gl.TRIANGLES;
 
         /**
          * an array of vertex attribute properties
-         * @name attributes
          * @see WebGLCompositor.addAttribute
-         * @memberof WebGLCompositor
+         * @type {Array}
          */
         this.attributes = [];
 
         /**
          * the size of a single vertex in bytes
          * (will automatically be calculated as attributes definitions are added)
-         * @name vertexByteSize
          * @see WebGLCompositor.addAttribute
-         * @memberof WebGLCompositor
+         * @type {number}
          */
         this.vertexByteSize = 0;
 
         /**
          * the size of a single vertex in floats
          * (will automatically be calculated as attributes definitions are added)
-         * @name vertexSize
          * @see WebGLCompositor.addAttribute
-         * @memberof WebGLCompositor
+         * @type {number}
          */
         this.vertexSize = 0;
 
@@ -132,8 +125,8 @@ class WebGLCompositor {
         // initial viewport size
         this.setViewport(
             0, 0,
-            this.renderer.getScreenCanvas().width,
-            this.renderer.getScreenCanvas().height
+            this.renderer.getCanvas().width,
+            this.renderer.getCanvas().height
         );
 
         // Initialize clear color
@@ -154,8 +147,6 @@ class WebGLCompositor {
 
     /**
      * add vertex attribute property definition to the compositor
-     * @name addAttribute
-     * @memberof WebGLCompositor
      * @param {string} name name of the attribute in the vertex shader
      * @param {number} size number of components per vertex attribute. Must be 1, 2, 3, or 4.
      * @param {GLenum} type data type of each component in the array
@@ -201,8 +192,6 @@ class WebGLCompositor {
 
     /**
      * Sets the viewport
-     * @name setViewport
-     * @memberof WebGLCompositor
      * @param {number} x x position of viewport
      * @param {number} y y position of viewport
      * @param {number} w width of viewport
@@ -214,8 +203,6 @@ class WebGLCompositor {
 
     /**
      * Create a WebGL texture from an image
-     * @name createTexture2D
-     * @memberof WebGLCompositor
      * @param {number} unit Destination texture unit
      * @param {Image|HTMLCanvasElement|ImageData|Uint8Array[]|Float32Array[]} image Source image
      * @param {number} filter gl.LINEAR or gl.NEAREST
@@ -258,8 +245,6 @@ class WebGLCompositor {
 
     /**
      * delete the given WebGL texture
-     * @name bindTexture2D
-     * @memberof WebGLCompositor
      * @param {WebGLTexture} [texture] a WebGL texture to delete
      * @param {number} [unit] Texture unit to delete
      */
@@ -270,8 +255,6 @@ class WebGLCompositor {
 
     /**
      * returns the WebGL texture associated to the given texture unit
-     * @name bindTexture2D
-     * @memberof WebGLCompositor
      * @param {number} unit Texture unit to which a texture is bound
      * @returns {WebGLTexture} texture a WebGL texture
      */
@@ -281,8 +264,6 @@ class WebGLCompositor {
 
     /**
      * assign the given WebGL texture to the current batch
-     * @name bindTexture2D
-     * @memberof WebGLCompositor
      * @param {WebGLTexture} texture a WebGL texture
      * @param {number} unit Texture unit to which the given texture is bound
      */
@@ -308,8 +289,6 @@ class WebGLCompositor {
 
     /**
      * unbind the given WebGL texture, forcing it to be reuploaded
-     * @name unbindTexture2D
-     * @memberof WebGLCompositor
      * @param {WebGLTexture} [texture] a WebGL texture
      * @param {number} [unit] a WebGL texture
      * @returns {number} unit the unit number that was associated with the given texture
@@ -354,8 +333,6 @@ class WebGLCompositor {
 
     /**
      * set/change the current projection matrix
-     * @name setProjection
-     * @memberof WebGLCompositor
      * @param {Matrix3d} matrix
      */
     setProjection(matrix) {
@@ -364,9 +341,7 @@ class WebGLCompositor {
 
     /**
      * Select the shader to use for compositing
-     * @name useShader
      * @see GLShader
-     * @memberof WebGLCompositor
      * @param {GLShader} shader a reference to a GLShader instance
      */
     useShader(shader) {
@@ -381,8 +356,6 @@ class WebGLCompositor {
 
     /**
      * Add a textured quad
-     * @name addQuad
-     * @memberof WebGLCompositor
      * @param {TextureAtlas} texture Source texture atlas
      * @param {number} x Destination x-coordinate
      * @param {number} y Destination y-coordinate
@@ -438,7 +411,6 @@ class WebGLCompositor {
     /**
      * Flush batched texture operations to the GPU
      * @param {number} [mode=gl.TRIANGLES] the GL drawing mode
-     * @memberof WebGLCompositor
      */
     flush(mode = this.mode) {
         var vertex = this.vertexBuffer;
@@ -464,8 +436,6 @@ class WebGLCompositor {
 
     /**
      * Draw an array of vertices
-     * @name drawVertices
-     * @memberof WebGLCompositor
      * @param {GLenum} mode primitive type to render (gl.POINTS, gl.LINE_STRIP, gl.LINE_LOOP, gl.LINES, gl.TRIANGLE_STRIP, gl.TRIANGLE_FAN, gl.TRIANGLES)
      * @param {Vector2d[]} verts vertices
      * @param {number} [vertexCount=verts.length] amount of points defined in the points array
@@ -492,25 +462,26 @@ class WebGLCompositor {
     }
 
     /**
-     * Specify the color values used when clearing color buffers. The values are clamped between 0 and 1.
-     * @name clearColor
-     * @memberof WebGLCompositor
-     * @param {number} [r=0] - the red color value used when the color buffers are cleared
-     * @param {number} [g=0] - the green color value used when the color buffers are cleared
-     * @param {number} [b=0] - the blue color value used when the color buffers are cleared
-     * @param {number} [a=0] - the alpha color value used when the color buffers are cleared
+     * Clear the frame buffer
+     * @param {number} [alpha = 0.0] - the alpha value used when clearing the framebuffer
      */
-    clearColor(r, g, b, a) {
-        this.gl.clearColor(r, g, b, a);
+    clear(alpha = 0) {
+        var gl = this.gl;
+        gl.clearColor(0, 0, 0, alpha);
+        gl.clear(gl.COLOR_BUFFER_BIT | gl.STENCIL_BUFFER_BIT);
     }
 
     /**
-     * Clear the frame buffer
-     * @name clear
-     * @memberof WebGLCompositor
+     * Specify the color values used when clearing color buffers. The values are clamped between 0 and 1.
+     * @param {number} [r = 0] - the red color value used when the color buffers are cleared
+     * @param {number} [g = 0] - the green color value used when the color buffers are cleared
+     * @param {number} [b = 0] - the blue color value used when the color buffers are cleared
+     * @param {number} [a = 0] - the alpha color value used when the color buffers are cleared
      */
-    clear() {
-        this.gl.clear(this.gl.COLOR_BUFFER_BIT);
+    clearColor(r = 0, g = 0, b = 0, a = 0) {
+        var gl = this.gl;
+        gl.clearColor(r, g, b, a);
+        gl.clear(gl.COLOR_BUFFER_BIT);
     }
 };