Skip to main content

EnginePlugin

Struct EnginePlugin 

Source
pub struct EnginePlugin { /* private fields */ }
Expand description

A plugin that injects callbacks into the frame pipeline.

Implementations§

Source§

impl EnginePlugin

Source

pub fn new(name: &str) -> Self

Creates a new plugin with the given name.

Source

pub fn on_phase( &mut self, phase: ExecutionPhase, f: impl Fn(&mut World) + Send + 'static, )

Registers a callback for a specific execution phase.

Source

pub fn execute(&mut self, phase: ExecutionPhase, world: &mut World)

Executes the hook for a phase, if one is registered.

Source

pub fn wants_phase(&self, phase: ExecutionPhase) -> bool

Returns true if this plugin has a hook for the given phase.

Source

pub fn name(&self) -> &str

Returns the plugin name.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> AppLifecycle for T
where T: ?Sized,

§

fn on_start(&mut self, ctx: &mut dyn AppContext)

Called once after the backend is up but before the first update. Apps install their theme / fonts here.
§

fn on_exit(&mut self)

Called once when the window is closing. Persist state here.
§

impl<T> AsAny for T
where T: Any,

§

fn as_any(&self) -> &(dyn Any + 'static)

Returns a reference to the inner value as &dyn Any.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.