src/joystick/SDL_sysjoystick.h
author Sam Lantinga
Tue, 11 Dec 2012 12:16:28 -0800
changeset 6744 4ac2bb6dc80c
parent 6738 b408d5a406a3
child 6885 700f1b25f77f
permissions -rw-r--r--
Fixed joystick GUID renaming for other platforms
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2012 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_config.h"
    22 
    23 /* This is the system specific header for the SDL joystick API */
    24 
    25 #include "SDL_joystick.h"
    26 #include "SDL_joystick_c.h"
    27 
    28 /* The SDL joystick structure */
    29 struct _SDL_Joystick
    30 {
    31     int instance_id;                /* Device instance, monotonically increasing from 0 */
    32     char *name;          		 /* Joystick name - system dependent */
    33 
    34     int naxes;                  /* Number of axis controls on the joystick */
    35     Sint16 *axes;               /* Current axis states */
    36 
    37     int nhats;                  /* Number of hats on the joystick */
    38     Uint8 *hats;                /* Current hat states */
    39 
    40     int nballs;                 /* Number of trackballs on the joystick */
    41     struct balldelta
    42     {
    43         int dx;
    44         int dy;
    45     } *balls;                   /* Current ball motion deltas */
    46 
    47     int nbuttons;               /* Number of buttons on the joystick */
    48     Uint8 *buttons;             /* Current button states */
    49 
    50     struct joystick_hwdata *hwdata;     /* Driver dependent information */
    51 
    52     int ref_count;              /* Reference count for multiple opens */
    53 	
    54 	Uint8 closed;				/* 1 if this device is no longer valid */
    55 	Uint8 uncentered;			/* 1 if this device needs to have its state reset to 0 */
    56 	struct _SDL_Joystick *next; /* pointer to next joystick we have allocated */
    57 };
    58 
    59 /* Function to scan the system for joysticks.
    60  * Joystick 0 should be the system default joystick.
    61  * This function should return the number of available joysticks, or -1
    62  * on an unrecoverable fatal error.
    63  */
    64 extern int SDL_SYS_JoystickInit(void);
    65 
    66 /* Function to return the number of joystick devices plugged in right now */
    67 extern int SDL_SYS_NumJoysticks();
    68 
    69 /* Function to cause any queued joystick insertions to be processed */
    70 extern void SDL_SYS_JoystickDetect();
    71 
    72 /* Function to determine if the joystick loop needs to run right now */
    73 extern SDL_bool SDL_SYS_JoystickNeedsPolling();
    74 
    75 /* Function to get the device-dependent name of a joystick */
    76 extern const char *SDL_SYS_JoystickNameForDeviceIndex(int device_index);
    77 
    78 /* Function to get the current instance id of the joystick located at device_index */
    79 extern SDL_JoystickID SDL_SYS_GetInstanceIdOfDeviceIndex(int device_index);
    80 
    81 /* Function to open a joystick for use.
    82    The joystick to open is specified by the index field of the joystick.
    83    This should fill the nbuttons and naxes fields of the joystick structure.
    84    It returns 0, or -1 if there is an error.
    85  */
    86 extern int SDL_SYS_JoystickOpen(SDL_Joystick * joystick, int device_index);
    87 
    88 /* Function to query if the joystick is currently attached
    89  *   It returns 1 if attached, 0 otherwise.
    90  */
    91 extern SDL_bool SDL_SYS_JoystickAttached(SDL_Joystick * joystick);
    92 
    93 /* Function to update the state of a joystick - called as a device poll.
    94  * This function shouldn't update the joystick structure directly,
    95  * but instead should call SDL_PrivateJoystick*() to deliver events
    96  * and update joystick device state.
    97  */
    98 extern void SDL_SYS_JoystickUpdate(SDL_Joystick * joystick);
    99 
   100 /* Function to close a joystick after use */
   101 extern void SDL_SYS_JoystickClose(SDL_Joystick * joystick);
   102 
   103 /* Function to perform any system-specific joystick related cleanup */
   104 extern void SDL_SYS_JoystickQuit(void);
   105 
   106 /* Function to return the stable GUID for a plugged in device */
   107 extern SDL_JoystickGUID SDL_SYS_JoystickGetDeviceGUID(int device_index);
   108 
   109 /* Function to return the stable GUID for a opened joystick */
   110 extern SDL_JoystickGUID SDL_SYS_JoystickGetGUID(SDL_Joystick * joystick);
   111 
   112 #ifdef SDL_JOYSTICK_DINPUT
   113 /* Function to get the current instance id of the joystick located at device_index */
   114 extern SDL_bool SDL_SYS_IsXInputDeviceIndex( int device_index );
   115 #endif
   116 
   117 /* vi: set ts=4 sw=4 expandtab: */