Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 5131 | clevermous | 1 | |
| 2 | > |
||
| 3 | > |
||
| 4 | >SDL_UserEvent |
||
| 5 | > |
||
| 6 | NAME="GENERATOR" |
||
| 7 | CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
||
| 8 | "> |
||
| 9 | REL="HOME" |
||
| 10 | TITLE="SDL Library Documentation" |
||
| 11 | HREF="index.html"> |
||
| 12 | REL="UP" |
||
| 13 | TITLE="SDL Event Structures." |
||
| 14 | HREF="eventstructures.html"> |
||
| 15 | REL="PREVIOUS" |
||
| 16 | TITLE="SDL_SysWMEvent" |
||
| 17 | HREF="sdlsyswmevent.html"> |
||
| 18 | REL="NEXT" |
||
| 19 | TITLE="SDL_QuitEvent" |
||
| 20 | HREF="sdlquitevent.html"> |
||
| 21 | > |
||
| 22 | CLASS="REFENTRY" |
||
| 23 | BGCOLOR="#FFF8DC" |
||
| 24 | TEXT="#000000" |
||
| 25 | LINK="#0000ee" |
||
| 26 | VLINK="#551a8b" |
||
| 27 | ALINK="#ff0000" |
||
| 28 | > |
||
| 29 | CLASS="NAVHEADER" |
||
| 30 | > |
||
| 31 | WIDTH="100%" |
||
| 32 | BORDER="0" |
||
| 33 | CELLPADDING="0" |
||
| 34 | CELLSPACING="0" |
||
| 35 | > |
||
| 36 | > |
||
| 37 | COLSPAN="3" |
||
| 38 | ALIGN="center" |
||
| 39 | >SDL Library Documentation |
||
| 40 | > |
||
| 41 | > |
||
| 42 | > |
||
| 43 | WIDTH="10%" |
||
| 44 | ALIGN="left" |
||
| 45 | VALIGN="bottom" |
||
| 46 | > |
||
| 47 | HREF="sdlsyswmevent.html" |
||
| 48 | >Prev |
||
| 49 | > |
||
| 50 | > |
||
| 51 | WIDTH="80%" |
||
| 52 | ALIGN="center" |
||
| 53 | VALIGN="bottom" |
||
| 54 | > |
||
| 55 | > |
||
| 56 | WIDTH="10%" |
||
| 57 | ALIGN="right" |
||
| 58 | VALIGN="bottom" |
||
| 59 | > |
||
| 60 | HREF="sdlquitevent.html" |
||
| 61 | >Next |
||
| 62 | > |
||
| 63 | > |
||
| 64 | > |
||
| 65 | > |
||
| 66 | ALIGN="LEFT" |
||
| 67 | WIDTH="100%"> |
||
| 68 | > |
||
| 69 | > |
||
| 70 | NAME="SDLUSEREVENT" |
||
| 71 | >SDL_UserEvent |
||
| 72 | > |
||
| 73 | > |
||
| 74 | CLASS="REFNAMEDIV" |
||
| 75 | > |
||
| 76 | NAME="AEN4097" |
||
| 77 | > |
||
| 78 | > |
||
| 79 | >Name |
||
| 80 | >SDL_UserEvent -- A user-defined event type |
||
| 81 | > |
||
| 82 | CLASS="REFSECT1" |
||
| 83 | > |
||
| 84 | NAME="AEN4100" |
||
| 85 | > |
||
| 86 | > |
||
| 87 | >Structure Definition |
||
| 88 | > |
||
| 89 | CLASS="PROGRAMLISTING" |
||
| 90 | >typedef struct{ |
||
| 91 | Uint8 type; |
||
| 92 | int code; |
||
| 93 | void *data1; |
||
| 94 | void *data2; |
||
| 95 | } SDL_UserEvent; |
||
| 96 | > |
||
| 97 | > |
||
| 98 | CLASS="REFSECT1" |
||
| 99 | > |
||
| 100 | NAME="AEN4103" |
||
| 101 | > |
||
| 102 | > |
||
| 103 | >Structure Data |
||
| 104 | > |
||
| 105 | CLASS="INFORMALTABLE" |
||
| 106 | > |
||
| 107 | NAME="AEN4105" |
||
| 108 | > |
||
| 109 | > |
||
| 110 | > |
||
| 111 | > |
||
| 112 | BORDER="0" |
||
| 113 | CLASS="CALSTABLE" |
||
| 114 | > |
||
| 115 | > |
||
| 116 | > |
||
| 117 | ALIGN="LEFT" |
||
| 118 | VALIGN="TOP" |
||
| 119 | > |
||
| 120 | CLASS="STRUCTFIELD" |
||
| 121 | > |
||
| 122 | >type |
||
| 123 | > |
||
| 124 | > |
||
| 125 | > |
||
| 126 | ALIGN="LEFT" |
||
| 127 | VALIGN="TOP" |
||
| 128 | > |
||
| 129 | CLASS="LITERAL" |
||
| 130 | >SDL_USEREVENT |
||
| 131 | > through to |
||
| 132 | CLASS="LITERAL" |
||
| 133 | >SDL_NUMEVENTS-1 |
||
| 134 | > |
||
| 135 | > |
||
| 136 | > |
||
| 137 | > |
||
| 138 | ALIGN="LEFT" |
||
| 139 | VALIGN="TOP" |
||
| 140 | > |
||
| 141 | CLASS="STRUCTFIELD" |
||
| 142 | > |
||
| 143 | >code |
||
| 144 | > |
||
| 145 | > |
||
| 146 | > |
||
| 147 | ALIGN="LEFT" |
||
| 148 | VALIGN="TOP" |
||
| 149 | >User defined event code |
||
| 150 | > |
||
| 151 | > |
||
| 152 | > |
||
| 153 | ALIGN="LEFT" |
||
| 154 | VALIGN="TOP" |
||
| 155 | > |
||
| 156 | CLASS="STRUCTFIELD" |
||
| 157 | > |
||
| 158 | >data1 |
||
| 159 | > |
||
| 160 | > |
||
| 161 | > |
||
| 162 | ALIGN="LEFT" |
||
| 163 | VALIGN="TOP" |
||
| 164 | >User defined data pointer |
||
| 165 | > |
||
| 166 | > |
||
| 167 | > |
||
| 168 | ALIGN="LEFT" |
||
| 169 | VALIGN="TOP" |
||
| 170 | > |
||
| 171 | CLASS="STRUCTFIELD" |
||
| 172 | > |
||
| 173 | >data2 |
||
| 174 | > |
||
| 175 | > |
||
| 176 | > |
||
| 177 | ALIGN="LEFT" |
||
| 178 | VALIGN="TOP" |
||
| 179 | >User defined data pointer |
||
| 180 | > |
||
| 181 | > |
||
| 182 | > |
||
| 183 | > |
||
| 184 | > |
||
| 185 | > |
||
| 186 | > |
||
| 187 | > |
||
| 188 | CLASS="REFSECT1" |
||
| 189 | > |
||
| 190 | NAME="AEN4126" |
||
| 191 | > |
||
| 192 | > |
||
| 193 | >Description |
||
| 194 | > |
||
| 195 | > |
||
| 196 | CLASS="STRUCTNAME" |
||
| 197 | >SDL_UserEvent |
||
| 198 | > is in the |
||
| 199 | CLASS="STRUCTFIELD" |
||
| 200 | > |
||
| 201 | >user |
||
| 202 | > |
||
| 203 | > member of the structure |
||
| 204 | HREF="sdlevent.html" |
||
| 205 | > |
||
| 206 | CLASS="STRUCTNAME" |
||
| 207 | >SDL_Event |
||
| 208 | > |
||
| 209 | >. This event is unique, it is never created by SDL but only by the user. The event can be pushed onto the event queue using |
||
| 210 | HREF="sdlpushevent.html" |
||
| 211 | > |
||
| 212 | CLASS="FUNCTION" |
||
| 213 | >SDL_PushEvent |
||
| 214 | > |
||
| 215 | >. The contents of the structure members or completely up to the programmer, the only requirement is that |
||
| 216 | CLASS="STRUCTFIELD" |
||
| 217 | > |
||
| 218 | >type |
||
| 219 | > |
||
| 220 | > is a value from |
||
| 221 | CLASS="LITERAL" |
||
| 222 | >SDL_USEREVENT |
||
| 223 | > to |
||
| 224 | CLASS="LITERAL" |
||
| 225 | >SDL_NUMEVENTS-1 |
||
| 226 | > (inclusive). |
||
| 227 | > |
||
| 228 | > |
||
| 229 | CLASS="REFSECT1" |
||
| 230 | > |
||
| 231 | NAME="AEN4138" |
||
| 232 | > |
||
| 233 | > |
||
| 234 | >Examples |
||
| 235 | > |
||
| 236 | > |
||
| 237 | CLASS="PROGRAMLISTING" |
||
| 238 | >SDL_Event event; |
||
| 239 | |||
| 240 | event.type = SDL_USEREVENT; |
||
| 241 | event.user.code = my_event_code; |
||
| 242 | event.user.data1 = significant_data; |
||
| 243 | event.user.data2 = 0; |
||
| 244 | SDL_PushEvent(&event); |
||
| 245 | > |
||
| 246 | > |
||
| 247 | > |
||
| 248 | CLASS="REFSECT1" |
||
| 249 | > |
||
| 250 | NAME="AEN4142" |
||
| 251 | > |
||
| 252 | > |
||
| 253 | >See Also |
||
| 254 | > |
||
| 255 | > |
||
| 256 | HREF="sdlevent.html" |
||
| 257 | > |
||
| 258 | CLASS="STRUCTNAME" |
||
| 259 | >SDL_Event |
||
| 260 | > |
||
| 261 | >, |
||
| 262 | |||
| 263 | HREF="sdlpushevent.html" |
||
| 264 | > |
||
| 265 | CLASS="FUNCTION" |
||
| 266 | >SDL_PushEvent |
||
| 267 | > |
||
| 268 | > |
||
| 269 | > |
||
| 270 | > |
||
| 271 | CLASS="NAVFOOTER" |
||
| 272 | > |
||
| 273 | ALIGN="LEFT" |
||
| 274 | WIDTH="100%"> |
||
| 275 | WIDTH="100%" |
||
| 276 | BORDER="0" |
||
| 277 | CELLPADDING="0" |
||
| 278 | CELLSPACING="0" |
||
| 279 | > |
||
| 280 | > |
||
| 281 | WIDTH="33%" |
||
| 282 | ALIGN="left" |
||
| 283 | VALIGN="top" |
||
| 284 | > |
||
| 285 | HREF="sdlsyswmevent.html" |
||
| 286 | >Prev |
||
| 287 | > |
||
| 288 | > |
||
| 289 | WIDTH="34%" |
||
| 290 | ALIGN="center" |
||
| 291 | VALIGN="top" |
||
| 292 | > |
||
| 293 | HREF="index.html" |
||
| 294 | >Home |
||
| 295 | > |
||
| 296 | > |
||
| 297 | WIDTH="33%" |
||
| 298 | ALIGN="right" |
||
| 299 | VALIGN="top" |
||
| 300 | > |
||
| 301 | HREF="sdlquitevent.html" |
||
| 302 | >Next |
||
| 303 | > |
||
| 304 | > |
||
| 305 | > |
||
| 306 | > |
||
| 307 | WIDTH="33%" |
||
| 308 | ALIGN="left" |
||
| 309 | VALIGN="top" |
||
| 310 | >SDL_SysWMEvent |
||
| 311 | > |
||
| 312 | WIDTH="34%" |
||
| 313 | ALIGN="center" |
||
| 314 | VALIGN="top" |
||
| 315 | > |
||
| 316 | HREF="eventstructures.html" |
||
| 317 | >Up |
||
| 318 | > |
||
| 319 | > |
||
| 320 | WIDTH="33%" |
||
| 321 | ALIGN="right" |
||
| 322 | VALIGN="top" |
||
| 323 | >SDL_QuitEvent |
||
| 324 | > |
||
| 325 | > |
||
| 326 | > |
||
| 327 | > |
||
| 328 | > |
||
| 329 | > |