Skip to content

Commit

Permalink
Tweak docs
Browse files Browse the repository at this point in the history
  • Loading branch information
capehill committed Jul 28, 2019
2 parents fb08e2c + 63d94b5 commit 05d8820
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 19 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,16 @@ glSnoop supports partial logging of:
- ogles2.library
- Warp3DNova.library

Pausing stops the serial logging of functions until resumed.

## Profiling

glSnoop records the call count and duration of known OGLES2
glSnoop records the call count and duration of known OpenGL ES 2.0
and Warp3D Nova functions. Profiling summaries are logged when
contexts are being destroyed, or when user stops profiling manually
using the GUI. Restarting profiling clears the current statistics.
contexts are being destroyed, or when user finishes profiling manually
using the GUI. Re-starting profiling clears the current statistics.

Time spent inside OGLES2 functions includes also time spent
Time spent inside OpenGL ES 2.0 functions includes also time spent
inside Warp3D Nova functions.

## Filtering
Expand All @@ -27,17 +29,12 @@ functions. This produces less logs and is faster. Filtering
impacts also profiling, because non-patched functions
cannot be profiled either.

## Pausing

Pausing stops the serial logging until resumed. It doesn't impact
profiling currently.

## Command-line parameters

- OGLES2: enable ogles2.library tracing
- NOVA: enable Warp3DNova.library tracing
- OGLES2: enable ogles2.library tracing and profiling
- NOVA: enable Warp3DNova.library tracing and profiling
- GUI: launch the graphical user interface
- PROFILE: disable function tracing in serial logs
- PROFILE: disable function tracing in serial logs but keep profiling stats
- FILTER filename: define a subset of patched functions

## Tips
Expand Down
14 changes: 7 additions & 7 deletions glSnoop.guide
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
@{B}What is glSnoop for and what it does@{UB}

glSnoop is an experimental graphics API tracing and profiling tool for AmigaOS4.
It is born as an attempt to bring something like @{B}apitrace@{UB}, but written from scratch
It was born as an attempt to bring something like @{B}apitrace@{UB}, but written from scratch
and AmigaOS4 specific.

At the moment only ogles2.library and Warp3DNova.library are supported.
Expand Down Expand Up @@ -53,7 +53,7 @@
@{B} How to use@{UB}

glSnoop operates in two modes: Command-line one and GUI one.
Command-line mode is that one which glSnoop use by default, and for GUI one you provide GUI argument.
Command-line mode is the default mode, and GUI can be started with @{B}GUI@{UB} argument.
The difference between command-line and GUI mode is that in GUI mode you can pause/stop tracing & profiling
Both modes described in appropriate sections.

Expand All @@ -67,11 +67,11 @@

@{B} OGLES2@{UB}

Enable ogles2.library tracing
Enable ogles2.library tracing and profiling

@{B} NOVA@{UB}

Enable Warp3DNova.library tracing
Enable Warp3DNova.library tracing and profiling

@{B} GUI@{UB}

Expand All @@ -92,7 +92,7 @@
FILTER filename: define a subset of patched functions


By default glSnoop running with OGLES2 and Warp3DNova tracing enabled, while GUI and function's filtering disabled.
By default glSnoop is running with OpenGL ES 2.0 and Warp3D Nova tracing enabled, while GUI and function filtering are disabled.

@endnode

Expand All @@ -119,10 +119,10 @@

@{B}Profiling@{UB}

glSnoop records the call count and duration of known OGLES2 and Warp3D Nova functions.
glSnoop records the call count and duration of known OpenGL ES 2.0 and Warp3D Nova functions.
Profiling summaries are logged when contexts are being destroyed.

Time spent inside OGLES2 functions includes also time spent inside Warp3D Nova functions.
Time spent inside OpenGL ES 2.0 functions includes also time spent inside Warp3D Nova functions.

@endnode

Expand Down

0 comments on commit 05d8820

Please sign in to comment.