@scratch/scratch-render 12.1.0-login-from-editor → 12.1.0-membership-program

package/src/ShaderManager.js

@@ -4,7 +4,7 @@ const twgl = require('twgl.js');
 class ShaderManager {
     /**
      * @param {WebGLRenderingContext} gl WebGL rendering context to create shaders for
-     * @constructor
+     * @class
      */
     constructor (gl) {
         this._gl = gl;
@@ -63,10 +63,10 @@ class ShaderManager {
 
         const definesText = `${defines.join('\n')}\n`;
 
-        /* eslint-disable global-require */
+         
         const vsFullText = definesText + require('raw-loader!./shaders/sprite.vert');
         const fsFullText = definesText + require('raw-loader!./shaders/sprite.frag');
-        /* eslint-enable global-require */
+         
 
         return twgl.createProgramInfo(this._gl, [vsFullText, fsFullText]);
     }
@@ -74,11 +74,11 @@ class ShaderManager {
 
 /**
  * @typedef {object} ShaderManager.Effect
- * @prop {int} mask - The bit in 'effectBits' representing the effect.
- * @prop {function} converter - A conversion function which takes a Scratch value (generally in the range
+ * @property {int} mask - The bit in 'effectBits' representing the effect.
+ * @property {function} converter - A conversion function which takes a Scratch value (generally in the range
  *   0..100 or -100..100) and maps it to a value useful to the shader. This
  *   mapping may not be reversible.
- * @prop {boolean} shapeChanges - Whether the effect could change the drawn shape.
+ * @property {boolean} shapeChanges - Whether the effect could change the drawn shape.
  */
 
 /**

package/src/Silhouette.js

@@ -1,5 +1,5 @@
 /**
- * @fileoverview
+ * @file
  * A representation of a Skin's silhouette that can test if a point on the skin
  * renders a pixel where it is drawn.
  */
@@ -22,7 +22,7 @@ const intMax = (i, j) => i ^ ((i ^ j) & ((i - j) >> 31));
  * @param {Silhouette} silhouette - has data width and height
  * @param {number} x - x
  * @param {number} y - y
- * @return {number} Alpha value for x/y position
+ * @returns {number} Alpha value for x/y position
  */
 const getPoint = ({_width: width, _height: height, _colorData: data}, x, y) => {
     // 0 if outside bounds, otherwise read from data.
@@ -49,7 +49,7 @@ const __cornerWork = [
  * @param {number} x X position of texture [0, width).
  * @param {number} y Y position of texture [0, height).
  * @param {Uint8ClampedArray} dst A color 4b space.
- * @return {Uint8ClampedArray} The dst vector.
+ * @returns {Uint8ClampedArray} The dst vector.
  */
 const getColor4b = ({_width: width, _height: height, _colorData: data}, x, y, dst) => {
     // Clamp coords to edge, matching GL_CLAMP_TO_EDGE.
@@ -78,7 +78,7 @@ const getColor4b = ({_width: width, _height: height, _colorData: data}, x, y, ds
  * @param {number} x X position of texture [0, width).
  * @param {number} y Y position of texture [0, height).
  * @param {Uint8ClampedArray} dst A color 4b space.
- * @return {Uint8ClampedArray} The dst vector.
+ * @returns {Uint8ClampedArray} The dst vector.
  */
 const getPremultipliedColor4b = ({_width: width, _height: height, _colorData: data}, x, y, dst) => {
     // Clamp coords to edge, matching GL_CLAMP_TO_EDGE.
@@ -214,7 +214,7 @@ class Silhouette {
     /**
      * Test if texture coordinate touches the silhouette using nearest neighbor.
      * @param {twgl.v3} vec A texture coordinate.
-     * @return {boolean} If the nearest pixel has an alpha value.
+     * @returns {boolean} If the nearest pixel has an alpha value.
      */
     isTouchingNearest (vec) {
         if (!this._colorData) return;
@@ -229,7 +229,7 @@ class Silhouette {
      * Test to see if any of the 4 pixels used in the linear interpolate touch
      * the silhouette.
      * @param {twgl.v3} vec A texture coordinate.
-     * @return {boolean} Any of the pixels have some alpha.
+     * @returns {boolean} Any of the pixels have some alpha.
      */
     isTouchingLinear (vec) {
         if (!this._colorData) return;
@@ -244,7 +244,7 @@ class Silhouette {
     /**
      * Get the canvas element reused by Silhouettes to update their data with.
      * @private
-     * @return {CanvasElement} A canvas to draw bitmap data to.
+     * @returns {CanvasElement} A canvas to draw bitmap data to.
      */
     static _updateCanvas () {
         if (typeof __SilhouetteUpdateCanvas === 'undefined') {

package/src/Skin.js

@@ -9,7 +9,7 @@ class Skin extends EventEmitter {
     /**
      * Create a Skin, which stores and/or generates textures for use in rendering.
      * @param {int} id - The unique ID for this Skin.
-     * @constructor
+     * @class
      */
     constructor (id) {
         super();
@@ -60,7 +60,7 @@ class Skin extends EventEmitter {
     }
 
     /**
-     * @return {int} the unique ID for this Skin.
+     * @returns {int} the unique ID for this Skin.
      */
     get id () {
         return this._id;
@@ -75,7 +75,7 @@ class Skin extends EventEmitter {
 
     /**
      * @abstract
-     * @return {Array<number>} the "native" size, in texels, of this skin.
+     * @returns {Array<number>} the "native" size, in texels, of this skin.
      */
     get size () {
         return [0, 0];
@@ -83,10 +83,10 @@ class Skin extends EventEmitter {
 
     /**
      * Should this skin's texture be filtered with nearest-neighbor or linear interpolation at the given scale?
-     * @param {?Array<Number>} scale The screen-space X and Y scaling factors at which this skin's texture will be
+     * @param {?Array<number>} scale The screen-space X and Y scaling factors at which this skin's texture will be
      * displayed, as percentages (100 means 1 "native size" unit is 1 screen pixel; 200 means 2 screen pixels, etc).
      * @param {Drawable} drawable The drawable that this skin's texture will be applied to.
-     * @return {boolean} True if this skin's texture, as returned by {@link getTexture}, should be filtered with
+     * @returns {boolean} True if this skin's texture, as returned by {@link getTexture}, should be filtered with
      * nearest-neighbor interpolation.
      */
     // eslint-disable-next-line no-unused-vars
@@ -96,7 +96,7 @@ class Skin extends EventEmitter {
 
     /**
      * Get the center of the current bounding box
-     * @return {Array<number>} the center of the current bounding box
+     * @returns {Array<number>} the center of the current bounding box
      */
     calculateRotationCenter () {
         return [this.size[0] / 2, this.size[1] / 2];
@@ -105,7 +105,7 @@ class Skin extends EventEmitter {
     /**
      * @abstract
      * @param {Array<number>} scale - The scaling factors to be used.
-     * @return {WebGLTexture} The GL texture representation of this skin when drawing at the given size.
+     * @returns {WebGLTexture} The GL texture representation of this skin when drawing at the given size.
      */
     // eslint-disable-next-line no-unused-vars
     getTexture (scale) {
@@ -116,7 +116,7 @@ class Skin extends EventEmitter {
      * Get the bounds of the drawable for determining its fenced position.
      * @param {Array<number>} drawable - The Drawable instance this skin is using.
      * @param {?Rectangle} result - Optional destination for bounds calculation.
-     * @return {!Rectangle} The drawable's bounds. For compatibility with Scratch 2, we always use getAABB.
+     * @returns {!Rectangle} The drawable's bounds. For compatibility with Scratch 2, we always use getAABB.
      */
     getFenceBounds (drawable, result) {
         return drawable.getAABB(result);
@@ -199,7 +199,7 @@ class Skin extends EventEmitter {
      * @see updateSilhouette
      * @see Drawable.updateCPURenderAttributes
      * @param {twgl.v3} vec A texture coordinate.
-     * @return {boolean} Did it touch?
+     * @returns {boolean} Did it touch?
      */
     isTouchingNearest (vec) {
         return this._silhouette.isTouchingNearest(vec);
@@ -212,7 +212,7 @@ class Skin extends EventEmitter {
      * @see updateSilhouette
      * @see Drawable.updateCPURenderAttributes
      * @param {twgl.v3} vec A texture coordinate.
-     * @return {boolean} Did it touch?
+     * @returns {boolean} Did it touch?
      */
     isTouchingLinear (vec) {
         return this._silhouette.isTouchingLinear(vec);

package/src/TextBubbleSkin.js

@@ -30,8 +30,8 @@ class TextBubbleSkin extends Skin {
      * Create a new text bubble skin.
      * @param {!int} id - The ID for this Skin.
      * @param {!RenderWebGL} renderer - The renderer which will use this skin.
-     * @constructor
-     * @extends Skin
+     * @class
+     * @augments Skin
      */
     constructor (id, renderer) {
         super(id);
@@ -85,7 +85,7 @@ class TextBubbleSkin extends Skin {
     }
 
     /**
-     * @return {Array<number>} the dimensions, in Scratch units, of this skin.
+     * @returns {Array<number>} the dimensions, in Scratch units, of this skin.
      */
     get size () {
         if (this._textDirty) {
@@ -248,7 +248,7 @@ class TextBubbleSkin extends Skin {
 
     /**
      * @param {Array<number>} scale - The scaling factors to be used, each in the [0,100] range.
-     * @return {WebGLTexture} The GL texture representation of this skin when drawing at the given scale.
+     * @returns {WebGLTexture} The GL texture representation of this skin when drawing at the given scale.
      */
     getTexture (scale) {
         // The texture only ever gets uniform scale. Take the larger of the two axes.

package/src/playground/playground.js

@@ -80,7 +80,6 @@ const fudgePropertyInput = document.getElementById('fudgeproperty');
 const fudgeMinInput = document.getElementById('fudgeMin');
 const fudgeMaxInput = document.getElementById('fudgeMax');
 
-/* eslint require-jsdoc: 0 */
 const updateFudgeProperty = event => {
     fudgeProperty = event.target.value;
 };

package/src/util/color-conversions.js

@@ -3,13 +3,12 @@
  * adapted from http://lolengine.net/blog/2013/01/13/fast-rgb-to-hsv.
  * Assumes r, g, and b are in the range [0, 255] and
  * returns h, s, and v in the range [0, 1].
- *
  * @param   {Array<number>} rgb   The RGB color value
  * @param   {number}        rgb.r The red color value
  * @param   {number}        rgb.g The green color value
  * @param   {number}        rgb.b The blue color value
  * @param   {Array<number>} dst   The array to store the HSV values in
- * @return  {Array<number>}       The `dst` array passed in
+ * @returns  {Array<number>}       The `dst` array passed in
  */
 const rgbToHsv = ([r, g, b], dst) => {
     let K = 0.0;
@@ -52,13 +51,12 @@ const rgbToHsv = ([r, g, b], dst) => {
  * adapted from https://gist.github.com/mjackson/5311256.
  * Assumes h, s, and v are contained in the set [0, 1] and
  * returns r, g, and b in the set [0, 255].
- *
  * @param   {Array<number>}                hsv The HSV color value
  * @param   {number}                       hsv.h     The hue
  * @param   {number}                       hsv.s     The saturation
  * @param   {number}                       hsv.v     The value
  * @param   {Uint8Array|Uint8ClampedArray} dst The array to store the RGB values in
- * @return  {Uint8Array|Uint8ClampedArray}     The `dst` array passed in
+ * @returns  {Uint8Array|Uint8ClampedArray}     The `dst` array passed in
  */
 const hsvToRgb = ([h, s, v], dst) => {
     if (s === 0) {

package/src/.eslintrc.js

@@ -1,11 +0,0 @@
-module.exports = {
-    root: true,
-    extends: ['scratch', 'scratch/es6', 'scratch/node'],
-    env: {
-        node: false,
-        browser: true // TODO: disable this
-    },
-    globals: {
-        Buffer: true // TODO: remove this?
-    }
-};

package/src/playground/.eslintrc.js

@@ -1,9 +0,0 @@
-module.exports = {
-    extends: ['scratch'],
-    env: {
-        browser: true
-    },
-    rules: {
-        'no-console': 'off'
-    }
-};