32
32
//!
33
33
//! If you prefer, you can also consume the individual bevy crates directly.
34
34
//! Each module in the root of this crate, except for the prelude, can be found on crates.io
35
- //! with `bevy_` appended to the front, e.g. `app` -> [`bevy_app`](https://docs.rs/bevy_app/0.2.1 /bevy_app/).
35
+ //! with `bevy_` appended to the front, e.g. `app` -> [`bevy_app`](https://docs.rs/bevy_app/* /bevy_app/).
36
36
37
37
#![ doc(
38
38
html_logo_url = "https://bevyengine.org/assets/icon.png" ,
@@ -51,7 +51,7 @@ pub mod app {
51
51
}
52
52
53
53
pub mod asset {
54
- //! Load and store assets and resources for Apps
54
+ //! Load and store assets and resources for Apps.
55
55
pub use bevy_asset:: * ;
56
56
}
57
57
@@ -76,6 +76,7 @@ pub mod input {
76
76
}
77
77
78
78
pub mod math {
79
+ //! Math types (Vec3, Mat4, Quat, etc) and helpers.
79
80
pub use bevy_math:: * ;
80
81
}
81
82
@@ -85,18 +86,22 @@ pub mod property {
85
86
}
86
87
87
88
pub mod scene {
89
+ //! Save/load collections of entities and components to/from file.
88
90
pub use bevy_scene:: * ;
89
91
}
90
92
91
93
pub mod tasks {
94
+ //! Pools for async, IO, and compute tasks.
92
95
pub use bevy_tasks:: * ;
93
96
}
94
97
95
98
pub mod transform {
99
+ //! Local and global transforms (e.g. translation, scale, rotation).
96
100
pub use bevy_transform:: * ;
97
101
}
98
102
99
103
pub mod type_registry {
104
+ //! Registered types and components can be used when loading scenes.
100
105
pub use bevy_type_registry:: * ;
101
106
}
102
107
@@ -105,6 +110,7 @@ pub mod utils {
105
110
}
106
111
107
112
pub mod window {
113
+ //! Configuration, creation, and management of one or more windows.
108
114
pub use bevy_window:: * ;
109
115
}
110
116
@@ -122,12 +128,14 @@ pub mod gltf {
122
128
123
129
#[ cfg( feature = "bevy_pbr" ) ]
124
130
pub mod pbr {
125
- //! Physically based rendering. **Note**: true PBR has not yet been implemented; the name `pbr` is aspirational.
131
+ //! Physically based rendering.
132
+ //! **Note**: true PBR has not yet been implemented; the name `pbr` is aspirational.
126
133
pub use bevy_pbr:: * ;
127
134
}
128
135
129
136
#[ cfg( feature = "bevy_render" ) ]
130
137
pub mod render {
138
+ //! Cameras, meshes, textures, shaders, and pipelines.
131
139
pub use bevy_render:: * ;
132
140
}
133
141
@@ -139,11 +147,13 @@ pub mod sprite {
139
147
140
148
#[ cfg( feature = "bevy_text" ) ]
141
149
pub mod text {
150
+ //! Text drawing, styling, and font assets.
142
151
pub use bevy_text:: * ;
143
152
}
144
153
145
154
#[ cfg( feature = "bevy_ui" ) ]
146
155
pub mod ui {
156
+ //! User interface components and widgets.
147
157
pub use bevy_ui:: * ;
148
158
}
149
159
@@ -154,6 +164,7 @@ pub mod winit {
154
164
155
165
#[ cfg( feature = "bevy_wgpu" ) ]
156
166
pub mod wgpu {
167
+ //! A render backend utilizing [wgpu](https://github.com/gfx-rs/wgpu-rs).
157
168
pub use bevy_wgpu:: * ;
158
169
}
159
170
0 commit comments