Struct bevy_inspector_egui::Context

pub struct Context<'a> {
    pub ui_ctx: Option<&'a CtxRef>,
    pub id: Option<u64>,
    // some fields omitted
}

The context passed to Inspectable::ui.

Fields

ui_ctx: Option<&'a CtxRef>

egui ui context

id: Option<u64>

Something to distinguish between siblings.

Implementations

impl<'a> Context<'a>

pub unsafe fn world(&'a self) -> Option<&'a mut World>

Gives mutable access to the [bevy::ecs::world::World]

Safety

The pointer provided in Context::new_raw must give unique access.

impl<'a> Context<'a>

pub fn new(ui_ctx: &'a CtxRef, world: &'a mut World) -> Self

Create new context with exclusive access to the World

pub unsafe fn new_ptr(ui_ctx: Option<&'a CtxRef>, world: *mut World) -> Self

Create a new context with access to the world

Safety

The world pointer must come from a mutable reference to a world and no other threads must be writing to it.

pub fn new_shared(ui_ctx: Option<&'a CtxRef>) -> Self

Creates a context without access to World

pub fn with_id(&self, id: u64) -> Self

Same context but with a specified id

pub fn id(&self) -> Id

Returns the id if present, otherwise a dummy id.