CaptureSpec.source Contract 2.0.0 · package sha256
a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e· generated fromconfigurator-runtime.d.tsbyservices/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.
Property of CaptureSpec · stable · since 2.0.0
source?: 'render' | 'displayed';'render': off-display; the live camera, accumulators and canvas are untouched. 'displayed': the
frame presented next after the call, as is (beauty or accumulated), at display size; the
runtime re-presents an idle still as shown (an accumulated still's current mean, never a fresh
sample, and the run goes on), and a destroy() after the call doesn't cancel it. Runtime
overlays (rulers, hotspot badges) and role 'helper' items are in neither; a helper
collection's stage layer and rules still apply.
Default: 'render'
| Rule | Result |
|---|---|
| 1. Neutral name | pass: source names no product |
| 2. A precedent | pass: HTMLCanvasElement.toBlob (row G19); Unity ScreenCapture.CaptureScreenshot (row K38) |
| 3. Two apps, or labs | pass: 4 apps (ledger: app-4f16d2f6da, app-bcb7ef21da, app-ceb4eccc72, app-f9a32142f1) |
| 4. The cheaper fix first | decided per need in Appendix B: rows G19, K38 at tier stable (a member only where no rule, data, asset or app code serves the need) |