q5 4.3.0 → 4.4.1

package/deno.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "q5",
-	"version": "4.3.0",
+	"version": "4.4.1",
 	"description": "Beginner friendly graphics powered by WebGPU, optimized for interactive art!",
 	"author": "quinton-ashley",
 	"contributors": [

package/q5.d.ts

@@ -133,6 +133,8 @@ declare global {
 
 	/** 🧑‍🎨
 	 * Draws a line on the canvas.
+	 *
+	 * To draw lines with rounded stroke caps, use `capsule` instead.
 	 * @param {number} x1 x-coordinate of the first point
 	 * @param {number} y1 y-coordinate of the first point
 	 * @param {number} x2 x-coordinate of the second point
@@ -3820,33 +3822,51 @@ declare global {
 	function curveDetail(val: number): void;
 
 	/** 🖌
-	 * Starts storing vertices for a convex shape.
+	 * Starts storing vertices for a shape.
 	 */
 	function beginShape(): void;
 
 	/** 🖌
-	 * Ends storing vertices for a convex shape.
+	 * Ends storing vertices for a shape.
+	 * @param {boolean} [close] whether to close the shape by connecting the last vertex to the first vertex, default is false
 	 */
 	function endShape(): void;
 
-	/** 🖌
-	 * Starts storing vertices for a contour.
-	 * 
-	 * Not available in q5 WebGPU.
-	 */
-	function beginContour(): void;
-
-	/** 🖌
-	 * Ends storing vertices for a contour.
-	 * 
-	 * Not available in q5 WebGPU.
-	 */
-	function endContour(): void;
-
 	/** 🖌
 	 * Specifies a vertex in a shape.
+	 *
+	 * Each vertex can have its own fill color. Useful for creating gradients.
+	 * 
+	 * Note that shapes without a stroke will be drawn using the shapes shader. Stroked shapes will be drawn using the more complex stroked shapes shader.
 	 * @param {number} x x-coordinate
 	 * @param {number} y y-coordinate
+	 * @example
+	 * await Canvas(200);
+	 * 
+	 * noStroke();
+	 * 
+	 * beginShape();
+	 * fill(1, 0, 0);
+	 * vertex(-80, -80);
+	 * vertex(40, -60);
+	 * fill(0, 0, 1);
+	 * vertex(80, 60);
+	 * vertex(-60, 80);
+	 * endShape(true);
+	 * @example
+	 * await Canvas(200);
+	 * 
+	 * stroke(1, 0.5);
+	 * strokeWeight(20);
+	 * 
+	 * beginShape();
+	 * fill(1, 0, 0);
+	 * vertex(-80, -80);
+	 * vertex(40, -60);
+	 * fill(0, 0, 1);
+	 * vertex(80, 60);
+	 * vertex(-60, 80);
+	 * endShape(true);
 	 */
 	function vertex(x: number, y: number): void;
 
@@ -3907,6 +3927,20 @@ declare global {
 	 */
 	function quad(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number): void;
 
+	/** 🖌
+	 * Starts storing vertices for a contour.
+	 * 
+	 * Not available in q5 WebGPU.
+	 */
+	function beginContour(): void;
+
+	/** 🖌
+	 * Ends storing vertices for a contour.
+	 * 
+	 * Not available in q5 WebGPU.
+	 */
+	function endContour(): void;
+
 	// ⚡ shaders
 
 	/**
@@ -3917,11 +3951,7 @@ declare global {
 	/** ⚡
 	 * Creates a shader that q5's WebGPU renderer can use.
 	 * 
-	 * If `type` is not specified, this function customizes a copy of the [default shapes shader](https://github.com/q5js/q5.js/blob/main/src/shaders/shapes.wgsl), which affects the following functions:
-	 * 
-	 * `triangle`, `quad`, `plane`,
-	 * `curve`, `bezier`, `beginShape`/`endShape`,
-	 * and `background` (unless an image is used).
+	 * If `type` is not specified, this function customizes a copy of the [default shapes shader](https://github.com/q5js/q5.js/blob/main/src/shaders/shapes.wgsl), which affects these functions: `plane`, `line`, and `endShape` (only for shapes drawn without a stroke).
 	 * 
 	 * For more information on the vertex and fragment function
 	 * input parameters, data, and helper functions made available for use