Home | History | Annotate | Download | only in minui
      1 /*
      2  * Copyright (C) 2007 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 _MINUI_H_
     18 #define _MINUI_H_
     19 
     20 #include <sys/types.h>
     21 
     22 #include <stdbool.h>
     23 
     24 #ifdef __cplusplus
     25 extern "C" {
     26 #endif
     27 
     28 typedef struct {
     29     int width;
     30     int height;
     31     int row_bytes;
     32     int pixel_bytes;
     33     unsigned char* data;
     34 } GRSurface;
     35 
     36 typedef GRSurface* gr_surface;
     37 
     38 int gr_init(void);
     39 void gr_exit(void);
     40 
     41 int gr_fb_width(void);
     42 int gr_fb_height(void);
     43 
     44 void gr_flip(void);
     45 void gr_fb_blank(bool blank);
     46 
     47 void gr_clear();  // clear entire surface to current color
     48 void gr_color(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
     49 void gr_fill(int x1, int y1, int x2, int y2);
     50 void gr_text(int x, int y, const char *s, int bold);
     51 void gr_texticon(int x, int y, gr_surface icon);
     52 int gr_measure(const char *s);
     53 void gr_font_size(int *x, int *y);
     54 
     55 void gr_blit(gr_surface source, int sx, int sy, int w, int h, int dx, int dy);
     56 unsigned int gr_get_width(gr_surface surface);
     57 unsigned int gr_get_height(gr_surface surface);
     58 
     59 // input event structure, include <linux/input.h> for the definition.
     60 // see http://www.mjmwired.net/kernel/Documentation/input/ for info.
     61 struct input_event;
     62 
     63 typedef int (*ev_callback)(int fd, uint32_t epevents, void *data);
     64 typedef int (*ev_set_key_callback)(int code, int value, void *data);
     65 
     66 int ev_init(ev_callback input_cb, void *data);
     67 void ev_exit(void);
     68 int ev_add_fd(int fd, ev_callback cb, void *data);
     69 int ev_sync_key_state(ev_set_key_callback set_key_cb, void *data);
     70 
     71 /* timeout has the same semantics as for poll
     72  *    0 : don't block
     73  *  < 0 : block forever
     74  *  > 0 : block for 'timeout' milliseconds
     75  */
     76 int ev_wait(int timeout);
     77 
     78 int ev_get_input(int fd, uint32_t epevents, struct input_event *ev);
     79 void ev_dispatch(void);
     80 int ev_get_epollfd(void);
     81 
     82 // Resources
     83 
     84 // res_create_*_surface() functions return 0 if no error, else
     85 // negative.
     86 //
     87 // A "display" surface is one that is intended to be drawn to the
     88 // screen with gr_blit().  An "alpha" surface is a grayscale image
     89 // interpreted as an alpha mask used to render text in the current
     90 // color (with gr_text() or gr_texticon()).
     91 //
     92 // All these functions load PNG images from "/res/images/${name}.png".
     93 
     94 // Load a single display surface from a PNG image.
     95 int res_create_display_surface(const char* name, gr_surface* pSurface);
     96 
     97 // Load an array of display surfaces from a single PNG image.  The PNG
     98 // should have a 'Frames' text chunk whose value is the number of
     99 // frames this image represents.  The pixel data itself is interlaced
    100 // by row.
    101 int res_create_multi_display_surface(const char* name,
    102                                      int* frames, gr_surface** pSurface);
    103 
    104 // Load a single alpha surface from a grayscale PNG image.
    105 int res_create_alpha_surface(const char* name, gr_surface* pSurface);
    106 
    107 // Load part of a grayscale PNG image that is the first match for the
    108 // given locale.  The image is expected to be a composite of multiple
    109 // translations of the same text, with special added rows that encode
    110 // the subimages' size and intended locale in the pixel data.  See
    111 // development/tools/recovery_l10n for an app that will generate these
    112 // specialized images from Android resources.
    113 int res_create_localized_alpha_surface(const char* name, const char* locale,
    114                                        gr_surface* pSurface);
    115 
    116 // Free a surface allocated by any of the res_create_*_surface()
    117 // functions.
    118 void res_free_surface(gr_surface surface);
    119 
    120 #ifdef __cplusplus
    121 }
    122 #endif
    123 
    124 #endif
    125