scenic-prism-playwright 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +5 -4
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -61,7 +61,7 @@ keep it. `format` defaults to `png` there, there being no filename to read.
61
61
  | `size` | `number` | Square backing resolution in pixels (default 1024). |
62
62
  | `width` `height` | `number` | The same, when the image is not square. |
63
63
  | `maxFrames` | `number` | Samples per pixel to accumulate (default 1200). |
64
- | `bounces` | `number` | Light-bounce budget (default 6); glass and metal reward 8–12. |
64
+ | `bounces` | `number` | Light-bounce budget per path (default 6); metal rewards 8–12, glass 12–16. |
65
65
  | `tone` | `'aces' \| 'reinhard' \| 'linear'` | The curve that brings the traced light into display range (default `'aces'`). |
66
66
  | `exposure` | `number` | Exposure in stops, before that curve: `-1` is half as bright, `+2` four times (default 0). |
67
67
  | `alpha` | `boolean` | Save a cut-out rather than a background: rays that leave the scene write no coverage (default false). Wants a format with an alpha channel — `png` or `webp`. |
@@ -185,8 +185,9 @@ await renderToFile(SCENE, 'renders/plate.png', { gpu: false, seed: 7 });
185
185
  ```
186
186
 
187
187
  Software path tracing is minutes, not seconds, for a large image at a high
188
- sample count, so a script that opts out should raise `timeout` and report
189
- progress:
188
+ sample count — and a scene with glass in it traces one path per dispersion
189
+ band, three by default, in every sample — so a script that opts out should
190
+ raise `timeout` and report progress:
190
191
 
191
192
  ```ts
192
193
  await renderToFile(SCENE, 'renders/poster.png', {
@@ -233,7 +234,7 @@ same terms, passing on the licence and its `Required Notice:` line with any copy
233
234
 
234
235
  **Commercial use needs a separate licence.** If you want to use `scenic-prism`
235
236
  in or around a commercial product, ask via
236
- [the repository](https://github.com/jamesporter/Scenic-Draft).
237
+ [the repository](https://github.com/jamesporter/Scenic-Prism).
237
238
 
238
239
  The terms in full are in the `LICENSE` file shipped inside this package, and
239
240
  explained in plain language at
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "scenic-prism-playwright",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Render a scenic-prism scene to an image file from Node, by path-tracing it in a headless browser driven by Playwright.",
5
5
  "license": "PolyForm-Noncommercial-1.0.0",
6
6
  "type": "module",
@@ -18,7 +18,7 @@
18
18
  },
19
19
  "peerDependencies": {
20
20
  "playwright": ">=1.40",
21
- "scenic-prism-fluent": ">=0.1.0"
21
+ "scenic-prism-fluent": ">=0.1.1"
22
22
  },
23
23
  "files": [
24
24
  "dist",