 6a85eb3d7e
			
		
	
	
		6a85eb3d7e
		
			
		
	
	
	
	
		
			
			# Objective Add a convenient immediate mode drawing API for visual debugging. Fixes #5619 Alternative to #1625 Partial alternative to #5734 Based off https://github.com/Toqozz/bevy_debug_lines with some changes: * Simultaneous support for 2D and 3D. * Methods for basic shapes; circles, spheres, rectangles, boxes, etc. * 2D methods. * Removed durations. Seemed niche, and can be handled by users. <details> <summary>Performance</summary> Stress tested using Bevy's recommended optimization settings for the dev profile with the following command. ```bash cargo run --example many_debug_lines \ --config "profile.dev.package.\"*\".opt-level=3" \ --config "profile.dev.opt-level=1" ``` I dipped to 65-70 FPS at 300,000 lines CPU: 3700x RAM Speed: 3200 Mhz GPU: 2070 super - probably not very relevant, mostly cpu/memory bound </details> <details> <summary>Fancy bloom screenshot</summary>  </details> ## Changelog * Added `GizmoPlugin` * Added `Gizmos` system parameter for drawing lines and wireshapes. ### TODO - [ ] Update changelog - [x] Update performance numbers - [x] Add credit to PR description ### Future work - Cache rendering primitives instead of constructing them out of line segments each frame. - Support for drawing solid meshes - Interactions. (See [bevy_mod_gizmos](https://github.com/LiamGallagher737/bevy_mod_gizmos)) - Fancier line drawing. (See [bevy_polyline](https://github.com/ForesightMiningSoftwareCorporation/bevy_polyline)) - Support for `RenderLayers` - Display gizmos for a certain duration. Currently everything displays for one frame (ie. immediate mode) - Changing settings per drawn item like drawing on top or drawing to different `RenderLayers` Co-Authored By: @lassade <felipe.jorge.pereira@gmail.com> Co-Authored By: @The5-1 <agaku@hotmail.de> Co-Authored By: @Toqozz <toqoz@hotmail.com> Co-Authored By: @nicopap <nico@nicopap.ch> --------- Co-authored-by: Robert Swain <robert.swain@gmail.com> Co-authored-by: IceSentry <c.giguere42@gmail.com> Co-authored-by: Carter Anderson <mcanders1@gmail.com>
		
			
				
	
	
		
			174 lines
		
	
	
		
			7.2 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			174 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(not(target_arch = "wasm32"))]
 | ||
|             {
 | ||
|                 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())
 | ||
|     }
 | ||
| }
 |