2020-08-25 00:06:08 +00:00
# Cargo Features
## Default Features
2021-02-01 04:19:10 +00:00
|feature name|description|
|-|-|
|bevy_audio|Audio support. Support for all audio formats depends on this.|
|bevy_gilrs|Adds gamepad support.|
|bevy_gltf|[glTF](https://www.khronos.org/gltf/) support.|
|bevy_winit|GUI support.|
|render|The render pipeline and all render related plugins.|
|png|PNG picture format support.|
|hdr|[HDR](https://en.wikipedia.org/wiki/High_dynamic_range) support.|
2021-12-23 19:19:15 +00:00
|vorbis|Ogg Vorbis audio format support.|
2021-02-01 04:19:10 +00:00
|x11|Make GUI applications use X11 protocol. You could enable wayland feature to override this.|
2021-11-13 21:15:22 +00:00
|filesystem_watcher|Enable watching the file system for asset hot reload|
2020-08-25 00:06:08 +00:00
## Optional Features
2021-02-01 04:19:10 +00:00
|feature name|description|
|-|-|
2021-08-01 19:14:47 +00:00
|bevy_dynamic_plugin|Plugin for dynamic loading (using [libloading ](https://crates.io/crates/libloading )).|
2021-04-16 18:57:08 +00:00
|dynamic|Forces bevy to be dynamically linked, which improves iterative compile times.|
2021-12-18 00:09:22 +00:00
|trace|Enables system tracing.|
2021-02-01 04:19:10 +00:00
|trace_chrome|Enables [tracing-chrome ](https://github.com/thoren-d/tracing-chrome ) as bevy_log output. This allows you to visualize system execution.|
Add trace_tracy feature for Tracy profiling (#2832)
# Objective
[Tracy](https://github.com/wolfpld/tracy) is:
> A real time, nanosecond resolution, remote telemetry, hybrid frame and sampling profiler for games and other applications.
With the `trace_tracy` feature enabled, you run your bevy app and either a headless server (`capture`) or a live, interactive profiler UI (`Tracy`), and connect that to your bevy application to then stream the metric data and events, and save it or inspect it live/offline.
Previously when I implemented the spans across systems and stages and I was trying out different profiling tools, Tracy was too unstable on macOS to use. But now, quite some months later, it is working stably with Tracy 0.7.8. You can see timelines, aggregate statistics of mean system/stage execution times, and much more. It's very useful!
## Solution
- Use the `tracing-tracy` crate which supports our tracing spans
- Expose via the non-default feature `trace_tracy` for consistency with other `trace*` features
2021-09-16 23:39:22 +00:00
|trace_tracy|Enables [Tracy ](https://github.com/wolfpld/tracy ) as bevy_log output. This allows `Tracy` to connect to and capture profiling data as well as visualize system execution in real-time, present statistics about system execution times, and more.|
2021-02-01 04:19:10 +00:00
|wgpu_trace|For tracing wgpu.|
2021-04-16 18:57:08 +00:00
|dds|DDS picture format support.|
|tga|TGA picture format support.|
|jpeg|JPEG picture format support.|
|bmp|BMP picture format support.|
2021-02-01 04:19:10 +00:00
|flac|FLAC audio format support. It's included in bevy_audio feature.|
2021-12-23 19:19:15 +00:00
|mp3|MP3 audio format support.|
2021-02-01 04:19:10 +00:00
|wav|WAV audio format support.|
2021-04-16 18:57:08 +00:00
|serialize|Enables serialization of `bevy_input` types.|
2021-02-01 04:19:10 +00:00
|wayland|Enable this to use Wayland display server protocol other than X11.|
|subpixel_glyph_atlas|Enable this to cache glyphs using subpixel accuracy. This increases texture memory usage as each position requires a separate sprite in the glyph atlas, but provide more accurate character spacing.|
2021-04-16 18:57:08 +00:00
|bevy_ci_testing|Used for running examples in CI.|
