src/joystick/SDL_sysjoystick.h
author Sam Lantinga <slouken@libsdl.org>
Tue, 15 Dec 2009 08:11:06 +0000
changeset 3565 f43c8f688f77
parent 2859 99210400e8b9
child 3697 f7b03b6838cb
permissions -rw-r--r--
Fixed bug #906

Added better error reporting for OpenGL context creation failing.
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@2859
     3
    Copyright (C) 1997-2009 Sam Lantinga
slouken@0
     4
slouken@1336
     5
    This library is SDL_free software; you can redistribute it and/or
slouken@1312
     6
    modify it under the terms of the GNU Lesser General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@1312
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1312
    13
    Lesser General Public License for more details.
slouken@0
    14
slouken@1312
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1312
    16
    License along with this library; if not, write to the Free Software
slouken@1312
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@252
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@1402
    22
#include "SDL_config.h"
slouken@0
    23
slouken@0
    24
/* This is the system specific header for the SDL joystick API */
slouken@0
    25
slouken@0
    26
#include "SDL_joystick.h"
slouken@0
    27
slouken@0
    28
/* The SDL joystick structure */
slouken@1895
    29
struct _SDL_Joystick
slouken@1895
    30
{
slouken@1895
    31
    Uint8 index;                /* Device index */
slouken@1895
    32
    const 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@0
    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@1895
    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@0
    53
};
slouken@0
    54
slouken@0
    55
/* Function to scan the system for joysticks.
slouken@0
    56
 * Joystick 0 should be the system default joystick.
slouken@0
    57
 * This function should return the number of available joysticks, or -1
slouken@0
    58
 * on an unrecoverable fatal error.
slouken@0
    59
 */
slouken@0
    60
extern int SDL_SYS_JoystickInit(void);
slouken@0
    61
slouken@0
    62
/* Function to get the device-dependent name of a joystick */
slouken@0
    63
extern const char *SDL_SYS_JoystickName(int index);
slouken@0
    64
slouken@0
    65
/* Function to open a joystick for use.
slouken@0
    66
   The joystick to open is specified by the index field of the joystick.
slouken@0
    67
   This should fill the nbuttons and naxes fields of the joystick structure.
slouken@0
    68
   It returns 0, or -1 if there is an error.
slouken@0
    69
 */
slouken@1895
    70
extern int SDL_SYS_JoystickOpen(SDL_Joystick * joystick);
slouken@0
    71
slouken@0
    72
/* Function to update the state of a joystick - called as a device poll.
slouken@0
    73
 * This function shouldn't update the joystick structure directly,
slouken@0
    74
 * but instead should call SDL_PrivateJoystick*() to deliver events
slouken@0
    75
 * and update joystick device state.
slouken@0
    76
 */
slouken@1895
    77
extern void SDL_SYS_JoystickUpdate(SDL_Joystick * joystick);
slouken@0
    78
slouken@0
    79
/* Function to close a joystick after use */
slouken@1895
    80
extern void SDL_SYS_JoystickClose(SDL_Joystick * joystick);
slouken@0
    81
slouken@0
    82
/* Function to perform any system-specific joystick related cleanup */
slouken@0
    83
extern void SDL_SYS_JoystickQuit(void);
slouken@1978
    84
slouken@1895
    85
/* vi: set ts=4 sw=4 expandtab: */