src/joystick/SDL_sysjoystick.h
author Sam Lantinga
Tue, 07 Feb 2006 06:59:48 +0000
changeset 1336 3692456e7b0f
parent 1312 c9b51268668f
child 1402 d910939febfa
permissions -rw-r--r--
Use SDL_ prefixed versions of C library functions.
FIXME:
Change #include <stdlib.h> to #include "SDL_stdlib.h"
Change #include <string.h> to #include "SDL_string.h"
Make sure nothing else broke because of this...
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@1312
     3
    Copyright (C) 1997-2006 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@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@0
    28
struct _SDL_Joystick {
slouken@0
    29
	Uint8 index;		/* Device index */
slouken@0
    30
	const char *name;	/* Joystick name - system dependent */
slouken@0
    31
slouken@0
    32
	int naxes;		/* Number of axis controls on the joystick */
slouken@0
    33
	Sint16 *axes;		/* Current axis states */
slouken@0
    34
slouken@0
    35
	int nhats;		/* Number of hats on the joystick */
slouken@0
    36
	Uint8 *hats;		/* Current hat states */
slouken@0
    37
	
slouken@0
    38
	int nballs;		/* Number of trackballs on the joystick */
slouken@0
    39
	struct balldelta {
slouken@0
    40
		int dx;
slouken@0
    41
		int dy;
slouken@0
    42
	} *balls;		/* Current ball motion deltas */
slouken@0
    43
	
slouken@0
    44
	int nbuttons;		/* Number of buttons on the joystick */
slouken@0
    45
	Uint8 *buttons;		/* Current button states */
slouken@0
    46
	
slouken@0
    47
	struct joystick_hwdata *hwdata;	/* Driver dependent information */
slouken@0
    48
slouken@0
    49
	int ref_count;		/* Reference count for multiple opens */
slouken@0
    50
};
slouken@0
    51
slouken@0
    52
/* Function to scan the system for joysticks.
slouken@0
    53
 * Joystick 0 should be the system default joystick.
slouken@0
    54
 * This function should return the number of available joysticks, or -1
slouken@0
    55
 * on an unrecoverable fatal error.
slouken@0
    56
 */
slouken@0
    57
extern int SDL_SYS_JoystickInit(void);
slouken@0
    58
slouken@0
    59
/* Function to get the device-dependent name of a joystick */
slouken@0
    60
extern const char *SDL_SYS_JoystickName(int index);
slouken@0
    61
slouken@0
    62
/* Function to open a joystick for use.
slouken@0
    63
   The joystick to open is specified by the index field of the joystick.
slouken@0
    64
   This should fill the nbuttons and naxes fields of the joystick structure.
slouken@0
    65
   It returns 0, or -1 if there is an error.
slouken@0
    66
 */
slouken@0
    67
extern int SDL_SYS_JoystickOpen(SDL_Joystick *joystick);
slouken@0
    68
slouken@0
    69
/* Function to update the state of a joystick - called as a device poll.
slouken@0
    70
 * This function shouldn't update the joystick structure directly,
slouken@0
    71
 * but instead should call SDL_PrivateJoystick*() to deliver events
slouken@0
    72
 * and update joystick device state.
slouken@0
    73
 */
slouken@0
    74
extern void SDL_SYS_JoystickUpdate(SDL_Joystick *joystick);
slouken@0
    75
slouken@0
    76
/* Function to close a joystick after use */
slouken@0
    77
extern void SDL_SYS_JoystickClose(SDL_Joystick *joystick);
slouken@0
    78
slouken@0
    79
/* Function to perform any system-specific joystick related cleanup */
slouken@0
    80
extern void SDL_SYS_JoystickQuit(void);
slouken@0
    81