HDR: Add comment describing HDR_MODE_KEEP_HDR behavior.

PiperOrigin-RevId: 524301315
This commit is contained in:
huangdarwin 2023-04-14 16:46:56 +01:00 committed by Rohit Singh
parent b40f4792f0
commit 9835e58e4c

View File

@ -57,9 +57,11 @@ public final class TransformationRequest {
/** /**
* Processes HDR input as HDR, to generate HDR output. * Processes HDR input as HDR, to generate HDR output.
* *
* <p>The HDR output format (ex. color transfer) will be the same as the HDR input format.
*
* <p>Supported on API 31+, by some device and HDR format combinations. * <p>Supported on API 31+, by some device and HDR format combinations.
* *
* <p>If not supported, {@link Transformer} may fall back to {@link * <p>If not supported, {@link Transformer} will attempt to use {@link
* #HDR_MODE_TONE_MAP_HDR_TO_SDR_USING_MEDIACODEC}. * #HDR_MODE_TONE_MAP_HDR_TO_SDR_USING_MEDIACODEC}.
*/ */
public static final int HDR_MODE_KEEP_HDR = 0; public static final int HDR_MODE_KEEP_HDR = 0;
@ -68,7 +70,7 @@ public final class TransformationRequest {
* android.media.MediaCodec} decoder tone-mapper. * android.media.MediaCodec} decoder tone-mapper.
* *
* <p>Supported on API 31+, by some device and HDR format combinations. Tone-mapping is only * <p>Supported on API 31+, by some device and HDR format combinations. Tone-mapping is only
* guaranteed to be supported from Android T onwards. * guaranteed to be supported on API 33+, on devices with HDR capture support.
* *
* <p>If not supported, {@link Transformer} throws an {@link ExportException}. * <p>If not supported, {@link Transformer} throws an {@link ExportException}.
*/ */
@ -95,7 +97,7 @@ public final class TransformationRequest {
* metadata will be ignored, contents will be displayed incorrectly, likely with a washed out * metadata will be ignored, contents will be displayed incorrectly, likely with a washed out
* look. * look.
* *
* <p>Using this API may lead to codec errors before API 29, per b/269759013. * <p>Using this API may lead to codec errors before API 29.
* *
* <p>Use of this flag may result in {@code ERROR_CODE_DECODING_FORMAT_UNSUPPORTED}. * <p>Use of this flag may result in {@code ERROR_CODE_DECODING_FORMAT_UNSUPPORTED}.
* *