shaderpad 1.0.0-beta.80 → 1.0.0-beta.82

package/CHANGELOG.md

@@ -0,0 +1,648 @@
+# shaderpad
+
+## 1.0.0-beta.82
+
+### Patch Changes
+
+- Reduce size
+
+## 1.0.0-beta.81
+
+### Minor Changes
+
+- Improve timing / lifecycle behavior
+
+    Pause `u_time` on `pause()`, so that `step()` and `play()` resume from the same timestamp after a pause.
+
+    Also renamed:
+    - `resetFrame()` => `rewind()`
+    - `beforeDraw` => `preDraw`
+    - `afterDraw` => `postDraw`
+    - `beforeStep` => `preStep`
+    - `afterStep` => `postStep`
+
+## 1.0.0-beta.80
+
+### Minor Changes
+
+- Add configurable `wasmBaseUrl` option for MediaPipe plugins
+
+## 1.0.0-beta.79
+
+### Patch Changes
+
+- Add package READMEs
+
+## 1.0.0-beta.78
+
+### Minor Changes
+
+- Add `<shader-pad>` web component
+
+## 1.0.0-beta.77
+
+### Minor Changes
+
+- Add default export to shaderpad/react
+
+## 1.0.0-beta.76
+
+### Minor Changes
+
+- Add `shaderpad/react` export
+
+## 1.0.0-beta.75
+
+### Minor Changes
+
+- Improve face plugin performance and simplify templates
+
+## 1.0.0-beta.74
+
+### Minor Changes
+
+- API improvements for public release
+
+## 1.0.0-beta.73
+
+### Minor Changes
+
+- Expand `create-shaderpad` starters and support modular GLSL includes
+
+## 1.0.0-beta.72
+
+### Minor Changes
+
+- Simplify history writes and shared MediaPipe plugins
+
+## 1.0.0-beta.71
+
+### Minor Changes
+
+- Publish development build
+
+## 1.0.0-beta.70
+
+### Minor Changes
+
+- Update error shortlinks and enable texture historyWriteIndex
+
+## 1.0.0-beta.69
+
+### Minor Changes
+
+- Improve runtime error handling
+
+## 1.0.0-beta.68
+
+### Minor Changes
+
+- Autosize: replace `ignorePixelRatio` with `scale`
+
+## 1.0.0-beta.67
+
+### Patch Changes
+
+- Fix eyebrow fill region
+
+## 1.0.0-beta.66
+
+### Minor Changes
+
+- Improve eye/mouth geometry
+    - Reduces triangle count in face mesh by filling eyes/mouth
+    - Improves eye and inner-mouth masks by triangulating between contour curves instead of fan-filling across the opening
+
+    In practice, you’ll notice a better inner mouth shape with a
+    closed-mouth smile.
+
+## 1.0.0-beta.65
+
+### Patch Changes
+
+- Fill eyes/mouth in face tessellation
+
+## 1.0.0-beta.64
+
+### Patch Changes
+
+- Refactor face mask rendering to use overlap-safe scratch composition
+
+## 1.0.0-beta.63
+
+### Minor Changes
+
+- Rename "outer mouth" to "mouth"
+
+## 1.0.0-beta.62
+
+### Minor Changes
+
+- Misc fixes and improvements
+
+## 1.0.0-beta.61
+
+### Patch Changes
+
+- Fix UNPACK_ALIGNMENT for non-RGBA formats
+
+## 1.0.0-beta.60
+
+### Patch Changes
+
+- Release v60
+
+## 1.0.0-beta.59
+
+### Minor Changes
+
+- Allow uint uniforms
+
+## 1.0.0-beta.58
+
+### Patch Changes
+
+- Add a synchronous handleResize() during autosize init
+
+## 1.0.0-beta.57
+
+### Minor Changes
+
+- Fix autosize target sizing
+
+## 1.0.0-beta.56
+
+### Patch Changes
+
+- Improve ShaderPad chaining
+
+## 1.0.0-beta.55
+
+### Minor Changes
+
+- Add preventShare option to save plugin
+
+## 1.0.0-beta.54
+
+### Patch Changes
+
+- Fix formatString defaults and improve play/pause ergonomics
+
+## 1.0.0-beta.53
+
+### Minor Changes
+
+- Improve integer format compatibility, perf, add cursorTarget option
+
+## 1.0.0-beta.52
+
+### Minor Changes
+
+- Enable model choice for segmenter plugin
+
+## 1.0.0-beta.51
+
+### Patch Changes
+
+- Bind framebuffer in step
+
+## 1.0.0-beta.50
+
+### Minor Changes
+
+- Improve plugin history consistency and performance
+
+## 1.0.0-beta.49
+
+### Minor Changes
+
+- Remove time as first arg for public step method
+
+    This version also fixes high-precision float formats, and handles a race condition between init and destroy in MediaPipe plugins.
+
+## 1.0.0-beta.48
+
+### Minor Changes
+
+- Improve inX checks and add public clear method
+
+## 1.0.0-beta.47
+
+### Patch Changes
+
+- Add precision qualifiers to mask uniforms
+
+## 1.0.0-beta.46
+
+### Minor Changes
+
+- Enable headless ShaderPads
+
+    This version also migrates some canvas-specific code out of the core package into `plugins/autosize` and `util/createFullscreenCanvas`.
+
+## 1.0.0-beta.45
+
+### Patch Changes
+
+- Improve destroy()
+
+## 1.0.0-beta.44
+
+### Minor Changes
+
+- Swap play() arg order
+
+## 1.0.0-beta.43
+
+### Patch Changes
+
+- Improve mobile save/dismiss behaviour
+
+## 1.0.0-beta.42
+
+### Minor Changes
+
+- Allow ShaderPad texture sources, improve MediaPipe perf, add MediaPipe history
+
+## 1.0.0-beta.41
+
+### Minor Changes
+
+- Overhaul hook system and MediaPipe init order
+
+## 1.0.0-beta.40
+
+### Patch Changes
+
+- Improve save / dismiss behaviour on mobile
+
+## 1.0.0-beta.39
+
+### Patch Changes
+
+- Bugfix: allocate storage for intermediate texture
+
+## 1.0.0-beta.38
+
+### Minor Changes
+
+- Allow high-precision history
+
+    Also:
+    - Allow texture options to be passed during ShaderPad creation
+    - Add onReady callbacks to MediaPipe plugins
+    - Add an afterStep lifecycle method
+    - Add option to skip history writes
+    - Various bugfixes and performance improvements
+
+## 1.0.0-beta.37
+
+### Minor Changes
+
+- Generate face mask with GL TRIANGLEs
+
+## 1.0.0-beta.36
+
+### Minor Changes
+
+- Re-address antialiasing in face plugin
+
+## 1.0.0-beta.35
+
+### Patch Changes
+
+- Fix bug in face plugin
+
+## 1.0.0-beta.34
+
+### Minor Changes
+
+- Limit antialiasing on mask textures
+
+## 1.0.0-beta.33
+
+### Minor Changes
+
+- Expand texture input types and improve MediaPipe plugins
+
+## 1.0.0-beta.32
+
+### Minor Changes
+
+- Add segmenter plugin
+
+## 1.0.0-beta.31
+
+### Minor Changes
+
+- Add onResults callbacks to MediaPipe plugins
+
+## 1.0.0-beta.30
+
+### Minor Changes
+
+- Rewrite plugins to transfer landmark data as textures
+
+    Rewrite MediaPipe plugins (pose, face, hands) to transfer landmark data as textures instead of uniform arrays. Landmarks are now accessed via `texelFetch()` on `u_poseLandmarksTex`, `u_faceLandmarksTex`, and `u_handLandmarksTex` textures. The `poseLandmark()`, `faceLandmark()`, and `handLandmark()` functions now return `vec4` (x, y, z, visibility) instead of `vec2`. Function names updated: `getBody()` → `inBody()`, `getFace()` → `inFace()`, etc.
+
+    As part of this change, typed arrays (e.g., `Float32Array`) are now valid texture sources when provided with width and height.
+
+    Also:
+    - Updated examples for the new API
+    - Added debug option to reduce logging in production
+
+## 1.0.0-beta.29
+
+### Minor Changes
+
+- Expose individual face landmarks in face plugin
+
+## 1.0.0-beta.28
+
+### Minor Changes
+
+- Add share text as optional second argument to save()
+
+## 1.0.0-beta.27
+
+### Minor Changes
+
+- Add u_mouth to face plugin
+
+## 1.0.0-beta.26
+
+### Minor Changes
+
+- Improve MediaPipe media handling
+
+## 1.0.0-beta.25
+
+### Minor Changes
+
+- Improve pose segmentation
+
+## 1.0.0-beta.24
+
+### Patch Changes
+
+- Fix fitCover/fitContain function name swap
+
+## 1.0.0-beta.23
+
+### Patch Changes
+
+- Include u_resolution definition in helpers plugin
+
+## 1.0.0-beta.22
+
+### Minor Changes
+
+- Add fitContain and fitCover helper functions
+
+## 1.0.0-beta.21
+
+### Minor Changes
+
+- Export all plugins as default exports
+
+    Also resolve deprecation warning for non-DOM textures
+
+## 1.0.0-beta.20
+
+### Minor Changes
+
+- Add draw() method
+
+## 1.0.0-beta.19
+
+### Minor Changes
+
+- Add hands and pose plugins
+
+    ### Minor Changes
+    - Add MediaPipe hands plugin
+
+        The `hands` plugin uses [MediaPipe Hand Landmarker](https://ai.google.dev/edge/mediapipe/solutions/vision/hand_landmarker) to detect and track hand landmarks in video or image textures. Each hand contributes 22 landmarks (21 standard landmarks plus hand center).
+
+    - Add MediaPipe pose plugin
+
+        The `pose` plugin uses [MediaPipe Pose Landmarker](https://ai.google.dev/edge/mediapipe/solutions/vision/pose_landmarker) to detect and track body pose landmarks. Each pose contributes 33 landmarks, and the plugin provides both landmark data and a mask texture showing the skeleton and body segmentation.
+
+    - Add documentation site
+
+        Added a new documentation site that showcases ShaderPad with a live shader example. The site is automatically deployed to GitHub Pages via a new GitHub Actions workflow.
+
+    - Add new example shaders
+
+        Added several new example shaders demonstrating the new plugins and various shader techniques:
+        - `hands.ts`: Hand tracking example
+        - `pose.ts`: Pose tracking example
+        - `god-rays.ts`: God rays effect example
+        - `fragmentum.ts`: Complex procedural shader example
+
+    ### Patch Changes
+    - Update package.json exports to include new plugins (hands, pose)
+    - Remove plugins/index.ts in favor of individual plugin exports (optimizes bundle size)
+    - Update README with comprehensive documentation for all MediaPipe plugins
+    - Add project logo
+
+## 1.0.0-beta.18
+
+### Minor Changes
+
+- Add per-texture history
+
+    The history plugin now supports history tracking for individual textures, in addition to framebuffer history. When initializing a texture with `initializeTexture()`, you can now specify a historyDepth parameter to maintain a buffer of prior frames for that specific texture:
+
+    ```ts
+    // Store the last 30 webcam frames
+    // shader.initializeTexture('u_webcam', videoElement, 30);
+    ```
+
+    Added two new examples demonstrating per-texture history:
+    - history-webcam-channels
+    - history-webcam-grid
+
+## 1.0.0-beta.17
+
+### Minor Changes
+
+- Add plugin system
+
+    Finally in beta! This version adds a new plugin system, and migrates history
+    and save functionality out of the main class into standalone plugins. This
+    reduces bundle size for the most common usecases, and ensures flexibility going
+    forward.
+
+    This commit also reorganizes the examples directory; now all demos can be
+    played without needing to edit any files.
+
+    Other significant changes:
+    - The `play` callback now runs after the next loop is requested, so
+      `shader.pause()` can be called from within the `play` callback.
+    - The constructor no-longer accepts a `history` option. That has moved to the
+      history plugin’s configuration.
+    - The constructor now accepts a `plugins` option.
+
+## 1.0.0-alpha.16
+
+### Minor Changes
+
+- Prevent double play
+
+## 1.0.0-alpha.15
+
+### Patch Changes
+
+- Improve iOS recognition on save
+
+## 1.0.0-alpha.14
+
+### Patch Changes
+
+- Improve mobile save experience
+
+## 1.0.0-alpha.13
+
+### Minor Changes
+
+- Improve save experience on mobile
+
+## 1.0.0-alpha.12
+
+### Minor Changes
+
+- Improve resize behaviour
+
+## 1.0.0-alpha.11
+
+### Patch Changes
+
+- Remove wheel position from u_cursor
+
+## 1.0.0-alpha.10
+
+### Minor Changes
+
+- Add reset() and onResize
+
+## 1.0.0-alpha.9
+
+### Patch Changes
+
+- Make initial history frames transparent
+
+## 1.0.0-alpha.8
+
+### Minor Changes
+
+- Allow `initializeTexture` and `history` to exist in the same shader
+
+## 1.0.0-alpha.7
+
+### Minor Changes
+
+-   - **WebGL 2.0 upgrade** 🚀
+
+        ShaderPad now uses WebGL 2.0 and GLSL 3.00 ES. All shaders now use the `#version 300 es` directive with updated syntax:
+        - `attribute` → `in`
+        - `varying` → `out` (vertex) / `in` (fragment)
+        - `gl_FragColor` → custom `out` variables
+        - `texture2D` → `texture`
+
+        This is a breaking change - existing shaders will need to be updated to use the new syntax.
+
+    - **Frame history buffers**
+
+        Added support for frame history buffers, enabling shaders to reference prior frames. The `u_history` uniform provides access to previous frames as a `sampler2DArray`.
+
+        ```typescript
+        // 2-frame history (eg. for cellular automata)
+        const shader = new ShaderPad(fragmentShaderSrc, { history: 2 });
+        ```
+
+    - **Options object constructor**
+
+        The constructor now accepts an options object instead of just a canvas element:
+
+        ```typescript
+        // Old API
+        const shader = new ShaderPad(fragmentShaderSrc, canvas);
+
+        // New API
+        const shader = new ShaderPad(fragmentShaderSrc, { canvas });
+        ```
+
+    - **Resize throttling**
+
+        Added throttled resize handling to improve performance during window resizing.
+
+    - **Minor bugfixes around click handling**
+
+## 1.0.0-alpha.6
+
+### Minor Changes
+
+- Update uniform names to use conventional u\_ prefix
+
+### Patch Changes
+
+- b9bf4b1: npx changeset version
+
+## 1.0.0-alpha.5
+
+### Minor Changes
+
+- Enhanced mouse interaction uniforms
+
+    Updated the mouse interaction uniforms to provide comprehensive input tracking:
+    - `u_cursor` is now a `vec4` with cursor position (x, y) and scroll position (z, w)
+    - `u_click` is now a `vec3` with click position (x, y) and left click state (z)
+
+    This allows shaders to respond to cursor movement, scrolling, and mouse clicks.
+
+- Callbacks passed to `play` now receive `time` in seconds, not milliseconds.
+
+    This improves consistency with the `u_time` uniform.
+
+## 1.0.0-alpha.4
+
+### Minor Changes
+
+- Add step method and frame counter
+
+    This release adds a `shaderPad.step` method, which enables finer-grained control over animation loops. The `shaderPad.play` callback now receives a `frame` parameter, which is the current frame number.
+
+## 1.0.0-alpha.3
+
+### Minor Changes
+
+- Add texture and destroy methods
+
+    This release adds `shaderPad.initializeTexture` and `shaderPad.updateTextures` methods, which roughly map to how `initializeUniform` and `updateUniform` works. It also adds a `shaderPad.destroy` method, which runs some general cleanup.
+
+    This release also fixes a bug where a passed-in canvas would resize indefinitely on a retina display.
+
+## 1.0.0-alpha.2
+
+### Patch Changes
+
+- Remove log from save()
+
+## 1.0.0-alpha.1
+
+### Minor Changes
+
+- Add save() method
+
+    This method saves the current frame to a PNG file. The filename is optional; if not provided, it will be "export.png".
+
+## 1.0.0-alpha.0
+
+### Major Changes
+
+- Initial alpha release 🎉
+
+    I’ve started using this on a few projects, and I’m pretty confident that the API will retain this general shape. I want to try adopting ShaderPad into a few more projects before officially moving this out of alpha.
+
+    Always open to suggestions!

package/README.md

@@ -240,7 +240,7 @@ shader.updateTextures({
 
 ### Lifecycle methods
 
-#### `play(onBeforeStep?)`
+#### `play(onPreStep?)`
 
 Start the render loop.
 
@@ -257,7 +257,7 @@ shader.play((_time, frame) => {
 
 **Parameters:**
 
-- `onBeforeStep?`: `(time: number, frame: number) => StepOptions | void` - Called before each frame
+- `onPreStep?`: `(time: number, frame: number) => StepOptions | void` - Called before each frame
 
 #### `step(options?)`
 
@@ -297,12 +297,12 @@ interface StepOptions {
 - `skipClear?: boolean` - If `true`, the canvas is not cleared before rendering. Useful for accumulating effects or multi-pass rendering.
 - `skipHistory?: boolean` - If `true`, history buffers are not updated. Useful when you want to render without affecting the history state.
 
-#### `pause()`, `reset()`, `destroy()`
+#### `pause()`, `rewind()`, `reset()`, `destroy()`
 
 ```typescript
-shader.pause(); // Pause the render loop.
-shader.reset(); // Reset frame counter, clock, and clear history buffers.
-shader.resetFrame(); // Reset frame counter and clock only.
+shader.pause(); // Pause the render loop and preserve playback time/frame.
+shader.rewind(); // Reset frame counter and clock.
+shader.reset(); // Rewind and clear output/history buffers.
 shader.destroy(); // Clean up resources.
 ```
 
@@ -352,10 +352,10 @@ Remove a previously registered callback.
 | `pause`             | none                                                   | Fired when the render loop is paused             |
 | `reset`             | none                                                   | Fired when the shader is reset                   |
 | `destroy`           | none                                                   | Fired when the shader is destroyed               |
-| `beforeStep`        | `(time: number, frame: number, options?: StepOptions)` | Fired before each render step                    |
-| `afterStep`         | `(time: number, frame: number, options?: StepOptions)` | Fired after each render step                     |
-| `beforeDraw`        | `(options?: StepOptions)`                              | Fired before each draw call                      |
-| `afterDraw`         | `(options?: StepOptions)`                              | Fired after each draw call                       |
+| `preStep`           | `(time: number, frame: number, options?: StepOptions)` | Fired before each render step                    |
+| `postStep`          | `(time: number, frame: number, options?: StepOptions)` | Fired after each render step                     |
+| `preDraw`           | `(options?: StepOptions)`                              | Fired before each draw call                      |
+| `postDraw`          | `(options?: StepOptions)`                              | Fired after each draw call                       |
 | `initializeTexture` | `(name, source, options?)`                             | Fired after a texture is initialized             |
 | `initializeUniform` | `(name, type, value, options?)`                        | Fired after a uniform is initialized             |
 | `updateTextures`    | `(updates)`                                            | Fired after textures are updated                 |
@@ -371,7 +371,7 @@ inject GLSL, listen to lifecycle events with `shader.on(...)`, emit its own name
 textures with `updateTexture(...)`. If a plugin needs the backing canvas or raw WebGL access, use `shader.canvas` and
 `shader.gl`.
 
-The most useful lifecycle hooks are usually `_init` for setup, `beforeStep` / `beforeDraw` for per-frame work, and
+The most useful lifecycle hooks are usually `_init` for setup, `preStep` / `preDraw` for per-frame work, and
 `destroy` for cleanup. Plugin order is stable: plugins install in `plugins[]` order, handlers run in registration
 order, and GLSL injections preserve plugin order. If a plugin touches shared GL state directly, it should restore that
 state before returning.