sfml 0.25.1

Rust binding for sfml
Documentation 
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

//! Access to the real-time state of the mouse.
//!
//! `mouse` provides an interface to the state of the mouse.
//!
//! This module allows users to query the mouse state at any time and directly, without having to
//! deal with a window and its events. Compared to the [`MouseMoved`], [`MouseButtonPressed`] and
//! [`MouseButtonReleased`] events, `mouse` can retrieve the state of the cursor and
//! the buttons at any time (you don't need to store and update a boolean on your side in order to
//! know if a button is pressed or released), and you always get the real state of the mouse, even
//! if it is moved, pressed or released when your window is out of focus and no event is triggered.
//!
//! [`MouseMoved`]: crate::window::Event::MouseMoved
//! [`MouseButtonPressed`]: crate::window::Event::MouseButtonPressed
//! [`MouseButtonReleased`]: crate::window::Event::MouseButtonReleased

use crate::{ffi::window as ffi, system::Vector2i, window::thread_safety};
pub use ffi::window::{MouseButton as Button, MouseWheel as Wheel};

impl Button {
    /// Return whether this mouse button is currently pressed.
    ///
    /// Queries the real-time state of the mouse, even if buttons have been
    /// pressed or released while no window was focused and no events were
    /// triggered.
    #[must_use]
    pub fn is_pressed(self) -> bool {
        thread_safety::set_window_thread();

        unsafe { ffi::sfMouse_isButtonPressed(self) }
    }
}

/// Get the current position of the mouse in desktop coordinates.
///
/// This function returns the global position of the mouse cursor on the desktop.
#[must_use]
pub fn desktop_position() -> Vector2i {
    unsafe { ffi::sfMouse_getPosition() }
}

/// Set the current position of the mouse in desktop coordinates.
///
/// This function sets the global position of the mouse cursor on the desktop.
pub fn set_desktop_position(position: Vector2i) {
    unsafe { ffi::sfMouse_setPosition(position) }
}