sfml 0.10.1

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

/*
* Rust-SFML - Copyright (c) 2013 Letang Jeremy.
*
* The original software, SFML library, is provided by Laurent Gomila.
*
* This software is provided 'as-is', without any express or implied warranty.
* In no event will the authors be held liable for any damages arising from
* the use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not claim
*    that you wrote the original software. If you use this software in a product,
*    an acknowledgment in the product documentation would be appreciated but is
*    not required.
*
* 2. Altered source versions must be plainly marked as such, and must not be
*    misrepresented as being the original software.
*
* 3. This notice may not be removed or altered from any source distribution.
*/

/*!
 * Handle Joysticks
 *
 * Offers a set of function for manage joystick
 */

use libc::c_uint;

use csfml_window_sys as ffi;

/// Maximum number of supported joysticks.
pub const COUNT: u32  = 8;
/// Maximum number of supported buttons.
pub const BUTTON_COUNT: u32 = 32;
/// Maximum number of supported axes.
pub const AXIS_COUNT: u32 = 8;

/// Axes supported by SFML joysticks
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Copy)]
pub enum Axis {
    /// The X axis.
    X,
    /// The Y axis.
    Y,
    /// The Z axis.
    Z,
    /// The R axis.
    R,
    /// The U axis.
    U,
    /// The V axis.
    V,
    /// The X axis of the point-of-view hat.
    PovX,
    /// The Y axis of the point-of-view hat.
    PovY
}

/**
 * Check if the joystick is connected
 *
 * # Arguments
 * * joystick - Index of the joystick to check
 *
 * Return true if the joystick is connected, false otherwise
 */
pub fn is_connected(joystick: u32) -> bool {
    unsafe {
        ffi::sfJoystick_isConnected(joystick as c_uint).to_bool()
    }
}

/**
 * Return the number of buttons supported by a joystick
 *
 * # Arguments
 * * joystick - Index of the joystick
 *
 * Return the number of buttons supported by the joystick.
 */
pub fn button_count(joystick: u32) -> u32 {
    unsafe {
        ffi::sfJoystick_getButtonCount(joystick as c_uint) as u32
    }
}

/**
 * Check if the joystick support a given Axis
 *
 * If the joystick is not connected, this function returns false.
 *
 * # Arguments
 * * joystick - Index of the joystick
 * * axis - Axis to check
 *
 * Return true if the joystick supports the axis, false otherwise
 */
pub fn has_axis(joystick: u32, axis: Axis) -> bool {
    unsafe {
        ffi::sfJoystick_hasAxis(joystick as c_uint, axis as c_uint).to_bool()
    }
}

/**
 * Check if the button is pressed on a given joystick.
 *
 * If the joystick is not connected, this function returns false.
 *
 * # Arguments
 * * joystick - Index of the joystick
 * * button - Button to check
 *
 * Return true if the button is pressed, false otherwise
 */
pub fn is_button_pressed(joystick: u32, button: u32) -> bool {
    unsafe {
        ffi::sfJoystick_isButtonPressed(joystick as c_uint, button as c_uint).to_bool()
    }
}


/**
 * Get the current position on a given Axis, on a given joystick.
 *
 * If the joystick is not connected, this function returns 0.
 *
 * # Arguments
 * * joystick - Index of the joystick
 * * axis - Axis to check
 *
 * Return the current position of the axis, in range [-100 .. 100]
 */
pub fn get_axis_position(joystick: u32, axis: Axis) -> f32 {
    unsafe {
        ffi::sfJoystick_getAxisPosition(joystick as c_uint, axis as c_uint) as f32
    }
}

/**
 * Update the states of all joysticks
 *
 * This function is used internally by SFML, so you normally
 * don't have to call it explicitely. However, you may need to
 * call it if you have no window yet (or no window at all):
 * in this case the joysticks states are not updated automatically.
 *
 */
pub fn update() {
    unsafe {
        ffi::sfJoystick_update();
    }
}