# 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>
		
			
				
	
	
		
			110 lines
		
	
	
		
			2.9 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			110 lines
		
	
	
		
			2.9 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
use std::f32::consts::TAU;
 | 
						|
 | 
						|
use bevy::{
 | 
						|
    diagnostic::{Diagnostics, FrameTimeDiagnosticsPlugin},
 | 
						|
    prelude::*,
 | 
						|
    window::PresentMode,
 | 
						|
};
 | 
						|
 | 
						|
const SYSTEM_COUNT: u32 = 10;
 | 
						|
 | 
						|
fn main() {
 | 
						|
    let mut app = App::new();
 | 
						|
    app.add_plugins(DefaultPlugins.set(WindowPlugin {
 | 
						|
        primary_window: Some(Window {
 | 
						|
            title: "Many Debug Lines".to_string(),
 | 
						|
            present_mode: PresentMode::AutoNoVsync,
 | 
						|
            ..default()
 | 
						|
        }),
 | 
						|
        ..default()
 | 
						|
    }))
 | 
						|
    .add_plugin(FrameTimeDiagnosticsPlugin::default())
 | 
						|
    .insert_resource(Config {
 | 
						|
        line_count: 50_000,
 | 
						|
        fancy: false,
 | 
						|
    })
 | 
						|
    .insert_resource(GizmoConfig {
 | 
						|
        on_top: false,
 | 
						|
        ..default()
 | 
						|
    })
 | 
						|
    .add_systems(Startup, setup)
 | 
						|
    .add_systems(Update, (input, ui_system));
 | 
						|
 | 
						|
    for _ in 0..SYSTEM_COUNT {
 | 
						|
        app.add_systems(Update, system);
 | 
						|
    }
 | 
						|
 | 
						|
    app.run();
 | 
						|
}
 | 
						|
 | 
						|
#[derive(Resource, Debug)]
 | 
						|
struct Config {
 | 
						|
    line_count: u32,
 | 
						|
    fancy: bool,
 | 
						|
}
 | 
						|
 | 
						|
fn input(mut config: ResMut<Config>, input: Res<Input<KeyCode>>) {
 | 
						|
    if input.just_pressed(KeyCode::Up) {
 | 
						|
        config.line_count += 10_000;
 | 
						|
    }
 | 
						|
    if input.just_pressed(KeyCode::Down) {
 | 
						|
        config.line_count = config.line_count.saturating_sub(10_000);
 | 
						|
    }
 | 
						|
    if input.just_pressed(KeyCode::Space) {
 | 
						|
        config.fancy = !config.fancy;
 | 
						|
    }
 | 
						|
}
 | 
						|
 | 
						|
fn system(config: Res<Config>, time: Res<Time>, mut draw: Gizmos) {
 | 
						|
    if !config.fancy {
 | 
						|
        for _ in 0..(config.line_count / SYSTEM_COUNT) {
 | 
						|
            draw.line(Vec3::NEG_Y, Vec3::Y, Color::BLACK);
 | 
						|
        }
 | 
						|
    } else {
 | 
						|
        for i in 0..(config.line_count / SYSTEM_COUNT) {
 | 
						|
            let angle = i as f32 / (config.line_count / SYSTEM_COUNT) as f32 * TAU;
 | 
						|
 | 
						|
            let vector = Vec2::from(angle.sin_cos()).extend(time.elapsed_seconds().sin());
 | 
						|
            let start_color = Color::rgb(vector.x, vector.z, 0.5);
 | 
						|
            let end_color = Color::rgb(-vector.z, -vector.y, 0.5);
 | 
						|
 | 
						|
            draw.line_gradient(vector, -vector, start_color, end_color);
 | 
						|
        }
 | 
						|
    }
 | 
						|
}
 | 
						|
 | 
						|
fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
 | 
						|
    warn!(include_str!("warning_string.txt"));
 | 
						|
 | 
						|
    commands.spawn(Camera3dBundle {
 | 
						|
        transform: Transform::from_xyz(3., 1., 5.).looking_at(Vec3::ZERO, Vec3::Y),
 | 
						|
        ..default()
 | 
						|
    });
 | 
						|
 | 
						|
    commands.spawn(TextBundle::from_section(
 | 
						|
        "",
 | 
						|
        TextStyle {
 | 
						|
            font: asset_server.load("fonts/FiraSans-Bold.ttf"),
 | 
						|
            font_size: 30.,
 | 
						|
            ..default()
 | 
						|
        },
 | 
						|
    ));
 | 
						|
}
 | 
						|
 | 
						|
fn ui_system(mut query: Query<&mut Text>, config: Res<Config>, diag: Res<Diagnostics>) {
 | 
						|
    let mut text = query.single_mut();
 | 
						|
 | 
						|
    let Some(fps) = diag.get(FrameTimeDiagnosticsPlugin::FPS).and_then(|fps| fps.smoothed()) else {
 | 
						|
        return;
 | 
						|
    };
 | 
						|
 | 
						|
    text.sections[0].value = format!(
 | 
						|
        "Line count: {}\n\
 | 
						|
        FPS: {:.0}\n\n\
 | 
						|
        Controls:\n\
 | 
						|
        Up/Down: Raise or lower the line count.\n\
 | 
						|
        Spacebar: Toggle fancy mode.",
 | 
						|
        config.line_count, fps,
 | 
						|
    );
 | 
						|
}
 |