mirror of
https://github.com/bevyengine/bevy
synced 2024-09-20 06:22:01 +00:00
1af9bc853b
# Objective - This is an adopted version of #10420 - The objective is to help debugging the Ui layout tree with helpful outlines, that can be easily enabled/disabled ## Solution - Like #10420, the solution is using the bevy_gizmos in outlining the nodes --- ## Changelog ### Added - Added debug_overlay mod to `bevy_dev_tools` - Added bevy_ui_debug feature to `bevy_dev_tools` ## How to use - The user must use `bevy_dev_tools` feature in TOML - The user must use the plugin UiDebugPlugin, that can be found on `bevy::dev_tools::debug_overlay` - Finally, to enable the function, the user must set `UiDebugOptions::enabled` to true Someone can easily toggle the function with something like: ```rust fn toggle_overlay(input: Res<ButtonInput<KeyCode>>, options: ResMut<UiDebugOptions>) { if input.just_pressed(KeyCode::Space) { // The toggle method will enable if disabled and disable if enabled options.toggle(); } } ``` Note that this feature can be disabled from dev_tools, as its in fact behind a default feature there, being the feature bevy_ui_debug. # Limitations Currently, due to limitations with gizmos itself, it's not possible to support this feature to more the one window, so this tool is limited to the primary window only. # Showcase  Ui example with debug_overlay enabled  And disabled --------- Co-authored-by: Nicola Papale <nico@nicopap.ch> Co-authored-by: Pablo Reinhardt <pabloreinhardt@gmail.com> Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com> |
||
|---|---|---|
| .. | ||
| borders.rs | ||
| button.rs | ||
| display_and_visibility.rs | ||
| flex_layout.rs | ||
| font_atlas_debug.rs | ||
| grid.rs | ||
| overflow.rs | ||
| overflow_debug.rs | ||
| relative_cursor_position.rs | ||
| render_ui_to_texture.rs | ||
| size_constraints.rs | ||
| text.rs | ||
| text_debug.rs | ||
| text_wrap_debug.rs | ||
| transparency_ui.rs | ||
| ui.rs | ||
| ui_material.rs | ||
| ui_scaling.rs | ||
| ui_texture_atlas.rs | ||
| ui_texture_atlas_slice.rs | ||
| ui_texture_slice.rs | ||
| viewport_debug.rs | ||
| window_fallthrough.rs | ||
| z_index.rs | ||