Merge commit 'origin/master' into gallium-0.2
[mesa.git] / src / gallium / drivers / trace / README
1 TRACE PIPE DRIVER
2
3
4 = About =
5
6 This directory contains a Gallium3D pipe driver which traces all incoming calls.
7
8
9 = Build Instructions =
10
11 To build, invoke scons on the top dir as
12
13 scons statetrackers=mesa drivers=softpipe,i965simple,trace winsys=xlib
14
15
16 = Usage =
17
18 To use do
19
20 ln -s libGL.so build/linux-x86-debug/gallium/winsys/xlib/libGL.so.1
21 export LD_LIBRARY_PATH=$PWD/build/linux-x86-debug/gallium/winsys/xlib
22
23 ensure the right libGL.so is being picked by doing
24
25 ldd progs/trivial/tri
26
27 and then try running
28
29 GALLIUM_TRACE=tri.trace progs/trivial/tri
30
31 which should create a tri.trace file, which is an XML file. You can view copying
32 trace.xsl to the same directory, and opening with a XSLT capable browser such as
33 Firefox or Internet Explorer.
34
35
36 = Integrating =
37
38 You can integrate the trace pipe driver either inside the state tracker or the
39 winsys. The procedure on both cases is the same. Let's assume you have a
40 pipe_screen and a pipe_context pair obtained by the usual means (variable and
41 function names are just for illustration purposes):
42
43 real_screen = real_screen_create(...);
44
45 real_context = real_context_create(...);
46
47 The trace screen and pipe_context is then created by doing
48
49 trace_screen = trace_screen_create(real_screen);
50
51 trace_context = trace_context_create(trace_screen, real_context);
52
53 You can then simply use trace_screen and trace_context instead of real_screen
54 and real_context.
55
56 Do not call trace_winsys_create. Simply pass trace_screen->winsys or
57 trace_context->winsys in places you would pass winsys.
58
59 You can create as many contexts you wish. Just ensure that you don't mistake
60 trace_screen with real_screen when creating them.
61
62
63 --
64 Jose Fonseca <jrfonseca@tungstengraphics.com>