ImageWrapper

interface ImageWrapper : UnsafeWrapper, AutoCloseable

Known direct subclasses
MutableImageWrapper

A mutable extension of ImageWrapper that includes write properties.
Known indirect subclasses
AndroidImage

ImageWrapper implementation that wraps an android.media.Image object.
FakeImage

Fake implementation of MutableImageWrapper for testing.

Wrapper interfaces that mirrors the primary read-only properties of android.media.Image.

Summary

Public properties
Rect
open Int
Int
open HardwareBuffer?

Returns a handle to the underlying image's hardware buffer, or null if this image does not support hardware buffer.
Int
List<ImagePlane>
open SyncFence?
Long
Int

Inherited functions
From java.lang.AutoCloseable
Unit
From androidx.camera.common.UnsafeWrapper
T?
<T : Any> unwrapAs(type: Class<T>)

Attempt to unwrap this object into an underlying type.

Public properties

cropRect

Added in 1.7.0-alpha02
val cropRect: Rect
See also
getCropRect

dataSpace

Added in 1.7.0-alpha02
open val dataSpace: Int
See also
getDataSpace

format

Added in 1.7.0-alpha02
val format: Int
See also
getFormat

hardwareBuffer

Added in 1.7.0-alpha02
open val hardwareBuffer: HardwareBuffer?

Returns a handle to the underlying image's hardware buffer, or null if this image does not support hardware buffer.

The android.hardware.HardwareBuffer follows the lifecycle of its associated image. It is not required to be closed explicitly; however, the image needs to be closed after finishing processing the hardware buffer. In other words, if the hardware buffer is being used, the image cannot be closed.

See also
getHardwareBuffer

height

Added in 1.7.0-alpha02
val height: Int
See also
getHeight

imagePlanes

Added in 1.7.0-alpha02
val imagePlanes: List<ImagePlane>
See also
getPlanes

syncFence

Added in 1.7.0-alpha02
open val syncFence: SyncFence?
See also
getFence

timestamp

Added in 1.7.0-alpha02
val timestamp: Long
See also
getTimestamp

width

Added in 1.7.0-alpha02
val width: Int
See also
getWidth