comparison docs/html/sdlwmgrabinput.html @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
comparison
equal deleted inserted replaced
-1:000000000000 0:74212992fb08
1 <HTML
2 ><HEAD
3 ><TITLE
4 >SDL_WM_GrabInput</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.61
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 WIDTH="100%"
32 BORDER="0"
33 CELLPADDING="0"
34 CELLSPACING="0"
35 ><TR
36 ><TH
37 COLSPAN="3"
38 ALIGN="center"
39 >SDL Library Documentation</TH
40 ></TR
41 ><TR
42 ><TD
43 WIDTH="10%"
44 ALIGN="left"
45 VALIGN="bottom"
46 ><A
47 HREF="sdlwmtogglefullscreen.html"
48 >Prev</A
49 ></TD
50 ><TD
51 WIDTH="80%"
52 ALIGN="center"
53 VALIGN="bottom"
54 ></TD
55 ><TD
56 WIDTH="10%"
57 ALIGN="right"
58 VALIGN="bottom"
59 ><A
60 HREF="event.html"
61 >Next</A
62 ></TD
63 ></TR
64 ></TABLE
65 ><HR
66 ALIGN="LEFT"
67 WIDTH="100%"></DIV
68 ><H1
69 ><A
70 NAME="SDLWMGRABINPUT"
71 >SDL_WM_GrabInput</A
72 ></H1
73 ><DIV
74 CLASS="REFNAMEDIV"
75 ><A
76 NAME="AEN3166"
77 ></A
78 ><H2
79 >Name</H2
80 >SDL_WM_GrabInput&nbsp;--&nbsp;Grabs mouse and keyboard input.</DIV
81 ><DIV
82 CLASS="REFSYNOPSISDIV"
83 ><A
84 NAME="AEN3169"
85 ></A
86 ><H2
87 >Synopsis</H2
88 ><DIV
89 CLASS="FUNCSYNOPSIS"
90 ><A
91 NAME="AEN3170"
92 ></A
93 ><P
94 ></P
95 ><PRE
96 CLASS="FUNCSYNOPSISINFO"
97 >#include "SDL.h"</PRE
98 ><P
99 ><CODE
100 ><CODE
101 CLASS="FUNCDEF"
102 >SDL_GrabMode <B
103 CLASS="FSFUNC"
104 >SDL_WM_GrabInput</B
105 ></CODE
106 >(SDL_GrabMode mode);</CODE
107 ></P
108 ><P
109 ></P
110 ></DIV
111 ></DIV
112 ><DIV
113 CLASS="REFSECT1"
114 ><A
115 NAME="AEN3176"
116 ></A
117 ><H2
118 >Description</H2
119 ><P
120 >Grabbing means that the mouse is confined to the application window,
121 and nearly all keyboard input is passed directly to the application,
122 and not interpreted by a window manager, if any.</P
123 ><P
124 >When <TT
125 CLASS="PARAMETER"
126 ><I
127 >mode</I
128 ></TT
129 > is <TT
130 CLASS="LITERAL"
131 >SDL_GRAB_QUERY</TT
132 > the grab mode is not changed, but the current grab mode is returned.</P
133 ><P
134 ><PRE
135 CLASS="PROGRAMLISTING"
136 >typedef enum {
137 SDL_GRAB_QUERY,
138 SDL_GRAB_OFF,
139 SDL_GRAB_ON
140 } SDL_GrabMode;</PRE
141 >
142 </P
143 ></DIV
144 ><DIV
145 CLASS="REFSECT1"
146 ><A
147 NAME="AEN3184"
148 ></A
149 ><H2
150 >Return Value</H2
151 ><P
152 >The current/new <SPAN
153 CLASS="STRUCTNAME"
154 >SDL_GrabMode</SPAN
155 >.</P
156 ></DIV
157 ><DIV
158 CLASS="NAVFOOTER"
159 ><HR
160 ALIGN="LEFT"
161 WIDTH="100%"><TABLE
162 WIDTH="100%"
163 BORDER="0"
164 CELLPADDING="0"
165 CELLSPACING="0"
166 ><TR
167 ><TD
168 WIDTH="33%"
169 ALIGN="left"
170 VALIGN="top"
171 ><A
172 HREF="sdlwmtogglefullscreen.html"
173 >Prev</A
174 ></TD
175 ><TD
176 WIDTH="34%"
177 ALIGN="center"
178 VALIGN="top"
179 ><A
180 HREF="index.html"
181 >Home</A
182 ></TD
183 ><TD
184 WIDTH="33%"
185 ALIGN="right"
186 VALIGN="top"
187 ><A
188 HREF="event.html"
189 >Next</A
190 ></TD
191 ></TR
192 ><TR
193 ><TD
194 WIDTH="33%"
195 ALIGN="left"
196 VALIGN="top"
197 >SDL_WM_ToggleFullScreen</TD
198 ><TD
199 WIDTH="34%"
200 ALIGN="center"
201 VALIGN="top"
202 ><A
203 HREF="wm.html"
204 >Up</A
205 ></TD
206 ><TD
207 WIDTH="33%"
208 ALIGN="right"
209 VALIGN="top"
210 >Events</TD
211 ></TR
212 ></TABLE
213 ></DIV
214 ></BODY
215 ></HTML
216 >