Skip to content

Commit

Permalink
Add per-directory synopsis.
Browse files Browse the repository at this point in the history
  • Loading branch information
jrfonseca committed Mar 27, 2013
1 parent 04b70cf commit 6bb028d
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 0 deletions.
1 change: 1 addition & 0 deletions cli/README.markdown
@@ -0,0 +1 @@
Implementation of the `apitrace` command line interface.
9 changes: 9 additions & 0 deletions dispatch/README.markdown
@@ -0,0 +1,9 @@
The dispatch layer objecting is to get public or private symbols from DLLs /
shared objects and dispatch calls to them.

It used both by the tracing wrappers (to dispatch the intercepted calls to
their true counterparts) and when replaying traces (to dispatch the calls
recorded on the file)

All code is generated from dispatch.py Python script, which is then used in
several places.
1 change: 1 addition & 0 deletions gui/README.markdown
@@ -0,0 +1 @@
Implementation of the `qapitrace` Qt-based GUI for apitrace.
5 changes: 5 additions & 0 deletions helpers/README.markdown
@@ -0,0 +1,5 @@
This directory contains several headers with inline functions that are referred
in the specs for determining array/sizes.

These are used both when tracing and replaying so care must be taken not to
make any assumptions.
2 changes: 2 additions & 0 deletions image/README.markdown
@@ -0,0 +1,2 @@
This directory contains class to represent and manipulate images, in memory or
disk.
5 changes: 5 additions & 0 deletions inject/README.markdown
@@ -0,0 +1,5 @@
Utilities for injection of DLLs in Windows.

Wrapper DLLs work well for self-contained APIs (e.g., OpenGL with its
opengl32.dll), but not for APIs which are spread across multiple DLLs, in
particular DXGI and D3D10+ APIs.
9 changes: 9 additions & 0 deletions retrace/README.markdown
@@ -0,0 +1,9 @@
The source for replaying retraces lives in this directory.

There are actually several discting layers in this directory which should be eventually be split out:

- `*`retrace -- deserialization and interpretation of calls from a trace

- `*`ws -- windowing system helpers and abstractions

- `*`state -- dumping of state into JSON format
7 changes: 7 additions & 0 deletions specs/README.markdown
@@ -0,0 +1,7 @@
This directory contains specification of several APIs in a Python class
hierarchy.

The base classes of this hierarchy are in stdapi.py.

Some of this specifications are (partially) generated from other external
specifications, by scripts in the scripts subdirectory.
5 changes: 5 additions & 0 deletions wrappers/README.markdown
@@ -0,0 +1,5 @@
This directory contains the source for the generation of wrapper DLLs or
preload shared-objects.

The cmake targets have names different from the true DLLs/shared-objects to
prevent collision when trying to link against the true ones.

0 comments on commit 6bb028d

Please sign in to comment.