Documentation of SFML 1.6

Warning: this page refers to an old version of SFML. Click here to switch to the latest version.
sf::Input Class Reference

Input handles real-time input from keyboard and mouse. More...

#include <Input.hpp>

Inheritance diagram for sf::Input:
sf::WindowListener sf::NonCopyable

Public Member Functions

 Input ()
 Default constructor.
 
bool IsKeyDown (Key::Code KeyCode) const
 Get the state of a key.
 
bool IsMouseButtonDown (Mouse::Button Button) const
 Get the state of a mouse button.
 
bool IsJoystickButtonDown (unsigned int JoyId, unsigned int Button) const
 Get the state of a joystick button.
 
int GetMouseX () const
 Get the mouse X position.
 
int GetMouseY () const
 Get the mouse Y position.
 
float GetJoystickAxis (unsigned int JoyId, Joy::Axis Axis) const
 Get a joystick axis position.
 

Detailed Description

Input handles real-time input from keyboard and mouse.

Use it instead of events to handle continuous moves and more game-friendly inputs

Definition at line 44 of file Input.hpp.

Constructor & Destructor Documentation

sf::Input::Input ( )

Default constructor.

Member Function Documentation

float sf::Input::GetJoystickAxis ( unsigned int  JoyId,
Joy::Axis  Axis 
) const

Get a joystick axis position.

Parameters
JoyId: Identifier of the joystick to check (0 or 1)
Axis: Axis to get
Returns
Current axis position, in the range [-100, 100] (except for POV, which is [0, 360])
int sf::Input::GetMouseX ( ) const

Get the mouse X position.

Returns
Current mouse left position, relative to owner window
int sf::Input::GetMouseY ( ) const

Get the mouse Y position.

Returns
Current mouse top position, relative to owner window
bool sf::Input::IsJoystickButtonDown ( unsigned int  JoyId,
unsigned int  Button 
) const

Get the state of a joystick button.

Parameters
JoyId: Identifier of the joystick to check (0 or 1)
Button: Button to check
Returns
True if button is down, false if button is up
bool sf::Input::IsKeyDown ( Key::Code  KeyCode) const

Get the state of a key.

Parameters
KeyCode: Key to check
Returns
True if key is down, false if key is up
bool sf::Input::IsMouseButtonDown ( Mouse::Button  Button) const

Get the state of a mouse button.

Parameters
Button: Button to check
Returns
True if button is down, false if button is up

The documentation for this class was generated from the following file: