rbug: Update and add READMEs
[mesa.git] / src / gallium / drivers / rbug / README
1 RBUG PIPE DRIVER
2
3
4 = About =
5
6 This directory contains a Gallium3D remote debugger pipe driver.
7 It provides remote debugging functionality.
8
9
10 = Build Instructions =
11
12 To build, invoke scons on the top dir as
13
14 scons dri=no statetrackers=mesa winsys=xlib
15
16
17 = Usage =
18
19 To use do
20
21 export LD_LIBRARY_PATH=$PWD/build/linux-x86-debug/lib
22
23 ensure the right libGL.so is being picked by doing
24
25 ldd progs/trivial/tri
26
27 export XMESA_TRACE=y
28 GALLIUM_RBUG=true progs/trivial/tri
29
30 which should open gallium remote debugging session. While the program is running
31 you can launch the small remote debugging application from progs/rbug. More
32 information is in that directory. Also for a gui see:
33
34 http://cgit.freedesktop.org/mesa/rbug-gui
35
36
37 = Integrating =
38
39 You can integrate the rbug pipe driver either inside the state tracker or the
40 target. The procedure on both cases is the same. Let's assume you have a
41 pipe_screen obtained by the usual means (variable and function names are just
42 for illustration purposes):
43
44 real_screen = real_screen_create(...);
45
46 The rbug screen is then created by doing
47
48 rbug_screen = rbug_screen_create(real_screen);
49
50 You can then simply use rbug_screen instead of real_screen.
51
52 You can create as many contexts you wish from rbug_screen::context_create they
53 are automatically wrapped by rbug_screen.
54
55
56 --
57 Jose Fonseca <jrfonseca@tungstengraphics.com>
58 Jakob Bornecrantz <jakob@vmware.com>