Edgaru089/SFML
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor fixes in documentation related to joysticks

Browse Source
This commit is contained in:
Laurent Gomila 2011-05-06 14:03:15 +02:00
parent 49c0208b2e
commit 2f9a47b463
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/SFML/Window/Event.hpp
View File

@ -266,9 +266,9 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct JoyMoveEvent struct JoyMoveEvent
{ {
unsigned int JoystickId; ///< Index of the joystick (0 or 1) unsigned int JoystickId; ///< Index of the joystick (in range [0 .. Joy::Count - 1])
Joy::Axis Axis; ///< Axis on which the joystick moved Joy::Axis Axis; ///< Axis on which the joystick moved
float Position; ///< New position on the axis (in range [-100, 100]) float Position; ///< New position on the axis (in range [-100 .. 100])
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -278,8 +278,8 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct JoyButtonEvent struct JoyButtonEvent
{ {
unsigned int JoystickId; ///< Index of the joystick (0 or 1) unsigned int JoystickId; ///< Index of the joystick (in range [0 .. Joy::Count - 1])
unsigned int Button; ///< Index of the button that has been pressed unsigned int Button; ///< Index of the button that has been pressed (in range [0 .. Joy::ButtonCount - 1])
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////

10
include/SFML/Window/Input.hpp
View File

@ -75,8 +75,8 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current state of a joystick button (pressed or released) /// \brief Get the current state of a joystick button (pressed or released)
/// ///
/// \param joystick Index of the joystick to test (0 or 1) /// \param joystick Index of the joystick to test (in range [0 .. Joy::Count - 1])
/// \param button Index of the button to test /// \param button Index of the button to test (in range [0 .. Joy::ButtonCount - 1])
/// ///
/// \return True if button is down, false if button is up /// \return True if button is down, false if button is up
/// ///
@ -108,10 +108,10 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current position of a joystick axis /// \brief Get the current position of a joystick axis
/// ///
/// The returned position is in the range [-100, 100], except /// The returned position is in the range [-100 .. 100], except
/// the POV which is an angle and is thus defined in [0, 360]. /// the POV which is an angle and is thus defined in [0 .. 360].
/// ///
/// \param joystick Index of the joystick to test (0 or 1) /// \param joystick Index of the joystick to test (in range [0 .. Joy::Count - 1])
/// \param axis Axis to test /// \param axis Axis to test
/// ///
/// \return Current axis position /// \return Current axis position