@weasel-js/renderer 0.0.0-stage → 1.10.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 orochi235
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,62 @@
-# Temporary Holding Version
+# @weasel-js/renderer
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A WebGL2 renderer that turns a list of draw commands into pixels.
+
+Part of [weasel](https://github.com/orochi235/weasel), a domain-agnostic 2D
+scene-graph canvas kit for React. See the
+[API reference](https://orochi235.github.io/weasel/api/).
+
+```sh
+npm install @weasel-js/renderer
+```
+
+It knows nothing about a scene graph and has no React in it. `@weasel-js/core`
+builds draw commands from scene nodes and hands them here; anything else that
+can build a `DrawCommand[]` can do the same.
+
+## Drawing
+
+```ts
+import { WeaselRenderer, type DrawCommand } from '@weasel-js/renderer';
+
+const renderer = new WeaselRenderer({ canvas, width: 800, height: 600, dpr: devicePixelRatio });
+renderer.render(commands);
+```
+
+A `DrawCommand` is a path, a group, text, an image, a run of sprites, or a
+shader quad. Paths carry a fill and a stroke from `@weasel-js/paint`; a group
+carries a transform, a clip, a color matrix, and effects. Neighboring commands
+that can share a draw call are merged into one.
+
+`cullDrawCommands` drops the commands that cannot reach a screen rectangle.
+
+## Paint
+
+- `commandPaint` and `commandStroke` resolve a `Paint` or `Stroke` against a
+  pose box into what a command carries.
+- `createTilePattern` builds a repeating tile; `resolvePatternSpec` builds one
+  from a serializable `TilePatternSpec`. The named tiles (`hatch`, `crosshatch`,
+  `dots`, `chunks`) are under `@weasel-js/renderer/patterns-builtin`.
+- `registerPaintDrawKind` adds a fill kind the renderer can bind: its shader
+  programs and how its geometry moves between a pose frame and a bounds frame.
+  The mesh gradient is one, under `@weasel-js/renderer/mesh`.
+
+## Shaders and effects
+
+`registerProgram` registers a fragment shader a `kind: 'shader'` command draws
+with, and `registerTexture` a texture it can sample. `registerEffect` adds a
+full-screen pass a group names in `effects`; `blur` and `vignette` are built in.
+
+## Text and images
+
+`textCommand`, `textCommandFromRuns`, and `textCommandFromPose` build a text
+command from laid-out runs. Fonts are registered through `@weasel-js/font`,
+which this package re-exports.
+
+`getImageBitmap` decodes and caches an image by its `src`, and
+`subscribeImageReady` reports when one a frame asked for has arrived.
+
+## Testing
+
+`@weasel-js/renderer/testing/glRecorder` is a WebGL2 stand-in that records
+every call, for asserting what a frame drew without a GPU.

package/dist/chunk-43YL7HZV.js

@@ -0,0 +1,11 @@
+import { rasterizeTile, registerTexture } from './chunk-Q4SIHV7Q.js';
+
+// src/patterns/index.ts
+function createTilePattern(opts) {
+  const bitmap = rasterizeTile(opts);
+  return bitmap ? registerTexture(bitmap) : null;
+}
+
+export { createTilePattern };
+//# sourceMappingURL=chunk-43YL7HZV.js.map
+//# sourceMappingURL=chunk-43YL7HZV.js.map

package/dist/chunk-43YL7HZV.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/patterns/index.ts"],"names":[],"mappings":";;;AA2BO,SAAS,kBAAkB,IAAA,EAA6C;AAC7E,EAAA,MAAM,MAAA,GAAS,cAAc,IAAI,CAAA;AACjC,EAAA,OAAO,MAAA,GAAS,eAAA,CAAgB,MAAM,CAAA,GAAI,IAAA;AAC5C","file":"chunk-43YL7HZV.js","sourcesContent":["/**\n * Tile-pattern primitive — a small helper for building repeating texture\n * tiles from a draw callback. The result plugs into a `Paint` of\n * `{ kind: 'texture', texture }` (see `@weasel-js/paint`).\n *\n * For ready-to-use named patterns (hatch, crosshatch, dots, chunks),\n * see the `@weasel-js/renderer/patterns-builtin` subpath.\n */\n\nimport { registerTexture } from '../textures/registerTexture';\nimport type { TextureHandle } from '../textures/registerTexture';\nimport { rasterizeTile } from './rasterizeTile';\n\n/** Options for `createTilePattern`. */\nexport interface TilePatternOpts {\n  /** Edge length (in pixels) of the square offscreen tile. */\n  size: number;\n  /** Paint one tile at integer-pixel coordinates `(0, 0) .. (size, size)`. */\n  draw: (oc: CanvasRenderingContext2D, size: number) => void;\n}\n\n/**\n * Render a single tile and register it as a GL texture, returning a\n * `TextureHandle` you can wrap in a `Paint` of\n * `{ kind: 'texture', texture }`. Returns `null` only when an\n * `OffscreenCanvas`/2D context can't be acquired.\n */\nexport function createTilePattern(opts: TilePatternOpts): TextureHandle | null {\n  const bitmap = rasterizeTile(opts);\n  return bitmap ? registerTexture(bitmap) : null;\n}\n"]}