handle src buffer underflow corner cases
[sdl_omap.git] / README.PicoGUI
1  ========================
2   Using SDL with PicoGUI
3  ========================
4
5 - Originally contributed by Micah Dowty <micahjd@users.sourceforge.net>
6
7 PicoGUI is a scalable GUI system with a unique architecture, primarily focused
8 on scalability to various embedded systems. You can find more information
9 including a FAQ at http://picogui.org
10
11 To use the patch:
12
13   1. When compiling, add the "--enable-video-picogui" switch to ./configure
14
15   2. When running your program, ensure that the picogui driver for SDL
16      is in use by setting the SDL_VIDEODRIVER environment variable 
17      to "picogui".
18
19   3. The program must also be linked to the C client library for PicoGUI
20      (libpgui.so). If the program is being compiled with a patched SDL 
21      installed this should be done automatically. If you want to use an
22      existing binary with PicoGUI, you can set the LD_PRELOAD environment
23      variable to the path of your libpgui.so file.
24
25 Capabilities:
26
27   So far only basic functionality is provided on true color (linear16/24/32)
28   devices. Accessing a memory mapped bitmap, updating the display, and handling
29   mouse/keyboard input. This functionality has been tested with several
30   applications, including mplayer, Xine, sldroids, and Abuse.
31
32 TODO list:
33
34   - YUV overlays will be helpful for watching video on set top boxes or other
35     embedded devices that have some graphics acceleration hardware
36
37   - Account for rotated bitmap storage in pgserver
38
39   - Support for hiding or changing the cursor
40
41   - The display should be centered when the SDL application is smaller
42     than the PicoGUI panel
43
44   - Fullscreen or any other special modes
45
46   - Support for indexed and grayscale modes
47
48   - Probably much more...
49
50 --- The End ---