oden/third-party/vendor/tracy-client-sys/FEATURES.mkd
2024-03-08 11:03:01 -08:00

27 lines
1.7 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

* `enable` enables the Tracy client. Corresponds to the `TRACY_ENABLE` define.
* `system-tracing` enable capture of system level details. Corresponds to the
`TRACY_NO_SYSTEM_TRACING` define.
* `context-switch-tracing` enable capture of the context switch data. Corresponds to the
`TRACY_NO_CONTEXT_SWITCH` define.
* `sampling` enable periodic sampling of the call stack. Corresponds to the
`TRACY_NO_SAMPLING` define.
* `code-transfer` enable transfer of the machine code to the profiler. Corresponds to the
`TRACY_NO_CODE_TRANSFER` define.
* `broadcast` announce presence of the client to the profilers on the local network.
Corresponds to the `TRACY_NO_BROADCAST` define.
* `only-localhost` listen for profilers on the localhost interface only. Corresponds to the
`TRACY_ONLY_LOCALHOST` define.
* `only-ipv4` listen for profilers on IPv4 interfaces only. Corresponds to the
`TRACY_ONLY_IPV4` define.
* `timer-fallback` allow running on devices without a high resolution timer support.
Corresponds to the `TRACY_TIMER_FALLBACK` define.
* `ondemand` start collecting traces only when a server connects to the client. Corresponds
to the `TRACY_ON_DEMAND` define.
* `fibers` enable support for instrumenting fibers, coroutines and similar such asynchrony
primitives. Corresponds to the `TRACY_FIBERS` define.
* `callstack-inlines` - enables resolution of inline frames for call stacks. Disabling it will make the profiler use
the basic but much faster frame resolution mode. Corresponds to the `TRACY_NO_CALLSTACK_INLINES` define.
Refer to this package's `Cargo.toml` for the list of the features enabled by default. Refer to
the `Tracy` manual for more information on the implications of each feature.