HardwareBuffer

Kotlin |Java

class HardwareBuffer : AutoCloseable, Parcelable

kotlin.Any
↳	android.hardware.HardwareBuffer

HardwareBuffer wraps a native AHardwareBuffer object, which is a low-level object representing a memory buffer accessible by various hardware units. HardwareBuffer allows sharing buffers across different application processes. In particular, HardwareBuffers may be mappable to memory accessible to various hardware systems, such as the GPU, a sensor or context hub, or other auxiliary processing units. For more information, see the NDK documentation for AHardwareBuffer.

Summary

Constants
static Int	`BGRA_1010102` 32-bit packed format that has 2-bit A, 10-bit R, G, and B components, in that order, from the most-significant bits to the least-significant bits.
static Int	`BGRX_1010102` 32-bit packed format that has 2-bit unused, 10-bit R, G, and B components, in that order, from the most-significant bits to the least-significant bits.
static Int	`BLOB` Format: opaque format used for raw data transfer; must have a height of 1
static Int	`DS_24UI8` Format: 24 bits depth, 8 bits stencil
static Int	`DS_FP32UI8` Format: 32 bits depth, 8 bits stencil
static Int	`D_16` Format: 16 bits depth
static Int	`D_24` Format: 24 bits depth
static Int	`D_FP32` Format: 32 bits depth
static Int	`RGBA_10101010` Format: 10 bits each red, green, blue, alpha
static Int	`RGBA_1010102` Format: 10 bits each red, green, blue, 2 bits alpha
static Int	`RGBA_12121212` 64-bit format that has 12-bit R, G, B, and A components, in that order, from the lowest memory address to the highest memory address.
static Int	`RGBA_14141414` 64-bit format that has 14-bit R, G, B, and A components, in that order, from the lowest memory address to the highest memory address.
static Int	`RGBA_8888` Format: 8 bits each red, green, blue, alpha.
static Int	`RGBA_FP16` Format: 16 bits each red, green, blue, alpha
static Int	`RGBX_8888` Format: 8 bits each red, green, blue, alpha, alpha is always 0xFF
static Int	`RGB_565` Format: 5 bits each red and blue, 6 bits green, no alpha
static Int	`RGB_888` Format: 8 bits each red, green, blue, no alpha
static Int	`RG_1212` 32-bit format that has 12-bit R and G components, in that order, from the lowest memory address to the highest memory address.
static Int	`RG_1414` 32-bit format that has 14-bit R and G components, in that order, from the lowest memory address to the highest memory address.
static Int	`RG_1616` Format: 16 bits each red, green.
static Int	`R_12` 16 bit format with a single 12-bit component.
static Int	`R_14` 16 bit format with a single 14-bit component.
static Int	`R_16` Format: 16 bits red.
static Int	`R_8` Format: 8 bits red
static Int	`S_UI8` Format: 8 bits stencil
static Long	`USAGE_COMPOSER_OVERLAY` The buffer will be used as a hardware composer overlay layer.
static Long	`USAGE_CPU_READ_OFTEN` Usage: The buffer will often be read by the CPU
static Long	`USAGE_CPU_READ_RARELY` Usage: The buffer will sometimes be read by the CPU.
static Long	`USAGE_CPU_WRITE_OFTEN` Usage: The buffer will often be written to by the CPU
static Long	`USAGE_CPU_WRITE_RARELY` Usage: The buffer will sometimes be written to by the CPU
static Long	`USAGE_FRONT_BUFFER` Usage: The buffer is used for front-buffer rendering.
static Long	`USAGE_GPU_COLOR_OUTPUT` Usage: The buffer will be written to by the GPU
static Long	`USAGE_GPU_CUBE_MAP` Usage: The buffer will be used as a cube map texture
static Long	`USAGE_GPU_DATA_BUFFER` Usage: The buffer will be used as a shader storage or uniform buffer object
static Long	`USAGE_GPU_MIPMAP_COMPLETE` Usage: The buffer contains a complete mipmap hierarchy
static Long	`USAGE_GPU_SAMPLED_IMAGE` Usage: The buffer will be read from by the GPU
static Long	`USAGE_PROTECTED_CONTENT` Usage: The buffer must not be used outside of a protected hardware path
static Long	`USAGE_SENSOR_DIRECT_DATA` Usage: The buffer will be used for sensor direct data
static Long	`USAGE_VIDEO_ENCODE` Usage: The buffer will be read by a hardware video encoder
static Int	`YCBCR_420_888` Format: Planar YCbCr 420; must have an even width and height
static Int	`YCBCR_P010` Android YUV P010 format.
static Int	`YCBCR_P210` Android YUV P210 format.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Unit	`close()` Destroys this buffer immediately.
static HardwareBuffer	`create(width: Int, height: Int, format: Int, layers: Int, usage: Long)` Creates a new `HardwareBuffer` instance.
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Int	`getFormat()` Returns the @Format of this buffer.
Int	`getHeight()` Returns the height of this buffer in pixels.
Long	`getId()` Returns the system-wide unique id for this buffer This can be useful as a cache key for associating additional objects with a given HardwareBuffer, such as associating an imported EGLImage with the target HardwareBuffer when processing a stream of buffers from ImageReader.
Int	`getLayers()` Returns the number of layers in this buffer.
Long	`getUsage()` Returns the usage flags of the usage hints set on this buffer.
Int	`getWidth()` Returns the width of this buffer in pixels.
Boolean	`isClosed()` Indicates whether this buffer has been closed.
static Boolean	`isSupported(width: Int, height: Int, format: Int, layers: Int, usage: Long)` Queries whether the given buffer description is supported by the system.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Protected methods
Unit	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Properties
static Parcelable.Creator<HardwareBuffer!>	`CREATOR`

Constants

BGRA_1010102

Added in API level 37

static val BGRA_1010102: Int

32-bit packed format that has 2-bit A, 10-bit R, G, and B components, in that order, from the most-significant bits to the least-significant bits. The component values are unsigned normalized to the range [0, 1], whose interpretation is defined by the dataspace.

Value: 67

BGRX_1010102

Added in API level 37

static val BGRX_1010102: Int

32-bit packed format that has 2-bit unused, 10-bit R, G, and B components, in that order, from the most-significant bits to the least-significant bits. The component values are unsigned normalized to the range [0, 1], whose interpretation is defined by the dataspace.

Value: 68

HardwareBuffer

Summary

Constants

BGRA_1010102

BGRX_1010102

BLOB

DS_24UI8

DS_FP32UI8

D_16

D_24

D_FP32

RGBA_10101010

RGBA_1010102

RGBA_12121212

RGBA_14141414

RGBA_8888

RGBA_FP16

RGBX_8888

RGB_565

RGB_888

RG_1212

RG_1414

RG_1616

R_12

R_14

R_16

R_8

S_UI8

USAGE_COMPOSER_OVERLAY

USAGE_CPU_READ_OFTEN

USAGE_CPU_READ_RARELY

USAGE_CPU_WRITE_OFTEN

USAGE_CPU_WRITE_RARELY

USAGE_FRONT_BUFFER

USAGE_GPU_COLOR_OUTPUT

USAGE_GPU_CUBE_MAP

USAGE_GPU_DATA_BUFFER

USAGE_GPU_MIPMAP_COMPLETE

USAGE_GPU_SAMPLED_IMAGE

USAGE_PROTECTED_CONTENT

USAGE_SENSOR_DIRECT_DATA