2
<title>pygame.constants</title>
3
<body bgcolor=#aaeebb text=#000000 link=#331111 vlink=#331111>
6
<table cellspacing=3 width=100%><tr><td bgcolor=#00000>
7
<table width=100%><tr><td bgcolor=c2fc20 align=center>
8
<a href=http://www.pygame.org>
9
<img src=../pygame_tiny.gif border=0 width=200 height=60></a><br>
10
<b>pygame documentation</b>
11
</td><td bgcolor=6aee28 align=center valign=top width=100%>
14
<a href=http://www.pygame.org>Home</a> ||
15
<a href=../index.html>Help Contents</a> ||
18
|| <a href=pygame.html>pygame</a> ||
19
<a href=pygame_cdrom.html>cdrom</a> ||
20
<a href=pygame_constants.html>constants</a> ||
21
<a href=pygame_display.html>display</a> ||
22
<a href=pygame_draw.html>draw</a> ||
23
<a href=pygame_event.html>event</a> ||<br>
24
|| <a href=pygame_font.html>font</a> ||
25
<a href=pygame_image.html>image</a> ||
26
<a href=pygame_joystick.html>joystick</a> ||
27
<a href=pygame_key.html>key</a> ||
28
<a href=pygame_mixer.html>mixer</a> ||
29
<a href=pygame_mixer_music.html>mixer_music</a> ||<br>
30
|| <a href=pygame_mouse.html>mouse</a> ||
31
<a href=pygame_movie.html>movie</a> ||
32
<a href=pygame_surfarray.html>surfarray</a> ||
33
<a href=pygame_time.html>time</a> ||
34
<a href=pygame_transform.html>transform</a> ||<br>
35
<br>|| <a href=CD.html>CD</a> ||
36
<a href=Channel.html>Channel</a> ||
37
<a href=Clock.html>Clock</a> ||
38
<a href=Font.html>Font</a> ||
39
<a href=Joystick.html>Joystick</a> ||
40
<a href=Movie.html>Movie</a> ||<br>
41
|| <a href=Rect.html>Rect</a> ||
42
<a href=Sound.html>Sound</a> ||
43
<a href=Surface.html>Surface</a> ||<br>
44
<br>|| <a href=pygame_cursors.html>cursors</a> ||
45
<a href=pygame_sprite.html>sprite</a> ||
46
<a href=pygame_version.html>version</a> ||<br>
49
</td></tr></table></td></tr></table>
51
<h2 align=center>pygame.constants</h2>
52
These constants are defined by SDL, and needed in pygame. Note
53
that many of the flags for SDL are not needed in pygame, and are
54
not included here. These constants are generally accessed from
55
the pygame.locals module. This module is automatically placed in
56
the pygame namespace, but you will usually want to place them
57
directly into your module's namespace with the following command,
58
'from pygame.locals import *'.
63
<tr><td><a href=#display >display </a></td><td> -
64
The following constants are used by the display module and Surfaces</td></tr>
67
<tr><td><a href=#events >events </a></td><td> -
68
These constants define the various event types</td></tr>
71
<tr><td><a href=#keyboard >keyboard </a></td><td> -
72
These constants represent the keys on the keyboard.</td></tr>
75
<tr><td><a href=#modifiers >modifiers </a></td><td> -
76
These constants represent the modifier keys on the keyboard.</td></tr>
79
<tr><td><a href=#zdepracated >zdepracated </a></td><td> -
80
The following constants are made available, but generally not needed</td></tr>
87
<a name=display ><font size=+2><b>display
88
</b></font><br><font size=+1><tt>
89
pygame.constants.display (constants)
91
HWSURFACE - surface in hardware video memory. (equal to 1)<br>
92
RESIZABLE - display window is resizeable<br>
93
ASYNCBLIT - surface blits happen asynchronously (threaded)<br>
94
OPENGL - display surface will be controlled by opengl<br>
95
HWPALETTE - display surface has animatable hardware palette
97
DOUBLEBUF - hardware display surface is page flippable<br>
98
FULLSCREEN - display surface is fullscreen (nonwindowed)<br>
99
RLEACCEL - compile for quick alpha blits, only set in alpha or
103
<a name=events ><font size=+2><b>events
104
</b></font><br><font size=+1><tt>
105
pygame.constants.events (constants)
107
NOEVENT - no event, represents an empty event list, equal to 0<br>
108
ACTIVEEVENT - window has gain/lost mouse/keyboard/visiblity focus<br>
109
KEYDOWN - keyboard button has been pressed (or down and repeating)<br>
110
KEYUP - keyboard button has been released<br>
111
MOUSEMOTION - mouse has moved<br>
112
MOUSEBUTTONDOWN- mouse button has been pressed<br>
113
MOUSEBUTTONUP - mouse button has been released<br>
114
JOYAXISMOTION - an opened joystick axis has changed<br>
115
JOYBALLMOTION - an opened joystick ball has moved<br>
116
JOYHATMOTION - an opened joystick hat has moved<br>
117
JOYBUTTONDOWN - an opened joystick button has been pressed<br>
118
JOYBUTTONUP - an opened joystick button has been released<br>
119
VIDEORESIZE - the display window has been resized by the user<br>
120
QUIT - the user has requested the game to quit<br>
121
SYSWMEVENT - currently unsupported, system dependant<br>
122
USEREVENT - all user messages are this or higher<br>
123
NUMEVENTS - all user messages must be lower than this, equal to 32<br>
126
<a name=keyboard ><font size=+2><b>keyboard
127
</b></font><br><font size=+1><tt>
128
pygame.constants.keyboard (constants)
130
There are many keyboard constants, they are used to represent
131
keys on the keyboard. The following is a list of all keyboard
134
<table cellpadding=0 cellspacing=0><tr><td><b>KeyASCII</b></td><td><b>ASCII </b></td><td><b>Common Name</b></td></tr>
135
<tr><td>K_BACKSPACE</td><td>\b</td><td><i>backspace</i></td></tr>
136
<tr><td>K_TAB</td><td>\t</td><td><i>tab</i></td></tr>
137
<tr><td>K_CLEAR</td><td></td><td><i>clear</i></td></tr>
138
<tr><td>K_RETURN</td><td>\r</td><td><i>return</i></td></tr>
139
<tr><td>K_PAUSE</td><td></td><td><i>pause</i></td></tr>
140
<tr><td>K_ESCAPE</td><td>^[</td><td><i>escape</i></td></tr>
141
<tr><td>K_SPACE</td><td></td><td><i>space</i></td></tr>
142
<tr><td>K_EXCLAIM</td><td>!</td><td><i>exclaim</i></td></tr>
143
<tr><td>K_QUOTEDBL</td><td>\"</td><td><i>quotedbl</i></td></tr>
144
<tr><td>K_HASH</td><td>#</td><td><i>hash</i></td></tr>
145
<tr><td>K_DOLLAR</td><td>$</td><td><i>dollar</i></td></tr>
146
<tr><td>K_AMPERSAND</td><td>&</td><td><i>ampersand</i></td></tr>
147
<tr><td>K_QUOTE</td><td></td><td><i>quote</i></td></tr>
148
<tr><td>K_LEFTPAREN</td><td>(</td><td><i>left parenthesis</i></td></tr>
149
<tr><td>K_RIGHTPAREN</td><td>)</td><td><i>right parenthesis</i></td></tr>
150
<tr><td>K_ASTERISK</td><td>*</td><td><i>asterisk</i></td></tr>
151
<tr><td>K_PLUS</td><td>+</td><td><i>plus sign</i></td></tr>
152
<tr><td>K_COMMA</td><td>,</td><td><i>comma</i></td></tr>
153
<tr><td>K_MINUS</td><td>-</td><td><i>minus sign</i></td></tr>
154
<tr><td>K_PERIOD</td><td>.</td><td><i>period</i></td></tr>
155
<tr><td>K_SLASH</td><td>/</td><td><i>forward slash</i></td></tr>
156
<tr><td>K_0</td><td>0</td><td><i>0</i></td></tr>
157
<tr><td>K_1</td><td>1</td><td><i>1</i></td></tr>
158
<tr><td>K_2</td><td>2</td><td><i>2</i></td></tr>
159
<tr><td>K_3</td><td>3</td><td><i>3</i></td></tr>
160
<tr><td>K_4</td><td>4</td><td><i>4</i></td></tr>
161
<tr><td>K_5</td><td>5</td><td><i>5</i></td></tr>
162
<tr><td>K_6</td><td>6</td><td><i>6</i></td></tr>
163
<tr><td>K_7</td><td>7</td><td><i>7</i></td></tr>
164
<tr><td>K_8</td><td>8</td><td><i>8</i></td></tr>
165
<tr><td>K_9</td><td>9</td><td><i>9</i></td></tr>
166
<tr><td>K_COLON</td><td>:</td><td><i>colon</i></td></tr>
167
<tr><td>K_SEMICOLON</td><td>;</td><td><i>semicolon</i></td></tr>
168
<tr><td>K_LESS</td><td><</td><td><i>less-than sign</i></td></tr>
169
<tr><td>K_EQUALS</td><td>=</td><td><i>equals sign</i></td></tr>
170
<tr><td>K_GREATER</td><td>></td><td><i>greater-than sign</i></td></tr>
171
<tr><td>K_QUESTION</td><td>?</td><td><i>question mark</i></td></tr>
172
<tr><td>K_AT</td><td>@</td><td><i>at</i></td></tr>
173
<tr><td>K_LEFTBRACKET</td><td>[</td><td><i>left bracket</i></td></tr>
174
<tr><td>K_BACKSLASH</td><td>\\</td><td><i>backslash</i></td></tr>
175
<tr><td>K_RIGHTBRACKET</td><td>]</td><td><i>right bracket</i></td></tr>
176
<tr><td>K_CARET</td><td>^</td><td><i>caret</i></td></tr>
177
<tr><td>K_UNDERSCORE</td><td>_</td><td><i>underscore</i></td></tr>
178
<tr><td>K_BACKQUOTE</td><td>`</td><td><i>grave</i></td></tr>
179
<tr><td>K_a</td><td>a</td><td><i>a</i></td></tr>
180
<tr><td>K_b</td><td>b</td><td><i>b</i></td></tr>
181
<tr><td>K_c</td><td>c</td><td><i>c</i></td></tr>
182
<tr><td>K_d</td><td>d</td><td><i>d</i></td></tr>
183
<tr><td>K_e</td><td>e</td><td><i>e</i></td></tr>
184
<tr><td>K_f</td><td>f</td><td><i>f</i></td></tr>
185
<tr><td>K_g</td><td>g</td><td><i>g</i></td></tr>
186
<tr><td>K_h</td><td>h</td><td><i>h</i></td></tr>
187
<tr><td>K_i</td><td>i</td><td><i>i</i></td></tr>
188
<tr><td>K_j</td><td>j</td><td><i>j</i></td></tr>
189
<tr><td>K_k</td><td>k</td><td><i>k</i></td></tr>
190
<tr><td>K_l</td><td>l</td><td><i>l</i></td></tr>
191
<tr><td>K_m</td><td>m</td><td><i>m</i></td></tr>
192
<tr><td>K_n</td><td>n</td><td><i>n</i></td></tr>
193
<tr><td>K_o</td><td>o</td><td><i>o</i></td></tr>
194
<tr><td>K_p</td><td>p</td><td><i>p</i></td></tr>
195
<tr><td>K_q</td><td>q</td><td><i>q</i></td></tr>
196
<tr><td>K_r</td><td>r</td><td><i>r</i></td></tr>
197
<tr><td>K_s</td><td>s</td><td><i>s</i></td></tr>
198
<tr><td>K_t</td><td>t</td><td><i>t</i></td></tr>
199
<tr><td>K_u</td><td>u</td><td><i>u</i></td></tr>
200
<tr><td>K_v</td><td>v</td><td><i>v</i></td></tr>
201
<tr><td>K_w</td><td>w</td><td><i>w</i></td></tr>
202
<tr><td>K_x</td><td>x</td><td><i>x</i></td></tr>
203
<tr><td>K_y</td><td>y</td><td><i>y</i></td></tr>
204
<tr><td>K_z</td><td>z</td><td><i>z</i></td></tr>
205
<tr><td>K_DELETE</td><td></td><td><i>delete</i></td></tr>
206
<tr><td>K_KP0</td><td></td><td><i>keypad 0</i></td></tr>
207
<tr><td>K_KP1</td><td></td><td><i>keypad 1</i></td></tr>
208
<tr><td>K_KP2</td><td></td><td><i>keypad 2</i></td></tr>
209
<tr><td>K_KP3</td><td></td><td><i>keypad 3</i></td></tr>
210
<tr><td>K_KP4</td><td></td><td><i>keypad 4</i></td></tr>
211
<tr><td>K_KP5</td><td></td><td><i>keypad 5</i></td></tr>
212
<tr><td>K_KP6</td><td></td><td><i>keypad 6</i></td></tr>
213
<tr><td>K_KP7</td><td></td><td><i>keypad 7</i></td></tr>
214
<tr><td>K_KP8</td><td></td><td><i>keypad 8</i></td></tr>
215
<tr><td>K_KP9</td><td></td><td><i>keypad 9</i></td></tr>
216
<tr><td>K_KP_PERIOD</td><td>.</td><td><i>keypad period</i></td></tr>
217
<tr><td>K_KP_DIVIDE</td><td>/</td><td><i>keypad divide</i></td></tr>
218
<tr><td>K_KP_MULTIPLY</td><td>*</td><td><i>keypad multiply</i></td></tr>
219
<tr><td>K_KP_MINUS</td><td>-</td><td><i>keypad minus</i></td></tr>
220
<tr><td>K_KP_PLUS</td><td>+</td><td><i>keypad plus</i></td></tr>
221
<tr><td>K_KP_ENTER</td><td>\r</td><td><i>keypad enter</i></td></tr>
222
<tr><td>K_KP_EQUALS</td><td>=</td><td><i>keypad equals</i></td></tr>
223
<tr><td>K_UP</td><td></td><td><i>up arrow</i></td></tr>
224
<tr><td>K_DOWN</td><td></td><td><i>down arrow</i></td></tr>
225
<tr><td>K_RIGHT</td><td></td><td><i>right arrow</i></td></tr>
226
<tr><td>K_LEFT</td><td></td><td><i>left arrow</i></td></tr>
227
<tr><td>K_INSERT</td><td></td><td><i>insert</i></td></tr>
228
<tr><td>K_HOME</td><td></td><td><i>home</i></td></tr>
229
<tr><td>K_END</td><td></td><td><i>end</i></td></tr>
230
<tr><td>K_PAGEUP</td><td></td><td><i>page up</i></td></tr>
231
<tr><td>K_PAGEDOWN</td><td></td><td><i>page down</i></td></tr>
232
<tr><td>K_F1</td><td></td><td><i>F1</i></td></tr>
233
<tr><td>K_F2</td><td></td><td><i>F2</i></td></tr>
234
<tr><td>K_F3</td><td></td><td><i>F3</i></td></tr>
235
<tr><td>K_F4</td><td></td><td><i>F4</i></td></tr>
236
<tr><td>K_F5</td><td></td><td><i>F5</i></td></tr>
237
<tr><td>K_F6</td><td></td><td><i>F6</i></td></tr>
238
<tr><td>K_F7</td><td></td><td><i>F7</i></td></tr>
239
<tr><td>K_F8</td><td></td><td><i>F8</i></td></tr>
240
<tr><td>K_F9</td><td></td><td><i>F9</i></td></tr>
241
<tr><td>K_F10</td><td></td><td><i>F10</i></td></tr>
242
<tr><td>K_F11</td><td></td><td><i>F11</i></td></tr>
243
<tr><td>K_F12</td><td></td><td><i>F12</i></td></tr>
244
<tr><td>K_F13</td><td></td><td><i>F13</i></td></tr>
245
<tr><td>K_F14</td><td></td><td><i>F14</i></td></tr>
246
<tr><td>K_F15</td><td></td><td><i>F15</i></td></tr>
247
<tr><td>K_NUMLOCK</td><td></td><td><i>numlock</i></td></tr>
248
<tr><td>K_CAPSLOCK</td><td></td><td><i>capslock</i></td></tr>
249
<tr><td>K_SCROLLOCK</td><td></td><td><i>scrollock</i></td></tr>
250
<tr><td>K_RSHIFT</td><td></td><td><i>right shift</i></td></tr>
251
<tr><td>K_LSHIFT</td><td></td><td><i>left shift</i></td></tr>
252
<tr><td>K_RCTRL</td><td></td><td><i>right ctrl</i></td></tr>
253
<tr><td>K_LCTRL</td><td></td><td><i>left ctrl</i></td></tr>
254
<tr><td>K_RALT</td><td></td><td><i>right alt</i></td></tr>
255
<tr><td>K_LALT</td><td></td><td><i>left alt</i></td></tr>
256
<tr><td>K_RMETA</td><td></td><td><i>right meta</i></td></tr>
257
<tr><td>K_LMETA</td><td></td><td><i>left meta</i></td></tr>
258
<tr><td>K_LSUPER</td><td></td><td><i>left windows key</i></td></tr>
259
<tr><td>K_RSUPER</td><td></td><td><i>right windows key</i></td></tr>
260
<tr><td>K_MODE</td><td></td><td><i>mode shift</i></td></tr>
261
<tr><td>K_HELP</td><td></td><td><i>help</i></td></tr>
262
<tr><td>K_PRINT</td><td></td><td><i>print-screen</i></td></tr>
263
<tr><td>K_SYSREQ</td><td></td><td><i>SysRq</i></td></tr>
264
<tr><td>K_BREAK</td><td></td><td><i>break</i></td></tr>
265
<tr><td>K_MENU</td><td></td><td><i>menu</i></td></tr>
266
<tr><td>K_POWER</td><td></td><td><i>power</i></td></tr>
267
<tr><td>K_EURO</td><td></td><td><i>euro</i></td></tr></table>
270
<a name=modifiers ><font size=+2><b>modifiers
271
</b></font><br><font size=+1><tt>
272
pygame.constants.modifiers (constants)
274
Their states are treated slightly differently than normal
275
keyboard button states, and you can temporarily set their states.
277
KMOD_NONE, KMOD_LSHIFT, KMOD_RSHIFT, KMOD_SHIFT, KMOD_CAPS,<br>
278
KMOD_LCTRL, KMOD_RCTRL, KMOD_CTRL, KMOD_LALT, KMOD_RALT,<br>
279
KMOD_ALT, KMOD_LMETA, KMOD_RMETA, KMOD_META, KMOD_NUM, KMOD_MODE<br>
282
<a name=zdepracated ><font size=+2><b>zdepracated
283
</b></font><br><font size=+1><tt>
284
pygame.constants.zdepracated (constants)
286
The flags labeled as readonly should never be used,
287
except when comparing checking flags against <a href=Surface.html#get_flags>Surface.get_flags()</a>.
289
SWSURFACE - not really usable as a surface flag, equates to 0 and
290
is always default<br>
291
ANYFORMAT - creates a display with in best possible bit depth<br>
292
HWACCEL - surface is hardware accelerated, readonly<br>
293
SRCCOLORKEY- surface has a colorkey for blits, readonly<br>
294
SRCALPHA - surface has alpha enabled, readonly<br>
295
RLEACCELOK - surface is rle accelrated but uncompiled, readonly
added
removed
docs/ref/pygame_constants.html
