SDL
2.0
|
Go to the source code of this file.
Data Structures | |
struct | SDL_JoystickGUID |
Macros | |
#define | SDL_IPHONE_MAX_GFORCE 5.0 |
#define | SDL_JOYSTICK_AXIS_MAX 32767 |
#define | SDL_JOYSTICK_AXIS_MIN -32768 |
Typedefs | |
typedef struct _SDL_Joystick | SDL_Joystick |
typedef Sint32 | SDL_JoystickID |
Include file for SDL joystick event handling
The term "device_index" identifies currently plugged in joystick devices between 0 and SDL_NumJoysticks(), with the exact joystick behind a device_index changing as joysticks are plugged and unplugged.
The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted then it will get a new instance_id, instance_id's are monotonically increasing identifiers of a joystick plugged in.
The term JoystickGUID is a stable 128-bit identifier for a joystick device that does not change over time, it identifies class of the device (a X360 wired controller for example). This identifier is platform dependent.
In order to use these functions, SDL_Init() must have been called with the SDL_INIT_JOYSTICK flag. This causes SDL to scan the system for joysticks, and load appropriate drivers.
If you would like to receive joystick updates while the application is in the background, you should set the following hint before calling SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
Definition in file SDL_joystick.h.
#define SDL_HAT_CENTERED 0x00 |
Definition at line 386 of file SDL_joystick.h.
#define SDL_HAT_DOWN 0x04 |
Definition at line 389 of file SDL_joystick.h.
#define SDL_HAT_LEFT 0x08 |
Definition at line 390 of file SDL_joystick.h.
#define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN) |
Definition at line 394 of file SDL_joystick.h.
#define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP) |
Definition at line 393 of file SDL_joystick.h.
#define SDL_HAT_RIGHT 0x02 |
Definition at line 388 of file SDL_joystick.h.
#define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN) |
Definition at line 392 of file SDL_joystick.h.
#define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP) |
Definition at line 391 of file SDL_joystick.h.
#define SDL_HAT_UP 0x01 |
Definition at line 387 of file SDL_joystick.h.
#define SDL_IPHONE_MAX_GFORCE 5.0 |
Definition at line 111 of file SDL_joystick.h.
#define SDL_JOYSTICK_AXIS_MAX 32767 |
Definition at line 358 of file SDL_joystick.h.
#define SDL_JOYSTICK_AXIS_MIN -32768 |
Definition at line 359 of file SDL_joystick.h.
typedef struct _SDL_Joystick SDL_Joystick |
Definition at line 1 of file SDL_joystick.h.
typedef Sint32 SDL_JoystickID |
This is a unique ID for a joystick for the time it is connected to the system, and is never reused for the lifetime of the application. If the joystick is disconnected and reconnected, it will get a new ID.
The ID value starts at 0 and increments from there. The value -1 is an invalid ID.
Definition at line 81 of file SDL_joystick.h.
Enumerator | |
---|---|
SDL_JOYSTICK_POWER_UNKNOWN | |
SDL_JOYSTICK_POWER_EMPTY | |
SDL_JOYSTICK_POWER_LOW | |
SDL_JOYSTICK_POWER_MEDIUM | |
SDL_JOYSTICK_POWER_FULL | |
SDL_JOYSTICK_POWER_WIRED | |
SDL_JOYSTICK_POWER_MAX |
Definition at line 97 of file SDL_joystick.h.
enum SDL_JoystickType |
Definition at line 83 of file SDL_joystick.h.
int SDL_JoystickAttachVirtual | ( | SDL_JoystickType | type, |
int | naxes, | ||
int | nbuttons, | ||
int | nhats | ||
) |
Attaches a new virtual joystick. Returns the joystick's device index, or -1 if an error occurred.
void SDL_JoystickClose | ( | SDL_Joystick * | joystick | ) |
Close a joystick previously opened with SDL_JoystickOpen().
SDL_JoystickPowerLevel SDL_JoystickCurrentPowerLevel | ( | SDL_Joystick * | joystick | ) |
Return the battery level of this joystick
int SDL_JoystickDetachVirtual | ( | int | device_index | ) |
Detaches a virtual joystick Returns 0 on success, or -1 if an error occurred.
int SDL_JoystickEventState | ( | int | state | ) |
Enable/disable joystick event polling.
If joystick events are disabled, you must call SDL_JoystickUpdate() yourself and check the state of the joystick when you want joystick information.
The state can be one of SDL_QUERY, SDL_ENABLE or SDL_IGNORE.
SDL_Joystick* SDL_JoystickFromInstanceID | ( | SDL_JoystickID | instance_id | ) |
Return the SDL_Joystick associated with an instance id.
SDL_Joystick* SDL_JoystickFromPlayerIndex | ( | int | player_index | ) |
Return the SDL_Joystick associated with a player index.
SDL_bool SDL_JoystickGetAttached | ( | SDL_Joystick * | joystick | ) |
Returns SDL_TRUE if the joystick has been opened and currently connected, or SDL_FALSE if it has not.
Sint16 SDL_JoystickGetAxis | ( | SDL_Joystick * | joystick, |
int | axis | ||
) |
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.
SDL_bool SDL_JoystickGetAxisInitialState | ( | SDL_Joystick * | joystick, |
int | axis, | ||
Sint16 * | state | ||
) |
Get the initial 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.
int SDL_JoystickGetBall | ( | SDL_Joystick * | joystick, |
int | ball, | ||
int * | dx, | ||
int * | dy | ||
) |
Get the ball axis change since the last poll.
The ball indices start at index 0.
Uint8 SDL_JoystickGetButton | ( | SDL_Joystick * | joystick, |
int | button | ||
) |
Get the current state of a button on a joystick.
The button indices start at index 0.
SDL_JoystickGUID SDL_JoystickGetDeviceGUID | ( | int | device_index | ) |
Return the GUID for the joystick at this index This can be called before any joysticks are opened.
SDL_JoystickID SDL_JoystickGetDeviceInstanceID | ( | int | device_index | ) |
Get the instance ID of a joystick. This can be called before any joysticks are opened. If the index is out of range, this function will return -1.
int SDL_JoystickGetDevicePlayerIndex | ( | int | device_index | ) |
Get the player index of a joystick, or -1 if it's not available This can be called before any joysticks are opened.
Uint16 SDL_JoystickGetDeviceProduct | ( | int | device_index | ) |
Get the USB product ID of a joystick, if available. This can be called before any joysticks are opened. If the product ID isn't available this function returns 0.
Uint16 SDL_JoystickGetDeviceProductVersion | ( | int | device_index | ) |
Get the product version of a joystick, if available. This can be called before any joysticks are opened. If the product version isn't available this function returns 0.
SDL_JoystickType SDL_JoystickGetDeviceType | ( | int | device_index | ) |
Get the type of a joystick, if available. This can be called before any joysticks are opened.
Uint16 SDL_JoystickGetDeviceVendor | ( | int | device_index | ) |
Get the USB vendor ID of a joystick, if available. This can be called before any joysticks are opened. If the vendor ID isn't available this function returns 0.
SDL_JoystickGUID SDL_JoystickGetGUID | ( | SDL_Joystick * | joystick | ) |
Return the GUID for this opened joystick
SDL_JoystickGUID SDL_JoystickGetGUIDFromString | ( | const char * | pchGUID | ) |
Convert a string into a joystick guid
void SDL_JoystickGetGUIDString | ( | SDL_JoystickGUID | guid, |
char * | pszGUID, | ||
int | cbGUID | ||
) |
Return a string representation for this guid. pszGUID must point to at least 33 bytes (32 for the string plus a NULL terminator).
Uint8 SDL_JoystickGetHat | ( | SDL_Joystick * | joystick, |
int | hat | ||
) |
Get the current state of a POV hat on a joystick.
The hat indices start at index 0.
int SDL_JoystickGetPlayerIndex | ( | SDL_Joystick * | joystick | ) |
Get the player index of an opened joystick, or -1 if it's not available
For XInput controllers this returns the XInput user index.
Uint16 SDL_JoystickGetProduct | ( | SDL_Joystick * | joystick | ) |
Get the USB product ID of an opened joystick, if available. If the product ID isn't available this function returns 0.
Uint16 SDL_JoystickGetProductVersion | ( | SDL_Joystick * | joystick | ) |
Get the product version of an opened joystick, if available. If the product version isn't available this function returns 0.
const char* SDL_JoystickGetSerial | ( | SDL_Joystick * | joystick | ) |
Get the serial number of an opened joystick, if available.
Returns the serial number of the joystick, or NULL if it is not available.
SDL_JoystickType SDL_JoystickGetType | ( | SDL_Joystick * | joystick | ) |
Get the type of an opened joystick.
Uint16 SDL_JoystickGetVendor | ( | SDL_Joystick * | joystick | ) |
Get the USB vendor ID of an opened joystick, if available. If the vendor ID isn't available this function returns 0.
SDL_bool SDL_JoystickHasLED | ( | SDL_Joystick * | joystick | ) |
Return whether a joystick has an LED
joystick | The joystick to query |
SDL_JoystickID SDL_JoystickInstanceID | ( | SDL_Joystick * | joystick | ) |
Get the instance ID of an opened joystick or -1 if the joystick is invalid.
SDL_bool SDL_JoystickIsVirtual | ( | int | device_index | ) |
Indicates whether or not a virtual-joystick is at a given device index.
const char* SDL_JoystickName | ( | SDL_Joystick * | joystick | ) |
Return the name for this currently opened joystick. If no name can be found, this function returns NULL.
const char* SDL_JoystickNameForIndex | ( | int | device_index | ) |
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.
int SDL_JoystickNumAxes | ( | SDL_Joystick * | joystick | ) |
Get the number of general axis controls on a joystick.
int SDL_JoystickNumBalls | ( | 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.
int SDL_JoystickNumButtons | ( | SDL_Joystick * | joystick | ) |
Get the number of buttons on a joystick.
int SDL_JoystickNumHats | ( | SDL_Joystick * | joystick | ) |
Get the number of POV hats on a joystick.
SDL_Joystick* SDL_JoystickOpen | ( | int | device_index | ) |
Open a joystick for use. The index passed as an argument refers to the N'th joystick on the system. This index is not the value which will identify this joystick in future joystick events. The joystick's instance id (SDL_JoystickID) will be used there instead.
int SDL_JoystickRumble | ( | SDL_Joystick * | joystick, |
Uint16 | low_frequency_rumble, | ||
Uint16 | high_frequency_rumble, | ||
Uint32 | duration_ms | ||
) |
Start a rumble effect Each call to this function cancels any previous rumble effect, and calling it with 0 intensity stops any rumbling.
joystick | The joystick to vibrate |
low_frequency_rumble | The intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF |
high_frequency_rumble | The intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF |
duration_ms | The duration of the rumble effect, in milliseconds |
int SDL_JoystickRumbleTriggers | ( | SDL_Joystick * | joystick, |
Uint16 | left_rumble, | ||
Uint16 | right_rumble, | ||
Uint32 | duration_ms | ||
) |
Start a rumble effect in the joystick's triggers Each call to this function cancels any previous trigger rumble effect, and calling it with 0 intensity stops any rumbling.
joystick | The joystick to vibrate |
left_rumble | The intensity of the left trigger rumble motor, from 0 to 0xFFFF |
right_rumble | The intensity of the right trigger rumble motor, from 0 to 0xFFFF |
duration_ms | The duration of the rumble effect, in milliseconds |
int SDL_JoystickSetLED | ( | SDL_Joystick * | joystick, |
Uint8 | red, | ||
Uint8 | green, | ||
Uint8 | blue | ||
) |
Update a joystick's LED color.
joystick | The joystick to update |
red | The intensity of the red LED |
green | The intensity of the green LED |
blue | The intensity of the blue LED |
void SDL_JoystickSetPlayerIndex | ( | SDL_Joystick * | joystick, |
int | player_index | ||
) |
Set the player index of an opened joystick
int SDL_JoystickSetVirtualAxis | ( | SDL_Joystick * | joystick, |
int | axis, | ||
Sint16 | value | ||
) |
Set values on an opened, virtual-joystick's controls. Please note that values set here will not be applied until the next call to SDL_JoystickUpdate, which can either be called directly, or can be called indirectly through various other SDL APIS, including, but not limited to the following: SDL_PollEvent, SDL_PumpEvents, SDL_WaitEventTimeout, SDL_WaitEvent.
Returns 0 on success, -1 on error.
int SDL_JoystickSetVirtualButton | ( | SDL_Joystick * | joystick, |
int | button, | ||
Uint8 | value | ||
) |
int SDL_JoystickSetVirtualHat | ( | SDL_Joystick * | joystick, |
int | hat, | ||
Uint8 | value | ||
) |
void SDL_JoystickUpdate | ( | void | ) |
Update the current state of the open joysticks.
This is called automatically by the event loop if any joystick events are enabled.
void SDL_LockJoysticks | ( | void | ) |
Locking for multi-threaded access to the joystick API
If you are using the joystick API or handling events from multiple threads you should use these locking functions to protect access to the joysticks.
In particular, you are guaranteed that the joystick list won't change, so the API functions that take a joystick index will be valid, and joystick and game controller events will not be delivered.
int SDL_NumJoysticks | ( | void | ) |
Count the number of joysticks attached to the system right now
void SDL_UnlockJoysticks | ( | void | ) |