1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
//! User and system [Event]s.
use bitflags::bitflags;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use std::{
fmt,
ops::{Deref, DerefMut},
};
/// System or User `Event`.
#[non_exhaustive]
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum Event {
/// System quit event for the application.
Quit,
/// System termination event for the application.
AppTerminating,
/// Window events.
Window {
/// Window identifer for this event.
window_id: u32,
/// Specific window event.
win_event: WindowEvent,
},
/// User key press event.
KeyDown {
/// Specific key being pressed.
key: Option<Key>,
/// Key modifiers being held upon press, e.g. Shift or Ctrl, etc.
keymod: KeyMod,
/// Whether this is a key-repeat event.
repeat: bool,
},
/// User key release event.
KeyUp {
/// Specific key being released.
key: Option<Key>,
/// Key modifiers being held upon release, e.g. Shift or Ctrl, etc.
keymod: KeyMod,
/// Whether this is a key-repeat event.
repeat: bool,
},
/// User text entry event.
TextInput {
/// The user-entered text.
text: String,
},
/// User mouse movement event.
MouseMotion {
/// Current horizontal mouse position after motion.
x: i32,
/// Current vertical mouse position after motion.
y: i32,
/// Relative horizontal screen movement since last event.
xrel: i32,
/// Relative vertical screen movement since last event.
yrel: i32,
},
/// User mouse click event.
MouseDown {
/// Specific mouse button being clicked.
button: Mouse,
/// Current horizontal mouse position after click.
x: i32,
/// Current vertical mouse position after click.
y: i32,
},
/// User mouse release event.
MouseUp {
/// Specific mouse button being released.
button: Mouse,
/// Current horizontal mouse position after release.
x: i32,
/// Current vertical mouse position after release.
y: i32,
},
/// User mouse wheel event.
MouseWheel {
/// Relative horizontal wheel offset.
x: i32,
/// Relative vertical wheel offset.
y: i32,
},
/// User joystick axis movement event.
JoyAxisMotion {
/// Specific attached joystick identifier.
joy_id: u32,
/// Specific joystick axis being moved.
axis_idx: u8,
/// Relative value of axis motion.
value: i16,
},
/// User joystick hat movement event.
JoyHatMotion {
/// Specific attached joystick identifier.
joy_id: u32,
/// Specific joystick hat being moved.
hat_idx: u8,
/// Hat state.
state: HatState,
},
/// User joystick ball movement event.
JoyBallMotion {
/// Specific attached joystick identifier.
joy_id: u32,
/// Specific joystick ball being moved.
ball_idx: u8,
/// Relative horizontal value of ball motion.
xrel: i16,
/// Relative vertical value of ball motion.
yrel: i16,
},
/// User joystick button pressed event.
JoyDown {
/// Specific attached joystick identifier.
joy_id: u32,
/// Specific joystick button being pressed.
button_idx: u8,
},
/// User joystick button released event.
JoyUp {
/// Specific attached joystick identifier.
joy_id: u32,
/// Specific joystick button being released.
button_idx: u8,
},
/// User joystick connected event.
JoyDeviceAdded {
/// Specific attached joystick identifier.
joy_id: u32,
},
/// User joystick disconnected event.
JoyDeviceRemoved {
/// Specific attached joystick identifier.
joy_id: u32,
},
/// User controller axis movement event.
ControllerAxisMotion {
/// Specific attached controller identifier.
controller_id: u32,
/// Specific controller axis being moved.
axis: Axis,
/// Relative value of axis motion.
value: i16,
},
/// User controller button pressed event.
ControllerDown {
/// Specific attached controller identifier.
controller_id: u32,
/// Specific controller button being pressed.
button: ControllerButton,
},
/// User controller button released event.
ControllerUp {
/// Specific attached controller identifier.
controller_id: u32,
/// Specific controller button being released.
button: ControllerButton,
},
/// User controller connected event.
ControllerAdded {
/// Specific attached controller identifier.
controller_id: u32,
},
/// User controller disconnected event.
ControllerRemoved {
/// Specific attached controller identifier.
controller_id: u32,
},
/// User controller remapped event.
ControllerRemapped {
/// Specific attached controller identifier.
controller_id: u32,
},
/// User finger press event.
FingerDown {
/// Specific touch device identifier.
touch_id: i64,
/// Specific finger identifier.
finger_id: i64,
/// Current horizontal finger position after press.
x: f32,
/// Current vertical finger position after press.
y: f32,
/// Relative horizontal finger position since last event.
dx: f32,
/// Relative vertical finger position since last event.
dy: f32,
/// Amount of finger pressure being applied during press.
pressure: f32,
},
/// User finger released event.
FingerUp {
/// Specific touch device identifier.
touch_id: i64,
/// Specific finger identifier.
finger_id: i64,
/// Current horizontal finger position after press.
x: f32,
/// Current vertical finger position after press.
y: f32,
/// Relative horizontal finger position since last event.
dx: f32,
/// Relative vertical finger position since last event.
dy: f32,
/// Amount of finger pressure being applied during press.
pressure: f32,
},
/// User finger movement event.
FingerMotion {
/// Specific touch device identifier.
touch_id: i64,
/// Specific finger identifier.
finger_id: i64,
/// Current horizontal finger position after press.
x: f32,
/// Current vertical finger position after press.
y: f32,
/// Relative horizontal finger position since last event.
dx: f32,
/// Relative vertical finger position since last event.
dy: f32,
/// Amount of finger pressure being applied during press.
pressure: f32,
},
/// Audio device connected event.
AudioDeviceAdded {
/// Specific audio device identifier.
device_id: u32,
/// Whether this device is a capture device or not.
iscapture: bool,
},
/// Audio device disconnected event.
AudioDeviceRemoved {
/// Specific audio device identifier.
device_id: u32,
/// Whether this device is a capture device or not.
iscapture: bool,
},
/// An unknown/unsupported event.
Unhandled,
}
impl Default for Event {
fn default() -> Self {
Self::Unhandled
}
}
/// A specific [Event] representing a keypress.
#[non_exhaustive]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct KeyEvent {
/// Specific key for this event.
pub key: Key,
/// Key modifiers being held upon press, e.g. Shift or Ctrl, etc.
pub keymod: KeyMod,
/// Whether this is a key-repeat event.
pub repeat: bool,
}
impl KeyEvent {
pub(crate) const fn new(key: Key, keymod: KeyMod, repeat: bool) -> Self {
Self {
key,
keymod,
repeat,
}
}
}
/// Window [Event].
#[non_exhaustive]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum WindowEvent {
/// Window is being shown.
Shown,
/// Window is being exposed.
Exposed,
/// Window is being hidden.
Hidden,
/// Window moved to new position `(x, y)`
Moved(i32, i32),
/// Window resized to new dimensions `(width, height
Resized(i32, i32),
/// Window size changed to new dimensions `(width, height
SizeChanged(i32, i32),
/// Window minimized.
Minimized,
/// Window maximized.
Maximized,
/// Window restored.
Restored,
/// Users mouse entered the window.
Enter,
/// Users mouse left the window.
Leave,
/// Window gained user focus.
FocusGained,
/// Window lost user focus.
FocusLost,
/// Window closed.
Close,
/// An unknown/unsupported window event.
Unhandled,
}
impl Default for WindowEvent {
fn default() -> Self {
Self::Unhandled
}
}
/// Mouse Button type.
#[non_exhaustive]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum Mouse {
/// Left mouse button.
Left,
/// Middle mouse wheel/button.
Middle,
/// Right mouse button.
Right,
/// An unknown/unsupported mouse button.
Unhandled,
}
impl Default for Mouse {
fn default() -> Self {
Self::Unhandled
}
}
bitflags! {
/// Key Modifier.
#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(transparent))]
#[must_use]
pub struct KeyMod: u16 {
/// No key modifier.
const NONE = 0x0000;
/// Left Shift or Right Shift.
const SHIFT = 0x0001;
/// Left Control or Right Control.
const CTRL = 0x0040;
/// Left Alt/Option or Right Alt/Option.
const ALT = 0x0100;
/// Left GUI or Right GUI (e.g. Windows or Command keys).
const GUI = 0x0400;
}
}
/// Keyboard key.
#[allow(missing_docs)]
#[non_exhaustive]
#[rustfmt::skip]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum Key {
Backspace, Tab, Return, Escape, Space, Exclaim, Quotedbl, Hash, Dollar, Percent, Ampersand,
Quote, LeftParen, RightParen, Asterisk, Plus, Comma, Minus, Period, Slash, Num0, Num1, Num2,
Num3, Num4, Num5, Num6, Num7, Num8, Num9, Colon, Semicolon, Less, Equals, Greater, Question,
At, LeftBracket, Backslash, RightBracket, Caret, Underscore, Backquote, A, B, C, D, E, F, G, H,
I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, Delete, CapsLock, F1, F2, F3, F4, F5, F6,
F7, F8, F9, F10, F11, F12, PrintScreen, ScrollLock, Pause, Insert, Home, PageUp, End, PageDown,
Right, Left, Down, Up, NumLock, KpDivide, KpMultiply, KpMinus, KpPlus, KpEnter, Kp1, Kp2, Kp3,
Kp4, Kp5, Kp6, Kp7, Kp8, Kp9, Kp0, KpPeriod, KpEquals, KpComma, LCtrl, LShift, LAlt, LGui,
RCtrl, RShift, RAlt, RGui, Unhandled
}
impl Default for Key {
fn default() -> Self {
Self::Unhandled
}
}
/// A Joystick axis.
#[non_exhaustive]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum Axis {
/// Left horizontal axis.
LeftX,
/// Left vertical axis.
LeftY,
/// Right horizontal axis.
RightX,
/// Left horizontal axis.
RightY,
/// Left trigger switch.
TriggerLeft,
/// Right trigger switch.
TriggerRight,
/// An unknown/unsupported axis.
Unhandled,
}
impl Default for Axis {
fn default() -> Self {
Self::Unhandled
}
}
/// A Joystick hat state.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum HatState {
/// Left+Up state.
LeftUp,
/// Left state.
Left,
/// Left+Down state.
LeftDown,
/// Up state.
Up,
/// Centered state.
Centered,
/// Down state.
Down,
/// Right+Up state.
RightUp,
/// Right state.
Right,
/// Right+Down state.
RightDown,
}
impl Default for HatState {
fn default() -> Self {
Self::Centered
}
}
/// A Controller button
#[non_exhaustive]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum ControllerButton {
/// A button.
A,
/// B button.
B,
/// X button.
X,
/// Y button.
Y,
/// Back button.
Back,
/// Guide button.
Guide,
/// Start button.
Start,
/// Left axis button.
LeftStick,
/// Right axis button.
RightStick,
/// Left shoulder button.
LeftShoulder,
/// Right shoulder button.
RightShoulder,
/// Directional pad up button.
DPadUp,
/// Directional pad down button.
DPadDown,
/// Directional pad left button.
DPadLeft,
/// Directional pad right button.
DPadRight,
/// Misc Controller button
/// - Xbox Series X share button
/// - PS5 microphone button
/// - Nintendo Switch Pro capture button
/// - Amazon Luna microphone button
Misc1,
/// Xbox Elite paddle P1
Paddle1,
/// Xbox Elite paddle P2
Paddle2,
/// Xbox Elite paddle P3
Paddle3,
/// Xbox Elite paddle P4
Paddle4,
/// PS4/PS5 touchpad button
Touchpad,
/// An unknown/unsupported button
Unhandled,
}
impl Default for ControllerButton {
fn default() -> Self {
Self::Unhandled
}
}
/// `Controller` identifier used to reference attached controllers.
#[derive(Default, Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct ControllerId(pub(crate) u32);
impl fmt::Display for ControllerId {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.0)
}
}
impl Deref for ControllerId {
type Target = u32;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl DerefMut for ControllerId {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
/// `Controller` update event.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum ControllerUpdate {
/// A controller was attached.
Added,
/// A controller was unattached.
Removed,
/// A controller has been remapped.
Remapped,
}
/// A specific [Event] representing a controller button press.
#[non_exhaustive]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct ControllerEvent {
/// The Identifier for this controller.
pub controller_id: ControllerId,
/// Specific button for this event.
pub button: ControllerButton,
}
impl ControllerEvent {
pub(crate) const fn new(controller_id: u32, button: ControllerButton) -> Self {
Self {
controller_id: ControllerId(controller_id),
button,
}
}
}