Mercurial > sdl-ios-xcode

diff include/SDL_joystick.h @ 1662:782fd950bd46 SDL-1.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. WARNING: None of the video drivers have been updated for the new API yet! The API is still under design and very fluid. The code is now run through a consistent indent format: indent -i4 -nut -nsc -br -ce The headers are being converted to automatically generate doxygen documentation.
author Sam Lantinga <slouken@libsdl.org>
date Sun, 28 May 2006 13:04:16 +0000
parents c71e05b4dc2e
children 4da1ee79c9af
line wrap: on
line diff
--- a/include/SDL_joystick.h	Sun May 21 17:27:13 2006 +0000
+++ b/include/SDL_joystick.h	Sun May 28 13:04:16 2006 +0000
@@ -20,7 +20,11 @@
     slouken@libsdl.org
 */
 
-/* Include file for SDL joystick event handling */
+/**
+ * \file SDL_joystick.h
+ *
+ * Include file for SDL joystick event handling
+ */
 
 #ifndef _SDL_joystick_h
 #define _SDL_joystick_h
@@ -31,7 +35,9 @@
 #include "begin_code.h"
 /* Set up for C function definitions, even when using C++ */
 #ifdef __cplusplus
+/* *INDENT-OFF* */
 extern "C" {
+/* *INDENT-ON* */
 #endif
 
 /* In order to use these functions, SDL_Init() must have been called
@@ -48,14 +54,14 @@
 /*
  * Count the number of joysticks attached to the system
  */
-extern DECLSPEC int SDLCALL SDL_NumJoysticks(void);
+extern DECLSPEC int SDLCALL SDL_NumJoysticks (void);
 
 /*
  * Get the implementation dependent name of a joystick.
  * This can be called before any joysticks are opened.
  * If no name can be found, this function returns NULL.
  */
-extern DECLSPEC const char * SDLCALL SDL_JoystickName(int device_index);
+extern DECLSPEC const char *SDLCALL SDL_JoystickName (int device_index);
 
 /*
  * Open a joystick for use - the index passed as an argument refers to
@@ -64,46 +70,46 @@
  *
  * This function returns a joystick identifier, or NULL if an error occurred.
  */
-extern DECLSPEC SDL_Joystick * SDLCALL SDL_JoystickOpen(int device_index);
+extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen (int device_index);
 
 /*
  * Returns 1 if the joystick has been opened, or 0 if it has not.
  */
-extern DECLSPEC int SDLCALL SDL_JoystickOpened(int device_index);
+extern DECLSPEC int SDLCALL SDL_JoystickOpened (int device_index);
 
 /*
  * Get the device index of an opened joystick.
  */
-extern DECLSPEC int SDLCALL SDL_JoystickIndex(SDL_Joystick *joystick);
+extern DECLSPEC int SDLCALL SDL_JoystickIndex (SDL_Joystick * joystick);
 
 /*
  * Get the number of general axis controls on a joystick
  */
-extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick *joystick);
+extern DECLSPEC int SDLCALL SDL_JoystickNumAxes (SDL_Joystick * joystick);
 
 /*
  * Get the number of trackballs on a joystick
  * Joystick trackballs have only relative motion events associated
  * with them and their state cannot be polled.
  */
-extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick *joystick);
+extern DECLSPEC int SDLCALL SDL_JoystickNumBalls (SDL_Joystick * joystick);
 
 /*
  * Get the number of POV hats on a joystick
  */
-extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick *joystick);
+extern DECLSPEC int SDLCALL SDL_JoystickNumHats (SDL_Joystick * joystick);
 
 /*
  * Get the number of buttons on a joystick
  */
-extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick *joystick);
+extern DECLSPEC int SDLCALL SDL_JoystickNumButtons (SDL_Joystick * joystick);
 
 /*
  * Update the current state of the open joysticks.
  * This is called automatically by the event loop if any joystick
  * events are enabled.
  */
-extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
+extern DECLSPEC void SDLCALL SDL_JoystickUpdate (void);
 
 /*
  * Enable/disable joystick event polling.
@@ -112,14 +118,15 @@
  * information.
  * The state can be one of SDL_QUERY, SDL_ENABLE or SDL_IGNORE.
  */
-extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
+extern DECLSPEC int SDLCALL SDL_JoystickEventState (int state);
 
 /*
  * Get the current state of an axis control on a joystick
  * The state is a value ranging from -32768 to 32767.
  * The axis indices start at index 0.
  */
-extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick *joystick, int axis);
+extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis (SDL_Joystick * joystick,
+                                                    int axis);
 
 /*
  * Get the current state of a POV hat on a joystick
@@ -137,31 +144,38 @@
 /*
  * The hat indices start at index 0.
  */
-extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick *joystick, int hat);
+extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat (SDL_Joystick * joystick,
+                                                  int hat);
 
 /*
  * Get the ball axis change since the last poll
  * This returns 0, or -1 if you passed it invalid parameters.
  * The ball indices start at index 0.
  */
-extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick *joystick, int ball, int *dx, int *dy);
+extern DECLSPEC int SDLCALL SDL_JoystickGetBall (SDL_Joystick * joystick,
+                                                 int ball, int *dx, int *dy);
 
 /*
  * Get the current state of a button on a joystick
  * The button indices start at index 0.
  */
-extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick *joystick, int button);
+extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton (SDL_Joystick * joystick,
+                                                     int button);
 
 /*
  * Close a joystick previously opened with SDL_JoystickOpen()
  */
-extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick *joystick);
+extern DECLSPEC void SDLCALL SDL_JoystickClose (SDL_Joystick * joystick);
 
 
 /* Ends C function definitions when using C++ */
 #ifdef __cplusplus
+/* *INDENT-OFF* */
 }
+/* *INDENT-ON* */
 #endif
 #include "close_code.h"
 
 #endif /* _SDL_joystick_h */
+
+/* vi: set ts=4 sw=4 expandtab: */