Simple and Fast Multimedia Library
Documentation for SFML 1.6
Initializing search
SFML
Home
Learn
Tutorials
Documentation
Download
Community
Development
Donate
Simple and Fast Multimedia Library
Home
Learn
Tutorials
Documentation
Documentation
SFML 3.1.0
SFML 3.0.2
SFML 3.0.1
SFML 3.0.0
SFML 2.6.2
SFML 2.6.1
SFML 2.6.0
SFML 2.5.1
SFML 2.5.0
SFML 2.4.2
SFML 2.4.1
SFML 2.4.0
SFML 2.3.2
SFML 2.3.1
SFML 2.3
SFML 2.2
SFML 2.1
SFML 2.0
SFML 1.6
Download
Community
Development
Warning
This page refers to an old version of SFML.
Click here to switch to the latest version.
Main Page
Namespaces
Classes
Files
File List
File Members
Loading...
Searching...
No Matches
SFML
include
SFML
Window
Event.hpp
Go to the documentation of this file.
1
2
//
3
// SFML - Simple and Fast Multimedia Library
4
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
5
//
6
// This software is provided 'as-is', without any express or implied warranty.
7
// In no event will the authors be held liable for any damages arising from the use of this software.
8
//
9
// Permission is granted to anyone to use this software for any purpose,
10
// including commercial applications, and to alter it and redistribute it freely,
11
// subject to the following restrictions:
12
//
13
// 1. The origin of this software must not be misrepresented;
14
// you must not claim that you wrote the original software.
15
// If you use this software in a product, an acknowledgment
16
// in the product documentation would be appreciated but is not required.
17
//
18
// 2. Altered source versions must be plainly marked as such,
19
// and must not be misrepresented as being the original software.
20
//
21
// 3. This notice may not be removed or altered from any source distribution.
22
//
24
25
#ifndef SFML_EVENT_HPP
26
#define SFML_EVENT_HPP
27
29
// Headers
31
#include <
SFML/Config.hpp
>
32
33
34
namespace
sf
35
{
39
namespace
Key
40
{
41
enum
Code
42
{
43
A
=
'a'
,
44
B
=
'b'
,
45
C
=
'c'
,
46
D
=
'd'
,
47
E
=
'e'
,
48
F
=
'f'
,
49
G
=
'g'
,
50
H
=
'h'
,
51
I
=
'i'
,
52
J
=
'j'
,
53
K
=
'k'
,
54
L
=
'l'
,
55
M
=
'm'
,
56
N
=
'n'
,
57
O
=
'o'
,
58
P
=
'p'
,
59
Q
=
'q'
,
60
R
=
'r'
,
61
S
=
's'
,
62
T
=
't'
,
63
U
=
'u'
,
64
V
=
'v'
,
65
W
=
'w'
,
66
X
=
'x'
,
67
Y
=
'y'
,
68
Z
=
'z'
,
69
Num0
=
'0'
,
70
Num1
=
'1'
,
71
Num2
=
'2'
,
72
Num3
=
'3'
,
73
Num4
=
'4'
,
74
Num5
=
'5'
,
75
Num6
=
'6'
,
76
Num7
=
'7'
,
77
Num8
=
'8'
,
78
Num9
=
'9'
,
79
Escape
= 256,
80
LControl
,
81
LShift
,
82
LAlt
,
83
LSystem
,
84
RControl
,
85
RShift
,
86
RAlt
,
87
RSystem
,
88
Menu
,
89
LBracket
,
90
RBracket
,
91
SemiColon
,
92
Comma
,
93
Period
,
94
Quote
,
95
Slash
,
96
BackSlash
,
97
Tilde
,
98
Equal
,
99
Dash
,
100
Space
,
101
Return
,
102
Back
,
103
Tab
,
104
PageUp
,
105
PageDown
,
106
End
,
107
Home
,
108
Insert
,
109
Delete
,
110
Add
,
111
Subtract
,
112
Multiply
,
113
Divide
,
114
Left
,
115
Right
,
116
Up
,
117
Down
,
118
Numpad0
,
119
Numpad1
,
120
Numpad2
,
121
Numpad3
,
122
Numpad4
,
123
Numpad5
,
124
Numpad6
,
125
Numpad7
,
126
Numpad8
,
127
Numpad9
,
128
F1
,
129
F2
,
130
F3
,
131
F4
,
132
F5
,
133
F6
,
134
F7
,
135
F8
,
136
F9
,
137
F10
,
138
F11
,
139
F12
,
140
F13
,
141
F14
,
142
F15
,
143
Pause
,
144
145
Count
// Keep last -- total number of keyboard keys
146
};
147
}
148
149
153
namespace
Mouse
154
{
155
enum
Button
156
{
157
Left
,
158
Right
,
159
Middle
,
160
XButton1
,
161
XButton2
,
162
163
ButtonCount
// Keep last -- total number of mouse buttons
164
};
165
}
166
167
171
namespace
Joy
172
{
173
enum
Axis
174
{
175
AxisX
,
176
AxisY
,
177
AxisZ
,
178
AxisR
,
179
AxisU
,
180
AxisV
,
181
AxisPOV
,
182
183
AxisCount
// Keep last -- total number of joystick axis
184
};
185
186
enum
187
{
188
Count
= 4,
189
ButtonCount
= 32
190
};
191
}
192
193
197
class
Event
198
{
199
public :
200
204
struct
KeyEvent
205
{
206
Key::Code
Code
;
207
bool
Alt
;
208
bool
Control
;
209
bool
Shift
;
210
};
211
215
struct
TextEvent
216
{
217
Uint32
Unicode
;
218
};
219
223
struct
MouseMoveEvent
224
{
225
int
X
;
226
int
Y
;
227
};
228
232
struct
MouseButtonEvent
233
{
234
Mouse::Button
Button
;
235
int
X
;
236
int
Y
;
237
};
238
242
struct
MouseWheelEvent
243
{
244
int
Delta
;
245
};
246
250
struct
JoyMoveEvent
251
{
252
unsigned
int
JoystickId
;
253
Joy::Axis
Axis
;
254
float
Position
;
255
};
256
260
struct
JoyButtonEvent
261
{
262
unsigned
int
JoystickId
;
263
unsigned
int
Button
;
264
};
265
269
struct
SizeEvent
270
{
271
unsigned
int
Width
;
272
unsigned
int
Height
;
273
};
274
278
enum
EventType
279
{
280
Closed
,
281
Resized
,
282
LostFocus
,
283
GainedFocus
,
284
TextEntered
,
285
KeyPressed
,
286
KeyReleased
,
287
MouseWheelMoved
,
288
MouseButtonPressed
,
289
MouseButtonReleased
,
290
MouseMoved
,
291
MouseEntered
,
292
MouseLeft
,
293
JoyButtonPressed
,
294
JoyButtonReleased
,
295
JoyMoved
,
296
297
Count
// Keep last -- total number of event types
298
};
299
301
// Member data
303
EventType
Type
;
304
305
union
306
{
307
KeyEvent
Key
;
308
TextEvent
Text
;
309
MouseMoveEvent
MouseMove
;
310
MouseButtonEvent
MouseButton
;
311
MouseWheelEvent
MouseWheel
;
312
JoyMoveEvent
JoyMove
;
313
JoyButtonEvent
JoyButton
;
314
SizeEvent
Size
;
315
};
316
};
317
318
}
// namespace sf
319
320
321
#endif
// SFML_EVENT_HPP
Config.hpp
sf::Event
Event defines a system event and its parameters.
Definition
Event.hpp:198
sf::Event::MouseMove
MouseMoveEvent MouseMove
Definition
Event.hpp:309
sf::Event::Key
KeyEvent Key
Definition
Event.hpp:307
sf::Event::MouseWheel
MouseWheelEvent MouseWheel
Definition
Event.hpp:311
sf::Event::JoyMove
JoyMoveEvent JoyMove
Definition
Event.hpp:312
sf::Event::Type
EventType Type
Type of the event.
Definition
Event.hpp:303
sf::Event::Text
TextEvent Text
Definition
Event.hpp:308
sf::Event::MouseButton
MouseButtonEvent MouseButton
Definition
Event.hpp:310
sf::Event::Size
SizeEvent Size
Definition
Event.hpp:314
sf::Event::JoyButton
JoyButtonEvent JoyButton
Definition
Event.hpp:313
sf::Event::EventType
EventType
Enumeration of the different types of events.
Definition
Event.hpp:279
sf::Event::Closed
@ Closed
Definition
Event.hpp:280
sf::Event::MouseMoved
@ MouseMoved
Definition
Event.hpp:290
sf::Event::MouseEntered
@ MouseEntered
Definition
Event.hpp:291
sf::Event::MouseButtonPressed
@ MouseButtonPressed
Definition
Event.hpp:288
sf::Event::MouseWheelMoved
@ MouseWheelMoved
Definition
Event.hpp:287
sf::Event::Resized
@ Resized
Definition
Event.hpp:281
sf::Event::TextEntered
@ TextEntered
Definition
Event.hpp:284
sf::Event::GainedFocus
@ GainedFocus
Definition
Event.hpp:283
sf::Event::MouseButtonReleased
@ MouseButtonReleased
Definition
Event.hpp:289
sf::Event::KeyReleased
@ KeyReleased
Definition
Event.hpp:286
sf::Event::MouseLeft
@ MouseLeft
Definition
Event.hpp:292
sf::Event::LostFocus
@ LostFocus
Definition
Event.hpp:282
sf::Event::KeyPressed
@ KeyPressed
Definition
Event.hpp:285
sf::Event::JoyMoved
@ JoyMoved
Definition
Event.hpp:295
sf::Event::JoyButtonPressed
@ JoyButtonPressed
Definition
Event.hpp:293
sf::Event::Count
@ Count
Definition
Event.hpp:297
sf::Event::JoyButtonReleased
@ JoyButtonReleased
Definition
Event.hpp:294
sf::Joy
Definition of joystick axis for joystick events.
Definition
Event.hpp:172
sf::Joy::Count
@ Count
Total number of supported joysticks.
Definition
Event.hpp:188
sf::Joy::ButtonCount
@ ButtonCount
Total number of supported joystick buttons.
Definition
Event.hpp:189
sf::Joy::Axis
Axis
Definition
Event.hpp:174
sf::Joy::AxisCount
@ AxisCount
Definition
Event.hpp:183
sf::Joy::AxisY
@ AxisY
Definition
Event.hpp:176
sf::Joy::AxisPOV
@ AxisPOV
Definition
Event.hpp:181
sf::Joy::AxisX
@ AxisX
Definition
Event.hpp:175
sf::Joy::AxisR
@ AxisR
Definition
Event.hpp:178
sf::Joy::AxisZ
@ AxisZ
Definition
Event.hpp:177
sf::Joy::AxisV
@ AxisV
Definition
Event.hpp:180
sf::Joy::AxisU
@ AxisU
Definition
Event.hpp:179
sf::Key
Definition of key codes for keyboard events.
Definition
Event.hpp:40
sf::Key::Code
Code
Definition
Event.hpp:42
sf::Key::Num1
@ Num1
Definition
Event.hpp:70
sf::Key::F10
@ F10
Definition
Event.hpp:137
sf::Key::F11
@ F11
Definition
Event.hpp:138
sf::Key::Multiply
@ Multiply
Definition
Event.hpp:112
sf::Key::Pause
@ Pause
Definition
Event.hpp:143
sf::Key::L
@ L
Definition
Event.hpp:54
sf::Key::E
@ E
Definition
Event.hpp:47
sf::Key::F14
@ F14
Definition
Event.hpp:141
sf::Key::V
@ V
Definition
Event.hpp:64
sf::Key::Left
@ Left
Left arrow.
Definition
Event.hpp:114
sf::Key::Num3
@ Num3
Definition
Event.hpp:72
sf::Key::Count
@ Count
Definition
Event.hpp:145
sf::Key::Numpad9
@ Numpad9
Definition
Event.hpp:127
sf::Key::F1
@ F1
Definition
Event.hpp:128
sf::Key::End
@ End
Definition
Event.hpp:106
sf::Key::Home
@ Home
Definition
Event.hpp:107
sf::Key::Space
@ Space
Definition
Event.hpp:100
sf::Key::Right
@ Right
Right arrow.
Definition
Event.hpp:115
sf::Key::Numpad1
@ Numpad1
Definition
Event.hpp:119
sf::Key::Numpad7
@ Numpad7
Definition
Event.hpp:125
sf::Key::Menu
@ Menu
Definition
Event.hpp:88
sf::Key::PageDown
@ PageDown
Definition
Event.hpp:105
sf::Key::Numpad5
@ Numpad5
Definition
Event.hpp:123
sf::Key::F15
@ F15
Definition
Event.hpp:142
sf::Key::PageUp
@ PageUp
Definition
Event.hpp:104
sf::Key::RSystem
@ RSystem
OS specific key (right side) : windows (Win and Linux), apple (MacOS), ...
Definition
Event.hpp:87
sf::Key::Period
@ Period
Definition
Event.hpp:93
sf::Key::Insert
@ Insert
Definition
Event.hpp:108
sf::Key::Slash
@ Slash
/
Definition
Event.hpp:95
sf::Key::Equal
@ Equal
=
Definition
Event.hpp:98
sf::Key::F9
@ F9
Definition
Event.hpp:136
sf::Key::Subtract
@ Subtract
Definition
Event.hpp:111
sf::Key::Numpad4
@ Numpad4
Definition
Event.hpp:122
sf::Key::N
@ N
Definition
Event.hpp:56
sf::Key::Num8
@ Num8
Definition
Event.hpp:77
sf::Key::Back
@ Back
Definition
Event.hpp:102
sf::Key::RControl
@ RControl
Definition
Event.hpp:84
sf::Key::F7
@ F7
Definition
Event.hpp:134
sf::Key::D
@ D
Definition
Event.hpp:46
sf::Key::Numpad8
@ Numpad8
Definition
Event.hpp:126
sf::Key::LBracket
@ LBracket
[
Definition
Event.hpp:89
sf::Key::F3
@ F3
Definition
Event.hpp:130
sf::Key::LSystem
@ LSystem
OS specific key (left side) : windows (Win and Linux), apple (MacOS), ...
Definition
Event.hpp:83
sf::Key::F4
@ F4
Definition
Event.hpp:131
sf::Key::Numpad3
@ Numpad3
Definition
Event.hpp:121
sf::Key::Num9
@ Num9
Definition
Event.hpp:78
sf::Key::K
@ K
Definition
Event.hpp:53
sf::Key::Y
@ Y
Definition
Event.hpp:67
sf::Key::F6
@ F6
Definition
Event.hpp:133
sf::Key::SemiColon
@ SemiColon
;
Definition
Event.hpp:91
sf::Key::M
@ M
Definition
Event.hpp:55
sf::Key::Up
@ Up
Up arrow.
Definition
Event.hpp:116
sf::Key::G
@ G
Definition
Event.hpp:49
sf::Key::T
@ T
Definition
Event.hpp:62
sf::Key::RBracket
@ RBracket
]
Definition
Event.hpp:90
sf::Key::W
@ W
Definition
Event.hpp:65
sf::Key::Delete
@ Delete
Definition
Event.hpp:109
sf::Key::F5
@ F5
Definition
Event.hpp:132
sf::Key::Return
@ Return
Definition
Event.hpp:101
sf::Key::Num6
@ Num6
Definition
Event.hpp:75
sf::Key::F12
@ F12
Definition
Event.hpp:139
sf::Key::A
@ A
Definition
Event.hpp:43
sf::Key::C
@ C
Definition
Event.hpp:45
sf::Key::Num7
@ Num7
Definition
Event.hpp:76
sf::Key::B
@ B
Definition
Event.hpp:44
sf::Key::S
@ S
Definition
Event.hpp:61
sf::Key::F8
@ F8
Definition
Event.hpp:135
sf::Key::Add
@ Add
Definition
Event.hpp:110
sf::Key::Num0
@ Num0
Definition
Event.hpp:69
sf::Key::Numpad6
@ Numpad6
Definition
Event.hpp:124
sf::Key::Num4
@ Num4
Definition
Event.hpp:73
sf::Key::LShift
@ LShift
Definition
Event.hpp:81
sf::Key::Q
@ Q
Definition
Event.hpp:59
sf::Key::Num5
@ Num5
Definition
Event.hpp:74
sf::Key::Escape
@ Escape
Definition
Event.hpp:79
sf::Key::Dash
@ Dash
Definition
Event.hpp:99
sf::Key::U
@ U
Definition
Event.hpp:63
sf::Key::BackSlash
@ BackSlash
Definition
Event.hpp:96
sf::Key::F2
@ F2
Definition
Event.hpp:129
sf::Key::RShift
@ RShift
Definition
Event.hpp:85
sf::Key::Comma
@ Comma
,
Definition
Event.hpp:92
sf::Key::Quote
@ Quote
'
Definition
Event.hpp:94
sf::Key::Down
@ Down
Down arrow.
Definition
Event.hpp:117
sf::Key::RAlt
@ RAlt
Definition
Event.hpp:86
sf::Key::F
@ F
Definition
Event.hpp:48
sf::Key::R
@ R
Definition
Event.hpp:60
sf::Key::Tilde
@ Tilde
~
Definition
Event.hpp:97
sf::Key::LControl
@ LControl
Definition
Event.hpp:80
sf::Key::P
@ P
Definition
Event.hpp:58
sf::Key::Tab
@ Tab
Definition
Event.hpp:103
sf::Key::I
@ I
Definition
Event.hpp:51
sf::Key::Divide
@ Divide
/
Definition
Event.hpp:113
sf::Key::H
@ H
Definition
Event.hpp:50
sf::Key::F13
@ F13
Definition
Event.hpp:140
sf::Key::Num2
@ Num2
Definition
Event.hpp:71
sf::Key::LAlt
@ LAlt
Definition
Event.hpp:82
sf::Key::J
@ J
Definition
Event.hpp:52
sf::Key::Numpad0
@ Numpad0
Definition
Event.hpp:118
sf::Key::O
@ O
Definition
Event.hpp:57
sf::Key::Numpad2
@ Numpad2
Definition
Event.hpp:120
sf::Key::Z
@ Z
Definition
Event.hpp:68
sf::Key::X
@ X
Definition
Event.hpp:66
sf::Mouse
Definition of button codes for mouse events.
Definition
Event.hpp:154
sf::Mouse::Button
Button
Definition
Event.hpp:156
sf::Mouse::XButton2
@ XButton2
Definition
Event.hpp:161
sf::Mouse::Middle
@ Middle
Definition
Event.hpp:159
sf::Mouse::ButtonCount
@ ButtonCount
Definition
Event.hpp:163
sf::Mouse::Left
@ Left
Definition
Event.hpp:157
sf::Mouse::XButton1
@ XButton1
Definition
Event.hpp:160
sf::Mouse::Right
@ Right
Definition
Event.hpp:158
sf
Definition
AudioResource.hpp:35
sf::Event::JoyButtonEvent
Joystick buttons events parameters.
Definition
Event.hpp:261
sf::Event::JoyButtonEvent::Button
unsigned int Button
Definition
Event.hpp:263
sf::Event::JoyButtonEvent::JoystickId
unsigned int JoystickId
Definition
Event.hpp:262
sf::Event::JoyMoveEvent
Joystick axis move event parameters.
Definition
Event.hpp:251
sf::Event::JoyMoveEvent::Axis
Joy::Axis Axis
Definition
Event.hpp:253
sf::Event::JoyMoveEvent::Position
float Position
Definition
Event.hpp:254
sf::Event::JoyMoveEvent::JoystickId
unsigned int JoystickId
Definition
Event.hpp:252
sf::Event::KeyEvent
Keyboard event parameters.
Definition
Event.hpp:205
sf::Event::KeyEvent::Shift
bool Shift
Definition
Event.hpp:209
sf::Event::KeyEvent::Code
Key::Code Code
Definition
Event.hpp:206
sf::Event::KeyEvent::Alt
bool Alt
Definition
Event.hpp:207
sf::Event::KeyEvent::Control
bool Control
Definition
Event.hpp:208
sf::Event::MouseButtonEvent
Mouse buttons events parameters.
Definition
Event.hpp:233
sf::Event::MouseButtonEvent::Button
Mouse::Button Button
Definition
Event.hpp:234
sf::Event::MouseButtonEvent::X
int X
Definition
Event.hpp:235
sf::Event::MouseButtonEvent::Y
int Y
Definition
Event.hpp:236
sf::Event::MouseMoveEvent
Mouse move event parameters.
Definition
Event.hpp:224
sf::Event::MouseMoveEvent::X
int X
Definition
Event.hpp:225
sf::Event::MouseMoveEvent::Y
int Y
Definition
Event.hpp:226
sf::Event::MouseWheelEvent
Mouse wheel events parameters.
Definition
Event.hpp:243
sf::Event::MouseWheelEvent::Delta
int Delta
Definition
Event.hpp:244
sf::Event::SizeEvent
Size events parameters.
Definition
Event.hpp:270
sf::Event::SizeEvent::Height
unsigned int Height
Definition
Event.hpp:272
sf::Event::SizeEvent::Width
unsigned int Width
Definition
Event.hpp:271
sf::Event::TextEvent
Text event parameters.
Definition
Event.hpp:216
sf::Event::TextEvent::Unicode
Uint32 Unicode
Definition
Event.hpp:217
Back to top