Home | History | Annotate | Download | only in html
      1 <HTML
      2 ><HEAD
      3 ><TITLE
      4 >SDL_JoystickGetButton</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="Joystick"
     14 HREF="joystick.html"><LINK
     15 REL="PREVIOUS"
     16 TITLE="SDL_JoystickGetHat"
     17 HREF="sdljoystickgethat.html"><LINK
     18 REL="NEXT"
     19 TITLE="SDL_JoystickGetBall"
     20 HREF="sdljoystickgetball.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="sdljoystickgethat.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="sdljoystickgetball.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="SDLJOYSTICKGETBUTTON"
     74 ></A
     75 >SDL_JoystickGetButton</H1
     76 ><DIV
     77 CLASS="REFNAMEDIV"
     78 ><A
     79 NAME="AEN6404"
     80 ></A
     81 ><H2
     82 >Name</H2
     83 >SDL_JoystickGetButton&nbsp;--&nbsp;Get the current state of a given button on a given joystick</DIV
     84 ><DIV
     85 CLASS="REFSYNOPSISDIV"
     86 ><A
     87 NAME="AEN6407"
     88 ></A
     89 ><H2
     90 >Synopsis</H2
     91 ><DIV
     92 CLASS="FUNCSYNOPSIS"
     93 ><A
     94 NAME="AEN6408"
     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 >Uint8 <B
    106 CLASS="FSFUNC"
    107 >SDL_JoystickGetButton</B
    108 ></CODE
    109 >(SDL_Joystick *joystick, int button);</CODE
    110 ></P
    111 ><P
    112 ></P
    113 ></DIV
    114 ></DIV
    115 ><DIV
    116 CLASS="REFSECT1"
    117 ><A
    118 NAME="AEN6414"
    119 ></A
    120 ><H2
    121 >Description</H2
    122 ><P
    123 >SDL_JoystickGetButton returns the current state of the given <TT
    124 CLASS="PARAMETER"
    125 ><I
    126 >button</I
    127 ></TT
    128 > on the given <TT
    129 CLASS="PARAMETER"
    130 ><I
    131 >joystick</I
    132 ></TT
    133 >.</P
    134 ></DIV
    135 ><DIV
    136 CLASS="REFSECT1"
    137 ><A
    138 NAME="AEN6419"
    139 ></A
    140 ><H2
    141 >Return Value</H2
    142 ><P
    143 ><SPAN
    144 CLASS="RETURNVALUE"
    145 >1</SPAN
    146 > if the button is pressed. Otherwise, <SPAN
    147 CLASS="RETURNVALUE"
    148 >0</SPAN
    149 >.</P
    150 ></DIV
    151 ><DIV
    152 CLASS="REFSECT1"
    153 ><A
    154 NAME="AEN6424"
    155 ></A
    156 ><H2
    157 >See Also</H2
    158 ><P
    159 ><A
    160 HREF="sdljoysticknumbuttons.html"
    161 ><TT
    162 CLASS="FUNCTION"
    163 >SDL_JoystickNumButtons</TT
    164 ></A
    165 ></P
    166 ></DIV
    167 ><DIV
    168 CLASS="NAVFOOTER"
    169 ><HR
    170 ALIGN="LEFT"
    171 WIDTH="100%"><TABLE
    172 SUMMARY="Footer navigation table"
    173 WIDTH="100%"
    174 BORDER="0"
    175 CELLPADDING="0"
    176 CELLSPACING="0"
    177 ><TR
    178 ><TD
    179 WIDTH="33%"
    180 ALIGN="left"
    181 VALIGN="top"
    182 ><A
    183 HREF="sdljoystickgethat.html"
    184 ACCESSKEY="P"
    185 >Prev</A
    186 ></TD
    187 ><TD
    188 WIDTH="34%"
    189 ALIGN="center"
    190 VALIGN="top"
    191 ><A
    192 HREF="index.html"
    193 ACCESSKEY="H"
    194 >Home</A
    195 ></TD
    196 ><TD
    197 WIDTH="33%"
    198 ALIGN="right"
    199 VALIGN="top"
    200 ><A
    201 HREF="sdljoystickgetball.html"
    202 ACCESSKEY="N"
    203 >Next</A
    204 ></TD
    205 ></TR
    206 ><TR
    207 ><TD
    208 WIDTH="33%"
    209 ALIGN="left"
    210 VALIGN="top"
    211 >SDL_JoystickGetHat</TD
    212 ><TD
    213 WIDTH="34%"
    214 ALIGN="center"
    215 VALIGN="top"
    216 ><A
    217 HREF="joystick.html"
    218 ACCESSKEY="U"
    219 >Up</A
    220 ></TD
    221 ><TD
    222 WIDTH="33%"
    223 ALIGN="right"
    224 VALIGN="top"
    225 >SDL_JoystickGetBall</TD
    226 ></TR
    227 ></TABLE
    228 ></DIV
    229 ></BODY
    230 ></HTML
    231 >