CaptureSpec.pixelRatio ​

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
pixelRatio?: number;

The image is size × pixelRatio pixels: pass 1 for an exact pixel size. A side over 4096 px (or info().device.maxTextureSize, when smaller) or an area over 16.7 MP (8.3 MP on a phone) lowers the ratio; snapshot.size.pixelRatio reports the one used. 'render' only, as view: a 'displayed' capture has the display's ratio, which snapshot.size.pixelRatio reports.

Default: the live view's pixel ratio (the device's, capped by the quality tier). On a phone at rest the canvas may show a sharper still; source: 'displayed' copies it, or pass pixelRatio.

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: pixelRatio 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)