mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 07:04:33 +00:00
35ac1b152e
# Objective Keep core dependencies up to date. ## Solution Update the dependencies. wgpu 0.19 only supports raw-window-handle (rwh) 0.6, so bumping that was included in this. The rwh 0.6 version bump is just the simplest way of doing it. There might be a way we can take advantage of wgpu's new safe surface creation api, but I'm not familiar enough with bevy's window management to untangle it and my attempt ended up being a mess of lifetimes and rustc complaining about missing trait impls (that were implemented). Thanks to @MiniaczQ for the (much simpler) rwh 0.6 version bump code. Unblocks https://github.com/bevyengine/bevy/pull/9172 and https://github.com/bevyengine/bevy/pull/10812 ~~This might be blocked on cpal and oboe updating their ndk versions to 0.8, as they both currently target ndk 0.7 which uses rwh 0.5.2~~ Tested on android, and everything seems to work correctly (audio properly stops when minimized, and plays when re-focusing the app). --- ## Changelog - `wgpu` has been updated to 0.19! The long awaited arcanization has been merged (for more info, see https://gfx-rs.github.io/2023/11/24/arcanization.html), and Vulkan should now be working again on Intel GPUs. - Targeting WebGPU now requires that you add the new `webgpu` feature (setting the `RUSTFLAGS` environment variable to `--cfg=web_sys_unstable_apis` is still required). This feature currently overrides the `webgl2` feature if you have both enabled (the `webgl2` feature is enabled by default), so it is not recommended to add it as a default feature to libraries without putting it behind a flag that allows library users to opt out of it! In the future we plan on supporting wasm binaries that can target both webgl2 and webgpu now that wgpu added support for doing so (see https://github.com/bevyengine/bevy/issues/11505). - `raw-window-handle` has been updated to version 0.6. ## Migration Guide - `bevy_render::instance_index::get_instance_index()` has been removed as the webgl2 workaround is no longer required as it was fixed upstream in wgpu. The `BASE_INSTANCE_WORKAROUND` shaderdef has also been removed. - WebGPU now requires the new `webgpu` feature to be enabled. The `webgpu` feature currently overrides the `webgl2` feature so you no longer need to disable all default features and re-add them all when targeting `webgpu`, but binaries built with both the `webgpu` and `webgl2` features will only target the webgpu backend, and will only work on browsers that support WebGPU. - Places where you conditionally compiled things for webgl2 need to be updated because of this change, eg: - `#[cfg(any(not(feature = "webgl"), not(target_arch = "wasm32")))]` becomes `#[cfg(any(not(feature = "webgl") ,not(target_arch = "wasm32"), feature = "webgpu"))]` - `#[cfg(all(feature = "webgl", target_arch = "wasm32"))]` becomes `#[cfg(all(feature = "webgl", target_arch = "wasm32", not(feature = "webgpu")))]` - `if cfg!(all(feature = "webgl", target_arch = "wasm32"))` becomes `if cfg!(all(feature = "webgl", target_arch = "wasm32", not(feature = "webgpu")))` - `create_texture_with_data` now also takes a `TextureDataOrder`. You can probably just set this to `TextureDataOrder::default()` - `TextureFormat`'s `block_size` has been renamed to `block_copy_size` - See the `wgpu` changelog for anything I might've missed: https://github.com/gfx-rs/wgpu/blob/trunk/CHANGELOG.md --------- Co-authored-by: François <mockersf@gmail.com>
5.3 KiB
5.3 KiB
Cargo Features
Bevy exposes many features to customise the engine. Enabling them add functionalities but often come at the cost of longer compilation times and extra dependencies.
Default Features
The default feature set enables most of the expected features of a game engine, like rendering in both 2D and 3D, asset loading, audio and UI. To help reduce compilation time, consider disabling default features and enabling only those you need.
| feature name | description |
|---|---|
| android_shared_stdcxx | Enable using a shared stdlib for cxx on Android |
| animation | Enable animation support, and glTF animation loading |
| bevy_animation | Provides animation functionality |
| bevy_asset | Provides asset functionality |
| bevy_audio | Provides audio functionality |
| bevy_core_pipeline | Provides cameras and other basic render pipeline features |
| bevy_gilrs | Adds gamepad support |
| bevy_gizmos | Adds support for rendering gizmos |
| bevy_gltf | glTF support |
| bevy_pbr | Adds PBR rendering |
| bevy_render | Provides rendering functionality |
| bevy_scene | Provides scene functionality |
| bevy_sprite | Provides sprite functionality |
| bevy_text | Provides text functionality |
| bevy_ui | A custom ECS-driven UI framework |
| bevy_winit | winit window and input backend |
| default_font | Include a default font, containing only ASCII characters, at the cost of a 20kB binary size increase |
| hdr | HDR image format support |
| ktx2 | KTX2 compressed texture support |
| multi-threaded | Enables multithreaded parallelism in the engine. Disabling it forces all engine tasks to run on a single thread. |
| png | PNG image format support |
| tonemapping_luts | Include tonemapping Look Up Tables KTX2 files. If everything is pink, you need to enable this feature or change the Tonemapping method on your Camera2dBundle or Camera3dBundle. |
| vorbis | OGG/VORBIS audio format support |
| webgl2 | Enable some limitations to be able to use WebGL2. Please refer to the WebGL2 and WebGPU section of the examples README for more information on how to run Wasm builds with WebGPU. |
| x11 | X11 display server support |
| zstd | For KTX2 supercompression |
Optional Features
| feature name | description |
|---|---|
| accesskit_unix | Enable AccessKit on Unix backends (currently only works with experimental screen readers and forks.) |
| asset_processor | Enables the built-in asset processor for processed assets. |
| async-io | Use async-io's implementation of block_on instead of futures-lite's implementation. This is preferred if your application uses async-io. |
| basis-universal | Basis Universal compressed texture support |
| bevy_ci_testing | Enable systems that allow for automated testing on CI |
| bevy_dynamic_plugin | Plugin for dynamic loading (using libloading) |
| bmp | BMP image format support |
| dds | DDS compressed texture support |
| debug_glam_assert | Enable assertions in debug builds to check the validity of parameters passed to glam |
| detailed_trace | Enable detailed trace event logging. These trace events are expensive even when off, thus they require compile time opt-in |
| dynamic_linking | Force dynamic linking, which improves iterative compile times |
| embedded_watcher | Enables watching in memory asset providers for Bevy Asset hot-reloading |
| exr | EXR image format support |
| file_watcher | Enables watching the filesystem for Bevy Asset hot-reloading |
| flac | FLAC audio format support |
| glam_assert | Enable assertions to check the validity of parameters passed to glam |
| jpeg | JPEG image format support |
| minimp3 | MP3 audio format support (through minimp3) |
| mp3 | MP3 audio format support |
| pbr_transmission_textures | Enable support for transmission-related textures in the StandardMaterial, at the risk of blowing past the global, per-shader texture limit on older/lower-end GPUs |
| pnm | PNM image format support, includes pam, pbm, pgm and ppm |
| serialize | Enable serialization support through serde |
| shader_format_glsl | Enable support for shaders in GLSL |
| shader_format_spirv | Enable support for shaders in SPIR-V |
| subpixel_glyph_atlas | Enable rendering of font glyphs using subpixel accuracy |
| symphonia-aac | AAC audio format support (through symphonia) |
| symphonia-all | AAC, FLAC, MP3, MP4, OGG/VORBIS, and WAV audio formats support (through symphonia) |
| symphonia-flac | FLAC audio format support (through symphonia) |
| symphonia-isomp4 | MP4 audio format support (through symphonia) |
| symphonia-vorbis | OGG/VORBIS audio format support (through symphonia) |
| symphonia-wav | WAV audio format support (through symphonia) |
| tga | TGA image format support |
| trace | Tracing support |
| trace_chrome | Tracing support, saving a file in Chrome Tracing format |
| trace_tracy | Tracing support, exposing a port for Tracy |
| trace_tracy_memory | Tracing support, with memory profiling, exposing a port for Tracy |
| wav | WAV audio format support |
| wayland | Wayland display server support |
| webgpu | Enable support for WebGPU in Wasm. When enabled, this feature will override the webgl2 feature and you won't be able to run Wasm builds with WebGL2, only with WebGPU. Requires the RUSTFLAGS environment variable to be set to --cfg=web_sys_unstable_apis when building. |
| webp | WebP image format support |
| wgpu_trace | Save a trace of all wgpu calls |
| zlib | For KTX2 supercompression |