Struct EguiBridge 

pub struct EguiBridge {
    pub max_texture_bits: u8,
    /* private fields */
}

Primary Egui Interface.

Fields

max_texture_bits: u8

Number of bits allowed for texture size.

The texture will be 2^max_texture_size

Implementations

impl EguiBridge

pub fn get_max_texture_bits(&self) -> <u8 as GodotConvert>::Via

pub fn set_max_texture_bits( &mut self, max_texture_bits: <u8 as GodotConvert>::Via, )

impl EguiBridge

APIs for spawning viewports.

Key for every APIs are that any access to egui::Context triggers

pub fn setup_context(&self, setter: impl FnOnce(&Context) + 'static + Send)

Access to egui context at intra-frame. This will be called immediately if we’re already out of frame boundary(e.g. start..end), otherwise, queue it to be called later.

pub fn sync_root_region(&self, target: Option<Gd<Control>>)

Synchronize root viewport’s region with given control. If None is given, it unregisters synchronization.

pub fn current_frame(&self) -> &Context

Start a new frame (if required), and return context which you can draw with.

This is very default way of using EGUI, and anything you draw upon this will be shown below the spawned root canvas; EguiBridge

Use this when you want to draw widget every frame within process() function.

Caveats

• Cloning egui::Context and access it directly out of provided lifecycle is not recommneded. Please guarantee that you only access this context within main thread, right after calling current_frame.

Panics

• Called from non main gameplay thread.

pub fn viewport_immediate<R>( &self, id: ViewportId, builder: ViewportBuilder, show: impl FnMut(&Context, ViewportClass) -> R, ) -> R

Render viewport for current frame.

This is shortcut to following code.

let id = ViewportId::from_hash("123");
let builder = ViewportBuilder::default();

bridge.current_frame().show_viewport_immediate(
    id, builder, |ctx, viewport_class| {
        // do something ...    
    }
);

Panics

pub fn viewport_spawn<L>( &self, id: ViewportId, builder: ViewportBuilder, show: impl FnMut(&Context) -> L + 'static, )

where L: Into<WidgetRetain>,

Spawn new viewport, which renders provided callback at the start of next frame. This is thread-safe, however, you should call exactly once per gameplay frame to ensure viewport is persisted correctly.

This is inherently a shortcut to following code.

let id = ViewportId::from_hash("123");
let builder = ViewportBuilder::default();

bridge.egui_start().show_viewport_deferred(
    id, builder, move |ctx, viewport_class| {
        // do something ...    

        // Viewport will be retained as long as you
        true
    }
);

pub fn register_render_callback_first<L>( &self, priority: i32, widget: impl FnEguiDraw<L>, )

where L: Into<WidgetRetain>,

Registers callback for widget rendering at frame start.

See also FnEguiDrawExt decorator for every method with signature impl FnMut(&egui::Context) -> impl Into<WidgetRetain> + 'static

Callbacks registered with lower priority will be called earlier.

pub fn register_render_callback_last<L>( &self, priority: i32, widget: impl FnEguiDraw<L>, )

where L: Into<WidgetRetain>,

Registers callback for widget rendering at frame end.

See also FnEguiDrawExt decorator for every method with signature impl FnMut(&egui::Context) -> impl Into<WidgetRetain> + 'static

Callbacks registered with lower priority will be called earlier.

pub fn viewport_spawn_as_child( &self, _id: ViewportId, _parent: Gd<Control>, _builder: ViewportBuilder, _show: impl FnOnce(&Context) -> WidgetRetain + 'static, )

Spawn new viewport as child of existing node. If specified parent node is behind other node, the input may work naturally as the egui surface always intercepts any GUI input. It is advised to use this method for any node that lays over any other GUI nodes, which makes all egui rendering appear always top of the other GUI nodes.

pub fn attach_node_to_viewport( &self, _id: ViewportId, node: Gd<Node>, ) -> Result<(), Gd<Node>>

Attach given node to given viewport’s window.

TODO: Implement this!

Trait Implementations

impl Bounds for EguiBridge

type Memory = <<EguiBridge as GodotClass>::Base as Bounds>::Memory

Defines the memory strategy of the static type.

type Declarer = DeclUser

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl GodotClass for EguiBridge

type Base = CanvasLayer

The immediate superclass of T. This is always a Godot engine class.

fn class_id() -> ClassId

Globally unique class ID, linked to the name under which the class is registered in Godot.

fn class_name() -> ClassId

👎Deprecated:

Renamed to class_id()

const INIT_LEVEL: InitLevel = <Self::Base as GodotClass>::INIT_LEVEL

Initialization level, during which this class should be initialized with Godot.

fn inherits<Base>() -> bool

where Base: GodotClass,

Returns whether Self inherits from Base.

impl GodotDefault for EguiBridge

impl ICanvasLayer for EguiBridge

fn process(&mut self, _dt: f64)

fn enter_tree(&mut self)

fn exit_tree(&mut self)

fn init(base: Base<Self::Base>) -> Self

Godot constructor, accepting an injected base object.

fn to_string(&self) -> GString

String representation of the Godot instance.

fn on_notification(&mut self, what: NodeNotification)

Called when the object receives a Godot notification.

fn get_property(&self, property: StringName) -> Option<Variant>

Called whenever get() is called or Godot gets the value of a property.

fn set_property(&mut self, property: StringName, value: Variant) -> bool

Called whenever Godot set() is called or Godot sets the value of a property.

fn get_property_list(&mut self) -> Vec<PropertyInfo>

Called whenever Godot get_property_list() is called, the returned vector here is appended to the existing list of properties.

fn validate_property(&self, property: &mut PropertyInfo)

Called whenever Godot retrieves value of property. Allows to customize existing properties. Every property info goes through this method, except properties added with get_property_list().

fn property_get_revert(&self, property: StringName) -> Option<Variant>

Called by Godot to tell if a property has a custom revert or not.

fn physics_process(&mut self, delta: f64)

fn ready(&mut self)

fn get_configuration_warnings(&self) -> PackedArray<GString>

fn get_accessibility_configuration_warnings(&self) -> PackedArray<GString>

fn input(&mut self, event: Gd<InputEvent>)

fn shortcut_input(&mut self, event: Gd<InputEvent>)

fn unhandled_input(&mut self, event: Gd<InputEvent>)

fn unhandled_key_input(&mut self, event: Gd<InputEvent>)

fn get_focused_accessibility_element(&self) -> Rid

impl ImplementsGodotApi for EguiBridge

impl ImplementsGodotExports for EguiBridge

impl ImplementsGodotVirtual for EguiBridge

impl Inherits<CanvasLayer> for EguiBridge

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Node> for EguiBridge

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for EguiBridge

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl WithBaseField for EguiBridge

fn to_gd(&self) -> Gd<EguiBridge>

Returns the Gd pointer containing this object.

fn base(&self) -> BaseRef<'_, Self>

Returns a shared reference guard, suitable for calling &self engine methods on this object.

fn base_mut(&mut self) -> BaseMut<'_, Self>

Returns an exclusive reference guard, suitable for calling &self/&mut self engine methods on this object.

fn run_deferred<F>(&mut self, mut_self_method: F)

where F: FnOnce(&mut Self) + 'static,

Defers the given closure to run during idle time.

fn run_deferred_gd<F>(&mut self, gd_function: F)

where F: FnOnce(Gd<Self>) + 'static,

Defers the given closure to run during idle time.

fn apply_deferred<F>(&mut self, rust_function: F)

where F: FnOnce(&mut Self) + 'static,

👎Deprecated:

Split into run_deferred() + run_deferred_gd().

impl WithSignals for EguiBridge

type SignalCollection<'c, C: WithSignals> = __godot_Signals_EguiBridge<'c, C>

The associated struct listing all signals of this class.

impl WithUserSignals for EguiBridge

fn signals(&mut self) -> Self::SignalCollection<'_, Self>

Access user-defined signals of the current object self.

impl You_forgot_the_attribute__godot_api for EguiBridge