forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
0c91317102
bevy/docs/cargo_features.md
Daniel McNab 43d99bb583 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

1.9 KiB
Raw Blame History

Cargo Features

Default Features

feature name description
bevy_audio Audio support. Support for all audio formats depends on this.
bevy_gilrs Adds gamepad support.
bevy_gltf glTF support.
bevy_winit GUI support.
bevy_wgpu Make use of GPU via WebGPU support.
render The render pipeline and all render related plugins.
png PNG picture format support.
hdr HDR support.
mp3 MP3 audio format support.
x11 Make GUI applications use X11 protocol. You could enable wayland feature to override this.

Optional Features

feature name description
bevy_dynamic_plugin Plugin for dynamic loading (using libloading).
dynamic Forces bevy to be dynamically linked, which improves iterative compile times.
trace Enables system tracing (useful in tandem with a feature like trace_chrome).
trace_chrome Enables tracing-chrome as bevy_log output. This allows you to visualize system execution.
wgpu_trace For tracing wgpu.
dds DDS picture format support.
tga TGA picture format support.
jpeg JPEG picture format support.
bmp BMP picture format support.
flac FLAC audio format support. It's included in bevy_audio feature.
wav WAV audio format support.
vorbis Vorbis audio format support.
wasm_audio WASM audio support. (Currently only works with flac, wav and vorbis. Not with mp3)
serialize Enables serialization of bevy_input types.
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.
bevy_ci_testing Used for running examples in CI.