Skip to main content

InputState

Struct InputState 

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

输入状态资源

每帧追踪键盘和鼠标的完整输入状态。 支持 pressed(持续按下)、just_pressed(本帧按下)、just_released(本帧松开)查询。

§示例

use anvilkit_input::input_state::{InputState, KeyCode, MouseButton};

let mut input = InputState::new();

// 模拟按键
input.press_key(KeyCode::W);
assert!(input.is_key_pressed(KeyCode::W));
assert!(input.is_key_just_pressed(KeyCode::W));

// 帧结束
input.end_frame();
assert!(input.is_key_pressed(KeyCode::W));
assert!(!input.is_key_just_pressed(KeyCode::W));

// 松开
input.release_key(KeyCode::W);
assert!(!input.is_key_pressed(KeyCode::W));
assert!(input.is_key_just_released(KeyCode::W));

Implementations§

Source§

impl InputState

Source

pub fn new() -> Self

创建空的输入状态

Source

pub fn press_key(&mut self, key: KeyCode)

记录按键按下

Source

pub fn release_key(&mut self, key: KeyCode)

记录按键松开

Source

pub fn is_key_pressed(&self, key: KeyCode) -> bool

键是否正在按下

Source

pub fn is_key_just_pressed(&self, key: KeyCode) -> bool

键是否本帧刚按下

Source

pub fn is_key_just_released(&self, key: KeyCode) -> bool

键是否本帧刚松开

Source

pub fn press_mouse(&mut self, button: MouseButton)

记录鼠标按钮按下

Source

pub fn release_mouse(&mut self, button: MouseButton)

记录鼠标按钮松开

Source

pub fn is_mouse_pressed(&self, button: MouseButton) -> bool

鼠标按钮是否正在按下

Source

pub fn is_mouse_just_pressed(&self, button: MouseButton) -> bool

鼠标按钮是否本帧刚按下

Source

pub fn is_mouse_just_released(&self, button: MouseButton) -> bool

鼠标按钮是否本帧刚松开

Source

pub fn set_mouse_position(&mut self, position: Vec2)

设置鼠标位置

Source

pub fn add_mouse_delta(&mut self, delta: Vec2)

累加鼠标移动量

Source

pub fn mouse_position(&self) -> Vec2

获取鼠标位置

Source

pub fn mouse_delta(&self) -> Vec2

获取本帧鼠标移动量

Source

pub fn add_scroll_delta(&mut self, delta: f32)

累加滚轮滚动量

Source

pub fn scroll_delta(&self) -> f32

获取本帧滚轮滚动量

Source

pub fn end_frame(&mut self)

帧结束,清除 just_pressed / just_released / delta 状态

Source

pub fn pressed_keys(&self) -> &HashSet<KeyCode>

获取当前按下的所有键

Trait Implementations§

Source§

impl Default for InputState

Source§

fn default() -> Self

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

impl Resource for InputState
where Self: Send + Sync + 'static,

Auto Trait Implementations§

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

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

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

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

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

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

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

Source§

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

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,