bitmap.h revision 31e575b4a93596d0b76059eae5e9464aed2d17ec 
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
32enum AndroidBitmapFormat {
33    ANDROID_BITMAP_FORMAT_NONE      = 0,
34    ANDROID_BITMAP_FORMAT_RGBA_8888 = 1,
35    ANDROID_BITMAP_FORMAT_RGB_565   = 4,
36    ANDROID_BITMAP_FORMAT_RGBA_4444 = 7,
37    ANDROID_BITMAP_FORMAT_A_8       = 8,
38};
39
40typedef struct {
41    uint32_t    width;
42    uint32_t    height;
43    uint32_t    stride;
44    int32_t     format;
45    uint32_t    flags;      // 0 for now
46} AndroidBitmapInfo;
47
48/**
49 * Given a java bitmap object, fill out the AndroidBitmap struct for it.
50 * If the call fails, the info parameter will be ignored
51 */
52int AndroidBitmap_getInfo(JNIEnv* env, jobject jbitmap,
53                          AndroidBitmapInfo* info);
54
55/**
56 * Given a java bitmap object, attempt to lock the pixel address.
57 * Locking will ensure that the memory for the pixels will not move
58 * until the unlockPixels call, and ensure that, if the pixels had been
59 * previously purged, they will have been restored.
60 *
61 * If this call succeeds, it must be balanced by a call to
62 * AndroidBitmap_unlockPixels, after which time the address of the pixels should
63 * no longer be used.
64 *
65 * If this succeeds, *addrPtr will be set to the pixel address. If the call
66 * fails, addrPtr will be ignored.
67 */
68int AndroidBitmap_lockPixels(JNIEnv* env, jobject jbitmap, void** addrPtr);
69
70/**
71 * Call this to balanace a successful call to AndroidBitmap_lockPixels
72 */
73int AndroidBitmap_unlockPixels(JNIEnv* env, jobject jbitmap);
74
75#ifdef __cplusplus
76}
77#endif
78
79#endif
80