From 8cee65ec1d67ee8ea0a40099a26e1f94c7b06feb Mon Sep 17 00:00:00 2001 From: Leon Scroggins III Date: Thu, 30 Jan 2020 14:20:42 -0500 Subject: AImageDecoder: update comments around dataspaces Bug: 135133301 Test: I5e8bdcdae6837db23c0f4ef08f931f3bebe0ce0d A companion change (I489f31fef79dec11e97c8e8fb9207adb77a3d0c7) makes AImageDecoder default to doing no color conversion. Update comments to reflect that. Change-Id: Icc3b0f101598ce98c458ff43597ee05b3662664c --- include/android/imagedecoder.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) (limited to 'include/android/imagedecoder.h') diff --git a/include/android/imagedecoder.h b/include/android/imagedecoder.h index 6e5da52cb5..7437ab1093 100644 --- a/include/android/imagedecoder.h +++ b/include/android/imagedecoder.h @@ -349,20 +349,20 @@ int AImageDecoderHeaderInfo_getAlphaFlags( const AImageDecoderHeaderInfo*) __INTRODUCED_IN(30); /** - * Report the dataspace the {@link AImageDecoder} will decode to by default. - * AImageDecoder will try to choose one that is sensible for the - * image and the system. Note that this may not exactly match the ICC - * profile (or other color information) stored in the encoded image. + * Report the dataspace the AImageDecoder will decode to by default. * - * @return The {@link ADataSpace} most closely representing the way the colors - * are encoded (or {@link ADATASPACE_UNKNOWN} if there is not an - * approximate ADataSpace). This specifies how to interpret the colors + * By default, {@link AImageDecoder_decodeImage} will not do any color + * conversion. + * + * @return The {@link ADataSpace} representing the way the colors + * are encoded (or {@link ADATASPACE_UNKNOWN} if there is not a + * corresponding ADataSpace). This specifies how to interpret the colors * in the decoded image, unless {@link AImageDecoder_setDataSpace} is * called to decode to a different ADataSpace. * * Note that ADataSpace only exposes a few values. This may return - * ADATASPACE_UNKNOWN, even for Named ColorSpaces, if they have no - * corresponding ADataSpace. + * {@link ADATASPACE_UNKNOWN}, even for Named ColorSpaces, if they have + * no corresponding {@link ADataSpace}. */ int32_t AImageDecoderHeaderInfo_getDataSpace( const AImageDecoderHeaderInfo*) __INTRODUCED_IN(30); -- cgit v1.2.3-59-g8ed1b