p5 2.2.1-rc.0 → 2.2.1

package/dist/dom/p5.File.js

@@ -72,8 +72,6 @@ function file(p5, fn){
    * @param {File} file wrapped file.
    *
    * @example
-   * <div>
-   * <code>
    * // Use the file input to load a
    * // file and display its info.
    *
@@ -103,11 +101,8 @@ function file(p5, fn){
    *   // Display the p5.File's size in bytes.
    *   text(file.size, 10, 90);
    * }
-   * </code>
-   * </div>
    *
-   * <div>
-   * <code>
+   * @example
    * // Use the file input to select an image to
    * // load and display.
    * let img;
@@ -145,8 +140,6 @@ function file(p5, fn){
    *     img = null;
    *   }
    * }
-   * </code>
-   * </div>
    */
   p5.File = File;
 
@@ -158,8 +151,6 @@ function file(p5, fn){
    * @for p5.File
    * @property {File} file
    * @example
-   * <div>
-   * <code>
    * // Use the file input to load a
    * // file and display its info.
    *
@@ -189,8 +180,6 @@ function file(p5, fn){
    *   // Display the p5.File's size in bytes.
    *   text(file.size, 10, 90);
    * }
-   * </code>
-   * </div>
    */
 
   /**
@@ -203,8 +192,6 @@ function file(p5, fn){
    * @for p5.File
    * @property {String} type
    * @example
-   * <div>
-   * <code>
    * // Use the file input to load a file and display its info.
    *
    * function setup() {
@@ -227,8 +214,6 @@ function file(p5, fn){
    *   // Display the p5.File's type.
    *   text(`This is file's type is: ${file.type}`, 10, 10, 80, 80);
    * }
-   * </code>
-   * </div>
    */
 
   /**
@@ -242,8 +227,6 @@ function file(p5, fn){
    * @for p5.File
    *
    * @example
-   * <div>
-   * <code>
    * // Use the file input to load a
    * // file and display its info.
    *
@@ -267,8 +250,6 @@ function file(p5, fn){
    *   // Display the p5.File's subtype.
    *   text(`This is file's subtype is: ${file.subtype}`, 10, 10, 80, 80);
    * }
-   * </code>
-   * </div>
    */
 
   /**
@@ -278,8 +259,6 @@ function file(p5, fn){
    * @for p5.File
    *
    * @example
-   * <div>
-   * <code>
    * // Use the file input to load a
    * // file and display its info.
    *
@@ -303,8 +282,6 @@ function file(p5, fn){
    *   // Display the p5.File's name.
    *   text(`This is file's name is: ${file.name}`, 10, 10, 80, 80);
    * }
-   * </code>
-   * </div>
    */
 
   /**
@@ -314,8 +291,6 @@ function file(p5, fn){
    * @for p5.File
    *
    * @example
-   * <div>
-   * <code>
    * // Use the file input to load a file and display its info.
    *
    * function setup() {
@@ -338,8 +313,6 @@ function file(p5, fn){
    *   // Display the p5.File's size.
    *   text(`This is file has ${file.size} bytes.`, 10, 10, 80, 80);
    * }
-   * </code>
-   * </div>
    */
 
   /**
@@ -352,8 +325,6 @@ function file(p5, fn){
    * @for p5.File
    *
    * @example
-   * <div>
-   * <code>
    * // Use the file input to load a file and display its info.
    *
    * function setup() {
@@ -376,8 +347,6 @@ function file(p5, fn){
    *   // Display the p5.File's data, which looks like a random string of characters.
    *   text(file.data, 10, 10, 80, 80);
    * }
-   * </code>
-   * </div>
    */
 }
 

package/dist/dom/p5.MediaElement.js

@@ -1,10 +1,10 @@
 import { Element } from './p5.Element.js';
 import './p5.File.js';
 import '../io/p5.XML.js';
-import '../creating_reading-CgHCHxqN.js';
+import '../creating_reading-ZXzcZEsb.js';
 import 'colorjs.io/fn';
 import '../color/color_spaces/hsb.js';
-import '../constants-DEJVKr9Z.js';
+import '../constants-DQyACdzq.js';
 
 /**
  * @module DOM
@@ -91,8 +91,6 @@ class MediaElement extends Element {
    * @chainable
    *
    * @example
-   * <div>
-   * <code>
    * let beat;
    *
    * function setup() {
@@ -117,8 +115,6 @@ class MediaElement extends Element {
    * function mousePressed() {
    *   beat.play();
    * }
-   * </code>
-   * </div>
    */
   play() {
     if (this.elt.currentTime === this.elt.duration) {
@@ -158,8 +154,6 @@ class MediaElement extends Element {
    * @chainable
    *
    * @example
-   * <div>
-   * <code>
    * let beat;
    * let isStopped = true;
    *
@@ -199,8 +193,6 @@ class MediaElement extends Element {
    *     isStopped = true;
    *   }
    * }
-   * </code>
-   * </div>
    */
   stop() {
     this.elt.pause();
@@ -216,8 +208,6 @@ class MediaElement extends Element {
    * @chainable
    *
    * @example
-   * <div>
-   * <code>
    * let beat;
    * let isPaused = true;
    *
@@ -259,8 +249,6 @@ class MediaElement extends Element {
    *     isPaused = true;
    *   }
    * }
-   * </code>
-   * </div>
    */
   pause() {
     this.elt.pause();
@@ -273,8 +261,6 @@ class MediaElement extends Element {
    * @chainable
    *
    * @example
-   * <div>
-   * <code>
    * let beat;
    * let isLooping = false;
    *
@@ -316,8 +302,6 @@ class MediaElement extends Element {
    *     isLooping = true;
    *   }
    * }
-   * </code>
-   * </div>
    */
   loop() {
     this.elt.setAttribute('loop', true);
@@ -332,8 +316,6 @@ class MediaElement extends Element {
    * @chainable
    *
    * @example
-   * <div>
-   * <code>
    * let beat;
    * let isPlaying = false;
    *
@@ -375,8 +357,6 @@ class MediaElement extends Element {
    *     isPlaying = true;
    *   }
    * }
-   * </code>
-   * </div>
    */
   noLoop() {
     this.elt.removeAttribute('loop');
@@ -415,8 +395,6 @@ class MediaElement extends Element {
    * @chainable
    *
    * @example
-   * <div class='notest'>
-   * <code>
    * let video;
    *
    * function setup() {
@@ -433,11 +411,8 @@ class MediaElement extends Element {
    *   video.size(100, 100);
    *   video.autoplay();
    * }
-   * </code>
-   * </div>
    *
-   * <div class='notest'>
-   * <code>
+   * @example
    * function setup() {
    *   noCanvas();
    *
@@ -449,8 +424,6 @@ class MediaElement extends Element {
    *
    *   describe('An image of fingers on a treadmill. They start walking when the user double-clicks on them.');
    * }
-   * </code>
-   * </div>
    *
    * // Set the video's size and playback mode.
    * function handleVideo() {
@@ -499,8 +472,6 @@ class MediaElement extends Element {
    * @return {Number} current volume.
    *
    * @example
-   * <div>
-   * <code>
    * let dragon;
    *
    * function setup() {
@@ -537,8 +508,6 @@ class MediaElement extends Element {
    *   // Display the volume.
    *   text(`Volume: ${v}`, 50, 50);
    * }
-   * </code>
-   * </div>
    */
   /**
    * @param {Number}            val volume between 0.0 and 1.0.
@@ -568,8 +537,6 @@ class MediaElement extends Element {
    * @return {Number} current playback speed.
    *
    * @example
-   * <div>
-   * <code>
    * let dragon;
    *
    * function setup() {
@@ -606,7 +573,6 @@ class MediaElement extends Element {
    *   // Display the speed.
    *   text(`Speed: ${s}`, 50, 50);
    * }
-   * </code>
    */
   /**
    * @param {Number} speed  speed multiplier for playback.
@@ -639,8 +605,6 @@ class MediaElement extends Element {
    * @return {Number} current time (in seconds).
    *
    * @example
-   * <div>
-   * <code>
    * let dragon;
    *
    * function setup() {
@@ -671,11 +635,8 @@ class MediaElement extends Element {
    *   // Display the playback time.
    *   text(`${s} seconds`, 50, 50);
    * }
-   * </code>
-   * </div>
    *
-   * <div>
-   * <code>
+   * @example
    * let dragon;
    *
    * function setup() {
@@ -709,8 +670,6 @@ class MediaElement extends Element {
    *   // Display the playback time.
    *   text(`${s} seconds`, 50, 50);
    * }
-   * </code>
-   * </div>
    */
   time(val) {
     if (typeof val !== 'undefined') {
@@ -725,8 +684,6 @@ class MediaElement extends Element {
    * @return {Number} duration (in seconds).
    *
    * @example
-   * <div>
-   * <code>
    * let dragon;
    *
    * function setup() {
@@ -759,8 +716,6 @@ class MediaElement extends Element {
    *   // Display the time remaining.
    *   text(`${s} seconds left`, 50, 50);
    * }
-   * </code>
-   * </div>
    */
   duration() {
     return this.elt.duration;
@@ -885,8 +840,6 @@ class MediaElement extends Element {
    * @chainable
    *
    * @example
-   * <div>
-   * <code>
    * let beat;
    * let isPlaying = false;
    * let isDone = false;
@@ -932,8 +885,6 @@ class MediaElement extends Element {
    * function handleEnd() {
    *   isDone = false;
    * }
-   * </code>
-   * </div>
    */
   onended(callback) {
     this._onended = callback;
@@ -1026,8 +977,6 @@ class MediaElement extends Element {
    * Note: The controls vary between web browsers.
    *
    * @example
-   * <div>
-   * <code>
    * function setup() {
    *   createCanvas(100, 100);
    *
@@ -1048,8 +997,6 @@ class MediaElement extends Element {
    *
    *   describe('A dragon emoji, 🐉, drawn in the center of a blue square. A song plays in the background. Audio controls are displayed beneath the canvas.');
    * }
-   * </code>
-   * </div>
    */
   showControls() {
     // must set style for the element to show on the page
@@ -1063,8 +1010,6 @@ class MediaElement extends Element {
    * controls.
    *
    * @example
-   * <div>
-   * <code>
    * let dragon;
    * let isHidden = false;
    *
@@ -1104,8 +1049,6 @@ class MediaElement extends Element {
    *     isHidden = true;
    *   }
    * }
-   * </code>
-   * </div>
    */
   hideControls() {
     this.elt.controls = false;
@@ -1135,8 +1078,6 @@ class MediaElement extends Element {
    *                     useful for `media.removeCue(id)`.
    *
    * @example
-   * <div>
-   * <code>
    * function setup() {
    *   createCanvas(100, 100);
    *
@@ -1159,8 +1100,6 @@ class MediaElement extends Element {
    * function changeBackground(c) {
    *   background(c);
    * }
-   * </code>
-   * </div>
    */
   addCue(time, callback, val) {
     const id = this._cueIDCounter++;
@@ -1181,8 +1120,6 @@ class MediaElement extends Element {
    * @param  {Number} id ID of the cue, created by `media.addCue()`.
    *
    * @example
-   * <div>
-   * <code>
    * let lavenderID;
    * let isRemoved = false;
    *
@@ -1229,8 +1166,6 @@ class MediaElement extends Element {
    *     isRemoved = true;
    *   }
    * }
-   * </code>
-   * </div>
    */
   removeCue(id) {
     for (let i = 0; i < this._cues.length; i++) {
@@ -1249,8 +1184,6 @@ class MediaElement extends Element {
    * Removes all functions scheduled with `media.addCue()`.
    *
    * @example
-   * <div>
-   * <code>
    * let isChanging = true;
    *
    * function setup() {
@@ -1297,8 +1230,6 @@ class MediaElement extends Element {
    *     isChanging = false;
    *   }
    * }
-   * </code>
-   * </div>
    */
   clearCues() {
     this._cues = [];
@@ -1415,8 +1346,6 @@ function media(p5, fn){
    * @return {p5.MediaElement}   new <a href="#/p5.MediaElement">p5.MediaElement</a> object.
    *
    * @example
-   * <div class='notest'>
-   * <code>
    * function setup() {
    *   noCanvas();
    *
@@ -1429,11 +1358,8 @@ function media(p5, fn){
    *
    *   describe('A video of a toy robot with playback controls beneath it.');
    * }
-   * </code>
-   * </div>
    *
-   * <div class='notest'>
-   * <code>
+   * @example
    * function setup() {
    *   noCanvas();
    *
@@ -1448,11 +1374,8 @@ function media(p5, fn){
    *
    *   describe('A video of a toy robot with playback controls beneath it.');
    * }
-   * </code>
-   * </div>
    *
-   * <div class='notest'>
-   * <code>
+   * @example
    * let video;
    *
    * function setup() {
@@ -1476,8 +1399,6 @@ function media(p5, fn){
    * function muteVideo() {
    *   video.volume(0);
    * }
-   * </code>
-   * </div>
    */
   fn.createVideo = function (src, callback) {
     // p5._validateParameters('createVideo', arguments);
@@ -1511,8 +1432,6 @@ function media(p5, fn){
    * @return {p5.MediaElement}       new <a href="#/p5.MediaElement">p5.MediaElement</a> object.
    *
    * @example
-   * <div class='notest'>
-   * <code>
    * function setup() {
    *   noCanvas();
    *
@@ -1524,8 +1443,6 @@ function media(p5, fn){
    *
    *   describe('An audio beat plays when the user double-clicks the square.');
    * }
-   * </code>
-   * </div>
    */
   fn.createAudio = function (src, callback) {
     // p5._validateParameters('createAudio', arguments);
@@ -1609,8 +1526,6 @@ function media(p5, fn){
    * @return {p5.MediaElement} new <a href="#/p5.MediaElement">p5.MediaElement</a> object.
    *
    * @example
-   * <div class='notest'>
-   * <code>
    * function setup() {
    *   noCanvas();
    *
@@ -1619,11 +1534,8 @@ function media(p5, fn){
    *
    *   describe('A video stream from the webcam.');
    * }
-   * </code>
-   * </div>
    *
-   * <div class='notest'>
-   * <code>
+   * @example
    * let capture;
    *
    * function setup() {
@@ -1643,10 +1555,8 @@ function media(p5, fn){
    *   // Invert the colors in the stream.
    *   filter(INVERT);
    * }
-   * </code>
-   * </div>
-   * <div class='notest'>
-   * <code>
+   *
+   * @example
    * let capture;
    *
    * function setup() {
@@ -1659,11 +1569,8 @@ function media(p5, fn){
    *   describe('A video stream from the webcam with flipped or mirrored output.');
    * }
    *
-   * </code>
-   * </div>
    *
-   * <div class='notest norender'>
-   * <code>
+   * @example
    * function setup() {
    *   createCanvas(480, 120);
    *
@@ -1684,8 +1591,6 @@ function media(p5, fn){
    *
    *   describe('A video stream from the webcam.');
    * }
-   * </code>
-   * </div>
    */
   fn.createCapture = function (...args) {
     // p5._validateParameters('createCapture', args);
@@ -1782,8 +1687,6 @@ function media(p5, fn){
    * @extends p5.Element
    *
    * @example
-   * <div class='notest'>
-   * <code>
    * let capture;
    *
    * function setup() {
@@ -1801,8 +1704,6 @@ function media(p5, fn){
    *   image(capture, 0, 0, width, width * capture.height / capture.width);
    *   filter(INVERT);
    * }
-   * </code>
-   * </div>
    */
   p5.MediaElement = MediaElement;
 
@@ -1826,8 +1727,6 @@ function media(p5, fn){
    * @property src
    * @return {String} src
    * @example
-   * <div>
-   * <code>
    * let beat;
    *
    * function setup() {
@@ -1845,8 +1744,6 @@ function media(p5, fn){
    *   textWrap(CHAR);
    *   text(beat.src, 10, 10, 80, 80);
    * }
-   * </code>
-   * </div>
    */
 }