mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 07:04:33 +00:00
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> ![Screenshot_20230207_155033](https://user-images.githubusercontent.com/29694403/217291980-f1e0500e-7a14-4131-8c96-eaaaf52596ae.png) </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>
41 lines
1.2 KiB
Rust
41 lines
1.2 KiB
Rust
//! This example demonstrates Bevy's immediate mode drawing API intended for visual debugging.
|
|
|
|
use bevy::prelude::*;
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.add_systems(Startup, setup)
|
|
.add_systems(Update, system)
|
|
.run();
|
|
}
|
|
|
|
fn setup(mut commands: Commands) {
|
|
commands.spawn(Camera2dBundle::default());
|
|
}
|
|
|
|
fn system(mut gizmos: Gizmos, time: Res<Time>) {
|
|
let sin = time.elapsed_seconds().sin() * 50.;
|
|
gizmos.line_2d(Vec2::Y * -sin, Vec2::splat(-80.), Color::RED);
|
|
gizmos.ray_2d(Vec2::Y * sin, Vec2::splat(80.), Color::GREEN);
|
|
|
|
// Triangle
|
|
gizmos.linestrip_gradient_2d([
|
|
(Vec2::Y * 300., Color::BLUE),
|
|
(Vec2::new(-255., -155.), Color::RED),
|
|
(Vec2::new(255., -155.), Color::GREEN),
|
|
(Vec2::Y * 300., Color::BLUE),
|
|
]);
|
|
|
|
gizmos.rect_2d(
|
|
Vec2::ZERO,
|
|
time.elapsed_seconds() / 3.,
|
|
Vec2::splat(300.),
|
|
Color::BLACK,
|
|
);
|
|
|
|
// The circles have 32 line-segments by default.
|
|
gizmos.circle_2d(Vec2::ZERO, 120., Color::BLACK);
|
|
// You may want to increase this for larger circles.
|
|
gizmos.circle_2d(Vec2::ZERO, 300., Color::NAVY).segments(64);
|
|
}
|