comparison docs/html/sdlevent.html @ 803:355632dca928

Updated SDL HTML documentation
author Sam Lantinga <slouken@libsdl.org>
date Tue, 10 Feb 2004 15:15:40 +0000
parents e5bc29de3f0a
children 85cbe9c892f4
comparison
equal deleted inserted replaced
802:3c609d54f100 803:355632dca928
2 ><HEAD 2 ><HEAD
3 ><TITLE 3 ><TITLE
4 >SDL_Event</TITLE 4 >SDL_Event</TITLE
5 ><META 5 ><META
6 NAME="GENERATOR" 6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 "><LINK 8 "><LINK
9 REL="HOME" 9 REL="HOME"
10 TITLE="SDL Library Documentation" 10 TITLE="SDL Library Documentation"
11 HREF="index.html"><LINK 11 HREF="index.html"><LINK
12 REL="UP" 12 REL="UP"
26 VLINK="#551a8b" 26 VLINK="#551a8b"
27 ALINK="#ff0000" 27 ALINK="#ff0000"
28 ><DIV 28 ><DIV
29 CLASS="NAVHEADER" 29 CLASS="NAVHEADER"
30 ><TABLE 30 ><TABLE
31 SUMMARY="Header navigation table"
31 WIDTH="100%" 32 WIDTH="100%"
32 BORDER="0" 33 BORDER="0"
33 CELLPADDING="0" 34 CELLPADDING="0"
34 CELLSPACING="0" 35 CELLSPACING="0"
35 ><TR 36 ><TR
43 WIDTH="10%" 44 WIDTH="10%"
44 ALIGN="left" 45 ALIGN="left"
45 VALIGN="bottom" 46 VALIGN="bottom"
46 ><A 47 ><A
47 HREF="eventstructures.html" 48 HREF="eventstructures.html"
49 ACCESSKEY="P"
48 >Prev</A 50 >Prev</A
49 ></TD 51 ></TD
50 ><TD 52 ><TD
51 WIDTH="80%" 53 WIDTH="80%"
52 ALIGN="center" 54 ALIGN="center"
56 WIDTH="10%" 58 WIDTH="10%"
57 ALIGN="right" 59 ALIGN="right"
58 VALIGN="bottom" 60 VALIGN="bottom"
59 ><A 61 ><A
60 HREF="sdlactiveevent.html" 62 HREF="sdlactiveevent.html"
63 ACCESSKEY="N"
61 >Next</A 64 >Next</A
62 ></TD 65 ></TD
63 ></TR 66 ></TR
64 ></TABLE 67 ></TABLE
65 ><HR 68 ><HR
66 ALIGN="LEFT" 69 ALIGN="LEFT"
67 WIDTH="100%"></DIV 70 WIDTH="100%"></DIV
68 ><H1 71 ><H1
69 ><A 72 ><A
70 NAME="SDLEVENT" 73 NAME="SDLEVENT"
71 >SDL_Event</A 74 ></A
72 ></H1 75 >SDL_Event</H1
73 ><DIV 76 ><DIV
74 CLASS="REFNAMEDIV" 77 CLASS="REFNAMEDIV"
75 ><A 78 ><A
76 NAME="AEN3327" 79 NAME="AEN3711"
77 ></A 80 ></A
78 ><H2 81 ><H2
79 >Name</H2 82 >Name</H2
80 >SDL_Event&nbsp;--&nbsp;General event structure</DIV 83 >SDL_Event&nbsp;--&nbsp;General event structure</DIV
81 ><DIV 84 ><DIV
82 CLASS="REFSECT1" 85 CLASS="REFSECT1"
83 ><A 86 ><A
84 NAME="AEN3330" 87 NAME="AEN3714"
85 ></A 88 ></A
86 ><H2 89 ><H2
87 >Structure Definition</H2 90 >Structure Definition</H2
88 ><PRE 91 ><PRE
89 CLASS="PROGRAMLISTING" 92 CLASS="PROGRAMLISTING"
105 } SDL_Event;</PRE 108 } SDL_Event;</PRE
106 ></DIV 109 ></DIV
107 ><DIV 110 ><DIV
108 CLASS="REFSECT1" 111 CLASS="REFSECT1"
109 ><A 112 ><A
110 NAME="AEN3333" 113 NAME="AEN3717"
111 ></A 114 ></A
112 ><H2 115 ><H2
113 >Structure Data</H2 116 >Structure Data</H2
114 ><DIV 117 ><DIV
115 CLASS="INFORMALTABLE" 118 CLASS="INFORMALTABLE"
116 ><A 119 ><A
117 NAME="AEN3335" 120 NAME="AEN3719"
118 ></A 121 ></A
119 ><P 122 ><P
120 ></P 123 ></P
121 ><TABLE 124 ><TABLE
122 BORDER="0" 125 BORDER="0"
378 ></DIV 381 ></DIV
379 ></DIV 382 ></DIV
380 ><DIV 383 ><DIV
381 CLASS="REFSECT1" 384 CLASS="REFSECT1"
382 ><A 385 ><A
383 NAME="AEN3407" 386 NAME="AEN3791"
384 ></A 387 ></A
385 ><H2 388 ><H2
386 >Description</H2 389 >Description</H2
387 ><P 390 ><P
388 >The <SPAN 391 >The <SPAN
402 >.</P 405 >.</P
403 ><P 406 ><P
404 ><DIV 407 ><DIV
405 CLASS="INFORMALTABLE" 408 CLASS="INFORMALTABLE"
406 ><A 409 ><A
407 NAME="AEN3415" 410 NAME="AEN3799"
408 ></A 411 ></A
409 ><P 412 ><P
410 ></P 413 ></P
411 ><TABLE 414 ><TABLE
412 BORDER="1" 415 BORDER="1"
684 ></P 687 ></P
685 ></DIV 688 ></DIV
686 ><DIV 689 ><DIV
687 CLASS="REFSECT1" 690 CLASS="REFSECT1"
688 ><A 691 ><A
689 NAME="AEN3501" 692 NAME="AEN3885"
690 ></A 693 ></A
691 ><H2 694 ><H2
692 >Use</H2 695 >Use</H2
693 ><P 696 ><P
694 >The <SPAN 697 >The <SPAN
761 CLASS="FUNCTION" 764 CLASS="FUNCTION"
762 >SDL_PollEvent</TT 765 >SDL_PollEvent</TT
763 > removes an event from the queue then the event information will be placed in our <SPAN 766 > removes an event from the queue then the event information will be placed in our <SPAN
764 CLASS="STRUCTNAME" 767 CLASS="STRUCTNAME"
765 >test_event</SPAN 768 >test_event</SPAN
766 > structure, but we also know that the <I 769 > structure, but we also know that the <SPAN
770 CLASS="emphasis"
771 ><I
767 CLASS="EMPHASIS" 772 CLASS="EMPHASIS"
768 >type</I 773 >type</I
774 ></SPAN
769 > of event will be placed in the <TT 775 > of event will be placed in the <TT
770 CLASS="STRUCTFIELD" 776 CLASS="STRUCTFIELD"
771 ><I 777 ><I
772 >type</I 778 >type</I
773 ></TT 779 ></TT
785 > statement. 791 > statement.
786 <PRE 792 <PRE
787 CLASS="PROGRAMLISTING" 793 CLASS="PROGRAMLISTING"
788 > switch(test_event.type) {</PRE 794 > switch(test_event.type) {</PRE
789 > 795 >
790 We need to know what kind of events we're looking for <I 796 We need to know what kind of events we're looking for <SPAN
797 CLASS="emphasis"
798 ><I
791 CLASS="EMPHASIS" 799 CLASS="EMPHASIS"
792 >and</I 800 >and</I
801 ></SPAN
793 > the event <TT 802 > the event <TT
794 CLASS="STRUCTFIELD" 803 CLASS="STRUCTFIELD"
795 ><I 804 ><I
796 >type</I 805 >type</I
797 ></TT 806 ></TT
889 ></P 898 ></P
890 ></DIV 899 ></DIV
891 ><DIV 900 ><DIV
892 CLASS="REFSECT1" 901 CLASS="REFSECT1"
893 ><A 902 ><A
894 NAME="AEN3558" 903 NAME="AEN3942"
895 ></A 904 ></A
896 ><H2 905 ><H2
897 >See Also</H2 906 >See Also</H2
898 ><P 907 ><P
899 ><A 908 ><A
921 ><DIV 930 ><DIV
922 CLASS="NAVFOOTER" 931 CLASS="NAVFOOTER"
923 ><HR 932 ><HR
924 ALIGN="LEFT" 933 ALIGN="LEFT"
925 WIDTH="100%"><TABLE 934 WIDTH="100%"><TABLE
935 SUMMARY="Footer navigation table"
926 WIDTH="100%" 936 WIDTH="100%"
927 BORDER="0" 937 BORDER="0"
928 CELLPADDING="0" 938 CELLPADDING="0"
929 CELLSPACING="0" 939 CELLSPACING="0"
930 ><TR 940 ><TR
932 WIDTH="33%" 942 WIDTH="33%"
933 ALIGN="left" 943 ALIGN="left"
934 VALIGN="top" 944 VALIGN="top"
935 ><A 945 ><A
936 HREF="eventstructures.html" 946 HREF="eventstructures.html"
947 ACCESSKEY="P"
937 >Prev</A 948 >Prev</A
938 ></TD 949 ></TD
939 ><TD 950 ><TD
940 WIDTH="34%" 951 WIDTH="34%"
941 ALIGN="center" 952 ALIGN="center"
942 VALIGN="top" 953 VALIGN="top"
943 ><A 954 ><A
944 HREF="index.html" 955 HREF="index.html"
956 ACCESSKEY="H"
945 >Home</A 957 >Home</A
946 ></TD 958 ></TD
947 ><TD 959 ><TD
948 WIDTH="33%" 960 WIDTH="33%"
949 ALIGN="right" 961 ALIGN="right"
950 VALIGN="top" 962 VALIGN="top"
951 ><A 963 ><A
952 HREF="sdlactiveevent.html" 964 HREF="sdlactiveevent.html"
965 ACCESSKEY="N"
953 >Next</A 966 >Next</A
954 ></TD 967 ></TD
955 ></TR 968 ></TR
956 ><TR 969 ><TR
957 ><TD 970 ><TD
963 WIDTH="34%" 976 WIDTH="34%"
964 ALIGN="center" 977 ALIGN="center"
965 VALIGN="top" 978 VALIGN="top"
966 ><A 979 ><A
967 HREF="eventstructures.html" 980 HREF="eventstructures.html"
981 ACCESSKEY="U"
968 >Up</A 982 >Up</A
969 ></TD 983 ></TD
970 ><TD 984 ><TD
971 WIDTH="33%" 985 WIDTH="33%"
972 ALIGN="right" 986 ALIGN="right"