CaptureSpec.background ​

Contract 2.0.0 · package sha256 a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e · generated from configurator-runtime.d.ts by services/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.

Property of CaptureSpec · stable · since 2.0.0

ts
background?: 'scene' | 'transparent' | ColorValue;

'scene': the stage's background. Another value is 'render' only: a 'displayed' capture copies the frame as presented, so 'transparent' or a colour with it rejects HoloInputError ('capture-displayed-fixed').

Default: 'scene'

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: background names no product
2. A precedent not recorded: no ledger row (coverage.json) names this member or its owner
3. Two apps, or labs not recorded: no ledger row names this member or its owner
4. The cheaper fix first not recorded per member (Appendix B decides it per need)