q5 2.27.8 → 2.28.0

package/deno.json

@@ -1,6 +1,6 @@
 {
 	"name": "@q5/q5",
-	"version": "2.27.6",
+	"version": "2.28.0",
 	"license": "LGPL-3.0",
 	"description": "Beginner friendly graphics powered by WebGPU and optimized for interactive art!",
 	"author": "quinton-ashley",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "q5",
-	"version": "2.27.8",
+	"version": "2.28.0",
 	"description": "Beginner friendly graphics powered by WebGPU and optimized for interactive art!",
 	"author": "quinton-ashley",
 	"contributors": [
@@ -12,7 +12,7 @@
 	"main": "q5-server.js",
 	"types": "q5.d.ts",
 	"scripts": {
-		"bundle": "cat src/q5-core.js src/q5-canvas.js src/q5-c2d-canvas.js src/q5-c2d-shapes.js src/q5-c2d-image.js src/q5-c2d-soft-filters.js src/q5-c2d-text.js src/q5-color.js src/q5-display.js src/q5-dom.js src/q5-fes.js src/q5-input.js src/q5-math.js src/q5-record.js src/q5-sound.js src/q5-util.js src/q5-vector.js src/q5-webgpu-canvas.js src/q5-webgpu-shapes.js src/q5-webgpu-image.js src/q5-webgpu-text.js src/q5-webgpu-shaders.js > q5.js",
+		"bundle": "cat src/q5-core.js src/q5-canvas.js src/q5-c2d-canvas.js src/q5-c2d-shapes.js src/q5-c2d-image.js src/q5-c2d-soft-filters.js src/q5-c2d-text.js src/q5-color.js src/q5-display.js src/q5-dom.js src/q5-fes.js src/q5-input.js src/q5-math.js src/q5-record.js src/q5-sound.js src/q5-util.js src/q5-vector.js src/q5-webgpu.js > q5.js",
 		"min": "terser q5.js --compress ecma=2025 --mangle > q5.min.js",
 		"dist": "bun bundle && bun min",
 		"dist-p5play": "bun dist && cp q5.js ../../web/p5play-web/v3/q5.js && cp q5.min.js ../../web/p5play-web/v3/q5.min.js",

package/q5.d.ts

@@ -368,6 +368,29 @@ q.draw = () => {
 		 */
 		static WebGPU(): Q5;
 
+		/** ⭐️
+		 * ___Experimental! Might be changed.___
+		 * 
+		 * Registers an addon with q5.js.
+		 * 
+		 * Addons can augment q5 with new functionality and register
+		 * functions to be executed at specific points in the q5 lifecycle:
+		 * init, presetup, postsetup, predraw, postdraw, and remove.
+		 * 
+		 * @param {Function} addon A function that receives `Q5`, `Q5.prototype`, and a `lifecycles` object.
+		 * @example
+// addon.js
+Q5.registerAddon((Q5, proto, lifecycles) => {
+  lifecycles.postsetup = function () {
+		this.background('blue');
+	};
+});
+
+// sketch.js
+createCanvas(200);
+		 */
+		static registerAddon(addon: Function): void; //-
+
 		/** ⭐️
 		 * The draw function is run 60 times per second by default.
 		 */
@@ -2184,7 +2207,7 @@ text('Hello, world!', 100, 100);
 	 */
 	function textAlign(horiz: 'left' | 'center' | 'right', vert?: 'top' | 'middle' | 'bottom' | 'alphabetic'): void;
 
-	/**
+	/** ✍️
 	 * Sets the text weight.
 	 * 
 	 * - 100: thin
@@ -2741,9 +2764,7 @@ function draw() {
 	 */
 	function random(low?: number | any[], high?: number): number | any;
 
-	/**
-	 * ___Experimental! May be renamed or removed in the future.___
-	 * 
+	/** 🧮
 	 * Generates a random number within a symmetric range around zero.
 	 * 
 	 * Can be used to create a jitter effect (random displacement).
@@ -3129,7 +3150,7 @@ function mousePressed() {
 	 */
 	function loadSound(url: string): Sound | Promise<Sound>;
 
-	/**
+	/** 🔊
 	 * Loads audio data from a file and returns an [HTMLAudioElement](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement).
 	 * 
 	 * Audio is considered loaded when the [canplaythrough event](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event) is fired.
@@ -4070,8 +4091,7 @@ plane(0, 0, 100);
 	function shader(shaderModule: GPUShaderModule): void;
 
 	/** ⚡️
-	 * Makes q5 use a default shader.
-	 * @param {string} [type] can be "shapes" (default), "image", "video", or "text"
+	 * Make q5 use the default shapes shader.
 	 * @example
 let q = await Q5.WebGPU();
 
@@ -4090,10 +4110,30 @@ q.draw = () => {
 	triangle(-50, -50, 0, 50, 50, -50);
 };
 */
-	function resetShader(type?: string): void;
+	function resetShader(): void;
 
 	/** ⚡️
-	 * Makes q5 use default shaders.
+	 * Make q5 use the default frame shader.
+	 */
+	function resetFrameShader(): void;
+
+	/** ⚡️
+	 * Make q5 use the default image shader.
+	 */
+	function resetImageShader(): void;
+
+	/** ⚡️
+	 * Make q5 use the default video shader.
+	 */
+	function resetVideoShader(): void;
+
+	/** ⚡️
+	 * Make q5 use the default text shader.
+	 */
+	function resetTextShader(): void;
+
+	/** ⚡️
+	 * Make q5 use all default shaders.
 	 */
 	function resetShaders(): void;
 
@@ -4174,7 +4214,8 @@ let flipper = createVideoShader(`
 fn vertexMain(v: VertexParams) -> FragParams {
 	var vert = transformVertex(v.pos, v.matrixIndex);
 
-	vert.y *= cos((q.frameCount + f32(v.vertexIndex) * 10) * 0.03);
+	var vi = f32(v.vertexIndex);
+	vert.y *= cos((q.frameCount + vi * 10) * 0.03);
 
 	var f: FragParams;
 	f.position = vert;
@@ -4184,7 +4225,8 @@ fn vertexMain(v: VertexParams) -> FragParams {
 	
 @fragment
 fn fragMain(f: FragParams) -> @location(0) vec4f {
-	var texColor = textureSampleBaseClampToEdge(tex, samp, f.texCoord);
+	var texColor =
+		textureSampleBaseClampToEdge(tex, samp, f.texCoord);
 	texColor.r = 0;
 	texColor.b *= 2;
 	return texColor;
@@ -4196,7 +4238,6 @@ q.draw = () => {
 	shader(flipper);
 	image(vid, -100, 150, 200, 150);
 };
-//
 	 */
 	function createVideoShader(code: string): GPUShaderModule;