docs/html/sdlpollevent.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >SDL_PollEvent</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="Event Functions."
  14 HREF="eventfunctions.html"><LINK
  15 REL="PREVIOUS"
  16 TITLE="SDL_PeepEvents"
  17 HREF="sdlpeepevents.html"><LINK
  18 REL="NEXT"
  19 TITLE="SDL_WaitEvent"
  20 HREF="sdlwaitevent.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="sdlpeepevents.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="sdlwaitevent.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="SDLPOLLEVENT"
  74 ></A
  75 >SDL_PollEvent</H1
  76 ><DIV
  77 CLASS="REFNAMEDIV"
  78 ><A
  79 NAME="AEN5472"
  80 ></A
  81 ><H2
  82 >Name</H2
  83 >SDL_PollEvent&nbsp;--&nbsp;Polls for currently pending events.</DIV
  84 ><DIV
  85 CLASS="REFSYNOPSISDIV"
  86 ><A
  87 NAME="AEN5475"
  88 ></A
  89 ><H2
  90 >Synopsis</H2
  91 ><DIV
  92 CLASS="FUNCSYNOPSIS"
  93 ><A
  94 NAME="AEN5476"
  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_PollEvent</B
 108 ></CODE
 109 >(SDL_Event *event);</CODE
 110 ></P
 111 ><P
 112 ></P
 113 ></DIV
 114 ></DIV
 115 ><DIV
 116 CLASS="REFSECT1"
 117 ><A
 118 NAME="AEN5482"
 119 ></A
 120 ><H2
 121 >Description</H2
 122 ><P
 123 >Polls for currently pending events, and returns <SPAN
 124 CLASS="RETURNVALUE"
 125 >1</SPAN
 126 >
 127 if there are any pending events, or <SPAN
 128 CLASS="RETURNVALUE"
 129 >0</SPAN
 130 > if there
 131 are none available.  </P
 132 ><P
 133 >If <TT
 134 CLASS="PARAMETER"
 135 ><I
 136 >event</I
 137 ></TT
 138 > is not <TT
 139 CLASS="LITERAL"
 140 >NULL</TT
 141 >, the next
 142 event is removed from the queue and stored in that area.</P
 143 ></DIV
 144 ><DIV
 145 CLASS="REFSECT1"
 146 ><A
 147 NAME="AEN5490"
 148 ></A
 149 ><H2
 150 >Examples</H2
 151 ><P
 152 ><PRE
 153 CLASS="PROGRAMLISTING"
 154 >SDL_Event event; /* Event structure */
 155
 156 .
 157 .
 158 .
 159 /* Check for events */
 160 while(SDL_PollEvent(&#38;event)){  /* Loop until there are no events left on the queue */
 161   switch(event.type){  /* Process the appropiate event type */
 162     case SDL_KEYDOWN:  /* Handle a KEYDOWN event */
 163       printf("Oh! Key press\n");
 164       break;
 165     case SDL_MOUSEMOTION:
 166       .
 167       .
 168       .
 169     default: /* Report an unhandled event */
 170       printf("I don't know what this event is!\n");
 171   }
 172 }</PRE
 173 ></P
 174 ></DIV
 175 ><DIV
 176 CLASS="REFSECT1"
 177 ><A
 178 NAME="AEN5494"
 179 ></A
 180 ><H2
 181 >See Also</H2
 182 ><P
 183 ><A
 184 HREF="sdlevent.html"
 185 ><SPAN
 186 CLASS="STRUCTNAME"
 187 >SDL_Event</SPAN
 188 ></A
 189 >,
 190 <A
 191 HREF="sdlwaitevent.html"
 192 ><TT
 193 CLASS="FUNCTION"
 194 >SDL_WaitEvent</TT
 195 ></A
 196 >,
 197 <A
 198 HREF="sdlpeepevents.html"
 199 ><TT
 200 CLASS="FUNCTION"
 201 >SDL_PeepEvents</TT
 202 ></A
 203 ></P
 204 ></DIV
 205 ><DIV
 206 CLASS="NAVFOOTER"
 207 ><HR
 208 ALIGN="LEFT"
 209 WIDTH="100%"><TABLE
 210 SUMMARY="Footer navigation table"
 211 WIDTH="100%"
 212 BORDER="0"
 213 CELLPADDING="0"
 214 CELLSPACING="0"
 215 ><TR
 216 ><TD
 217 WIDTH="33%"
 218 ALIGN="left"
 219 VALIGN="top"
 220 ><A
 221 HREF="sdlpeepevents.html"
 222 ACCESSKEY="P"
 223 >Prev</A
 224 ></TD
 225 ><TD
 226 WIDTH="34%"
 227 ALIGN="center"
 228 VALIGN="top"
 229 ><A
 230 HREF="index.html"
 231 ACCESSKEY="H"
 232 >Home</A
 233 ></TD
 234 ><TD
 235 WIDTH="33%"
 236 ALIGN="right"
 237 VALIGN="top"
 238 ><A
 239 HREF="sdlwaitevent.html"
 240 ACCESSKEY="N"
 241 >Next</A
 242 ></TD
 243 ></TR
 244 ><TR
 245 ><TD
 246 WIDTH="33%"
 247 ALIGN="left"
 248 VALIGN="top"
 249 >SDL_PeepEvents</TD
 250 ><TD
 251 WIDTH="34%"
 252 ALIGN="center"
 253 VALIGN="top"
 254 ><A
 255 HREF="eventfunctions.html"
 256 ACCESSKEY="U"
 257 >Up</A
 258 ></TD
 259 ><TD
 260 WIDTH="33%"
 261 ALIGN="right"
 262 VALIGN="top"
 263 >SDL_WaitEvent</TD
 264 ></TR
 265 ></TABLE
 266 ></DIV
 267 ></BODY
 268 ></HTML
 269 >