src/joystick/SDL_sysjoystick.h
author Sam Lantinga
Tue, 27 Nov 2012 00:58:12 -0800
changeset 6707 70eeb7e3ec2f
parent 6701 91160c9b35da
child 6738 b408d5a406a3
permissions -rw-r--r--
Organized joystick hotplug code a bit.
Cleaned up names, return types, etc.
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6138
     3
  Copyright (C) 1997-2012 Sam Lantinga <slouken@libsdl.org>
slouken@0
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@0
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@0
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@0
    20
*/
slouken@1402
    21
#include "SDL_config.h"
slouken@0
    22
slouken@0
    23
/* This is the system specific header for the SDL joystick API */
slouken@0
    24
slouken@0
    25
#include "SDL_joystick.h"
slouken@6690
    26
#include "SDL_joystick_c.h"
slouken@0
    27
slouken@0
    28
/* The SDL joystick structure */
slouken@1895
    29
struct _SDL_Joystick
slouken@1895
    30
{
slouken@6690
    31
    int instance_id;                /* Device instance, monotonically increasing from 0 */
slouken@6690
    32
    char *name;          		 /* Joystick name - system dependent */
slouken@0
    33
slouken@1895
    34
    int naxes;                  /* Number of axis controls on the joystick */
slouken@1895
    35
    Sint16 *axes;               /* Current axis states */
slouken@1895
    36
slouken@1895
    37
    int nhats;                  /* Number of hats on the joystick */
slouken@1895
    38
    Uint8 *hats;                /* Current hat states */
slouken@0
    39
slouken@1895
    40
    int nballs;                 /* Number of trackballs on the joystick */
slouken@1895
    41
    struct balldelta
slouken@1895
    42
    {
slouken@1895
    43
        int dx;
slouken@1895
    44
        int dy;
slouken@1895
    45
    } *balls;                   /* Current ball motion deltas */
slouken@0
    46
slouken@1895
    47
    int nbuttons;               /* Number of buttons on the joystick */
slouken@1895
    48
    Uint8 *buttons;             /* Current button states */
slouken@1895
    49
slouken@1895
    50
    struct joystick_hwdata *hwdata;     /* Driver dependent information */
slouken@1895
    51
slouken@1895
    52
    int ref_count;              /* Reference count for multiple opens */
slouken@6690
    53
	
slouken@6690
    54
	Uint8 closed;				/* 1 if this device is no longer valid */
slouken@6690
    55
	Uint8 uncentered;			/* 1 if this device needs to have its state reset to 0 */
slouken@6690
    56
	struct _SDL_Joystick *next; /* pointer to next joystick we have allocated */
slouken@0
    57
};
slouken@0
    58
slouken@0
    59
/* Function to scan the system for joysticks.
slouken@0
    60
 * Joystick 0 should be the system default joystick.
slouken@0
    61
 * This function should return the number of available joysticks, or -1
slouken@0
    62
 * on an unrecoverable fatal error.
slouken@0
    63
 */
slouken@0
    64
extern int SDL_SYS_JoystickInit(void);
slouken@0
    65
slouken@6707
    66
/* Function to return the number of joystick devices plugged in right now */
slouken@6707
    67
extern int SDL_SYS_NumJoysticks();
slouken@6707
    68
slouken@6707
    69
/* Function to cause any queued joystick insertions to be processed */
slouken@6707
    70
extern void SDL_SYS_JoystickDetect();
slouken@6707
    71
slouken@6707
    72
/* Function to determine if the joystick loop needs to run right now */
slouken@6707
    73
extern SDL_bool SDL_SYS_JoystickNeedsPolling();
slouken@6707
    74
slouken@0
    75
/* Function to get the device-dependent name of a joystick */
slouken@6707
    76
extern const char *SDL_SYS_JoystickNameForDeviceIndex(int device_index);
slouken@6690
    77
slouken@6690
    78
/* Function to get the current instance id of the joystick located at device_index */
slouken@6707
    79
extern SDL_JoystickID SDL_SYS_GetInstanceIdOfDeviceIndex(int device_index);
slouken@0
    80
slouken@0
    81
/* Function to open a joystick for use.
slouken@0
    82
   The joystick to open is specified by the index field of the joystick.
slouken@0
    83
   This should fill the nbuttons and naxes fields of the joystick structure.
slouken@0
    84
   It returns 0, or -1 if there is an error.
slouken@0
    85
 */
slouken@6707
    86
extern int SDL_SYS_JoystickOpen(SDL_Joystick * joystick, int device_index);
slouken@6707
    87
slouken@6707
    88
/* Function to query if the joystick is currently attached
slouken@6707
    89
 *   It returns 1 if attached, 0 otherwise.
slouken@6707
    90
 */
slouken@6707
    91
extern SDL_bool SDL_SYS_JoystickAttached(SDL_Joystick * joystick);
slouken@0
    92
slouken@0
    93
/* Function to update the state of a joystick - called as a device poll.
slouken@0
    94
 * This function shouldn't update the joystick structure directly,
slouken@0
    95
 * but instead should call SDL_PrivateJoystick*() to deliver events
slouken@0
    96
 * and update joystick device state.
slouken@0
    97
 */
slouken@1895
    98
extern void SDL_SYS_JoystickUpdate(SDL_Joystick * joystick);
slouken@0
    99
slouken@0
   100
/* Function to close a joystick after use */
slouken@1895
   101
extern void SDL_SYS_JoystickClose(SDL_Joystick * joystick);
slouken@0
   102
slouken@0
   103
/* Function to perform any system-specific joystick related cleanup */
slouken@0
   104
extern void SDL_SYS_JoystickQuit(void);
slouken@1978
   105
slouken@6707
   106
/* Function to return the stable GUID for a plugged in device */
slouken@6707
   107
extern JoystickGUID SDL_SYS_JoystickGetDeviceGUID(int device_index);
slouken@6690
   108
slouken@6707
   109
/* Function to return the stable GUID for a opened joystick */
slouken@6707
   110
extern JoystickGUID SDL_SYS_JoystickGetGUID(SDL_Joystick * joystick);
slouken@6690
   111
slouken@6701
   112
#ifdef SDL_JOYSTICK_DINPUT
slouken@6690
   113
/* Function to get the current instance id of the joystick located at device_index */
slouken@6707
   114
extern SDL_bool SDL_SYS_IsXInputDeviceIndex( int device_index );
slouken@6690
   115
#endif
slouken@6707
   116
slouken@1895
   117
/* vi: set ts=4 sw=4 expandtab: */