Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-12-01 17:09:12 +00:00
Code Issues Projects Releases Packages Wiki Activity
bevy/docs/cargo_features.md

54 lines
3.6 KiB
Markdown
Raw Normal View History

add an option about display server protocol, and create document `docs/cargo_features.md` (#249) add an option about display server protocol, and create document `docs/cargo_features.md`
2020-08-25 00:06:08 +00:00
# Cargo Features
## Default Features
Plugin guidelines (#1250) * add plugin guidelines * refactor features list
2021-02-01 04:19:10 +00:00
|feature name|description|
|-|-|
Add animation feature to cargo_features.md (#4450) # Objective The new feature `animation` is not documented in `cargo_features.md`. ## Solution Add it there.
2022-04-11 04:20:25 +00:00
|animation|Animation support and glTF animation loading.|
Lighter no default features (#5447) # Objective - Even though it's marked as optional, it is no longer possible to not depend on `bevy_render` as it's a dependency of `bevy_scene` ## Solution - Make `bevy_scene` optional - For the minimalist among us, also make `bevy_asset` optional
2022-07-25 15:48:14 +00:00
|bevy_asset|Provides asset functionality for Bevy Engine.|
Plugin guidelines (#1250) * add plugin guidelines * refactor features list
2021-02-01 04:19:10 +00:00
|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.|
Lighter no default features (#5447) # Objective - Even though it's marked as optional, it is no longer possible to not depend on `bevy_render` as it's a dependency of `bevy_scene` ## Solution - Make `bevy_scene` optional - For the minimalist among us, also make `bevy_asset` optional
2022-07-25 15:48:14 +00:00
|bevy_scene|Provides scene functionality for Bevy Engine.|
Plugin guidelines (#1250) * add plugin guidelines * refactor features list
2021-02-01 04:19:10 +00:00
|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.|
use ogg by default instead of mp3 (#3421) # Objective - mp3 feature of rodio has dependencies that are not maintained with security issues - mp3 feature of rodio doesn't build in wasm - mp3 feature of rodio uses internal memory allocation that cause rejection from Apple appstore ## Solution - Use vorbis instead of mp3 by default Co-authored-by: François <8672791+mockersf@users.noreply.github.com>
2021-12-23 19:19:15 +00:00
|vorbis|Ogg Vorbis audio format support.|
Plugin guidelines (#1250) * add plugin guidelines * refactor features list
2021-02-01 04:19:10 +00:00
|x11|Make GUI applications use X11 protocol. You could enable wayland feature to override this.|
default features from `bevy_asset` and `bevy_ecs` can actually be disabled (#3097) # Objective - `bevy_ecs` exposes as an optional feature `bevy_reflect`. Disabling it doesn't compile. - `bevy_asset` exposes as an optional feature `filesystem_watcher`. Disabling it doesn't compile. It is also not possible to disable this feature from Bevy ## Solution - Fix compilation errors when disabling the default features. Make it possible to disable the feature `filesystem_watcher` from Bevy
2021-11-13 21:15:22 +00:00
|filesystem_watcher|Enable watching the file system for asset hot reload|
add an option about display server protocol, and create document `docs/cargo_features.md` (#249) add an option about display server protocol, and create document `docs/cargo_features.md`
2020-08-25 00:06:08 +00:00
## Optional Features
Plugin guidelines (#1250) * add plugin guidelines * refactor features list
2021-02-01 04:19:10 +00:00
|feature name|description|
|-|-|
Remove bevy_dynamic_plugin as a default (#2578) It doesn't compile on wasm, and it's full of footguns # Objective - If bevy is used with default features on wasm, there's more of a chance it will compile - Note that I haven't done a full audit - it's possible that there are other problematic crates ## Solution - `bevy_dynamic_plugin` is no longer a default plugin - I've also done an accidental drive by reformatting of the root `Cargo.toml`, as I have [Even Better Toml](https://github.com/tamasfe/taplo) installed. - (Please, rustfmt do this for us)
2021-08-01 19:14:47 +00:00
|bevy_dynamic_plugin|Plugin for dynamic loading (using [libloading](https://crates.io/crates/libloading)).|
Update cargo_features.md (#1939) This adds missing features to the cargo_features.md file. closes #1391
2021-04-16 18:57:08 +00:00
|dynamic|Forces bevy to be dynamically linked, which improves iterative compile times.|
Enable trace feature for subfeatures using it (#3337) # Objective - It isn't very useful to be able to enable feature `trace_chrome` on its own ## Solution - Enable `trace` feature when enabling `trace_chrome` or `trace_tracy` Co-authored-by: François <8672791+mockersf@users.noreply.github.com>
2021-12-18 00:09:22 +00:00
|trace|Enables system tracing.|
Plugin guidelines (#1250) * add plugin guidelines * refactor features list
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! ![Screenshot_2021-09-15_at_18 07 19](https://user-images.githubusercontent.com/302146/133554920-350d3d45-fbb8-479f-91f7-7a7a4f9f5873.png) ## 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.|
Plugin guidelines (#1250) * add plugin guidelines * refactor features list
2021-02-01 04:19:10 +00:00
|wgpu_trace|For tracing wgpu.|
Update cargo_features.md (#1939) This adds missing features to the cargo_features.md file. closes #1391
2021-04-16 18:57:08 +00:00
|dds|DDS picture format support.|
KTX2/DDS/.basis compressed texture support (#3884) # Objective - Support compressed textures including 'universal' formats (ETC1S, UASTC) and transcoding of them to - Support `.dds`, `.ktx2`, and `.basis` files ## Solution - Fixes https://github.com/bevyengine/bevy/issues/3608 Look there for more details. - Note that the functionality is all enabled through non-default features. If it is desirable to enable some by default, I can do that. - The `basis-universal` crate, used for `.basis` file support and for transcoding, is built on bindings against a C++ library. It's not feasible to rewrite in Rust in a short amount of time. There are no Rust alternatives of which I am aware and it's specialised code. In its current state it doesn't support the wasm target, but I don't know for sure. However, it is possible to build the upstream C++ library with emscripten, so there is perhaps a way to add support for web too with some shenanigans. - There's no support for transcoding from BasisLZ/ETC1S in KTX2 files as it was quite non-trivial to implement and didn't feel important given people could use `.basis` files for ETC1S.
2022-03-15 22:26:46 +00:00
|ktx2|KTX2 picture format support.|
|zlib|KTX2 Zlib supercompression support.|
|zstd|KTX2 Zstandard supercompression support.|
|basis-universal|Basis Universal picture format support and, if the `ktx2` feature is enabled, also KTX2 UASTC picture format transcoding support.|
Update cargo_features.md (#1939) This adds missing features to the cargo_features.md file. closes #1391
2021-04-16 18:57:08 +00:00
|tga|TGA picture format support.|
|jpeg|JPEG picture format support.|
|bmp|BMP picture format support.|
Plugin guidelines (#1250) * add plugin guidelines * refactor features list
2021-02-01 04:19:10 +00:00
|flac|FLAC audio format support. It's included in bevy_audio feature.|
use ogg by default instead of mp3 (#3421) # Objective - mp3 feature of rodio has dependencies that are not maintained with security issues - mp3 feature of rodio doesn't build in wasm - mp3 feature of rodio uses internal memory allocation that cause rejection from Apple appstore ## Solution - Use vorbis instead of mp3 by default Co-authored-by: François <8672791+mockersf@users.noreply.github.com>
2021-12-23 19:19:15 +00:00
|mp3|MP3 audio format support.|
Plugin guidelines (#1250) * add plugin guidelines * refactor features list
2021-02-01 04:19:10 +00:00
|wav|WAV audio format support.|
Expose symphonia features from rodio in bevy_audio and bevy (#6388) # Objective Fix #6301 ## Solution Add new features in `bevy_audio` to use `symphonia` sound format from `rodio` Also add in `bevy`
2023-01-09 19:05:30 +00:00
|symphonia-aac|AAC audio format support by Symphonia. For more details, see `symphonia-all`.|
|symphonia-all|AAC, FLAC, MP4, MP3, Vorbis, and WAV support by Symphonia. Add support for parsing multiple file formats using a single crate instead of compiling different crates. The other non-`symphonia` features are disabled when its corresponding `symphonia` feature is enabled. [Link to `symphonia` documentation](https://docs.rs/symphonia/latest/symphonia/). More information about this topic can be found [here](https://github.com/bevyengine/bevy/pull/6388#discussion_r1009622883) |
|symphonia-flac|FLAC audio format support by Symphonia. For more details, see `symphonia-all`.|
|symphonia-isomp4|MP4 audio format support by Symphonia. For more details, see `symphonia-all`.|
|symphonia-mp3|MP3 audio format support by Symphonia. For more details, see `symphonia-all`.|
|symphonia-vorbis|Vorbis audio format support by Symphonia. For more details, see `symphonia-all`.|
|symphonia-wav|WAV audio format support by Symphonia. For more details, see `symphonia-all`.|
Update cargo_features.md (#1939) This adds missing features to the cargo_features.md file. closes #1391
2021-04-16 18:57:08 +00:00
|serialize|Enables serialization of `bevy_input` types.|
Plugin guidelines (#1250) * add plugin guidelines * refactor features list
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.|
Update cargo_features.md (#1939) This adds missing features to the cargo_features.md file. closes #1391
2021-04-16 18:57:08 +00:00
|bevy_ci_testing|Used for running examples in CI.|
Internal Asset Hot Reloading (#3966) Adds "hot reloading" of internal assets, which is normally not possible because they are loaded using `include_str` / direct Asset collection access. This is accomplished via the following: * Add a new `debug_asset_server` feature flag * When that feature flag is enabled, create a second App with a second AssetServer that points to a configured location (by default the `crates` folder). Plugins that want to add hot reloading support for their assets can call the new `app.add_debug_asset::<T>()` and `app.init_debug_asset_loader::<T>()` functions. * Load "internal" assets using the new `load_internal_asset` macro. By default this is identical to the current "include_str + register in asset collection" approach. But if the `debug_asset_server` feature flag is enabled, it will also load the asset dynamically in the debug asset server using the file path. It will then set up a correlation between the "debug asset" and the "actual asset" by listening for asset change events. This is an alternative to #3673. The goal was to keep the boilerplate and features flags to a minimum for bevy plugin authors, and allow them to home their shaders near relevant code. This is a draft because I haven't done _any_ quality control on this yet. I'll probably rename things and remove a bunch of unwraps. I just got it working and wanted to use it to start a conversation. Fixes #3660
2022-02-18 22:56:57 +00:00
|debug_asset_server|Enabling this turns on "hot reloading" of built in assets, such as shaders.|
Reference in a new issue Copy permalink