Bitmap

Summary

Enumerations
Anonymous Enum 21{
  ANDROID_BITMAP_RESULT_SUCCESS = 0,
  ANDROID_BITMAP_RESULT_BAD_PARAMETER = -1,
  ANDROID_BITMAP_RESULT_JNI_EXCEPTION = -2,
  ANDROID_BITMAP_RESULT_ALLOCATION_FAILED = -3
} 		enum
AndroidBitmap functions result code.
Anonymous Enum 22{
  ANDROID_BITMAP_FLAGS_ALPHA_PREMUL = 0,
  ANDROID_BITMAP_FLAGS_ALPHA_OPAQUE = 1,
  ANDROID_BITMAP_FLAGS_ALPHA_UNPREMUL = 2,
  ANDROID_BITMAP_FLAGS_ALPHA_MASK = 0x3,
  ANDROID_BITMAP_FLAGS_ALPHA_SHIFT = 0
} 		enum
Bitmap alpha format.
Anonymous Enum 23{
  ANDROID_BITMAP_FLAGS_IS_HARDWARE = 1 << 31
} 		enum
AndroidBitmapCompressFormat{
  ANDROID_BITMAP_COMPRESS_FORMAT_JPEG = 0,
  ANDROID_BITMAP_COMPRESS_FORMAT_PNG = 1,
  ANDROID_BITMAP_COMPRESS_FORMAT_WEBP_LOSSY = 3,
  ANDROID_BITMAP_COMPRESS_FORMAT_WEBP_LOSSLESS = 4
} 		enum
Specifies the formats that can be compressed to with AndroidBitmap_compress.
AndroidBitmapFormat{
  ANDROID_BITMAP_FORMAT_NONE = 0,
  ANDROID_BITMAP_FORMAT_RGBA_8888 = 1,
  ANDROID_BITMAP_FORMAT_RGB_565 = 4,
  ANDROID_BITMAP_FORMAT_RGBA_4444 = 7,
  ANDROID_BITMAP_FORMAT_A_8 = 8,
  ANDROID_BITMAP_FORMAT_RGBA_F16 = 9,
  ANDROID_BITMAP_FORMAT_RGBA_1010102 = 10
} 		enum
Bitmap pixel format.

Typedefs
AHardwareBuffer typedef
struct AHardwareBuffer
AndroidBitmap_CompressWriteFunc)(void *userContext, const void *data, size_t size) typedef
bool(*
User-defined function for writing the output of compression.

Functions
AndroidBitmap_compress(const AndroidBitmapInfo *info, int32_t dataspace, const void *pixels, int32_t format, int32_t quality, void *userContext, AndroidBitmap_CompressWriteFunc fn)
int
Compress pixels as described by info.
AndroidBitmap_getDataSpace(JNIEnv *env, jobject jbitmap)
int32_t
Given a java bitmap object, return its ADataSpace.
AndroidBitmap_getHardwareBuffer(JNIEnv *env, jobject bitmap, AHardwareBuffer **outBuffer)
int
Retrieve the native object associated with a HARDWARE Bitmap.
AndroidBitmap_getInfo(JNIEnv *env, jobject jbitmap, AndroidBitmapInfo *info)
int
Given a java bitmap object, fill out the AndroidBitmapInfo struct for it.
AndroidBitmap_lockPixels(JNIEnv *env, jobject jbitmap, void **addrPtr)
int
Given a java bitmap object, attempt to lock the pixel address.
AndroidBitmap_unlockPixels(JNIEnv *env, jobject jbitmap)
int
Call this to balance a successful call to AndroidBitmap_lockPixels.

Structs
AndroidBitmapInfo

Bitmap info, see AndroidBitmap_getInfo().

Enumerations

Anonymous Enum 21

Declared in android/bitmap.h 
 Anonymous Enum 21

AndroidBitmap functions result code.

Properties
ANDROID_BITMAP_RESULT_ALLOCATION_FAILED

Allocation failed.

ANDROID_BITMAP_RESULT_BAD_PARAMETER

Bad parameter.

ANDROID_BITMAP_RESULT_JNI_EXCEPTION

JNI exception occured.

ANDROID_BITMAP_RESULT_SUCCESS

Operation was successful.

Anonymous Enum 22

Declared in android/bitmap.h 
 Anonymous Enum 22

Bitmap alpha format.

Properties
ANDROID_BITMAP_FLAGS_ALPHA_MASK

Bit mask for AndroidBitmapFormat.flags to isolate the alpha.

ANDROID_BITMAP_FLAGS_ALPHA_OPAQUE

Pixels are opaque.

ANDROID_BITMAP_FLAGS_ALPHA_PREMUL

Pixel components are premultiplied by alpha.

ANDROID_BITMAP_FLAGS_ALPHA_SHIFT

Shift for AndroidBitmapFormat.flags to isolate the alpha.

ANDROID_BITMAP_FLAGS_ALPHA_UNPREMUL

Pixel components are independent of alpha.

Anonymous Enum 23

Declared in android/bitmap.h 
 Anonymous Enum 23
Properties
ANDROID_BITMAP_FLAGS_IS_HARDWARE

If this bit is set in AndroidBitmapInfo.flags, the Bitmap uses the HARDWARE Config, and its AHardwareBuffer can be retrieved via AndroidBitmap_getHardwareBuffer.

AndroidBitmapCompressFormat

Declared in android/bitmap.h 
 AndroidBitmapCompressFormat

Specifies the formats that can be compressed to with AndroidBitmap_compress.

Properties
ANDROID_BITMAP_COMPRESS_FORMAT_JPEG

Compress to the JPEG format.

quality of 0 means compress for the smallest size. 100 means compress for max visual quality.

ANDROID_BITMAP_COMPRESS_FORMAT_PNG

Compress to the PNG format.

PNG is lossless, so quality is ignored.

ANDROID_BITMAP_COMPRESS_FORMAT_WEBP_LOSSLESS

Compress to the WEBP lossless format.

quality refers to how much effort to put into compression. A value of 0 means to compress quickly, resulting in a relatively large file size. 100 means to spend more time compressing, resulting in a smaller file.

ANDROID_BITMAP_COMPRESS_FORMAT_WEBP_LOSSY

Compress to the WEBP lossy format.

quality of 0 means compress for the smallest size. 100 means compress for max visual quality.

AndroidBitmapFormat

Declared in android/bitmap.h 
 AndroidBitmapFormat

Bitmap pixel format.

Properties
ANDROID_BITMAP_FORMAT_A_8

Alpha: 8 bits.

ANDROID_BITMAP_FORMAT_NONE

No format.

ANDROID_BITMAP_FORMAT_RGBA_1010102

Red: 10 bits, Green: 10 bits, Blue: 10 bits, Alpha: 2 bits.

ANDROID_BITMAP_FORMAT_RGBA_4444

Deprecated in API level 13.

Because of the poor quality of this configuration, it is advised to use ARGB_8888 instead.

ANDROID_BITMAP_FORMAT_RGBA_8888

Red: 8 bits, Green: 8 bits, Blue: 8 bits, Alpha: 8 bits.

ANDROID_BITMAP_FORMAT_RGBA_F16

Each component is stored as a half float.

ANDROID_BITMAP_FORMAT_RGB_565

Red: 5 bits, Green: 6 bits, Blue: 5 bits.

Typedefs

AHardwareBuffer

Declared in android/bitmap.h 
struct AHardwareBuffer AHardwareBuffer

AndroidBitmap_CompressWriteFunc

Declared in android/bitmap.h 
bool(* AndroidBitmap_CompressWriteFunc)(void *userContext, const void *data, size_t size)

User-defined function for writing the output of compression.

Available since API level 30.

Details
Parameters
userContext
Pointer to user-defined data passed to AndroidBitmap_compress.
data
Compressed data of size bytes to write.
size
Length in bytes of data to write.
Returns
Whether the operation succeeded.

Functions

AndroidBitmap_compress

Declared in android/bitmap.h 
int AndroidBitmap_compress(
  const AndroidBitmapInfo *info,
  int32_t dataspace,
  const void *pixels,
  int32_t format,
  int32_t quality,
  void *userContext,
  AndroidBitmap_CompressWriteFunc fn
)

Compress pixels as described by info.

Available since API level 30.

Details
Parameters
info
Description of the pixels to compress.
dataspace
ADataSpace describing the color space of the pixels.
pixels
Pointer to pixels to compress.
format
quality
Hint to the compressor, 0-100. The value is interpreted differently depending on the AndroidBitmapCompressFormat.
userContext
User-defined data which will be passed to the supplied AndroidBitmap_CompressWriteFunc each time it is called. May be null.
fn
Function that writes the compressed data. Will be called each time the compressor has compressed more data that is ready to be written. May be called more than once for each call to this method. May not be null.
Returns
AndroidBitmap functions result code.

AndroidBitmap_getDataSpace

Declared in android/bitmap.h 
int32_t AndroidBitmap_getDataSpace(
  JNIEnv *env,
  jobject jbitmap
)

Given a java bitmap object, return its ADataSpace.

Note that ADataSpace only exposes a few values. This may return ADATASPACE_UNKNOWN, even for Named ColorSpaces, if they have no corresponding ADataSpace.

Available since API level 30.

AndroidBitmap_getHardwareBuffer

Declared in android/bitmap.h 
int AndroidBitmap_getHardwareBuffer(
  JNIEnv *env,
  jobject bitmap,
  AHardwareBuffer **outBuffer
)

Retrieve the native object associated with a HARDWARE Bitmap.

Client must not modify it while a Bitmap is wrapping it.

Available since API level 30.

Details
Parameters
env
Handle to the JNI environment pointer.
bitmap
Handle to an android.graphics.Bitmap.
outBuffer
On success, is set to a pointer to the AHardwareBuffer associated with bitmap. This acquires a reference on the buffer, and the client must call AHardwareBuffer_release when finished with it.
Returns
AndroidBitmap functions result code. ANDROID_BITMAP_RESULT_BAD_PARAMETER if bitmap is not a HARDWARE Bitmap.

AndroidBitmap_getInfo

Declared in android/bitmap.h 
int AndroidBitmap_getInfo(
  JNIEnv *env,
  jobject jbitmap,
  AndroidBitmapInfo *info
)

Given a java bitmap object, fill out the AndroidBitmapInfo struct for it.

If the call fails, the info parameter will be ignored.

AndroidBitmap_lockPixels

Declared in android/bitmap.h 
int AndroidBitmap_lockPixels(
  JNIEnv *env,
  jobject jbitmap,
  void **addrPtr
)

Given a java bitmap object, attempt to lock the pixel address.

Locking will ensure that the memory for the pixels will not move until the unlockPixels call, and ensure that, if the pixels had been previously purged, they will have been restored.

If this call succeeds, it must be balanced by a call to AndroidBitmap_unlockPixels, after which time the address of the pixels should no longer be used.

If this succeeds, *addrPtr will be set to the pixel address. If the call fails, addrPtr will be ignored.

AndroidBitmap_unlockPixels

Declared in android/bitmap.h 
int AndroidBitmap_unlockPixels(
  JNIEnv *env,
  jobject jbitmap
)

Call this to balance a successful call to AndroidBitmap_lockPixels.