sdlwmgrabinput.html
1
2
3
4
5
6
<HTML
><HEAD
><TITLE
>SDL_WM_GrabInput</TITLE
><META
NAME="GENERATOR"
7
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Window Management"
HREF="wm.html"><LINK
REL="PREVIOUS"
TITLE="SDL_WM_ToggleFullScreen"
HREF="sdlwmtogglefullscreen.html"><LINK
REL="NEXT"
TITLE="Events"
HREF="event.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
31
SUMMARY="Header navigation table"
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>SDL Library Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sdlwmtogglefullscreen.html"
49
ACCESSKEY="P"
50
51
52
53
54
55
56
57
58
59
60
61
62
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="event.html"
63
ACCESSKEY="N"
64
65
66
67
68
69
70
71
72
73
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLWMGRABINPUT"
74
75
></A
>SDL_WM_GrabInput</H1
76
77
78
><DIV
CLASS="REFNAMEDIV"
><A
79
NAME="AEN3663"
80
81
82
83
84
85
86
></A
><H2
>Name</H2
>SDL_WM_GrabInput -- Grabs mouse and keyboard input.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
87
NAME="AEN3666"
88
89
90
91
92
93
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
94
NAME="AEN3667"
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>SDL_GrabMode <B
CLASS="FSFUNC"
>SDL_WM_GrabInput</B
></CODE
>(SDL_GrabMode mode);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
118
NAME="AEN3673"
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
></A
><H2
>Description</H2
><P
>Grabbing means that the mouse is confined to the application window,
and nearly all keyboard input is passed directly to the application,
and not interpreted by a window manager, if any.</P
><P
>When <TT
CLASS="PARAMETER"
><I
>mode</I
></TT
> is <TT
CLASS="LITERAL"
>SDL_GRAB_QUERY</TT
> the grab mode is not changed, but the current grab mode is returned.</P
><P
><PRE
CLASS="PROGRAMLISTING"
>typedef enum {
SDL_GRAB_QUERY,
SDL_GRAB_OFF,
SDL_GRAB_ON
} SDL_GrabMode;</PRE
>
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
150
NAME="AEN3681"
151
152
153
154
155
156
157
158
159
160
161
162
163
164
></A
><H2
>Return Value</H2
><P
>The current/new <SPAN
CLASS="STRUCTNAME"
>SDL_GrabMode</SPAN
>.</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
165
SUMMARY="Footer navigation table"
166
167
168
169
170
171
172
173
174
175
176
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlwmtogglefullscreen.html"
177
ACCESSKEY="P"
178
179
180
181
182
183
184
185
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
186
ACCESSKEY="H"
187
188
189
190
191
192
193
194
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="event.html"
195
ACCESSKEY="N"
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_WM_ToggleFullScreen</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="wm.html"
211
ACCESSKEY="U"
212
213
214
215
216
217
218
219
220
221
222
223
224
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Events</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>