Skip to content

Commit

Permalink
docs: Update photoHdr and lowLightBoost docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrousavy committed May 3, 2024
1 parent f8b40fd commit 0e9a31b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions package/src/types/CameraProps.ts
Expand Up @@ -196,6 +196,9 @@ export interface CameraProps extends ViewProps {
/**
* Enables or disables HDR Photo Capture via a double capture routine that combines low- and high exposure photos.
*
* On Android, {@linkcode photoHdr} uses a vendor-specific "HDR" extension which is not compatible with {@linkcode videoHdr},

This comment has been minimized.

Copy link
@rodgomesc

rodgomesc May 3, 2024

Contributor

woaaaa, this is interesting, i faced this before, do we have any validations to prevent using both or just docs?

This comment has been minimized.

Copy link
@mrousavy

mrousavy May 3, 2024

Author Owner

Yes, I check in native code and throw the format/photo-hdr-and-video-hdr-not-suppoted-simultaneously error if misused.

* so only one of video- or photo-HDR can be enabled at a time.
*
* Make sure the given {@linkcode format} supports HDR (see {@linkcode CameraDeviceFormat.supportsPhotoHdr format.supportsPhotoHdr}).
*/
photoHdr?: boolean
Expand Down Expand Up @@ -235,6 +238,8 @@ export interface CameraProps extends ViewProps {
* Enabling low light boost allows the FPS rate to be throttled to up to half of what it is set to to allow for more
* exposure in low light conditions.
*
* On Android, {@linkcode lowLightBoost} might even use a vendor-specific "night-mode" extension to allow for even more visibility in low-light conditions.
*
* Make sure the given {@linkcode device} supports low-light-boost (see {@linkcode CameraDevice.supportsLowLightBoost device.supportsLowLightBoost}).
*/
lowLightBoost?: boolean
Expand Down

0 comments on commit 0e9a31b

Please sign in to comment.