Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 128 lines (75 sloc) 3.339 kb
0b21731 @jrfonseca Use markdown syntax.
jrfonseca authored
1 Things To Do
2 ============
44d2764 @jrfonseca Add to do list.
jrfonseca authored
3
0b21731 @jrfonseca Use markdown syntax.
jrfonseca authored
4 (in no particular order)
44d2764 @jrfonseca Add to do list.
jrfonseca authored
5
0b21731 @jrfonseca Use markdown syntax.
jrfonseca authored
6
7 Tracing
8 -------
c5d265c @jrfonseca Update docs.
jrfonseca authored
9
d5de170 @jrfonseca Add more to do items; reorganize.
jrfonseca authored
10 * Allow clamping to a GL version or a number of extensions.
73ed1d8 @jrfonseca Ignore alpha channel.
jrfonseca authored
11
39ffcb4 @jrfonseca Update to-do.
jrfonseca authored
12 * Put (de)compression in a separate thread.
c5d265c @jrfonseca Update docs.
jrfonseca authored
13
44d2764 @jrfonseca Add to do list.
jrfonseca authored
14 * Trace TSCs
15
d5de170 @jrfonseca Add more to do items; reorganize.
jrfonseca authored
16 * Trace window sizes somehow
17
18 * Allow to distinguish between the calls really done by the program, vs the
19 fakes one necessary to retrace correctly.
20
21 * Start tracing on demand (e.g., key-press, or by frame no), emitting calls
22 that recreate all current state.
23
c329991 @jrfonseca Add a to-do note about GLU.
jrfonseca authored
24 * Add option to include call stack frames in the trace.
25
26 * Trace the internal GL calls done by GLU on Mac OS X & Windows.
d5de170 @jrfonseca Add more to do items; reorganize.
jrfonseca authored
27
28
0b21731 @jrfonseca Use markdown syntax.
jrfonseca authored
29 Retracing
30 ---------
d5de170 @jrfonseca Add more to do items; reorganize.
jrfonseca authored
31
32 * Use visuals that best match those used in the trace; specially auto
33 detect single/double buffer visuals.
34
e54f8a4 @jrfonseca Update to-do.
jrfonseca authored
35 * Respect multiple context sharing of the traces.
d5de170 @jrfonseca Add more to do items; reorganize.
jrfonseca authored
36
37 * Support multiple threads
44d2764 @jrfonseca Add to do list.
jrfonseca authored
38
2f634d5 @jrfonseca Document known issues.
jrfonseca authored
39 * Leverage `ARB_debug_output` where available.
44d2764 @jrfonseca Add to do list.
jrfonseca authored
40
d5de170 @jrfonseca Add more to do items; reorganize.
jrfonseca authored
41 * D3D support.
42
43
0b21731 @jrfonseca Use markdown syntax.
jrfonseca authored
44 GUI
45 ---
d5de170 @jrfonseca Add more to do items; reorganize.
jrfonseca authored
46
47 * Timeline view.
48
49 * Visualize meshes in draw commands.
50
dc86bfd @jrfonseca Update to-do list.
jrfonseca authored
51 * Breakpointing and step-by-step debugging.
52
39ffcb4 @jrfonseca Update to-do.
jrfonseca authored
53
33b8ba3 @cworth-gh TODO: Add some notes on additions we want to the command-line interface
cworth-gh authored
54 CLI
55 ---
56
57 * Add retrace Replay all the calls in a trace
58 * Add dump-state Output the OpenGL state in JSON format
59 * Add dump-images Create image files for each frame/drawing operation of a trace
60
61 * Add some common command-line options:
62
63 Most commands acting on a trace accept the following common options:
64
65 --calls=[RANGE] Operate only on calls with index numbers within
66 the specified range.
67
68 --frames=[RANGE] Operate only on frames with index numbers within
69 the specified range.
70
71 --functions=[REGEXP] Operate only on function calls which have a
72 name that matches the given regular expression.
73
74 A [RANGE] can be any of the following:
75
76 Example Description
77 ------- -----------
78 4 A single number specifying a single call or frame.
79
80 10-20 Two numbers separated by '-' (FIRST-LAST) specifying a
81 range of consecutive calls/frames from FIRST to LAST. If
82 either of FIRST or LAST is omitted, the first or last
83 call/frame index in the trace will be used.
84
30d24d9 @cworth-gh TODO: Fix typo in the description of the range specification.
cworth-gh authored
85 1-100/5 Either of the above range specifications followed by '/'
33b8ba3 @cworth-gh TODO: Add some notes on additions we want to the command-line interface
cworth-gh authored
86 and a number (INTERVAL). This specifies the inclusion of
87 only each INTERVAL call/frame within the range. For
30d24d9 @cworth-gh TODO: Fix typo in the description of the range specification.
cworth-gh authored
88 example, 1-100/5 species frame 1, frame 5, frame 10,
33b8ba3 @cworth-gh TODO: Add some notes on additions we want to the command-line interface
cworth-gh authored
89 ... up to frame 100.
90
91 4,10-20/2 A comma separated list of any of the above range
92 specifications, specifying the union of the ranges.
93
94 * Add some retrace-specific options (-b, -db, -sb, -v)
95
96 * Add some trime-specific options (--every={draw,framebuffer,frame})
97
98 * Accept a filename for --calls or --functions (to use the same calls
99 or functions as present in a trace dump).
100
101 * Add an "apitrace bisect" for trimming down a trace based on user
102 input at each stage.
103
104 * Add an "apitrace git-bisect-helper" for calling from git-bisect.
105
d5de170 @jrfonseca Add more to do items; reorganize.
jrfonseca authored
106
38e72c6 @jrfonseca Update To-DO
jrfonseca authored
107 Other
108 -----
d5de170 @jrfonseca Add more to do items; reorganize.
jrfonseca authored
109
110 * Side-by-side trace diffing; either as a separate tool on or the GUI.
111
112 * Ability to extract just a single frame from a trace, and all previous calls
113 that contributed to it:
114
115 * via a state tracker (i.e., knowledge of how calls affect the state);
116
117 * or by leveragine retrace, dumping the calls to emit all state at beginning
118 of the frame.
119
120
2f634d5 @jrfonseca Document known issues.
jrfonseca authored
121 See also:
122
123 * open issues on [github](https://github.com/apitrace/apitrace/issues)
124
125 * _Known issues_ section in BUGS.markdown
126
127 * FIXME, TODO, and XXX comments on the source code.
Something went wrong with that request. Please try again.