Go to most recent revision | Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 5131 | clevermous | 1 | |
| 2 | > |
||
| 3 | > |
||
| 4 | >SDL_PushEvent |
||
| 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="Event Functions." |
||
| 14 | HREF="eventfunctions.html"> |
||
| 15 | REL="PREVIOUS" |
||
| 16 | TITLE="SDL_WaitEvent" |
||
| 17 | HREF="sdlwaitevent.html"> |
||
| 18 | REL="NEXT" |
||
| 19 | TITLE="SDL_SetEventFilter" |
||
| 20 | HREF="sdlseteventfilter.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="sdlwaitevent.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="sdlseteventfilter.html" |
||
| 61 | >Next |
||
| 62 | > |
||
| 63 | > |
||
| 64 | > |
||
| 65 | > |
||
| 66 | ALIGN="LEFT" |
||
| 67 | WIDTH="100%"> |
||
| 68 | > |
||
| 69 | > |
||
| 70 | NAME="SDLPUSHEVENT" |
||
| 71 | >SDL_PushEvent |
||
| 72 | > |
||
| 73 | > |
||
| 74 | CLASS="REFNAMEDIV" |
||
| 75 | > |
||
| 76 | NAME="AEN4993" |
||
| 77 | > |
||
| 78 | > |
||
| 79 | >Name |
||
| 80 | >SDL_PushEvent -- Pushes an event onto the event queue |
||
| 81 | > |
||
| 82 | CLASS="REFSYNOPSISDIV" |
||
| 83 | > |
||
| 84 | NAME="AEN4996" |
||
| 85 | > |
||
| 86 | > |
||
| 87 | >Synopsis |
||
| 88 | > |
||
| 89 | CLASS="FUNCSYNOPSIS" |
||
| 90 | > |
||
| 91 | NAME="AEN4997" |
||
| 92 | > |
||
| 93 | > |
||
| 94 | > |
||
| 95 | > |
||
| 96 | CLASS="FUNCSYNOPSISINFO" |
||
| 97 | >#include "SDL.h" |
||
| 98 | > |
||
| 99 | > |
||
| 100 | > |
||
| 101 | CLASS="FUNCDEF" |
||
| 102 | >int |
||
| 103 | CLASS="FSFUNC" |
||
| 104 | >SDL_PushEvent |
||
| 105 | > |
||
| 106 | >(SDL_Event *event); |
||
| 107 | > |
||
| 108 | > |
||
| 109 | > |
||
| 110 | > |
||
| 111 | > |
||
| 112 | > |
||
| 113 | CLASS="REFSECT1" |
||
| 114 | > |
||
| 115 | NAME="AEN5003" |
||
| 116 | > |
||
| 117 | > |
||
| 118 | >Description |
||
| 119 | > |
||
| 120 | >The event queue can actually be used as a two way communication channel. Not only can events be read from the queue, but the user can also push their own events onto it. |
||
| 121 | CLASS="PARAMETER" |
||
| 122 | > |
||
| 123 | >event |
||
| 124 | > |
||
| 125 | > is a pointer to the event structure you wish to push onto the queue. |
||
| 126 | > |
||
| 127 | CLASS="NOTE" |
||
| 128 | > |
||
| 129 | CLASS="NOTE" |
||
| 130 | > |
||
| 131 | > |
||
| 132 | >Note: |
||
| 133 | >Pushing device input events onto the queue doesn't modify the state of the device within SDL. |
||
| 134 | > |
||
| 135 | > |
||
| 136 | > |
||
| 137 | > |
||
| 138 | CLASS="REFSECT1" |
||
| 139 | > |
||
| 140 | NAME="AEN5009" |
||
| 141 | > |
||
| 142 | > |
||
| 143 | >Return Value |
||
| 144 | > |
||
| 145 | >Returns |
||
| 146 | CLASS="RETURNVALUE" |
||
| 147 | >0 |
||
| 148 | > on success or |
||
| 149 | CLASS="RETURNVALUE" |
||
| 150 | >-1 |
||
| 151 | > if the event couldn't be pushed. |
||
| 152 | > |
||
| 153 | > |
||
| 154 | CLASS="REFSECT1" |
||
| 155 | > |
||
| 156 | NAME="AEN5014" |
||
| 157 | > |
||
| 158 | > |
||
| 159 | >Examples |
||
| 160 | > |
||
| 161 | >See |
||
| 162 | HREF="sdlevent.html" |
||
| 163 | > |
||
| 164 | CLASS="STRUCTNAME" |
||
| 165 | >SDL_Event |
||
| 166 | > |
||
| 167 | >. |
||
| 168 | > |
||
| 169 | > |
||
| 170 | CLASS="REFSECT1" |
||
| 171 | > |
||
| 172 | NAME="AEN5019" |
||
| 173 | > |
||
| 174 | > |
||
| 175 | >See Also |
||
| 176 | > |
||
| 177 | > |
||
| 178 | HREF="sdlpollevent.html" |
||
| 179 | > |
||
| 180 | CLASS="FUNCTION" |
||
| 181 | >SDL_PollEvent |
||
| 182 | > |
||
| 183 | >, |
||
| 184 | |||
| 185 | HREF="sdlpeepevents.html" |
||
| 186 | > |
||
| 187 | CLASS="FUNCTION" |
||
| 188 | >SDL_PeepEvents |
||
| 189 | > |
||
| 190 | >, |
||
| 191 | |||
| 192 | HREF="sdlevent.html" |
||
| 193 | > |
||
| 194 | CLASS="STRUCTNAME" |
||
| 195 | >SDL_Event |
||
| 196 | > |
||
| 197 | > |
||
| 198 | > |
||
| 199 | > |
||
| 200 | CLASS="NAVFOOTER" |
||
| 201 | > |
||
| 202 | ALIGN="LEFT" |
||
| 203 | WIDTH="100%"> |
||
| 204 | WIDTH="100%" |
||
| 205 | BORDER="0" |
||
| 206 | CELLPADDING="0" |
||
| 207 | CELLSPACING="0" |
||
| 208 | > |
||
| 209 | > |
||
| 210 | WIDTH="33%" |
||
| 211 | ALIGN="left" |
||
| 212 | VALIGN="top" |
||
| 213 | > |
||
| 214 | HREF="sdlwaitevent.html" |
||
| 215 | >Prev |
||
| 216 | > |
||
| 217 | > |
||
| 218 | WIDTH="34%" |
||
| 219 | ALIGN="center" |
||
| 220 | VALIGN="top" |
||
| 221 | > |
||
| 222 | HREF="index.html" |
||
| 223 | >Home |
||
| 224 | > |
||
| 225 | > |
||
| 226 | WIDTH="33%" |
||
| 227 | ALIGN="right" |
||
| 228 | VALIGN="top" |
||
| 229 | > |
||
| 230 | HREF="sdlseteventfilter.html" |
||
| 231 | >Next |
||
| 232 | > |
||
| 233 | > |
||
| 234 | > |
||
| 235 | > |
||
| 236 | WIDTH="33%" |
||
| 237 | ALIGN="left" |
||
| 238 | VALIGN="top" |
||
| 239 | >SDL_WaitEvent |
||
| 240 | > |
||
| 241 | WIDTH="34%" |
||
| 242 | ALIGN="center" |
||
| 243 | VALIGN="top" |
||
| 244 | > |
||
| 245 | HREF="eventfunctions.html" |
||
| 246 | >Up |
||
| 247 | > |
||
| 248 | > |
||
| 249 | WIDTH="33%" |
||
| 250 | ALIGN="right" |
||
| 251 | VALIGN="top" |
||
| 252 | >SDL_SetEventFilter |
||
| 253 | > |
||
| 254 | > |
||
| 255 | > |
||
| 256 | > |
||
| 257 | > |
||
| 258 | > |