aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndre Weissflog <floooh@gmail.com>2019-03-05 18:20:17 +0100
committerGitHub <noreply@github.com>2019-03-05 18:20:17 +0100
commit04bbb7ac588db2a65064575dbedca9042d2c039e (patch)
treee6e0e90d0d464fac471cfecc002f3f1a26016aa8 /README.md
parent6570419898b72337c619be1d0f3cd66350ddc7a5 (diff)
Debugging UI extension headers via Dear ImGui (#125)
This PR adds optional debugging UI extension headers (or rather: currently only one for sokol_gfx.h called sokol_gfx_imgui.h). sokol_gfx.h gets a new API function to install callback functions for tracing the public sokol_gfx.h API calls.
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5c658f95..e97b1624 100644
--- a/README.md
+++ b/README.md
@@ -407,6 +407,20 @@ Mainly some "missing features" for desktop apps:
# Updates
+- **05-Mar-2019**: sokol_gfx.h now has a 'trace hook' API, and I have started
+implementing optional debug-inspection-UI headers on top of Dear ImGui:
+ - sokol_gfx.h has a new function sg_install_trace_hook(), this allows
+ you to install a callback function for each public sokol_gfx.h function
+ (and a couple or error callbacks). For more details, search for "TRACE HOOKS"
+ in sokol_gfx.h
+ - I have started a new 'subproject' in the 'imgui' directory, this will
+ contain a slowly growing set of optional debug-inspection-UI headers
+ which allow to peek under the hood of the Sokol headers. The UIs are
+ implemented with [Dear ImGui](https://github.com/ocornut/imgui). Again,
+ see the README in the 'imgui' directory and the headers in there
+ for details, and check out the live demos on the [Sokol Sample Webpage](https://floooh.github.io/sokol-html5/)
+ (click on the little UI buttons in the top right corner of each thumbnail)
+
- **21-Feb-2019**: sokol_app.h and sokol_audio.h now have an alternative
set of callbacks with user_data arguments. This is useful if you don't
want or cannot store your own application state in global variables.