bevy_input/

lib.rs

#![cfg_attr(docsrs, feature(doc_cfg))]
#![forbid(unsafe_code)]
#![doc(
    html_logo_url = "https://bevy.org/assets/icon.png",
    html_favicon_url = "https://bevy.org/assets/icon.png"
)]
#![no_std]

//! Input functionality for the [Bevy game engine](https://bevy.org/).
//!
//! # Supported input devices
//!
//! `bevy` currently supports keyboard, mouse, gamepad, and touch inputs.

#[cfg(feature = "std")]
extern crate std;

extern crate alloc;

mod axis;
mod button_input;
/// Common run conditions
pub mod common_conditions;

#[cfg(feature = "gamepad")]
pub mod gamepad;

#[cfg(feature = "gestures")]
pub mod gestures;

#[cfg(feature = "keyboard")]
pub mod keyboard;

#[cfg(feature = "mouse")]
pub mod mouse;

// Also enabled with `mouse` because `MouseWheel` reuses `TouchPhase` for trackpad scroll phases.
#[cfg(any(feature = "touch", feature = "mouse"))]
pub mod touch;

pub use axis::*;
pub use button_input::*;

/// The input prelude.
///
/// This includes the most common types in this crate, re-exported for your convenience.
pub mod prelude {
    #[doc(hidden)]
    pub use crate::{Axis, ButtonInput};

    #[doc(hidden)]
    #[cfg(feature = "gamepad")]
    pub use crate::gamepad::{Gamepad, GamepadAxis, GamepadButton, GamepadSettings};

    #[doc(hidden)]
    #[cfg(feature = "keyboard")]
    pub use crate::keyboard::KeyCode;

    #[doc(hidden)]
    #[cfg(feature = "mouse")]
    pub use crate::mouse::MouseButton;

    #[doc(hidden)]
    #[cfg(feature = "touch")]
    pub use crate::touch::{TouchInput, Touches};
}

use bevy_app::prelude::*;
use bevy_ecs::prelude::*;
#[cfg(feature = "bevy_reflect")]
use bevy_reflect::Reflect;

#[cfg(feature = "gestures")]
use gestures::*;

#[cfg(feature = "keyboard")]
use keyboard::{keyboard_input_system, Key, KeyCode, KeyboardFocusLost, KeyboardInput};

#[cfg(feature = "mouse")]
use mouse::{
    accumulate_mouse_motion_system, accumulate_mouse_scroll_system, mouse_button_input_system,
    AccumulatedMouseMotion, AccumulatedMouseScroll, MouseButton, MouseButtonInput, MouseMotion,
    MouseWheel,
};

#[cfg(feature = "touch")]
use touch::{touch_screen_input_system, TouchInput, Touches};

#[cfg(feature = "gamepad")]
use gamepad::{
    gamepad_connection_system, gamepad_event_processing_system, GamepadAxisChangedEvent,
    GamepadButtonChangedEvent, GamepadButtonStateChangedEvent, GamepadConnectionEvent,
    GamepadEvent, GamepadRumbleRequest, RawGamepadAxisChangedEvent, RawGamepadButtonChangedEvent,
    RawGamepadEvent,
};

#[cfg(all(feature = "serialize", feature = "bevy_reflect"))]
use bevy_reflect::{ReflectDeserialize, ReflectSerialize};

/// Adds input from various sources to an App
#[derive(Default)]
pub struct InputPlugin;

/// Label for systems that update the input data.
#[derive(Debug, PartialEq, Eq, Clone, Hash, SystemSet)]
pub struct InputSystems;

impl Plugin for InputPlugin {
    #[expect(clippy::allow_attributes, reason = "this is only sometimes unused")]
    #[allow(unused, reason = "all features could be disabled")]
    fn build(&self, app: &mut App) {
        #[cfg(feature = "keyboard")]
        app.add_message::<KeyboardInput>()
            .add_message::<KeyboardFocusLost>()
            .init_resource::<ButtonInput<KeyCode>>()
            .init_resource::<ButtonInput<Key>>()
            .add_systems(PreUpdate, keyboard_input_system.in_set(InputSystems));

        #[cfg(feature = "mouse")]
        app.add_message::<MouseButtonInput>()
            .add_message::<MouseMotion>()
            .add_message::<MouseWheel>()
            .init_resource::<AccumulatedMouseMotion>()
            .init_resource::<AccumulatedMouseScroll>()
            .init_resource::<ButtonInput<MouseButton>>()
            .add_systems(
                PreUpdate,
                (
                    mouse_button_input_system,
                    accumulate_mouse_motion_system,
                    accumulate_mouse_scroll_system,
                )
                    .in_set(InputSystems),
            );

        #[cfg(feature = "gestures")]
        app.add_message::<PinchGesture>()
            .add_message::<RotationGesture>()
            .add_message::<DoubleTapGesture>()
            .add_message::<PanGesture>();

        #[cfg(feature = "gamepad")]
        app.add_message::<GamepadEvent>()
            .add_message::<GamepadConnectionEvent>()
            .add_message::<GamepadButtonChangedEvent>()
            .add_message::<GamepadButtonStateChangedEvent>()
            .add_message::<GamepadAxisChangedEvent>()
            .add_message::<RawGamepadEvent>()
            .add_message::<RawGamepadAxisChangedEvent>()
            .add_message::<RawGamepadButtonChangedEvent>()
            .add_message::<GamepadRumbleRequest>()
            .add_systems(
                PreUpdate,
                (
                    gamepad_connection_system,
                    gamepad_event_processing_system.after(gamepad_connection_system),
                )
                    .in_set(InputSystems),
            );

        #[cfg(feature = "touch")]
        app.add_message::<TouchInput>()
            .init_resource::<Touches>()
            .add_systems(PreUpdate, touch_screen_input_system.in_set(InputSystems));
    }
}

/// The current "press" state of an element
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
#[cfg_attr(
    feature = "bevy_reflect",
    derive(Reflect),
    reflect(Debug, Hash, PartialEq, Clone)
)]
#[cfg_attr(feature = "serialize", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(
    all(feature = "serialize", feature = "bevy_reflect"),
    reflect(Serialize, Deserialize)
)]
pub enum ButtonState {
    /// The button is pressed.
    Pressed,
    /// The button is not pressed.
    Released,
}

impl ButtonState {
    /// Is this button pressed?
    pub fn is_pressed(&self) -> bool {
        matches!(self, ButtonState::Pressed)
    }
}