migrations/egui
1
0
Fork 0
mirror of https://github.com/emilk/egui.git synced 2026-06-26 22:53:14 -04:00
Code Activity

Improve docs of key/button "down" state (#7851)

Browse Source
This commit is contained in:
Emil Ernerfeldt
2026-01-19 09:01:11 +01:00
committed by GitHub
parent b3ffbca2ab
commit 83e61c6fb0
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
crates/egui/src/input_state/mod.rs
View File

@@ -319,7 +319,9 @@ pub struct InputState {
/// Which modifier keys are down at the start of the frame?
pub modifiers: Modifiers,
// The keys that are currently being held down.
/// The keys that are currently being held down.
///
/// Keys released this frame are NOT considered down.
pub keys_down: HashSet<Key>,
/// In-order events received this frame
@@ -765,6 +767,8 @@ impl InputState {
}
/// Is the given key currently held down?
///
/// Keys released this frame are NOT considered down.
pub fn key_down(&self, desired_key: Key) -> bool {
self.keys_down.contains(&desired_key)
}
@@ -1018,6 +1022,7 @@ pub struct PointerState {
/// Used for calculating velocity of pointer.
pos_history: History<Pos2>,
/// Buttons currently down, excluding those released this frame.
down: [bool; NUM_POINTER_BUTTONS],
/// Where did the current click/drag originate?
@@ -1405,6 +1410,8 @@ impl PointerState {
}
/// Is any pointer button currently down?
///
/// Buttons released this frame are NOT considered down.
pub fn any_down(&self) -> bool {
self.down.iter().any(|&down| down)
}
@@ -1460,6 +1467,8 @@ impl PointerState {
}
/// Is this button currently down?
///
/// Buttons released this frame are NOT considered down.
#[inline(always)]
pub fn button_down(&self, button: PointerButton) -> bool {
self.down[button as usize]
@@ -1516,18 +1525,24 @@ impl PointerState {
}
/// Is the primary button currently down?
///
/// Buttons released this frame are NOT considered down.
#[inline(always)]
pub fn primary_down(&self) -> bool {
self.button_down(PointerButton::Primary)
}
/// Is the secondary button currently down?
///
/// Buttons released this frame are NOT considered down.
#[inline(always)]
pub fn secondary_down(&self) -> bool {
self.button_down(PointerButton::Secondary)
}
/// Is the middle button currently down?
///
/// Buttons released this frame are NOT considered down.
#[inline(always)]
pub fn middle_down(&self) -> bool {
self.button_down(PointerButton::Middle)