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