annotate README.DirectFB @ 5206:25ffd4e5255c

Minor consistency cleanup and documentation link update.
author Sam Lantinga <slouken@libsdl.org>
date Sun, 06 Feb 2011 00:48:41 -0800
parents 164f20ba08eb
children
rev   line source
2226
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
1 SDL on DirectFB
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
2
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
3 Supports:
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
4
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
5 - Hardware YUV overlays
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
6 - OpenGL - software only
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
7 - 2D/3D accelerations (depends on directfb driver)
2815
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
8 - multiple displays
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
9 - windows
2226
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
10
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
11 What you need:
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
12
2815
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
13 DirectFB 1.0.1, 1.2.x, 1.3.0
2226
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
14 Kernel-Framebuffer support: required: vesafb, radeonfb ....
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
15 Mesa 7.0.x - optional for OpenGL
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
16
2815
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
17 /etc/directfbrc
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
18
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
19 This file should contain the following lines to make
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
20 your joystick work and avoid crashes:
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
21 ------------------------
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
22 disable-module=joystick
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
23 disable-module=cle266
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
24 disable-module=cyber5k
2998
d364ee9b9c15 Date: Sun, 04 Jan 2009 20:53:30 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2815
diff changeset
25 no-linux-input-grab
2815
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
26 ------------------------
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
27
2998
d364ee9b9c15 Date: Sun, 04 Jan 2009 20:53:30 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2815
diff changeset
28 To disable to use x11 backend when DISPLAY variable is found use
d364ee9b9c15 Date: Sun, 04 Jan 2009 20:53:30 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2815
diff changeset
29
d364ee9b9c15 Date: Sun, 04 Jan 2009 20:53:30 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2815
diff changeset
30 export SDL_DIRECTFB_X11_CHECK=0
d364ee9b9c15 Date: Sun, 04 Jan 2009 20:53:30 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2815
diff changeset
31
d364ee9b9c15 Date: Sun, 04 Jan 2009 20:53:30 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2815
diff changeset
32 To disable the use of linux input devices, i.e. multimice/multikeyboard support,
d364ee9b9c15 Date: Sun, 04 Jan 2009 20:53:30 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2815
diff changeset
33 use
d364ee9b9c15 Date: Sun, 04 Jan 2009 20:53:30 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2815
diff changeset
34
d364ee9b9c15 Date: Sun, 04 Jan 2009 20:53:30 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2815
diff changeset
35 export SDL_DIRECTFB_LINUX_INPUT=0
d364ee9b9c15 Date: Sun, 04 Jan 2009 20:53:30 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2815
diff changeset
36
2815
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
37 To use hardware accelerated YUV-overlays for YUV-textures, use:
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
38
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
39 export SDL_DIRECTFB_YUV_DIRECT=1
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
40
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
41 This is disabled by default. It will only support one
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
42 YUV texture, namely the first. Every other YUV texture will be
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
43 rendered in software.
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
44
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
45 In addition, you may use (directfb-1.2.x)
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
46
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
47 export SDL_DIRECTFB_YUV_UNDERLAY=1
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
48
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
49 to make the YUV texture an underlay. This will make the cursor to
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
50 be shown.
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
51
3023
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
52 Simple Window Manager
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
53 =====================
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
54
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
55 The driver has support for a very, very basic window manager you may
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
56 want to use when runnning with "wm=default". Use
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
57
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
58 export SDL_DIRECTFB_WM=1
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
59
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
60 to enable basic window borders. In order to have the window title rendered,
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
61 you need to have the following font installed:
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
62
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
63 /usr/share/fonts/truetype/freefont/FreeSans.ttf
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 2998
diff changeset
64
2815
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
65 OPENGL Support
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
66 ==============
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
67
4636
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
68 The following instructions will give you *software* opengl. However this
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
69 works at least on all directfb supported platforms.
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
70
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
71 As of this writing 20100802 you need to pull Mesa from git and do the following:
2226
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
72
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
73 ------------------------
5202
164f20ba08eb Updated the DirectFB support, from Couriersud
Sam Lantinga <slouken@libsdl.org>
parents: 4636
diff changeset
74 git clone git://anongit.freedesktop.org/git/mesa/mesa
2226
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
75 cd mesa
5202
164f20ba08eb Updated the DirectFB support, from Couriersud
Sam Lantinga <slouken@libsdl.org>
parents: 4636
diff changeset
76 git checkout 2c9fdaf7292423c157fc79b5ce43f0f199dd753a
4636
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
77 ------------------------
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
78
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
79 Edit configs/linux-directfb so that the Directories-section looks like
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
80 ------------------------
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
81 # Directories
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
82 SRC_DIRS = mesa glu
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
83 GLU_DIRS = sgi
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
84 DRIVER_DIRS = directfb
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
85 PROGRAM_DIRS =
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
86 ------------------------
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
87
2226
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
88 make linux-directfb
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
89 make
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
90
2815
e759ad5e6f43 Date: Mon, 01 Dec 2008 00:57:15 +0100
Sam Lantinga <slouken@libsdl.org>
parents: 2791
diff changeset
91 echo Installing - please enter sudo pw.
2226
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
92
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
93 sudo make install INSTALL_DIR=/usr/local/dfb_GL
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
94 cd src/mesa/drivers/directfb
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
95 make
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
96 sudo make install INSTALL_DIR=/usr/local/dfb_GL
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
97 ------------------------
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
98
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
99 To run the SDL - testprograms:
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
100
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
101 export SDL_VIDEODRIVER=directfb
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
102 export LD_LIBRARY_PATH=/usr/local/dfb_GL/lib
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
103 export LD_PRELOAD=/usr/local/dfb_GL/libGL.so.7
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
104
0e70b4b8cf84 Date: Sat, 11 Aug 2007 02:03:16 +0200 (CEST)
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
105 ./testgl
4636
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
106