Mercurial > sdl-ios-xcode
annotate docs/html/sdlshowcursor.html @ 1258:b2283b0ded26
Date: Thu, 19 Jan 2006 20:02:29 +0200
From: Vassilis Virvilis <vasvir@iit.demokritos.gr>
Subject: [SDL] Request: Please reconsider adding tag in SDL_Event
Hi,
Patch in question:
--- include/SDL_events.h 20 Aug 2004 18:57:01 -0000 1.11
+++ include/SDL_events.h 19 Jan 2006 17:35:09 -0000
@@ -214,7 +214,7 @@
} SDL_SysWMEvent;
/* General event structure */
-typedef union {
+typedef union SDL_Event {
Uint8 type;
SDL_ActiveEvent active;
SDL_KeyboardEvent key;
Reasoning:
----------
1) Allows forward declaration of the SDL_Event union in C++. Please
note that in plain C it is possible to forward declare it.
2) Forward declaration is good because it allows encapsulation. It hides
the specific implementation and does not necessarily exposes SDL staff
to my appication's namespace
3) It can't harm plain C because tags are living in a different namespace
than typenames
4) It is already done like this in other places in SDL. Check for example
SDL_KeySym, and SDL_.*Event structures.
5) Right now I have to include SDL/event.h from a C++ header file. See 2)
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 20 Jan 2006 13:07:25 +0000 |
parents | 355632dca928 |
children |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_ShowCursor</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
0 | 8 "><LINK |
9 REL="HOME" | |
10 TITLE="SDL Library Documentation" | |
11 HREF="index.html"><LINK | |
12 REL="UP" | |
13 TITLE="Video" | |
14 HREF="video.html"><LINK | |
15 REL="PREVIOUS" | |
16 TITLE="SDL_GetCursor" | |
17 HREF="sdlgetcursor.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_GL_LoadLibrary" | |
20 HREF="sdlglloadlibrary.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 | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
31 SUMMARY="Header navigation table" |
0 | 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="sdlgetcursor.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
49 ACCESSKEY="P" |
0 | 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="sdlglloadlibrary.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
63 ACCESSKEY="N" |
0 | 64 >Next</A |
65 ></TD | |
66 ></TR | |
67 ></TABLE | |
68 ><HR | |
69 ALIGN="LEFT" | |
70 WIDTH="100%"></DIV | |
71 ><H1 | |
72 ><A | |
73 NAME="SDLSHOWCURSOR" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
74 ></A |
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
75 >SDL_ShowCursor</H1 |
0 | 76 ><DIV |
77 CLASS="REFNAMEDIV" | |
78 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
79 NAME="AEN2615" |
0 | 80 ></A |
81 ><H2 | |
82 >Name</H2 | |
83 >SDL_ShowCursor -- Toggle whether or not the cursor is shown on the screen.</DIV | |
84 ><DIV | |
85 CLASS="REFSYNOPSISDIV" | |
86 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
87 NAME="AEN2618" |
0 | 88 ></A |
89 ><H2 | |
90 >Synopsis</H2 | |
91 ><DIV | |
92 CLASS="FUNCSYNOPSIS" | |
93 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
94 NAME="AEN2619" |
0 | 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 >int <B | |
106 CLASS="FSFUNC" | |
107 >SDL_ShowCursor</B | |
108 ></CODE | |
109 >(int toggle);</CODE | |
110 ></P | |
111 ><P | |
112 ></P | |
113 ></DIV | |
114 ></DIV | |
115 ><DIV | |
116 CLASS="REFSECT1" | |
117 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
118 NAME="AEN2625" |
0 | 119 ></A |
120 ><H2 | |
121 >Description</H2 | |
122 ><P | |
123 >Toggle whether or not the cursor is shown on the screen. Passing <TT | |
124 CLASS="LITERAL" | |
125 >SDL_ENABLE</TT | |
126 > displays the cursor and passing <TT | |
127 CLASS="LITERAL" | |
128 >SDL_DISABLE</TT | |
129 > hides it. The current state of the mouse cursor can be queried by passing <TT | |
130 CLASS="LITERAL" | |
131 >SDL_QUERY</TT | |
132 >, either <TT | |
133 CLASS="LITERAL" | |
134 >SDL_DISABLE</TT | |
135 > or <TT | |
136 CLASS="LITERAL" | |
137 >SDL_ENABLE</TT | |
138 > will be returned.</P | |
139 ><P | |
140 >The cursor starts off displayed, but can be turned off.</P | |
141 ></DIV | |
142 ><DIV | |
143 CLASS="REFSECT1" | |
144 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
145 NAME="AEN2634" |
0 | 146 ></A |
147 ><H2 | |
148 >Return Value</H2 | |
149 ><P | |
150 >Returns the current state of the cursor.</P | |
151 ></DIV | |
152 ><DIV | |
153 CLASS="REFSECT1" | |
154 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
155 NAME="AEN2637" |
0 | 156 ></A |
157 ><H2 | |
158 >See Also</H2 | |
159 ><P | |
160 ><A | |
161 HREF="sdlcreatecursor.html" | |
162 ><TT | |
163 CLASS="FUNCTION" | |
164 >SDL_CreateCursor</TT | |
165 ></A | |
166 >, | |
167 <A | |
168 HREF="sdlsetcursor.html" | |
169 ><TT | |
170 CLASS="FUNCTION" | |
171 >SDL_SetCursor</TT | |
172 ></A | |
173 ></P | |
174 ></DIV | |
175 ><DIV | |
176 CLASS="NAVFOOTER" | |
177 ><HR | |
178 ALIGN="LEFT" | |
179 WIDTH="100%"><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
180 SUMMARY="Footer navigation table" |
0 | 181 WIDTH="100%" |
182 BORDER="0" | |
183 CELLPADDING="0" | |
184 CELLSPACING="0" | |
185 ><TR | |
186 ><TD | |
187 WIDTH="33%" | |
188 ALIGN="left" | |
189 VALIGN="top" | |
190 ><A | |
191 HREF="sdlgetcursor.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
192 ACCESSKEY="P" |
0 | 193 >Prev</A |
194 ></TD | |
195 ><TD | |
196 WIDTH="34%" | |
197 ALIGN="center" | |
198 VALIGN="top" | |
199 ><A | |
200 HREF="index.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
201 ACCESSKEY="H" |
0 | 202 >Home</A |
203 ></TD | |
204 ><TD | |
205 WIDTH="33%" | |
206 ALIGN="right" | |
207 VALIGN="top" | |
208 ><A | |
209 HREF="sdlglloadlibrary.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
210 ACCESSKEY="N" |
0 | 211 >Next</A |
212 ></TD | |
213 ></TR | |
214 ><TR | |
215 ><TD | |
216 WIDTH="33%" | |
217 ALIGN="left" | |
218 VALIGN="top" | |
219 >SDL_GetCursor</TD | |
220 ><TD | |
221 WIDTH="34%" | |
222 ALIGN="center" | |
223 VALIGN="top" | |
224 ><A | |
225 HREF="video.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
226 ACCESSKEY="U" |
0 | 227 >Up</A |
228 ></TD | |
229 ><TD | |
230 WIDTH="33%" | |
231 ALIGN="right" | |
232 VALIGN="top" | |
233 >SDL_GL_LoadLibrary</TD | |
234 ></TR | |
235 ></TABLE | |
236 ></DIV | |
237 ></BODY | |
238 ></HTML | |
239 > |