src/joystick/SDL_sysjoystick.h
author Sam Lantinga
Sun, 20 Nov 2016 21:34:54 -0800
changeset 10638 d11daa346140
parent 10609 d702ecbd8ba7
child 10713 580fcf8605e3
permissions -rw-r--r--
Renaming of guard header names to quiet -Wreserved-id-macro
Patch contributed by Sylvain
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@9998
     3
  Copyright (C) 1997-2016 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
*/
icculus@8093
    21
#include "../SDL_internal.h"
slouken@0
    22
slouken@10638
    23
#ifndef SDL_sysjoystick_h_
slouken@10638
    24
#define SDL_sysjoystick_h_
slouken@8972
    25
slouken@0
    26
/* This is the system specific header for the SDL joystick API */
slouken@0
    27
slouken@0
    28
#include "SDL_joystick.h"
slouken@6690
    29
#include "SDL_joystick_c.h"
slouken@0
    30
slouken@0
    31
/* The SDL joystick structure */
slouken@1895
    32
struct _SDL_Joystick
slouken@1895
    33
{
slouken@6949
    34
    SDL_JoystickID instance_id; /* Device instance, monotonically increasing from 0 */
slouken@6949
    35
    char *name;                 /* Joystick name - system dependent */
slouken@0
    36
slouken@1895
    37
    int naxes;                  /* Number of axis controls on the joystick */
slouken@1895
    38
    Sint16 *axes;               /* Current axis states */
slouken@10477
    39
    Sint16 *axes_zero;          /* Zero point on the axis (-32768 for triggers) */
slouken@1895
    40
slouken@1895
    41
    int nhats;                  /* Number of hats on the joystick */
slouken@1895
    42
    Uint8 *hats;                /* Current hat states */
slouken@0
    43
slouken@1895
    44
    int nballs;                 /* Number of trackballs on the joystick */
slouken@6949
    45
    struct balldelta {
slouken@1895
    46
        int dx;
slouken@1895
    47
        int dy;
slouken@1895
    48
    } *balls;                   /* Current ball motion deltas */
slouken@0
    49
slouken@1895
    50
    int nbuttons;               /* Number of buttons on the joystick */
slouken@1895
    51
    Uint8 *buttons;             /* Current button states */
slouken@1895
    52
slouken@1895
    53
    struct joystick_hwdata *hwdata;     /* Driver dependent information */
slouken@1895
    54
slouken@1895
    55
    int ref_count;              /* Reference count for multiple opens */
slouken@6949
    56
icculus@9433
    57
    SDL_bool force_recentering; /* SDL_TRUE if this device needs to have its state reset to 0 */
slouken@9884
    58
    SDL_JoystickPowerLevel epowerlevel; /* power level of this joystick, SDL_JOYSTICK_POWER_UNKNOWN if not supported */
slouken@6949
    59
    struct _SDL_Joystick *next; /* pointer to next joystick we have allocated */
slouken@0
    60
};
slouken@0
    61
slouken@0
    62
/* Function to scan the system for joysticks.
slouken@0
    63
 * Joystick 0 should be the system default joystick.
slouken@0
    64
 * This function should return the number of available joysticks, or -1
slouken@0
    65
 * on an unrecoverable fatal error.
slouken@0
    66
 */
slouken@0
    67
extern int SDL_SYS_JoystickInit(void);
slouken@0
    68
slouken@6707
    69
/* Function to return the number of joystick devices plugged in right now */
slouken@10609
    70
extern int SDL_SYS_NumJoysticks(void);
slouken@6707
    71
slouken@6707
    72
/* Function to cause any queued joystick insertions to be processed */
slouken@10609
    73
extern void SDL_SYS_JoystickDetect(void);
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.
philipp@9380
    82
   The joystick to open is specified by the device index.
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
philipp@9380
    89
 * It returns SDL_TRUE if attached, SDL_FALSE 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@6738
   107
extern SDL_JoystickGUID SDL_SYS_JoystickGetDeviceGUID(int device_index);
slouken@6690
   108
slouken@6707
   109
/* Function to return the stable GUID for a opened joystick */
slouken@6738
   110
extern SDL_JoystickGUID SDL_SYS_JoystickGetGUID(SDL_Joystick * joystick);
slouken@6690
   111
slouken@8985
   112
#if SDL_JOYSTICK_XINPUT
slouken@8920
   113
/* Function returns SDL_TRUE if this device is an XInput gamepad */
slouken@8972
   114
extern SDL_bool SDL_SYS_IsXInputGamepad_DeviceIndex(int device_index);
slouken@8985
   115
#endif
slouken@8972
   116
slouken@10638
   117
#endif /* SDL_sysjoystick_h_ */
slouken@6707
   118
slouken@1895
   119
/* vi: set ts=4 sw=4 expandtab: */