src/joystick/SDL_sysjoystick.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 01 Jan 2017 18:33:28 -0800
changeset 10737 3406a0f8b041
parent 10713 580fcf8605e3
child 10745 7461fcef6ae2
permissions -rw-r--r--
Updated copyright for 2017
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2017 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 #include "../SDL_internal.h"
    22 
    23 #ifndef SDL_sysjoystick_h_
    24 #define SDL_sysjoystick_h_
    25 
    26 /* This is the system specific header for the SDL joystick API */
    27 
    28 #include "SDL_joystick.h"
    29 #include "SDL_joystick_c.h"
    30 
    31 /* The SDL joystick structure */
    32 typedef struct _SDL_JoystickAxisInfo
    33 {
    34     Sint16 value;           /* Current axis states */
    35     Sint16 zero;            /* Zero point on the axis (-32768 for triggers) */
    36     Sint16 intial_value;    /* The very first value we saw on this axis */
    37     SDL_bool moved;         /* Whether the axis has moved */
    38 } SDL_JoystickAxisInfo;
    39 
    40 struct _SDL_Joystick
    41 {
    42     SDL_JoystickID instance_id; /* Device instance, monotonically increasing from 0 */
    43     char *name;                 /* Joystick name - system dependent */
    44 
    45     int naxes;                  /* Number of axis controls on the joystick */
    46     SDL_JoystickAxisInfo *axes;
    47 
    48     int nhats;                  /* Number of hats on the joystick */
    49     Uint8 *hats;                /* Current hat states */
    50 
    51     int nballs;                 /* Number of trackballs on the joystick */
    52     struct balldelta {
    53         int dx;
    54         int dy;
    55     } *balls;                   /* Current ball motion deltas */
    56 
    57     int nbuttons;               /* Number of buttons on the joystick */
    58     Uint8 *buttons;             /* Current button states */
    59 
    60     struct joystick_hwdata *hwdata;     /* Driver dependent information */
    61 
    62     int ref_count;              /* Reference count for multiple opens */
    63 
    64     SDL_bool force_recentering; /* SDL_TRUE if this device needs to have its state reset to 0 */
    65     SDL_JoystickPowerLevel epowerlevel; /* power level of this joystick, SDL_JOYSTICK_POWER_UNKNOWN if not supported */
    66     struct _SDL_Joystick *next; /* pointer to next joystick we have allocated */
    67 };
    68 
    69 /* Function to scan the system for joysticks.
    70  * Joystick 0 should be the system default joystick.
    71  * This function should return the number of available joysticks, or -1
    72  * on an unrecoverable fatal error.
    73  */
    74 extern int SDL_SYS_JoystickInit(void);
    75 
    76 /* Function to return the number of joystick devices plugged in right now */
    77 extern int SDL_SYS_NumJoysticks(void);
    78 
    79 /* Function to cause any queued joystick insertions to be processed */
    80 extern void SDL_SYS_JoystickDetect(void);
    81 
    82 /* Function to get the device-dependent name of a joystick */
    83 extern const char *SDL_SYS_JoystickNameForDeviceIndex(int device_index);
    84 
    85 /* Function to get the current instance id of the joystick located at device_index */
    86 extern SDL_JoystickID SDL_SYS_GetInstanceIdOfDeviceIndex(int device_index);
    87 
    88 /* Function to open a joystick for use.
    89    The joystick to open is specified by the device index.
    90    This should fill the nbuttons and naxes fields of the joystick structure.
    91    It returns 0, or -1 if there is an error.
    92  */
    93 extern int SDL_SYS_JoystickOpen(SDL_Joystick * joystick, int device_index);
    94 
    95 /* Function to query if the joystick is currently attached
    96  * It returns SDL_TRUE if attached, SDL_FALSE otherwise.
    97  */
    98 extern SDL_bool SDL_SYS_JoystickAttached(SDL_Joystick * joystick);
    99 
   100 /* Function to update the state of a joystick - called as a device poll.
   101  * This function shouldn't update the joystick structure directly,
   102  * but instead should call SDL_PrivateJoystick*() to deliver events
   103  * and update joystick device state.
   104  */
   105 extern void SDL_SYS_JoystickUpdate(SDL_Joystick * joystick);
   106 
   107 /* Function to close a joystick after use */
   108 extern void SDL_SYS_JoystickClose(SDL_Joystick * joystick);
   109 
   110 /* Function to perform any system-specific joystick related cleanup */
   111 extern void SDL_SYS_JoystickQuit(void);
   112 
   113 /* Function to return the stable GUID for a plugged in device */
   114 extern SDL_JoystickGUID SDL_SYS_JoystickGetDeviceGUID(int device_index);
   115 
   116 /* Function to return the stable GUID for a opened joystick */
   117 extern SDL_JoystickGUID SDL_SYS_JoystickGetGUID(SDL_Joystick * joystick);
   118 
   119 #if SDL_JOYSTICK_XINPUT
   120 /* Function returns SDL_TRUE if this device is an XInput gamepad */
   121 extern SDL_bool SDL_SYS_IsXInputGamepad_DeviceIndex(int device_index);
   122 #endif
   123 
   124 #endif /* SDL_sysjoystick_h_ */
   125 
   126 /* vi: set ts=4 sw=4 expandtab: */