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