mirror of
https://github.com/bevyengine/bevy
synced 2025-01-08 19:29:04 +00:00
d33f5c759c
# Objective Fixes #6689. ## Solution Add `single-threaded` as an optional non-default feature to `bevy_ecs` and `bevy_tasks` that: - disable the `ParallelExecutor` as a default runner - disables the multi-threaded `TaskPool` - internally replace `QueryParIter::for_each` calls with `Query::for_each`. Removed the `Mutex` and `Arc` usage in the single-threaded task pool. ![image](https://user-images.githubusercontent.com/3137680/202833253-dd2d520f-75e6-4c7b-be2d-5ce1523cbd38.png) ## Future Work/TODO Create type aliases for `Mutex`, `Arc` that change to single-threaaded equivalents where possible. --- ## Changelog Added: Optional default feature `multi-theaded` to that enables multithreaded parallelism in the engine. Disabling it disables all multithreading in exchange for higher single threaded performance. Does nothing on WASM targets. --------- Co-authored-by: Carter Anderson <mcanders1@gmail.com>
173 lines
7.2 KiB
Rust
173 lines
7.2 KiB
Rust
use bevy_app::{PluginGroup, PluginGroupBuilder};
|
||
|
||
/// This plugin group will add all the default plugins for a *Bevy* application:
|
||
/// * [`LogPlugin`](crate::log::LogPlugin)
|
||
/// * [`TaskPoolPlugin`](crate::core::TaskPoolPlugin)
|
||
/// * [`TypeRegistrationPlugin`](crate::core::TypeRegistrationPlugin)
|
||
/// * [`FrameCountPlugin`](crate::core::FrameCountPlugin)
|
||
/// * [`TimePlugin`](crate::time::TimePlugin)
|
||
/// * [`TransformPlugin`](crate::transform::TransformPlugin)
|
||
/// * [`HierarchyPlugin`](crate::hierarchy::HierarchyPlugin)
|
||
/// * [`DiagnosticsPlugin`](crate::diagnostic::DiagnosticsPlugin)
|
||
/// * [`InputPlugin`](crate::input::InputPlugin)
|
||
/// * [`WindowPlugin`](crate::window::WindowPlugin)
|
||
/// * [`AssetPlugin`](crate::asset::AssetPlugin) - with feature `bevy_asset`
|
||
/// * [`DebugAssetPlugin`](crate::asset::debug_asset_server::DebugAssetServerPlugin) - with feature `debug_asset_server`
|
||
/// * [`ScenePlugin`](crate::scene::ScenePlugin) - with feature `bevy_scene`
|
||
/// * [`WinitPlugin`](crate::winit::WinitPlugin) - with feature `bevy_winit`
|
||
/// * [`RenderPlugin`](crate::render::RenderPlugin) - with feature `bevy_render`
|
||
/// * [`ImagePlugin`](crate::render::texture::ImagePlugin) - with feature `bevy_render`
|
||
/// * [`PipelinedRenderingPlugin`](crate::render::pipelined_rendering::PipelinedRenderingPlugin) - with feature `bevy_render` when not targeting `wasm32`
|
||
/// * [`CorePipelinePlugin`](crate::core_pipeline::CorePipelinePlugin) - with feature `bevy_core_pipeline`
|
||
/// * [`SpritePlugin`](crate::sprite::SpritePlugin) - with feature `bevy_sprite`
|
||
/// * [`TextPlugin`](crate::text::TextPlugin) - with feature `bevy_text`
|
||
/// * [`UiPlugin`](crate::ui::UiPlugin) - with feature `bevy_ui`
|
||
/// * [`PbrPlugin`](crate::pbr::PbrPlugin) - with feature `bevy_pbr`
|
||
/// * [`GltfPlugin`](crate::gltf::GltfPlugin) - with feature `bevy_gltf`
|
||
/// * [`AudioPlugin`](crate::audio::AudioPlugin) - with feature `bevy_audio`
|
||
/// * [`GilrsPlugin`](crate::gilrs::GilrsPlugin) - with feature `bevy_gilrs`
|
||
/// * [`AnimationPlugin`](crate::animation::AnimationPlugin) - with feature `bevy_animation`
|
||
///
|
||
/// [`DefaultPlugins`] obeys *Cargo* *feature* flags. Users may exert control over this plugin group
|
||
/// by disabling `default-features` in their `Cargo.toml` and enabling only those features
|
||
/// that they wish to use.
|
||
///
|
||
/// [`DefaultPlugins`] contains all the plugins typically required to build
|
||
/// a *Bevy* application which includes a *window* and presentation components.
|
||
/// For *headless* cases – without a *window* or presentation, see [`MinimalPlugins`].
|
||
pub struct DefaultPlugins;
|
||
|
||
impl PluginGroup for DefaultPlugins {
|
||
fn build(self) -> PluginGroupBuilder {
|
||
let mut group = PluginGroupBuilder::start::<Self>();
|
||
group = group
|
||
.add(bevy_log::LogPlugin::default())
|
||
.add(bevy_core::TaskPoolPlugin::default())
|
||
.add(bevy_core::TypeRegistrationPlugin::default())
|
||
.add(bevy_core::FrameCountPlugin::default())
|
||
.add(bevy_time::TimePlugin::default())
|
||
.add(bevy_transform::TransformPlugin::default())
|
||
.add(bevy_hierarchy::HierarchyPlugin::default())
|
||
.add(bevy_diagnostic::DiagnosticsPlugin::default())
|
||
.add(bevy_input::InputPlugin::default())
|
||
.add(bevy_window::WindowPlugin::default())
|
||
.add(bevy_a11y::AccessibilityPlugin);
|
||
|
||
#[cfg(feature = "bevy_asset")]
|
||
{
|
||
group = group.add(bevy_asset::AssetPlugin::default());
|
||
}
|
||
|
||
#[cfg(feature = "debug_asset_server")]
|
||
{
|
||
group = group.add(bevy_asset::debug_asset_server::DebugAssetServerPlugin::default());
|
||
}
|
||
|
||
#[cfg(feature = "bevy_scene")]
|
||
{
|
||
group = group.add(bevy_scene::ScenePlugin::default());
|
||
}
|
||
|
||
#[cfg(feature = "bevy_winit")]
|
||
{
|
||
group = group.add(bevy_winit::WinitPlugin::default());
|
||
}
|
||
|
||
#[cfg(feature = "bevy_render")]
|
||
{
|
||
group = group
|
||
.add(bevy_render::RenderPlugin::default())
|
||
// NOTE: Load this after renderer initialization so that it knows about the supported
|
||
// compressed texture formats
|
||
.add(bevy_render::texture::ImagePlugin::default());
|
||
|
||
#[cfg(all(not(target_arch = "wasm32"), feature = "multi-threaded"))]
|
||
{
|
||
group = group
|
||
.add(bevy_render::pipelined_rendering::PipelinedRenderingPlugin::default());
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "bevy_core_pipeline")]
|
||
{
|
||
group = group.add(bevy_core_pipeline::CorePipelinePlugin::default());
|
||
}
|
||
|
||
#[cfg(feature = "bevy_sprite")]
|
||
{
|
||
group = group.add(bevy_sprite::SpritePlugin::default());
|
||
}
|
||
|
||
#[cfg(feature = "bevy_text")]
|
||
{
|
||
group = group.add(bevy_text::TextPlugin::default());
|
||
}
|
||
|
||
#[cfg(feature = "bevy_ui")]
|
||
{
|
||
group = group.add(bevy_ui::UiPlugin::default());
|
||
}
|
||
|
||
#[cfg(feature = "bevy_pbr")]
|
||
{
|
||
group = group.add(bevy_pbr::PbrPlugin::default());
|
||
}
|
||
|
||
// NOTE: Load this after renderer initialization so that it knows about the supported
|
||
// compressed texture formats
|
||
#[cfg(feature = "bevy_gltf")]
|
||
{
|
||
group = group.add(bevy_gltf::GltfPlugin::default());
|
||
}
|
||
|
||
#[cfg(feature = "bevy_audio")]
|
||
{
|
||
group = group.add(bevy_audio::AudioPlugin::default());
|
||
}
|
||
|
||
#[cfg(feature = "bevy_gilrs")]
|
||
{
|
||
group = group.add(bevy_gilrs::GilrsPlugin::default());
|
||
}
|
||
|
||
#[cfg(feature = "bevy_animation")]
|
||
{
|
||
group = group.add(bevy_animation::AnimationPlugin::default());
|
||
}
|
||
|
||
#[cfg(feature = "bevy_gizmos")]
|
||
{
|
||
group = group.add(bevy_gizmos::GizmoPlugin);
|
||
}
|
||
|
||
group
|
||
}
|
||
}
|
||
|
||
/// This plugin group will add the minimal plugins for a *Bevy* application:
|
||
/// * [`TaskPoolPlugin`](crate::core::TaskPoolPlugin)
|
||
/// * [`TypeRegistrationPlugin`](crate::core::TypeRegistrationPlugin)
|
||
/// * [`FrameCountPlugin`](crate::core::FrameCountPlugin)
|
||
/// * [`TimePlugin`](crate::time::TimePlugin)
|
||
/// * [`ScheduleRunnerPlugin`](crate::app::ScheduleRunnerPlugin)
|
||
///
|
||
/// This group of plugins is intended for use for minimal, *headless* programs –
|
||
/// see the [*Bevy* *headless* example](https://github.com/bevyengine/bevy/blob/main/examples/app/headless.rs)
|
||
/// – and includes a [schedule runner (`ScheduleRunnerPlugin`)](crate::app::ScheduleRunnerPlugin)
|
||
/// to provide functionality that would otherwise be driven by a windowed application's
|
||
/// *event loop* or *message loop*.
|
||
///
|
||
/// Windowed applications that wish to use a reduced set of plugins should consider the
|
||
/// [`DefaultPlugins`] plugin group which can be controlled with *Cargo* *feature* flags.
|
||
pub struct MinimalPlugins;
|
||
|
||
impl PluginGroup for MinimalPlugins {
|
||
fn build(self) -> PluginGroupBuilder {
|
||
PluginGroupBuilder::start::<Self>()
|
||
.add(bevy_core::TaskPoolPlugin::default())
|
||
.add(bevy_core::TypeRegistrationPlugin::default())
|
||
.add(bevy_core::FrameCountPlugin::default())
|
||
.add(bevy_time::TimePlugin::default())
|
||
.add(bevy_app::ScheduleRunnerPlugin::default())
|
||
}
|
||
}
|