• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_JoyButtonEvent</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8"><LINK
9REL="HOME"
10TITLE="SDL Library Documentation"
11HREF="index.html"><LINK
12REL="UP"
13TITLE="SDL Event Structures."
14HREF="eventstructures.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_JoyAxisEvent"
17HREF="sdljoyaxisevent.html"><LINK
18REL="NEXT"
19TITLE="SDL_JoyHatEvent"
20HREF="sdljoyhatevent.html"></HEAD
21><BODY
22CLASS="REFENTRY"
23BGCOLOR="#FFF8DC"
24TEXT="#000000"
25LINK="#0000ee"
26VLINK="#551a8b"
27ALINK="#ff0000"
28><DIV
29CLASS="NAVHEADER"
30><TABLE
31SUMMARY="Header navigation table"
32WIDTH="100%"
33BORDER="0"
34CELLPADDING="0"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="3"
39ALIGN="center"
40>SDL Library Documentation</TH
41></TR
42><TR
43><TD
44WIDTH="10%"
45ALIGN="left"
46VALIGN="bottom"
47><A
48HREF="sdljoyaxisevent.html"
49ACCESSKEY="P"
50>Prev</A
51></TD
52><TD
53WIDTH="80%"
54ALIGN="center"
55VALIGN="bottom"
56></TD
57><TD
58WIDTH="10%"
59ALIGN="right"
60VALIGN="bottom"
61><A
62HREF="sdljoyhatevent.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLJOYBUTTONEVENT"
74></A
75>SDL_JoyButtonEvent</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN4258"
80></A
81><H2
82>Name</H2
83>SDL_JoyButtonEvent&nbsp;--&nbsp;Joystick button event structure</DIV
84><DIV
85CLASS="REFSECT1"
86><A
87NAME="AEN4261"
88></A
89><H2
90>Structure Definition</H2
91><PRE
92CLASS="PROGRAMLISTING"
93>typedef struct{
94  Uint8 type;
95  Uint8 which;
96  Uint8 button;
97  Uint8 state;
98} SDL_JoyButtonEvent;</PRE
99></DIV
100><DIV
101CLASS="REFSECT1"
102><A
103NAME="AEN4264"
104></A
105><H2
106>Structure Data</H2
107><DIV
108CLASS="INFORMALTABLE"
109><A
110NAME="AEN4266"
111></A
112><P
113></P
114><TABLE
115BORDER="0"
116CLASS="CALSTABLE"
117><TBODY
118><TR
119><TD
120ALIGN="LEFT"
121VALIGN="TOP"
122><TT
123CLASS="STRUCTFIELD"
124><I
125>type</I
126></TT
127></TD
128><TD
129ALIGN="LEFT"
130VALIGN="TOP"
131><TT
132CLASS="LITERAL"
133>SDL_JOYBUTTONDOWN</TT
134> or <TT
135CLASS="LITERAL"
136>SDL_JOYBUTTONUP</TT
137></TD
138></TR
139><TR
140><TD
141ALIGN="LEFT"
142VALIGN="TOP"
143><TT
144CLASS="STRUCTFIELD"
145><I
146>which</I
147></TT
148></TD
149><TD
150ALIGN="LEFT"
151VALIGN="TOP"
152>Joystick device index</TD
153></TR
154><TR
155><TD
156ALIGN="LEFT"
157VALIGN="TOP"
158><TT
159CLASS="STRUCTFIELD"
160><I
161>button</I
162></TT
163></TD
164><TD
165ALIGN="LEFT"
166VALIGN="TOP"
167>Joystick button index</TD
168></TR
169><TR
170><TD
171ALIGN="LEFT"
172VALIGN="TOP"
173><TT
174CLASS="STRUCTFIELD"
175><I
176>state</I
177></TT
178></TD
179><TD
180ALIGN="LEFT"
181VALIGN="TOP"
182><TT
183CLASS="LITERAL"
184>SDL_PRESSED</TT
185> or <TT
186CLASS="LITERAL"
187>SDL_RELEASED</TT
188></TD
189></TR
190></TBODY
191></TABLE
192><P
193></P
194></DIV
195></DIV
196><DIV
197CLASS="REFSECT1"
198><A
199NAME="AEN4289"
200></A
201><H2
202>Description</H2
203><P
204><SPAN
205CLASS="STRUCTNAME"
206>SDL_JoyButtonEvent</SPAN
207> is a member of the <A
208HREF="sdlevent.html"
209><SPAN
210CLASS="STRUCTNAME"
211>SDL_Event</SPAN
212></A
213> union and is used when an event of type <TT
214CLASS="LITERAL"
215>SDL_JOYBUTTONDOWN</TT
216> or <TT
217CLASS="LITERAL"
218>SDL_JOYBUTTONUP</TT
219> is reported.</P
220><P
221>A <TT
222CLASS="LITERAL"
223>SDL_JOYBUTTONDOWN</TT
224> or <TT
225CLASS="LITERAL"
226>SDL_JOYBUTTONUP</TT
227> event occurs when ever a user presses or releases a button on a joystick. The field <TT
228CLASS="STRUCTFIELD"
229><I
230>which</I
231></TT
232> is the index of the joystick that reported the event and <TT
233CLASS="STRUCTFIELD"
234><I
235>button</I
236></TT
237> is the index of the button (for a more detailed explaination see the <A
238HREF="joystick.html"
239>Joystick section</A
240>). <TT
241CLASS="STRUCTFIELD"
242><I
243>state</I
244></TT
245> is the current state or the button which is either <TT
246CLASS="LITERAL"
247>SDL_PRESSED</TT
248> or <TT
249CLASS="LITERAL"
250>SDL_RELEASED</TT
251>.</P
252></DIV
253><DIV
254CLASS="REFSECT1"
255><A
256NAME="AEN4306"
257></A
258><H2
259>See Also</H2
260><P
261><A
262HREF="sdlevent.html"
263><SPAN
264CLASS="STRUCTNAME"
265>SDL_Event</SPAN
266></A
267>,
268<A
269HREF="joystick.html"
270>Joystick Functions</A
271>,
272<A
273HREF="sdljoystickeventstate.html"
274><TT
275CLASS="FUNCTION"
276>SDL_JoystickEventState</TT
277></A
278>,
279<A
280HREF="sdljoystickgetbutton.html"
281><TT
282CLASS="FUNCTION"
283>SDL_JoystickGetButton</TT
284></A
285></P
286></DIV
287><DIV
288CLASS="NAVFOOTER"
289><HR
290ALIGN="LEFT"
291WIDTH="100%"><TABLE
292SUMMARY="Footer navigation table"
293WIDTH="100%"
294BORDER="0"
295CELLPADDING="0"
296CELLSPACING="0"
297><TR
298><TD
299WIDTH="33%"
300ALIGN="left"
301VALIGN="top"
302><A
303HREF="sdljoyaxisevent.html"
304ACCESSKEY="P"
305>Prev</A
306></TD
307><TD
308WIDTH="34%"
309ALIGN="center"
310VALIGN="top"
311><A
312HREF="index.html"
313ACCESSKEY="H"
314>Home</A
315></TD
316><TD
317WIDTH="33%"
318ALIGN="right"
319VALIGN="top"
320><A
321HREF="sdljoyhatevent.html"
322ACCESSKEY="N"
323>Next</A
324></TD
325></TR
326><TR
327><TD
328WIDTH="33%"
329ALIGN="left"
330VALIGN="top"
331>SDL_JoyAxisEvent</TD
332><TD
333WIDTH="34%"
334ALIGN="center"
335VALIGN="top"
336><A
337HREF="eventstructures.html"
338ACCESSKEY="U"
339>Up</A
340></TD
341><TD
342WIDTH="33%"
343ALIGN="right"
344VALIGN="top"
345>SDL_JoyHatEvent</TD
346></TR
347></TABLE
348></DIV
349></BODY
350></HTML
351>