git.cworth.org Git - apitrace/blob - TODO.markdown

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