q5 1.9.2 → 1.9.3

package/README.md

@@ -1,18 +1,16 @@
 # <img src="q5js_logo.png" height="64"> <img src="q5js_brand.png" height="64">
 
-q5.js is a drop-in replacement for [p5.js][]. It supports all of p5's 2D drawing APIs, math functionality, and some other utilities.
+**q5.js** implements all of [p5][]'s 2D drawing, math, and user input functionality.
 
-q5.min.js (42kb) is 23x smaller than p5.min.js (977kb)! It also has better performance, which is especially important on mobile devices.
+It's a drop-in replacement that's performance optimized and 23x smaller than p5. q5 even has a few exclusive features: top-level global mode, HDR color support, namespace mode, and text image caching.
 
-q5 doesn't include any friendly error messages to help you code though. Its mainly for people who are already familiar with p5.js or JS programming in general. If you're a beginner, stick with p5 while developing a sketch, then use q5 to share your work.
+But q5 doesn't include any friendly error messages, so its mainly for people who are already familiar with p5.js or JS programming in general. If you're a beginner, stick with p5 while developing a sketch, then use q5 to share your work.
 
 ## Usage
 
-q5 should work with your existing p5.js sketches, no modifications required! If you have any problems though, please [make an issue report.][]
+q5 should work with your existing p5.js sketches, no modifications required! If you have any problems though, please [make an issue report][].
 
-Try out the [q5.js template sketch](https://editor.p5js.org/quinton-ashley/sketches/8SEtLEDl9) for the online p5.js Web Editor.
-
-Or you can use q5.js in your own project by adding this line to your HTML file:
+Use q5.js in your own project by adding this line to your HTML file:
 
 ```html
 <script src="https://quinton-ashley.github.io/q5.js/q5.js"></script>
@@ -24,6 +22,8 @@ q5 is also available on [npm](https://www.npmjs.com/package/q5)!
 npm install q5
 ```
 
+Or try out the [q5.js template sketch](https://editor.p5js.org/quinton-ashley/sketches/8SEtLEDl9) for the online p5.js Web Editor.
+
 ## Support this project 🤝
 
 q5 is open source and [multi-licensed](https://github.com/quinton-ashley/p5play-web/blob/main/LICENSING.md). Anyone can use q5 for free under the terms of the AGPLv3. 🎉
@@ -34,7 +34,7 @@ If you can't afford to pay, you can apply for the free [p5play Novice License](h
 
 ## Using p5 Addon Libraries
 
-q5.js is compatible with popular p5 addons and projects that use p5, such as p5play, because it aliases `Q5` to `p5`.
+q5.js is compatible with popular p5 addons and projects that use p5, such as [p5play][], because it aliases `Q5` to `p5`.
 
 To use addons, simply load them after q5.js:
 
@@ -47,11 +47,11 @@ To use addons, simply load them after q5.js:
 
 ## New Features: Top-Level Global Mode
 
-There are some extra features in q5 that aren't in p5, but using them is totally optional.
+> q5.js includes some exclusive features that aren't available in p5.js. Using them is optional!
 
-**q5.js** has an automatic global mode, which is enabled by default. This means existing p5.js sketches can be run without any modification.
+In **p5**, p5 functions can't be used on the file level. Also you must declare a `setup` or `draw` function on the file level for p5 to start running in global mode.
 
-But with q5, you could do away with the preload and setup functions all together. Just write the initialization routine `new Q5()` or `new Q5('global')` at the top of your sketch.
+**q5** can automatically run in global mode as well, so existing sketches don't require any modification. But if you initialize Q5 at the top of your sketch, the `preload` and `setup` functions become optional.
 
 ```js
 new Q5();
@@ -62,82 +62,86 @@ fill(c);
 rect(15, 15, 35, 70);
 ```
 
-You could even use your own animation loop in place of `draw()`. But this would cause problems with addons that rely on `draw()`, such as p5play.
-
-```js
-new Q5();
-
-fill(255, 0, 0);
+This is great because you don't have to declare variables on the file level and then define them in `preload` or `setup`. You can declare and define them at the same time!
 
-function myLoop() {
-	requestAnimationFrame(myLoop);
-	rect(15, 15, 35, 70);
-}
-myLoop();
-```
+## New Features: HDR Color Support
 
-## New Features: Namespace Mode
+Most modern devices support the "display-p3" HDR color space. If a device doesn't support it, q5 will fall back to "srgb".
 
-In **p5.js**, all p5 functions are in the global namespace, unless you use "instance" mode, like this:
+**q5** now supports the [oklch](https://oklch.com/#63.65,0.2872,16.57,100) color format which is capable of representing HDR colors.
 
 ```js
-let sketch = function (p) {
-	p.setup = function () {
-		p.createCanvas(100, 100);
-	};
-	p.draw = function () {
-		p.background(0);
-	};
-};
+colorMode('oklch');
 
-let myp5 = new p5(sketch);
+//       (lightness, chroma, hue, alpha)
+let c = color(0.637, 0.287, 16.57, 1);
 ```
 
-This does solve the problem of global namespace pollution, but there're still some inconveniences:
+Support for the HSV color format was removed in q5 v1.9.3 because color experts thought HSV was flawed, outdated, and ought to be abandoned way back in 1997!
 
-- The extra wrapping of the `sketch` function makes code look complex. (Flat is better than nested!)
-- Variables inside `sketch` can no longer be accessed via browser console, which makes it less convenient for debugging.
+The `color` function does accept strings but only hex strings in "#RRGGBB" or "#RRGGBBAA" format. It also does not accept percentages so you'll have to convert those to decimal values.
 
-**q5** introduces "namespace" mode, in addition to global/instance modes:
+`colorMode` accepts 'rgb', 'oklch', or 'srgb'. The default mode is 'rgb', which upgrades rgb colors to HDR on supported displays. Specifying 'srgb' enables sRGB gamut correction for rgb colors on HDR displays.
 
-```js
-let q5 = new Q5('namespace');
+## New Features: Customize Canvas Context Attributes
 
-q5.setup = function () {
-	q5.createCanvas(100, 100);
-};
+In **p5**, you're stuck with the default [canvas context attributes][], which can't be changed. So the canvas must have an alpha layer, even if you don't need one. p5 also doesn't support HDR color spaces or desynchronized rendering.
 
-q5.draw = function () {
-	q5.background(0);
+But **q5** has its own defaults:
+
+```js
+Q5.canvasOptions = {
+	alpha: false,
+	desynchronized: true,
+	colorSpace: 'display-p3'
 };
 ```
 
-You can call the namespace whatever you like. You can even get multiple instances of q5 running on the same page easily.
+The `Q5.canvasOptions` object can be overridden, which will effect all q5 instances.You can also override any of these defaults by passing an options object as the fourth parameter to the `createCanvas()` function:
 
 ```js
-let q5 = new Q5('namespace');
-let q6 = new Q5('namespace');
+createCanvas(400, 400, '2d', {
+	alpha: true
+});
+```
 
-q5.setup = function () {
-	q5.createCanvas(400, 400);
-};
+## New Features: Namespace Mode
 
-q5.draw = function () {
-	q5.background(100);
-};
+**p5**'s [instance mode][] enables multiple sketches to run on one page. To avoid needing to preface every p5 function with `p.` you can use a JS [with statement][].
 
-q6.setup = function () {
-	q6.createCanvas(400, 400);
+```js
+let sketch = (p) => {
+	with (p) {
+		p.setup = () => {
+			createCanvas(400, 400);
+		};
+		p.draw = () => {
+			background(100);
+		};
+	}
 };
 
-q6.draw = function () {
-	q6.background(200);
-};
+let myp5 = new p5(sketch);
+```
+
+**q5** introduces "namespace" mode, in addition to the global and instance modes. You can call the namespace variable whatever you like.
+
+```js
+let q = new Q5('namespace');
+
+with (q) {
+	q.setup = () => {
+		createCanvas(400, 400);
+	};
+	q.draw = () => {
+		background(100);
+	};
+}
 ```
 
 ## Motivation: Part 1
 
-_This section was written by @LingDong-, co-creator of q5_
+> This section was written by @LingDong-, co-creator of q5.
 
 After having used many graphics libraries across many different languages, I have found that the Processing/p5.js/Openframeworks system has one huge advantage over others:
 
@@ -153,55 +157,66 @@ In fact, its not uncommon for successful software systems to have multiple imple
 
 ## Motivation: Part 2
 
-_This section was written by @quinton-ashley, co-creator of q5_
+> This section was written by @quinton-ashley, co-creator of q5.
 
 I thought @LingDong-'s work on q5 and the idea itself had great potential. So I decided to upgrade its compatibility with p5.js. My main goal was to make it work with [p5play](https://p5play.org)!
 
 An increase in performance of even a few frames per second can make a significant difference in the user experience of a work of interactive art or a game, especially on mobile devices.
 
-I was also interested in working on q5 because for a lot of p5.js users, the library itself is a black box. Even as an expert JS programmer and someone who teaches CS for a living, I still find myself scratching my head when I look at the p5.js source code. p5 was initially released 10 years ago and I think some bad design choices were made due to JS limitations at the time. It's also become an absolutely massive library, with literally over 100,000 lines of code and documentation! p5.js is 4.3 MB un-minified, q5.js is just 70kb.
+I was also interested in working on q5 because for a lot of p5.js users, the library itself is a black box. Even as an expert JS programmer and someone who teaches CS for a living, I still find myself scratching my head when I look at the p5.js source code. p5 was initially released 10 years ago and I think some bad design choices were made due to JS limitations at the time. It's also become an absolutely massive library, with literally over 100,000 lines of code and documentation! p5.js is 4.3 MB un-minified, q5.js is under 70kb.
 
 I think it'd be better if the canvas mode, webgl mode, Friendly Error System, and accessibility features of p5 were offered in separate files. Yet, the powers that be at the Processing Foundation have made it clear that they don't want to do that. Instead they insist on adding more accessibility features to the base library, which the majority of people just don't need. So q5 is a good alternative that trims out the fat.
 
 Thanks in large part to @LingDong-'s design, q5 is well organized, concise, and utilizes many modern JS features! I think even without documentation, the source code is easier for experienced JS programmers to comprehend.
 
-## More extra features
+## More exclusive features
 
 q5.js provides some other features that are not in p5.js:
 
 - `textCache(true)`: Text image caching is enabled by default. Rotated text is only rendered once, and then cached as an image. This can result in ridiculously high 90x performance boosts for text-heavy sketches. Users don't need to change their code, the `text` function can be used as normal, q5 takes care of everything behind the scenes.
 - `loadSound()`: Basic sound support in q5.js, returns a Web Audio object. Not as powerful as p5.sound, but it's good enough for simple sketches. Includes `sound.setVolume()`.
+- `ctx`: an alias for `drawingContext`
 - `randomExponential()` in addition to `randomGaussian()`: a random distribution that resembles exponential decay.
 - `curveAlpha()`: manipulate the `α` parameter of Catmull-Rom curves.
 - `relRotationX`, `relRotationY` and `relRotationZ`: Similar to `rotationX/Y/Z`, but are relative to the orientation of the mobile device.
 
 ## Cutting room floor
 
-**p5.js** has some pretty extensive parsing capabilities. For example, it can parse out a color from strings like `color('hsl(160, 100%, 50%)')` or `color("lightblue")`. Functions behave sightly differently when under different "modes" (e.g. `hue`), and some have secret default settings (e.g. `arc` and `text`).
+**p5.js** has some pretty extensive parsing capabilities. For example, it can parse out a color from strings like `color('hsl(160, 100%, 50%)')`. Functions behave sightly differently when under different "modes" and some have secret default settings, such as `arc` and `text`.
 
-**q5.js** will only do things when you communicate the command in the simplest way. This means that functions mainly just take numeric inputs. Any behavior needs to be explicitly triggered. q5 has almost no overhead between digesting your parameters and putting them into use.
+**q5.js** will only do things when you communicate the command in the simplest way. This means that functions mainly just take numeric inputs. q5 has almost no overhead between digesting your parameters and putting them into use.
 
-## Known Issues
+## Size Comparison
 
-- `curveTightness()` sets the 'alpha' parameter of Catmull-Rom curve, and is NOT identical to p5.js counterpart. As this might change in the future, please call `curveAlpha()` directly.
+Unminified:
 
-## Size Comparison
+- p5.js **4300kb** ⚠️
+- p5.sound.js 488kb
+- q5.js 66kb
 
-- p5.min.js 977kb
+Minified:
+
+- p5.min.js 1000kb
 - p5.sound.min.js 200kb
+- q5.min.js **42kb** 🎉
 
-- q5.min.js 42kb
+## Benchmarks
 
-- planck.min.js 209kb
-- p5play.min.js 93kb
+q5.js has a significant speed advantage in imaging operations because it uses hardware accelerated Canvas APIs whenever possible, instead of going pixel by pixel. Most other functionalities have very marginal speed improvements (or none at all when parameter validation overhead is negligible). The operations with important performance differences are listed below.
 
-## Benchmarks
+The following benchmarks are generated with Google Chrome 120, on a MacBook Air M1 2020. q5.js v1.9.3 vs p5.js v1.9.0.
 
-q5.js has significant speed advantage in imaging operations because it uses hardware accelerated Canvas APIs directly whenever possible, instead of going over pixel by pixel. Most other functionalities have very marginal speed improvements (or none at all when parameter validation overhead is negligible). The operations with important performance differences are listed below.
+Less time (milliseconds) is better.
 
-The following benchmarks are generated with Google Chrome 84, on an old-ish MacBook Pro 2015 (with lots of apps and tabs running); Performance varies depending on software and hardware.
+| Task                                               | p5.js | q5.js |
+| -------------------------------------------------- | ----- | ----- |
+| Generate 100,000 random colors with `color(r,g,b)` | 168ms | 12ms  |
 
-p5.js version used is **1.1.9**.
+## Older Benchmarks
+
+The following benchmarks are generated with Google Chrome 84, on an old-ish MacBook Pro 2015 (with lots of apps and tabs running); Performance varies depending on software and hardware. p5.js version used is v1.1.9.
+
+Higher FPS (frames per second) is better.
 
 | Operation on 1024x1024 image | p5.js | q5.js    |
 | ---------------------------- | ----- | -------- |
@@ -213,7 +228,7 @@ p5.js version used is **1.1.9**.
 | opaque                       | 20FPS | 60FPS    |
 | erode/dilate                 | 5FPS  | 9FPS     |
 
-| Misc                                                | p5.js | q5.js |
+| Task                                                | p5.js | q5.js |
 | --------------------------------------------------- | ----- | ----- |
 | Generating 10,000 `randomGaussian()` sample         | 10FPS | 20FPS |
 | Calling `noiseSeed()` 1,000 times                   | 10FPS | 60FPS |
@@ -222,7 +237,27 @@ p5.js version used is **1.1.9**.
 
 <sub>\* Only for browsers that support CanvasRenderingContext2D.filter ([75% of all](https://caniuse.com/#feat=mdn-api_canvasrenderingcontext2d_filter) as of Aug 2020, including Chrome, Firefox and Edge). For those that don't, performance is similar to p5.js, as identical implementations are usually used as fallbacks.</sub>
 
+## Contributing
+
 Speed is a goal for q5.js, and we would very much like to see the above list grow. If you know how to make something faster, advice/pull requests are very welcome!
 
-[p5.js]: https://p5js.org
-[make an issue report.]: https://github.com/quinton-ashley/q5.js/issues
+## Credits
+
+catmullRomSpline:
+https://en.wikipedia.org/wiki/Centripetal_Catmull%E2%80%93Rom_spline
+
+ziggurat:
+http://ziggurat.glitch.me/
+
+random:
+https://github.com/processing/p5.js/blob/1.1.9/src/math/noise.js
+
+Curve query:
+https://github.com/processing/p5.js/blob/1.1.9/src/core/shape/curves.js
+
+[p5]: https://p5js.org
+[p5play]: https://p5play.org
+[instance mode]: https://p5js.org/examples/instance-mode-instantiation.html
+[with statement]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/with
+[make an issue report]: https://github.com/quinton-ashley/q5.js/issues
+[context attributes]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/getContext#contextattributes

package/package.json

@@ -1,7 +1,7 @@
 {
 	"author": "quinton-ashley",
 	"name": "q5",
-	"version": "1.9.2",
+	"version": "1.9.3",
 	"description": "An implementation of the p5.js 2D API that's smaller and faster",
 	"main": "q5.js",
 	"scripts": {