src/joystick/SDL_sysjoystick.h
author Sam Lantinga
Fri, 08 Apr 2011 13:03:26 -0700
changeset 5535 96594ac5fd1a
parent 5262 b530ef003506
child 6138 4c64952a58fb
permissions -rw-r--r--
SDL 1.3 is now under the zlib license.
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@5535
     3
  Copyright (C) 1997-2011 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@0
    26
slouken@0
    27
/* The SDL joystick structure */
slouken@1895
    28
struct _SDL_Joystick
slouken@1895
    29
{
slouken@1895
    30
    Uint8 index;                /* Device index */
slouken@1895
    31
    const char *name;           /* Joystick name - system dependent */
slouken@0
    32
slouken@1895
    33
    int naxes;                  /* Number of axis controls on the joystick */
slouken@1895
    34
    Sint16 *axes;               /* Current axis states */
slouken@1895
    35
slouken@1895
    36
    int nhats;                  /* Number of hats on the joystick */
slouken@1895
    37
    Uint8 *hats;                /* Current hat states */
slouken@0
    38
slouken@1895
    39
    int nballs;                 /* Number of trackballs on the joystick */
slouken@1895
    40
    struct balldelta
slouken@1895
    41
    {
slouken@1895
    42
        int dx;
slouken@1895
    43
        int dy;
slouken@1895
    44
    } *balls;                   /* Current ball motion deltas */
slouken@0
    45
slouken@1895
    46
    int nbuttons;               /* Number of buttons on the joystick */
slouken@1895
    47
    Uint8 *buttons;             /* Current button states */
slouken@1895
    48
slouken@1895
    49
    struct joystick_hwdata *hwdata;     /* Driver dependent information */
slouken@1895
    50
slouken@1895
    51
    int ref_count;              /* Reference count for multiple opens */
slouken@0
    52
};
slouken@0
    53
slouken@0
    54
/* Function to scan the system for joysticks.
slouken@0
    55
 * Joystick 0 should be the system default joystick.
slouken@0
    56
 * This function should return the number of available joysticks, or -1
slouken@0
    57
 * on an unrecoverable fatal error.
slouken@0
    58
 */
slouken@0
    59
extern int SDL_SYS_JoystickInit(void);
slouken@0
    60
slouken@0
    61
/* Function to get the device-dependent name of a joystick */
slouken@0
    62
extern const char *SDL_SYS_JoystickName(int index);
slouken@0
    63
slouken@0
    64
/* Function to open a joystick for use.
slouken@0
    65
   The joystick to open is specified by the index field of the joystick.
slouken@0
    66
   This should fill the nbuttons and naxes fields of the joystick structure.
slouken@0
    67
   It returns 0, or -1 if there is an error.
slouken@0
    68
 */
slouken@1895
    69
extern int SDL_SYS_JoystickOpen(SDL_Joystick * joystick);
slouken@0
    70
slouken@0
    71
/* Function to update the state of a joystick - called as a device poll.
slouken@0
    72
 * This function shouldn't update the joystick structure directly,
slouken@0
    73
 * but instead should call SDL_PrivateJoystick*() to deliver events
slouken@0
    74
 * and update joystick device state.
slouken@0
    75
 */
slouken@1895
    76
extern void SDL_SYS_JoystickUpdate(SDL_Joystick * joystick);
slouken@0
    77
slouken@0
    78
/* Function to close a joystick after use */
slouken@1895
    79
extern void SDL_SYS_JoystickClose(SDL_Joystick * joystick);
slouken@0
    80
slouken@0
    81
/* Function to perform any system-specific joystick related cleanup */
slouken@0
    82
extern void SDL_SYS_JoystickQuit(void);
slouken@1978
    83
slouken@1895
    84
/* vi: set ts=4 sw=4 expandtab: */