bitmap.h revision 370980c52867864e1b0acd9f132e527fb6b2adee 
1/*
2 * Copyright (C) 2009 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ANDROID_BITMAP_H
18#define ANDROID_BITMAP_H
19
20#include <stdint.h>
21#include <jni.h>
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27#define ANDROID_BITMAP_RESULT_SUCCESS            0
28#define ANDROID_BITMAP_RESULT_BAD_PARAMETER     -1
29#define ANDROID_BITMAP_RESULT_JNI_EXCEPTION     -2
30#define ANDROID_BITMAP_RESULT_ALLOCATION_FAILED -3
31
32/* Backward compatibility: this macro used to be misspelled. */
33#define ANDROID_BITMAP_RESUT_SUCCESS ANDROID_BITMAP_RESULT_SUCCESS
34
35enum AndroidBitmapFormat {
36    ANDROID_BITMAP_FORMAT_NONE      = 0,
37    ANDROID_BITMAP_FORMAT_RGBA_8888 = 1,
38    ANDROID_BITMAP_FORMAT_RGB_565   = 4,
39    ANDROID_BITMAP_FORMAT_RGBA_4444 = 7,
40    ANDROID_BITMAP_FORMAT_A_8       = 8,
41};
42
43typedef struct {
44    uint32_t    width;
45    uint32_t    height;
46    uint32_t    stride;
47    int32_t     format;
48    uint32_t    flags;      // 0 for now
49} AndroidBitmapInfo;
50
51/**
52 * Given a java bitmap object, fill out the AndroidBitmap struct for it.
53 * If the call fails, the info parameter will be ignored
54 */
55int AndroidBitmap_getInfo(JNIEnv* env, jobject jbitmap,
56                          AndroidBitmapInfo* info);
57
58/**
59 * Given a java bitmap object, attempt to lock the pixel address.
60 * Locking will ensure that the memory for the pixels will not move
61 * until the unlockPixels call, and ensure that, if the pixels had been
62 * previously purged, they will have been restored.
63 *
64 * If this call succeeds, it must be balanced by a call to
65 * AndroidBitmap_unlockPixels, after which time the address of the pixels should
66 * no longer be used.
67 *
68 * If this succeeds, *addrPtr will be set to the pixel address. If the call
69 * fails, addrPtr will be ignored.
70 */
71int AndroidBitmap_lockPixels(JNIEnv* env, jobject jbitmap, void** addrPtr);
72
73/**
74 * Call this to balanace a successful call to AndroidBitmap_lockPixels
75 */
76int AndroidBitmap_unlockPixels(JNIEnv* env, jobject jbitmap);
77
78#ifdef __cplusplus
79}
80#endif
81
82#endif
83