Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 1e5a5567 authored by TreeHugger Robot's avatar TreeHugger Robot Committed by Automerger Merge Worker
Browse files

Merge "Update documentation for Image to be clear on valid format enums." into... 

Merge "Update documentation for Image to be clear on valid format enums." into tm-dev am: 82409626 am: f638686c am: 17fc0194

Original change: https://googleplex-android-review.googlesource.com/c/platform/frameworks/base/+/17006063



Change-Id: I9caa5a3a0005092412414400b3faee8c1a159727
Signed-off-by: default avatarAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
parents ea6d106b 17fc0194

media/java/android/media/Image.java

+10 −5
Original line number Diff line number Diff line
@@ -86,8 +86,10 @@ public abstract class Image implements AutoCloseable { 
     *

     * <p>

     * The format is one of the values from

     * {@link android.graphics.ImageFormat ImageFormat}. The mapping between the

     * formats and the planes is as follows:

     * {@link android.graphics.ImageFormat ImageFormat},

     * {@link android.graphics.PixelFormat PixelFormat}, or

     * {@link android.hardware.HardwareBuffer HardwareBuffer}. The mapping between the

     * formats and the planes is as follows (any formats not listed will have 1 plane):

     * </p>

     *

     * <table>
@@ -171,15 +173,18 @@ public abstract class Image implements AutoCloseable { 
     * </tr>

     * <tr>

     *   <td>{@link android.graphics.ImageFormat#YCBCR_P010 YCBCR_P010}</td>

     *   <td>1</td>

     *   <td>3</td>

     *   <td>P010 is a 4:2:0 YCbCr semiplanar format comprised of a WxH Y plane

     *     followed by a Wx(H/2) CbCr plane. Each sample is represented by a 16-bit

     *     little-endian value, with the lower 6 bits set to zero.

     *     followed by a Wx(H/2) Cb and Cr planes. Each sample is represented by a 16-bit

     *     little-endian value, with the lower 6 bits set to zero. Since this is guaranteed to be

     *     a semi-planar format, the Cb plane can also be treated as an interleaved Cb/Cr plane.

     *   </td>

     * </tr>

     * </table>

     *

     * @see android.graphics.ImageFormat

     * @see android.graphics.PixelFormat

     * @see android.hardware.HardwareBuffer

     */

    public abstract int getFormat();