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

Commit 99aecff4 authored by Eino-Ville Talvala's avatar Eino-Ville Talvala
Browse files

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

Also fix the number of planes for P010.

Change-Id: I5ef743478f4b93a68706acce73eabd72f6b89b2e
parent 9b4c7a9f

media/java/android/media/Image.java

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

     *

     * <p>

     * <p>

     * The format is one of the values from

     * The format is one of the values from

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

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

     * formats and the planes is as follows:

     * {@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>

     * </p>

     *

     *

     * <table>

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

     * </tr>

     * <tr>

     * <tr>

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

     *   <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

     *   <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

     *     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.

     *     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>

     *   </td>

     * </tr>

     * </tr>

     * </table>

     * </table>

     *

     *

     * @see android.graphics.ImageFormat

     * @see android.graphics.ImageFormat

     * @see android.graphics.PixelFormat

     * @see android.hardware.HardwareBuffer

     */

     */

    public abstract int getFormat();

    public abstract int getFormat();