113 lines
3.2 KiB
C
113 lines
3.2 KiB
C
/*
|
|
* Copyright (C) 2009 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup Bitmap
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @file bitmap.h
|
|
*/
|
|
|
|
#ifndef ANDROID_BITMAP_H
|
|
#define ANDROID_BITMAP_H
|
|
|
|
#include <stdint.h>
|
|
#include <jni.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** AndroidBitmap functions result code. */
|
|
enum {
|
|
/** Operation was successful. */
|
|
ANDROID_BITMAP_RESULT_SUCCESS = 0,
|
|
/** Bad parameter. */
|
|
ANDROID_BITMAP_RESULT_BAD_PARAMETER = -1,
|
|
/** JNI exception occured. */
|
|
ANDROID_BITMAP_RESULT_JNI_EXCEPTION = -2,
|
|
/** Allocation failed. */
|
|
ANDROID_BITMAP_RESULT_ALLOCATION_FAILED = -3,
|
|
};
|
|
|
|
/** Backward compatibility: this macro used to be misspelled. */
|
|
#define ANDROID_BITMAP_RESUT_SUCCESS ANDROID_BITMAP_RESULT_SUCCESS
|
|
|
|
/** Bitmap pixel format. */
|
|
enum AndroidBitmapFormat {
|
|
/** No format. */
|
|
ANDROID_BITMAP_FORMAT_NONE = 0,
|
|
/** Red: 8 bits, Green: 8 bits, Blue: 8 bits, Alpha: 8 bits. **/
|
|
ANDROID_BITMAP_FORMAT_RGBA_8888 = 1,
|
|
/** Red: 5 bits, Green: 6 bits, Blue: 5 bits. **/
|
|
ANDROID_BITMAP_FORMAT_RGB_565 = 4,
|
|
/** Red: 4 bits, Green: 4 bits, Blue: 4 bits, Alpha: 4 bits. **/
|
|
ANDROID_BITMAP_FORMAT_RGBA_4444 = 7,
|
|
/** Deprecated. */
|
|
ANDROID_BITMAP_FORMAT_A_8 = 8,
|
|
};
|
|
|
|
/** Bitmap info, see AndroidBitmap_getInfo(). */
|
|
typedef struct {
|
|
/** The bitmap width in pixels. */
|
|
uint32_t width;
|
|
/** The bitmap height in pixels. */
|
|
uint32_t height;
|
|
/** The number of byte per row. */
|
|
uint32_t stride;
|
|
/** The bitmap pixel format. See {@link AndroidBitmapFormat} */
|
|
int32_t format;
|
|
/** Unused. */
|
|
uint32_t flags; // 0 for now
|
|
} AndroidBitmapInfo;
|
|
|
|
/**
|
|
* Given a java bitmap object, fill out the AndroidBitmapInfo struct for it.
|
|
* If the call fails, the info parameter will be ignored.
|
|
*/
|
|
int AndroidBitmap_getInfo(JNIEnv* env, jobject jbitmap,
|
|
AndroidBitmapInfo* info);
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
int AndroidBitmap_lockPixels(JNIEnv* env, jobject jbitmap, void** addrPtr);
|
|
|
|
/**
|
|
* Call this to balance a successful call to AndroidBitmap_lockPixels.
|
|
*/
|
|
int AndroidBitmap_unlockPixels(JNIEnv* env, jobject jbitmap);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|
|
/** @} */
|