Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/wolfpld/tracy.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBartosz Taudul <wolf.pld@gmail.com>2018-06-22 21:53:17 +0300
committerBartosz Taudul <wolf.pld@gmail.com>2018-06-22 21:53:27 +0300
commit4d60d3a20e437477effc0b9fe6e4e99e243e590e (patch)
treee2ff387754fca3e64cdb4a8ed74981018ce6a827 /README.md
parent17194cb5918c850e000368d46f512a3dc6a1f66c (diff)
Document callstack capture.
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9b9351bd..f5e2b854 100644
--- a/README.md
+++ b/README.md
@@ -137,6 +137,10 @@ To mark a GPU zone use the `TracyVkZone( cmdbuf, name )` macro, where `name` is
You also need to periodically collect the GPU events using the `TracyVkCollect( cmdbuf )` macro. The provided command buffer must be in the recording state and outside of a render pass instance.
+#### Collecting call stacks
+
+Tracy can capture true calls stacks on selected platforms (Windows, Linux, Android). It can be performed by using macros with the `S` postfix, which require an additional parameter, specifying the depth of call stack to be captured. The greater the depth, the longer it will take to do capture. Currently you can use the following macros: `ZoneScopedS`, `ZoneScopedNS`, `ZoneScopedCS`, `ZoneScopedNCS`, `TracyAllocS`, `TracyFreeS`, `TracyGpuZoneS`, `TracyGpuZoneCS`, `TracyVkZoneS`, `TracyVkZoneCS`.
+
## Good practices
- Remember to set thread names for proper identification of threads. You may use the functions exposed in the `tracy/common/TracySystem.hpp` header to do so.