rayzee 6.4.0 → 7.0.0

package/README.md

@@ -1,7 +1,7 @@
 # Rayzee Engine
 
 [![npm](https://img.shields.io/npm/v/rayzee?label=npm)](https://www.npmjs.com/package/rayzee)
-[![minzipped size](https://img.shields.io/badge/minzipped-148.8%20KB-blue)](https://www.npmjs.com/package/rayzee)
+[![minzipped size](https://img.shields.io/badge/minzipped-155.1%20KB-blue)](https://www.npmjs.com/package/rayzee)
 [![downloads](https://img.shields.io/npm/dw/rayzee?label=downloads)](https://www.npmjs.com/package/rayzee)
 [![jsDelivr](https://img.shields.io/jsdelivr/npm/hm/rayzee?label=jsDelivr)](https://www.jsdelivr.com/package/npm/rayzee)
 
@@ -327,7 +327,6 @@ Key settings:
 | `focusDistance` | `number` | 0.8 | DOF focus distance |
 | `aperture` | `number` | 5.6 | DOF aperture (f-stop) |
 | `focalLength` | `number` | 50 | DOF focal length (mm) |
-| `adaptiveSampling` | `boolean` | false | Variance-guided sample distribution |
 | `transparentBackground` | `boolean` | false | Transparent canvas background |
 | `interactionModeEnabled` | `boolean` | true | Lower quality during camera movement for smoother navigation |
 | `debugMode` | `number` | 0 | Debug visualization mode (0 = off) |
@@ -429,7 +428,7 @@ engine.environmentManager.markDirty()        // Flag environment for GPU re-uplo
 
 ### engine.denoisingManager
 
-Denoiser strategy, ASVGF, OIDN, upscaler, adaptive sampling, and auto-exposure.
+Denoiser strategy, ASVGF, OIDN, upscaler, and auto-exposure.
 
 ```js
 // Strategy
@@ -437,14 +436,12 @@ engine.denoisingManager.setStrategy('asvgf', 'medium')  // 'none' | 'asvgf' | 's
 engine.denoisingManager.setASVGFEnabled(true, 'medium')
 engine.denoisingManager.applyASVGFPreset('high')         // 'low' | 'medium' | 'high'
 engine.denoisingManager.setAutoExposure(true)
-engine.denoisingManager.setAdaptiveSampling(true)
 
 // Fine-grained parameters
 engine.denoisingManager.setASVGFParams({ temporalAlpha: 0.1, phiColor: 10 })
 engine.denoisingManager.setSSRCParams({ temporalAlpha: 0.1, spatialRadius: 3 })
 engine.denoisingManager.setEdgeAwareParams({ pixelEdgeSharpness: 1.0 })
 engine.denoisingManager.setAutoExposureParams({ keyValue: 0.18 })
-engine.denoisingManager.setAdaptiveSamplingParams({ varianceThreshold: 0.01 })
 
 // OIDN & Upscaler
 engine.denoisingManager.setOIDNEnabled(true)
@@ -490,6 +487,7 @@ engine.setCanvasSize(1920, 1080)      // Set explicit canvas dimensions
 engine.onResize()                     // Trigger manual resize recalculation
 engine.isComplete()                   // Check if rendering has converged
 engine.getFrameCount()                // Get the current accumulated frame count
+engine.getMemoryInfo()                // GPU memory snapshot: { current, peak, byCategory } in bytes
 ```
 
 `screenshot()` returns a `Blob` for the host to save, upload, or display. To trigger a browser download:
@@ -504,6 +502,24 @@ URL.revokeObjectURL(url);
 
 ---
 
+### Memory Monitoring
+
+Track GPU (VRAM) usage across the whole pipeline. Sizes are measured from live GPU resources (buffer `byteLength` + texture dimensions × format), so they are exact, not estimated.
+
+```js
+const { current, peak, byCategory } = engine.getMemoryInfo();   // bytes
+// byCategory: { rays, queues, gbuffer, accum, geometry, materials, environment, stages }
+
+engine.vram.resetPeak();   // reset the high-water mark to the current value
+engine.vram.getReport();   // formatted one-line summary string
+```
+
+`peak` is a high-water mark, reset when a final render begins (`configureForMode('production')`). The engine's VRAM is largely monotonic — the ray pool only grows and the per-stage storage textures are fixed-size — so `peak` equals `current` during a steady render and only exceeds it after memory is released (lower resolution, a smaller scene, or removing the HDRI). The `stages` + `accum` categories (fixed 2048² storage textures) dominate the baseline.
+
+The React app surfaces this as a `Memory: … | Peak: …` readout in the on-canvas stats overlay.
+
+---
+
 ### Events
 
 Subscribe to engine lifecycle events via `addEventListener`:
@@ -601,6 +617,9 @@ import {
   StageExecutionMode,
   PipelineContext,
 } from 'rayzee';
+
+// VRAM accounting (VRAMTracker is also reachable as engine.vram)
+import { VRAMTracker, bufferBytes, textureBytes } from 'rayzee';
 ```
 
 ## Browser Requirements