Skip to main content

App

Struct App 

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

The main application container for ECS-based games.

App holds a World and a set of SystemStages organized by CoreStage. Systems are added to stages and executed in stage order.

§Stage Execution Order

Stages run in CoreStage order: PreUpdate, Update, PostUpdate, PreRender, Render, PostRender.

Implementations§

Source§

impl App

Source

pub fn new_with_defaults() -> Self

Creates a new App with default stages and all DefaultPlugins applied.

Source

pub fn new() -> Self

Creates a new App with default stages for each CoreStage variant.

Source

pub fn add_plugin<P: Plugin>(&mut self, plugin: P) -> &mut Self

Adds a plugin to the app.

Each plugin type can only be added once. Duplicate additions are silently ignored.

§Panics

Panics if the plugin declares dependencies that have not been added.

Source

pub fn add_plugin_group<G: PluginGroup>(&mut self, group: G) -> &mut Self

Adds a plugin group to the app.

Source

pub fn insert_non_send_resource<T: NonSendResource>( &mut self, resource: T, ) -> &mut Self

Inserts a non-send resource into the world.

Source

pub fn add_system<S, Marker>( &mut self, stage: CoreStage, system: S, ) -> &mut Self
where S: IntoSystem<Marker>,

Adds a system to the specified stage.

Source

pub fn insert_resource<R: Resource>(&mut self, resource: R) -> &mut Self

Inserts a resource into the world.

Source

pub fn world(&self) -> &World

Returns an immutable reference to the world.

Source

pub fn world_mut(&mut self) -> &mut World

Returns a mutable reference to the world.

Source

pub fn run_once(&mut self)

Executes all stages once in order.

This runs every stage’s systems on the world, from PreUpdate through PostRender.

Source

pub fn update(&mut self)

Executes all stages once, designed for per-frame use.

Currently identical to run_once. In the future, this may include frame-specific logic such as delta time updates.

Source

pub fn register_set(&mut self, stage: CoreStage, name: &str) -> &mut Self

Registers a named system set in the specified stage.

Source

pub fn add_system_to_set<S, Marker>( &mut self, stage: CoreStage, set_name: &str, system: S, ) -> &mut Self
where S: IntoSystem<Marker>,

Adds a system to a named set, returning its [SystemId].

The system is added to the stage and simultaneously placed in the named set.

Source

pub fn configure_set( &mut self, stage: CoreStage, name: &str, config: SystemSetConfig, ) -> &mut Self

Configures ordering for a named set in the specified stage.

Trait Implementations§

Source§

impl Debug for App

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for App

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for App

§

impl !RefUnwindSafe for App

§

impl !Send for App

§

impl !Sync for App

§

impl Unpin for App

§

impl UnsafeUnpin for App

§

impl !UnwindSafe for App

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
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<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,