[][src]Crate bevy_inspector_egui

This crate provides the ability to annotate structs with a #[derive(Inspectable)], which opens a debug interface using egui where you can visually edit the values of your struct live.

Your struct will then be available to you as a bevy resource.

Example

use bevy_inspector_egui::Inspectable;

#[derive(Inspectable, Default)]
struct Data {
    should_render: bool,
    text: String,
    #[inspectable(min = 42.0, max = 100.0)]
    size: f32,
}

Add the InspectorPlugin to your App.

use bevy_inspector_egui::InspectorPlugin;

fn main() {
    App::build()
        .add_plugins(DefaultPlugins)
        .add_plugin(InspectorPlugin::<Data>::new())
        .add_system(your_system.system())
        .run();
}

// fn your_system(data: Res<Data>) { /* */ }

Re-exports

pub use bevy_egui::egui;

Modules

options

Attributes for the built-in Inspectable implementations

Structs

InspectorPlugin

Bevy plugin for the inspector. See the crate-level docs for an example on how to use it.

Options

This type is passed to the Inspectable::ui method to give access to the attributes specified in the #[derive(Inspectable)]. For an example of defining custom attributes, see the docs of Inspectable.

Traits

Inspectable

This trait describes how a struct should be displayed. It can be derived for structs and enums, see the crate-level docs for how to do that.

Derive Macros

Inspectable

Derives the Inspectable trait.