summaryrefslogtreecommitdiffstats
path: root/src/input/button_state.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/input/button_state.rs')
-rw-r--r--src/input/button_state.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/input/button_state.rs b/src/input/button_state.rs
index e8845cc7..988043ba 100644
--- a/src/input/button_state.rs
+++ b/src/input/button_state.rs
@@ -1,5 +1,9 @@
+/// The state of a button.
#[derive(Debug, Hash, Ord, PartialOrd, PartialEq, Eq, Clone, Copy)]
pub enum ButtonState {
+ /// The button is pressed.
Pressed,
+
+ /// The button is __not__ pressed.
Released,
}