You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Objective
- Make it easier to understand what each feature collection is enabling.
## Solution
- Added the list of features that a collection will enable on its
description. These are located in the "cargo_features" templated doc
page.
## Testing
- Running the templated page generator for "features" and checking the
resulting markdown.
---
## Showcase
<img width="996" height="373" alt="image"
src="https://github.com/user-attachments/assets/9b31de60-ef33-4291-bd5f-2d1583467447"
/>
# COLLECTION: The core pieces that most apps need. This serves as a baseline feature set for other higher level feature collections (such as "2d" and "3d"). It is also useful as a baseline feature set for scenarios like headless apps that require no rendering (ex: command line tools, servers, etc).
@@ -273,7 +273,7 @@ ui_bevy_render = [
273
273
"bevy_ui_render",
274
274
]
275
275
276
-
# COLLECTION: Recommended defaults for no_std applications
276
+
# COLLECTION: Recommended defaults for no_std applications.
Copy file name to clipboardExpand all lines: docs/cargo_features.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,20 +36,20 @@ collections to build your own "profile" equivalent, without needing to manually
36
36
37
37
|Collection|Description|
38
38
|-|-|
39
-
|dev|Enable this feature during development to improve the development experience. This adds features like asset hot-reloading and debugging tools. This should not be enabled for published apps!|
40
-
|audio|Features used to build audio Bevy apps.|
41
-
|scene|Features used to compose Bevy scenes.|
42
-
|picking|Enables picking functionality|
43
-
|default_app|The core pieces that most apps need. This serves as a baseline feature set for other higher level feature collections (such as "2d" and "3d"). It is also useful as a baseline feature set for scenarios like headless apps that require no rendering (ex: command line tools, servers, etc).|
44
-
|default_platform|These are platform support features, such as OS support/features, windowing and input backends, etc.|
45
-
|common_api|Default scene definition features. Note that this does not include an actual renderer, such as bevy_render (Bevy's default render backend).|
46
-
|2d_api|Features used to build 2D Bevy apps (does not include a render backend). You generally don't need to worry about this unless you are using a custom renderer.|
47
-
|2d_bevy_render|Bevy's built-in 2D renderer, built on top of `bevy_render`.|
48
-
|3d_api|Features used to build 3D Bevy apps (does not include a render backend). You generally don't need to worry about this unless you are using a custom renderer.|
49
-
|3d_bevy_render|Bevy's built-in 3D renderer, built on top of `bevy_render`.|
50
-
|ui_api|Features used to build UI Bevy apps (does not include a render backend). You generally don't need to worry about this unless you are using a custom renderer.|
51
-
|ui_bevy_render|Bevy's built-in UI renderer, built on top of `bevy_render`.|
52
-
|default_no_std|Recommended defaults for no_std applications|
39
+
|dev|Enable this feature during development to improve the development experience. This adds features like asset hot-reloading and debugging tools. This should not be enabled for published apps!**Feature set:**`debug`, `bevy_dev_tools`, `file_watcher`.|
40
+
|audio|Features used to build audio Bevy apps.**Feature set:**`bevy_audio`, `vorbis`.|
41
+
|scene|Features used to compose Bevy scenes.**Feature set:**`bevy_scene`.|
|default_app|The core pieces that most apps need. This serves as a baseline feature set for other higher level feature collections (such as "2d" and "3d"). It is also useful as a baseline feature set for scenarios like headless apps that require no rendering (ex: command line tools, servers, etc).**Feature set:**`async_executor`, `bevy_asset`, `bevy_input_focus`, `bevy_log`, `bevy_state`, `bevy_window`, `custom_cursor`, `reflect_auto_register`.|
44
+
|default_platform|These are platform support features, such as OS support/features, windowing and input backends, etc.**Feature set:**`std`, `android-game-activity`, `android_shared_stdcxx`, `bevy_gilrs`, `bevy_winit`, `default_font`, `multi_threaded`, `webgl2`, `x11`, `wayland`, `sysinfo_plugin`.|
45
+
|common_api|Default scene definition features. Note that this does not include an actual renderer, such as bevy_render (Bevy's default render backend).**Feature set:**`bevy_animation`, `bevy_camera`, `bevy_color`, `bevy_gizmos`, `bevy_image`, `bevy_mesh`, `bevy_shader`, `bevy_material`, `bevy_text`, `hdr`, `png`.|
46
+
|2d_api|Features used to build 2D Bevy apps (does not include a render backend). You generally don't need to worry about this unless you are using a custom renderer.**Feature set:**`common_api`, `bevy_sprite`.|
47
+
|2d_bevy_render|Bevy's built-in 2D renderer, built on top of `bevy_render`.**Feature set:**`2d_api`, `bevy_render`, `bevy_core_pipeline`, `bevy_post_process`, `bevy_sprite_render`, `bevy_gizmos_render`.|
48
+
|3d_api|Features used to build 3D Bevy apps (does not include a render backend). You generally don't need to worry about this unless you are using a custom renderer.**Feature set:**`common_api`, `bevy_light`, `bevy_mikktspace`, `ktx2`, `morph_animation`, `morph`, `smaa_luts`, `tonemapping_luts`, `zstd_rust`.|
49
+
|3d_bevy_render|Bevy's built-in 3D renderer, built on top of `bevy_render`.**Feature set:**`3d_api`, `bevy_render`, `bevy_core_pipeline`, `bevy_gizmos_render`, `bevy_anti_alias`, `bevy_gltf`, `bevy_pbr`, `bevy_post_process`, `gltf_animation`.|
50
+
|ui_api|Features used to build UI Bevy apps (does not include a render backend). You generally don't need to worry about this unless you are using a custom renderer.**Feature set:**`default_app`, `common_api`, `bevy_ui`.|
51
+
|ui_bevy_render|Bevy's built-in UI renderer, built on top of `bevy_render`.**Feature set:**`ui_api`, `bevy_render`, `bevy_core_pipeline`, `bevy_ui_render`.|
52
+
|default_no_std|Recommended defaults for no_std applications. **Feature set:**`libm`, `critical-section`, `bevy_color`, `bevy_state`.|
0 commit comments