WindowSystem

amethyst_window

Struct WindowSystem

pub struct WindowSystem;

Expand description

System for opening and managing the window.

Implementations§

impl WindowSystem

pub fn from_config_path( world: &mut World, events_loop: &EventsLoop, path: impl AsRef<Path>, ) -> Result<Self, ConfigError>

Builds and spawns a new Window, using the provided DisplayConfig and EventsLoop as sources. Returns a new WindowSystem

pub fn from_config( world: &mut World, events_loop: &EventsLoop, config: DisplayConfig, ) -> Self

Builds and spawns a new Window, using the provided DisplayConfig and EventsLoop as sources. Returns a new WindowSystem

pub fn new(world: &mut World, window: Window) -> Self

Create a new WindowSystem wrapping the provided Window

Trait Implementations§

impl Debug for WindowSystem

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

Formats the value using the given formatter. Read more

impl<'a> System<'a> for WindowSystem

type SystemData = (Write<'a, ScreenDimensions, PanicHandler>, Read<'a, Window, PanicHandler>)

The resource bundle required to execute this system. Read more

fn run(&mut self, (screen_dimensions, window): Self::SystemData)

Executes the system with the required system data.

fn running_time(&self) -> RunningTime

Returns a hint how long the system needs for running. This is used to optimize the way they’re executed (might allow more parallelization). Read more

fn accessor<'b>(&'b self) -> AccessorCow<'a, 'b, Self>

Return the accessor from the SystemData.

fn setup(&mut self, world: &mut World)

Sets up the World using Self::SystemData::setup.

fn dispose(self, world: &mut World)
where Self: Sized,

Performs clean up that requires resources from the World. This commonly removes components from world which depend on external resources.

Auto Trait Implementations§

impl Freeze for WindowSystem

impl RefUnwindSafe for WindowSystem

impl Send for WindowSystem

impl Sync for WindowSystem

impl Unpin for WindowSystem

impl UnwindSafe for WindowSystem

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn get_type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

impl<'a, T> RunNow<'a> for T
where T: System<'a>,

fn run_now(&mut self, world: &'a World)

Runs the system now. Read more

fn setup(&mut self, world: &mut World)

Sets up World for a later call to run_now.

fn dispose(self: Box<T>, world: &mut World)

Performs clean up that requires resources from the World. This commonly removes components from world which depend on external resources.

impl<'a, T> RunWithPool<'a> for T
where T: System<'a>,

fn setup(&mut self, world: &mut World)

Sets up World for a later call to run.

fn run(&mut self, world: &'a World, _: &ThreadPool)

Runs the system/group of systems. Possibly in parallel depending on how the structure is set up. Read more

fn reads(&self, reads: &mut Vec<ResourceId>)

Accumulates the necessary read/shared resources from the systems in this group.

fn writes(&self, writes: &mut Vec<ResourceId>)

Accumulates the necessary write/exclusive resources from the systems in this group.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SetParameter for T

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result
where T: Parameter<Self>,

Sets value as a parameter of self.

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<'s, S> SystemExt for S
where S: System<'s>,

fn pausable<V>(self, value: V) -> Pausable<S, V>
where V: 'static + Send + Sync + Default + PartialEq,

Make a system pausable by tying it to a specific value of a resource. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> Event for T
where T: Send + Sync + 'static,

impl<T> Resource for T
where T: Any + Send + Sync,