Image.Plane

Kotlin |Java

public static abstract class Image.Plane
extends Object

java.lang.Object
↳	android.media.Image.Plane

A single color plane of image data.

The number and meaning of the planes in an Image are determined by the format of the Image.

Once the Image has been closed, any access to the plane's ByteBuffer will fail.

See also:

Image.getFormat()

Summary

Public methods
`abstract ByteBuffer`	`getBuffer()` Get a direct `ByteBuffer` containing the frame data.
`abstract int`	`getPixelStride()` The distance between adjacent pixel samples, in bytes.
`abstract int`	`getRowStride()` The row stride for this color plane, in bytes.

Public methods


        abstract
        
        
        
        
        ByteBuffer


      getBuffer()

Get a direct ByteBuffer containing the frame data.


      getPixelStride()

The distance between adjacent pixel samples, in bytes.


      getRowStride()

The row stride for this color plane, in bytes.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

getBuffer

Added in API level 19

public abstract ByteBuffer getBuffer ()

Get a direct ByteBuffer containing the frame data.

In particular, the buffer returned will always have isDirect return true, so the underlying data could be mapped as a pointer in JNI without doing any copies with GetDirectBufferAddress.

For raw formats, each plane is only guaranteed to contain data up to the last pixel in the last row. In other words, the stride after the last row may not be mapped into the buffer. This is a necessary requirement for any interleaved format.

Returns
`ByteBuffer`	the byte buffer containing the image data for this plane.

getPixelStride

Added in API level 19

public abstract int getPixelStride ()

The distance between adjacent pixel samples, in bytes.

This is the distance between two consecutive pixel values in a row of pixels. It may be larger than the size of a single pixel to account for interleaved image data or padded formats. Note that pixel stride is undefined for some formats such as RAW_PRIVATE, and calling getPixelStride on images of these formats will cause an UnsupportedOperationException being thrown. For formats where pixel stride is well defined, the pixel stride is always greater than 0.

Returns
`int`

getRowStride

Added in API level 19

public abstract int getRowStride ()

The row stride for this color plane, in bytes.

This is the distance between the start of two consecutive rows of pixels in the image. Note that row stride is undefined for some formats such as RAW_PRIVATE, and calling getRowStride on images of these formats will cause an UnsupportedOperationException being thrown. For formats where row stride is well defined, the row stride is always greater than 0.

Returns
`int`