melonjs 10.2.2 → 10.4.0

package/src/video/webgl/webgl_renderer.js

@@ -4,7 +4,7 @@ import Matrix2d from "./../../math/matrix2.js";
 import WebGLCompositor from "./webgl_compositor.js";
 import Renderer from "./../renderer.js";
 import TextureCache from "./../texture_cache.js";
-import {Texture, createAtlas } from "./../texture.js";
+import { TextureAtlas, createAtlas } from "./../texture.js";
 import { createCanvas, renderer } from "./../video.js";
 import * as event from "./../../system/event.js";
 import pool from "./../../system/pooling.js";
@@ -14,27 +14,25 @@ import { isPowerOfTwo, nextPowerOfTwo, TAU } from "./../../math/math.js";
 /**
  * @classdesc
  * a WebGL renderer object
- * @class WebGLRenderer
- * @extends me.Renderer
- * @memberOf me
- * @constructor
- * @param {object} options The renderer parameters
- * @param {number} options.width The width of the canvas without scaling
- * @param {number} options.height The height of the canvas without scaling
- * @param {HTMLCanvasElement} [options.canvas] The html canvas to draw to on screen
- * @param {boolean} [options.doubleBuffering=false] Whether to enable double buffering
- * @param {boolean} [options.antiAlias=false] Whether to enable anti-aliasing
- * @param {boolean} [options.failIfMajorPerformanceCaveat=true] If true, the renderer will switch to CANVAS mode if the performances of a WebGL context would be dramatically lower than that of a native application making equivalent OpenGL calls.
- * @param {boolean} [options.transparent=false] Whether to enable transparency on the canvas (performance hit when enabled)
- * @param {boolean} [options.subPixel=false] Whether to enable subpixel renderering (performance hit when enabled)
- * @param {boolean} [options.preferWebGL1=false] if true the renderer will only use WebGL 1
- * @param {string} [options.powerPreference="default"] a hint to the user agent indicating what configuration of GPU is suitable for the WebGL context ("default", "high-performance", "low-power"). To be noted that Safari and Chrome (since version 80) both default to "low-power" to save battery life and improve the user experience on these dual-GPU machines.
- * @param {number} [options.zoomX=width] The actual width of the canvas with scaling applied
- * @param {number} [options.zoomY=height] The actual height of the canvas with scaling applied
- * @param {me.WebGLCompositor} [options.compositor] A class that implements the compositor API
+ * @augments Renderer
  */
 class WebGLRenderer extends Renderer {
-
+    /**
+     * @param {object} options The renderer parameters
+     * @param {number} options.width The width of the canvas without scaling
+     * @param {number} options.height The height of the canvas without scaling
+     * @param {HTMLCanvasElement} [options.canvas] The html canvas to draw to on screen
+     * @param {boolean} [options.doubleBuffering=false] Whether to enable double buffering
+     * @param {boolean} [options.antiAlias=false] Whether to enable anti-aliasing
+     * @param {boolean} [options.failIfMajorPerformanceCaveat=true] If true, the renderer will switch to CANVAS mode if the performances of a WebGL context would be dramatically lower than that of a native application making equivalent OpenGL calls.
+     * @param {boolean} [options.transparent=false] Whether to enable transparency on the canvas (performance hit when enabled)
+     * @param {boolean} [options.subPixel=false] Whether to enable subpixel renderering (performance hit when enabled)
+     * @param {boolean} [options.preferWebGL1=false] if true the renderer will only use WebGL 1
+     * @param {string} [options.powerPreference="default"] a hint to the user agent indicating what configuration of GPU is suitable for the WebGL context ("default", "high-performance", "low-power"). To be noted that Safari and Chrome (since version 80) both default to "low-power" to save battery life and improve the user experience on these dual-GPU machines.
+     * @param {number} [options.zoomX=width] The actual width of the canvas with scaling applied
+     * @param {number} [options.zoomY=height] The actual height of the canvas with scaling applied
+     * @param {WebGLCompositor} [options.compositor] A class that implements the compositor API
+     */
     constructor(options) {
 
         // parent contructor
@@ -43,7 +41,7 @@ class WebGLRenderer extends Renderer {
         /**
          * The WebGL version used by this renderer (1 or 2)
          * @name WebGLVersion
-         * @memberOf me.WebGLRenderer
+         * @memberof WebGLRenderer
          * @type {number}
          * @default 1
          * @readonly
@@ -53,7 +51,7 @@ class WebGLRenderer extends Renderer {
         /**
          * The vendor string of the underlying graphics driver.
          * @name GPUVendor
-         * @memberOf me.WebGLRenderer
+         * @memberof WebGLRenderer
          * @type {string}
          * @default null
          * @readonly
@@ -63,7 +61,7 @@ class WebGLRenderer extends Renderer {
         /**
          * The renderer string of the underlying graphics driver.
          * @name GPURenderer
-         * @memberOf me.WebGLRenderer
+         * @memberof WebGLRenderer
          * @type {string}
          * @default null
          * @readonly
@@ -73,7 +71,7 @@ class WebGLRenderer extends Renderer {
         /**
          * The WebGL context
          * @name gl
-         * @memberOf me.WebGLRenderer
+         * @memberof WebGLRenderer
          * type {WebGLRenderingContext}
          */
         this.context = this.gl = this.getContextGL(this.getScreenCanvas(), options.transparent);
@@ -81,7 +79,7 @@ class WebGLRenderer extends Renderer {
         /**
          * Maximum number of texture unit supported under the current context
          * @name maxTextures
-         * @memberOf me.WebGLRenderer
+         * @memberof WebGLRenderer
          * @type {number}
          * @readonly
          */
@@ -115,22 +113,31 @@ class WebGLRenderer extends Renderer {
         /**
          * The current transformation matrix used for transformations on the overall scene
          * @name currentTransform
-         * @type {me.Matrix2d}
-         * @memberOf me.WebGLRenderer#
+         * @type {Matrix2d}
+         * @memberof WebGLRenderer#
          */
         this.currentTransform = new Matrix2d();
 
         /**
          * The current compositor used by the renderer
          * @name currentCompositor
-         * @type {me.WebGLCompositor}
-         * @memberOf me.WebGLRenderer#
+         * @type {WebGLCompositor}
+         * @memberof WebGLRenderer#
          */
         this.currentCompositor = null;
 
-        // Create a compositor
-        var Compositor = this.settings.compositor || WebGLCompositor;
-        this.setCompositor(new Compositor(this));
+        /**
+         * The list of active compositors
+         * @name compositors
+         * @type {Map}
+         * @memberof WebGLRenderer#
+         */
+        this.compositors = new Map();
+
+        // Create a default compositor
+        var compositor = new (this.settings.compositor || WebGLCompositor)(this);
+        this.compositors.set("default", compositor);
+        this.setCompositor(compositor);
 
 
         // default WebGL state(s)
@@ -172,17 +179,21 @@ class WebGLRenderer extends Renderer {
     /**
      * Reset context state
      * @name reset
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      */
     reset() {
         super.reset();
-        if (this.isContextValid === false) {
-            // on context lost/restore
-            this.currentCompositor.init(this);
-        } else {
-            this.currentCompositor.reset();
-        }
+
+        this.compositors.forEach((compositor) => {
+            if (this.isContextValid === false) {
+                // on context lost/restore
+                compositor.init(this);
+            } else {
+                compositor.reset();
+            }
+        });
+
         this.gl.disable(this.gl.SCISSOR_TEST);
         if (typeof this.fontContext2D !== "undefined" ) {
             this.createFontTexture(this.cache);
@@ -191,25 +202,37 @@ class WebGLRenderer extends Renderer {
     }
 
     /**
-     * assign a compositor to this renderer
+     * set the active compositor for this renderer
      * @name setCompositor
      * @function
-     * @param {WebGLCompositor} compositor a compositor instance
-     * @memberOf me.WebGLRenderer.prototype
+     * @param {WebGLCompositor|string} compositor a compositor name or instance
+     * @memberof WebGLRenderer.prototype
      * @function
      */
-    setCompositor(compositor) {
-        if (this.currentCompositor !== null && this.currentCompositor !== compositor) {
-            // flush the current compositor
-            this.currentCompositor.flush();
+    setCompositor(compositor = "default") {
+
+        if (typeof compositor === "string") {
+            compositor = this.compositors.get(compositor);
+        }
+
+        if (typeof compositor === "undefined") {
+            throw new Error("Invalid WebGL Compositor");
+        }
+
+        if (this.currentCompositor !== compositor) {
+            if (this.currentCompositor !== null) {
+                // flush the current compositor
+                this.currentCompositor.flush();
+            }
+            // set given one as current
+            this.currentCompositor = compositor;
         }
-        this.currentCompositor = compositor;
     }
 
     /**
      * Reset the gl transform to identity
      * @name resetTransform
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      */
     resetTransform() {
@@ -244,7 +267,7 @@ class WebGLRenderer extends Renderer {
             /**
              * @ignore
              */
-            this.fontTexture = new Texture(createAtlas(canvas.width, canvas.height, "fontTexture"), image, cache);
+            this.fontTexture = new TextureAtlas(createAtlas(canvas.width, canvas.height, "fontTexture"), image, cache);
             this.currentCompositor.uploadTexture(this.fontTexture, 0, 0, 0);
 
         } else {
@@ -256,12 +279,12 @@ class WebGLRenderer extends Renderer {
     /**
      * Create a pattern with the specified repetition
      * @name createPattern
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {Image} image Source image
      * @param {string} repeat Define how the pattern should be repeated
-     * @returns {me.Renderer.Texture}
-     * @see me.ImageLayer#repeat
+     * @returns {TextureAtlas}
+     * @see ImageLayer#repeat
      * @example
      * var tileable   = renderer.createPattern(image, "repeat");
      * var horizontal = renderer.createPattern(image, "repeat-x");
@@ -278,7 +301,7 @@ class WebGLRenderer extends Renderer {
             );
         }
 
-        var texture = new Texture(createAtlas(image.width, image.height, "pattern", repeat), image);
+        var texture = new TextureAtlas(createAtlas(image.width, image.height, "pattern", repeat), image);
 
         // FIXME: Remove old cache entry and texture when changing the repeat mode
         this.currentCompositor.uploadTexture(texture);
@@ -289,7 +312,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Flush the compositor to the frame buffer
      * @name flush
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      */
     flush() {
@@ -299,23 +322,22 @@ class WebGLRenderer extends Renderer {
     /**
      * Clears the gl context with the given color.
      * @name clearColor
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
-     * @param {me.Color|string} color CSS color.
+     * @param {Color|string} [color="#000000"] CSS color.
      * @param {boolean} [opaque=false] Allow transparency [default] or clear the surface completely [true]
      */
-    clearColor(color, opaque) {
+    clearColor(color = "#000000", opaque = false) {
         var glArray;
 
-        this.save();
-
         if (color instanceof Color) {
             glArray = color.toArray();
         } else {
+            var _color = pool.pull("me.Color");
             // reuse temporary the renderer default color object
-            glArray = this.getColor().parseCSS(color).toArray();
+            glArray = _color.parseCSS(color).toArray();
+            pool.push(_color);
         }
-
         // clear gl context with the specified color
         this.currentCompositor.clearColor(glArray[0], glArray[1], glArray[2], (opaque === true) ? 1.0 : glArray[3]);
         this.currentCompositor.clear();
@@ -323,13 +345,12 @@ class WebGLRenderer extends Renderer {
         // restore default clear Color black
         this.currentCompositor.clearColor(0.0, 0.0, 0.0, 0.0);
 
-        this.restore();
     }
 
     /**
      * Erase the pixels in the given rectangular area by setting them to transparent black (rgba(0,0,0,0)).
      * @name clearRect
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} x x axis of the coordinate for the rectangle starting point.
      * @param {number} y y axis of the coordinate for the rectangle starting point.
@@ -337,11 +358,10 @@ class WebGLRenderer extends Renderer {
      * @param {number} height The rectangle's height.
      */
     clearRect(x, y, width, height) {
-        var color = this.currentColor.clone();
-        this.currentColor.copy("#000000");
-        this.fillRect(x, y, width, height);
-        this.currentColor.copy(color);
-        pool.push(color);
+        this.save();
+        this.clipRect(x, y, width, height);
+        this.clearColor();
+        this.restore();
     }
 
     /**
@@ -380,7 +400,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Draw an image to the gl context
      * @name drawImage
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {Image} image An element to draw into the context. The specification permits any canvas image source (CanvasImageSource), specifically, a CSSImageValue, an HTMLImageElement, an SVGImageElement, an HTMLVideoElement, an HTMLCanvasElement, an ImageBitmap, or an OffscreenCanvas.
      * @param {number} sx The X coordinate of the top left corner of the sub-rectangle of the source image to draw into the destination context.
@@ -433,14 +453,14 @@ class WebGLRenderer extends Renderer {
     /**
      * Draw a pattern within the given rectangle.
      * @name drawPattern
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
-     * @param {me.Renderer.Texture} pattern Pattern object
+     * @param {TextureAtlas} pattern Pattern object
      * @param {number} x
      * @param {number} y
      * @param {number} width
      * @param {number} height
-     * @see me.WebGLRenderer#createPattern
+     * @see WebGLRenderer#createPattern
      */
     drawPattern(pattern, x, y, width, height) {
         var uvs = pattern.getUVs("0,0," + width + "," + height);
@@ -451,7 +471,7 @@ class WebGLRenderer extends Renderer {
     /**
      * return a reference to the screen canvas corresponding WebGL Context
      * @name getScreenContext
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @returns {WebGLRenderingContext}
      */
@@ -462,7 +482,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Returns the WebGL Context object of the given Canvas
      * @name getContextGL
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {HTMLCanvasElement} canvas
      * @param {boolean} [transparent=true] use false to disable transparency
@@ -520,7 +540,7 @@ class WebGLRenderer extends Renderer {
      * Returns the WebGLContext instance for the renderer
      * return a reference to the system 2d Context
      * @name getContext
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @returns {WebGLRenderingContext}
      */
@@ -531,7 +551,7 @@ class WebGLRenderer extends Renderer {
     /**
      * set a blend mode for the given context
      * @name setBlendMode
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {string} [mode="normal"] blend mode : "normal", "multiply"
      * @param {WebGLRenderingContext} [gl]
@@ -571,7 +591,7 @@ class WebGLRenderer extends Renderer {
     /**
      * restores the canvas context
      * @name restore
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      */
     restore() {
@@ -605,7 +625,7 @@ class WebGLRenderer extends Renderer {
     /**
      * saves the canvas context
      * @name save
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      */
     save() {
@@ -621,7 +641,7 @@ class WebGLRenderer extends Renderer {
     /**
      * rotates the uniform matrix
      * @name rotate
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} angle in radians
      */
@@ -632,7 +652,7 @@ class WebGLRenderer extends Renderer {
     /**
      * scales the uniform matrix
      * @name scale
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} x
      * @param {number} y
@@ -653,7 +673,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Set the global alpha
      * @name setGlobalAlpha
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} alpha 0.0 to 1.0 values accepted.
      */
@@ -665,9 +685,9 @@ class WebGLRenderer extends Renderer {
      * Set the current fill & stroke style color.
      * By default, or upon reset, the value is set to #000000.
      * @name setColor
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
-     * @param {me.Color|string} color css color string.
+     * @param {Color|string} color css color string.
      */
     setColor(color) {
         var alpha = this.currentColor.alpha;
@@ -678,7 +698,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Set the line width
      * @name setLineWidth
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} width Line width
      */
@@ -689,7 +709,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Stroke an arc at the specified coordinates with given radius, start and end points
      * @name strokeArc
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} x arc center point x-axis
      * @param {number} y arc center point y-axis
@@ -733,7 +753,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Fill an arc at the specified coordinates with given radius, start and end points
      * @name fillArc
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} x arc center point x-axis
      * @param {number} y arc center point y-axis
@@ -776,7 +796,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Stroke an ellipse at the specified coordinates with given radius
      * @name strokeEllipse
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} x ellipse center point x-axis
      * @param {number} y ellipse center point y-axis
@@ -813,7 +833,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Fill an ellipse at the specified coordinates with given radius
      * @name fillEllipse
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} x ellipse center point x-axis
      * @param {number} y ellipse center point y-axis
@@ -848,7 +868,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Stroke a line of the given two points
      * @name strokeLine
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} startX the start x coordinate
      * @param {number} startY the start y coordinate
@@ -868,7 +888,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Fill a line of the given two points
      * @name fillLine
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} startX the start x coordinate
      * @param {number} startY the start y coordinate
@@ -882,9 +902,9 @@ class WebGLRenderer extends Renderer {
     /**
      * Stroke a me.Polygon on the screen with a specified color
      * @name strokePolygon
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
-     * @param {me.Polygon} poly the shape to draw
+     * @param {Polygon} poly the shape to draw
      * @param {boolean} [fill=false] also fill the shape with the current color if true
      */
     strokePolygon(poly, fill = false) {
@@ -912,9 +932,9 @@ class WebGLRenderer extends Renderer {
     /**
      * Fill a me.Polygon on the screen
      * @name fillPolygon
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
-     * @param {me.Polygon} poly the shape to draw
+     * @param {Polygon} poly the shape to draw
      */
     fillPolygon(poly) {
         var points = poly.points;
@@ -940,7 +960,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Draw a stroke rectangle at the specified coordinates
      * @name strokeRect
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} x
      * @param {number} y
@@ -968,7 +988,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Draw a filled rectangle at the specified coordinates
      * @name fillRect
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} x
      * @param {number} y
@@ -992,9 +1012,9 @@ class WebGLRenderer extends Renderer {
      * Reset (overrides) the renderer transformation matrix to the
      * identity one, and then apply the given transformation matrix.
      * @name setTransform
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
-     * @param {me.Matrix2d} mat2d Matrix to transform by
+     * @param {Matrix2d} mat2d Matrix to transform by
      */
     setTransform(mat2d) {
         this.resetTransform();
@@ -1004,9 +1024,9 @@ class WebGLRenderer extends Renderer {
     /**
      * Multiply given matrix into the renderer tranformation matrix
      * @name transform
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
-     * @param {me.Matrix2d} mat2d Matrix to transform by
+     * @param {Matrix2d} mat2d Matrix to transform by
      */
     transform(mat2d) {
         var currentTransform = this.currentTransform;
@@ -1022,7 +1042,7 @@ class WebGLRenderer extends Renderer {
     /**
      * Translates the uniform matrix by the given coordinates
      * @name translate
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} x
      * @param {number} y
@@ -1045,7 +1065,7 @@ class WebGLRenderer extends Renderer {
      * and restore it (with the restore() method) any time in the future.
      * (<u>this is an experimental feature !</u>)
      * @name clipRect
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
      * @param {number} x
      * @param {number} y
@@ -1093,9 +1113,9 @@ class WebGLRenderer extends Renderer {
      * So, if the renderable is larger than the mask, only the intersecting part of the renderable will be visible.
      * Mask are not preserved through renderer context save and restore.
      * @name setMask
-     * @memberOf me.WebGLRenderer.prototype
+     * @memberof WebGLRenderer.prototype
      * @function
-     * @param {me.Rect|me.Polygon|me.Line|me.Ellipse} [mask] the shape defining the mask to be applied
+     * @param {Rect|Polygon|Line|Ellipse} [mask] the shape defining the mask to be applied
      */
     setMask(mask) {
         var gl = this.gl;
@@ -1124,8 +1144,8 @@ class WebGLRenderer extends Renderer {
     /**
      * disable (remove) the rendering mask set through setMask.
      * @name clearMask
-     * @see me.WebGLRenderer#setMask
-     * @memberOf me.WebGLRenderer.prototype
+     * @see WebGLRenderer#setMask
+     * @memberof WebGLRenderer.prototype
      * @function
      */
     clearMask() {