Struct amethyst_input::InputSystem

source ·

pub struct InputSystem<AX, AC>where
    AX: Hash + Eq,
    AC: Hash + Eq,{ /* private fields */ }

Expand description

Input system

Will read winit::Event from EventHandler<winit::Event>, process them with InputHandler, and push the results in EventHandler<InputEvent>.

Implementations

source

impl<AX, AC> InputSystem<AX, AC>where
AX: Hash + Eq,
AC: Hash + Eq,

source

pub fn new(bindings: Option<Bindings<AX, AC>>) -> Self

Create a new input system. Needs a reader id for EventHandler<winit::Event>.

Trait Implementations

source

impl<'a, AX, AC> System<'a> for InputSystem<AX, AC>where
AX: Hash + Eq + Clone + Send + Sync + 'static,
AC: Hash + Eq + Clone + Send + Sync + 'static,

type SystemData = (Read<'a, EventChannel<Event>, DefaultProvider>, Write<'a, InputHandler<AX, AC>, DefaultProvider>, Write<'a, EventChannel<InputEvent<AC>>, DefaultProvider>)

The resource bundle required to execute this system. Read more

source

fn run(&mut self, (input, handler, output): Self::SystemData)

Executes the system with the required system data. Read more

source

fn setup(&mut self, res: &mut Resources)

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

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 dispose(self, res: &mut Resources)where
Self: Sized,

Performs clean up that requires resources from the Resources. Read more

Auto Trait Implementations

impl<AX, AC> !RefUnwindSafe for InputSystem<AX, AC>

impl<AX, AC> Send for InputSystem<AX, AC>where
AC: Send,
AX: Send,

impl<AX, AC> Sync for InputSystem<AX, AC>where
AC: Sync,
AX: Sync,

impl<AX, AC> Unpin for InputSystem<AX, AC>where
AC: Unpin,
AX: Unpin,

impl<AX, AC> !UnwindSafe for InputSystem<AX, AC>

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Any for Twhere
T: Any,

fn get_type_id(&self) -> TypeId

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Downcast for Twhere
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

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 Twhere
T: System<'a>,

fn run_now(&mut self, res: &'a Resources)

Runs the system now. Read more

fn setup(&mut self, res: &mut Resources)

Sets up Resources for a later call to run_now.

fn dispose(self: Box<T, Global>, res: &mut Resources)

Performs clean up that requires resources from the Resources. Read more

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

fn setup(&mut self, res: &mut Resources)

Sets up Resources for a later call to run.

fn run(&mut self, res: &'a Resources, _: &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, Global>)

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

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct amethyst_input::InputSystem

Implementations

impl<AX, AC> InputSystem<AX, AC>where AX: Hash + Eq, AC: Hash + Eq,

pub fn new(bindings: Option<Bindings<AX, AC>>) -> Self

Trait Implementations

impl<'a, AX, AC> System<'a> for InputSystem<AX, AC>where AX: Hash + Eq + Clone + Send + Sync + 'static, AC: Hash + Eq + Clone + Send + Sync + 'static,

type SystemData = (Read<'a, EventChannel<Event>, DefaultProvider>, Write<'a, InputHandler<AX, AC>, DefaultProvider>, Write<'a, EventChannel<InputEvent<AC>>, DefaultProvider>)

fn run(&mut self, (input, handler, output): Self::SystemData)

fn setup(&mut self, res: &mut Resources)

fn running_time(&self) -> RunningTime

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

fn dispose(self, res: &mut Resources)where Self: Sized,

Auto Trait Implementations

impl<AX, AC> !RefUnwindSafe for InputSystem<AX, AC>

impl<AX, AC> Send for InputSystem<AX, AC>where AC: Send, AX: Send,

impl<AX, AC> Sync for InputSystem<AX, AC>where AC: Sync, AX: Sync,

impl<AX, AC> Unpin for InputSystem<AX, AC>where AC: Unpin, AX: Unpin,

impl<AX, AC> !UnwindSafe for InputSystem<AX, AC>

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> Any for Twhere T: Any,

fn get_type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

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

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

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

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

fn run_now(&mut self, res: &'a Resources)

fn setup(&mut self, res: &mut Resources)

fn dispose(self: Box<T, Global>, res: &mut Resources)

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

fn setup(&mut self, res: &mut Resources)

fn run(&mut self, res: &'a Resources, _: &ThreadPool)

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

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

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

type Error = Infallible

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

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

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

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

impl<T> Erased for T

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

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

impl<AX, AC> InputSystem<AX, AC>where
AX: Hash + Eq,
AC: Hash + Eq,

impl<'a, AX, AC> System<'a> for InputSystem<AX, AC>where
AX: Hash + Eq + Clone + Send + Sync + 'static,
AC: Hash + Eq + Clone + Send + Sync + 'static,

fn dispose(self, res: &mut Resources)where
Self: Sized,

impl<AX, AC> Send for InputSystem<AX, AC>where
AC: Send,
AX: Send,

impl<AX, AC> Sync for InputSystem<AX, AC>where
AC: Sync,
AX: Sync,

impl<AX, AC> Unpin for InputSystem<AX, AC>where
AC: Unpin,
AX: Unpin,

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

impl<T> Any for Twhere
T: Any,

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

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

impl<T> Downcast for Twhere
T: Any,

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

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

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

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

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

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

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

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