Struct amethyst_input::InputSystem

pub struct InputSystem<T> where
    T: BindingTypes,  { /* fields omitted */ }

Input system

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

Methods

impl<T: BindingTypes> InputSystem<T>

pub fn new(reader: ReaderId<Event>, bindings: Option<Bindings<T>>) -> Self

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

Trait Implementations

impl<T: Debug> Debug for InputSystem<T> where
    T: BindingTypes, 

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

Formats the value using the given formatter.

impl<'a, 'b, T> SystemDesc<'a, 'b, InputSystem<T>> for InputSystemDesc<T> where
    T: BindingTypes, 

fn build(self, world: &mut World) -> InputSystem<T>

Builds and returns a System.

impl<'a, T: BindingTypes> System<'a> for InputSystem<T>

type SystemData = (Read<'a, EventChannel<Event>>, Write<'a, InputHandler<T>>, Write<'a, EventChannel<InputEvent<T>>>, ReadExpect<'a, ScreenDimensions>)

The resource bundle required to execute this system.

fn run(&mut self, (input, handler, output, screen_dimensions): 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).

fn accessor(&'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)

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