SDL_joystick.c File Reference

#include "../SDL_internal.h"
#include "SDL.h"
#include "SDL_atomic.h"
#include "SDL_events.h"
#include "SDL_sysjoystick.h"
#include "SDL_hints.h"
#include "../events/SDL_events_c.h"
#include "../video/SDL_sysvideo.h"
#include "hidapi/SDL_hidapijoystick_c.h"
#include "controller_type.h"
#include "../core/windows/SDL_windows.h"
#include <tlhelp32.h>
#include "./virtual/SDL_virtualjoystick_c.h"

Include dependency graph for SDL_joystick.c:

Go to the source code of this file.

Functions
void	SDL_LockJoysticks (void)
void	SDL_UnlockJoysticks (void)
static int	SDL_FindFreePlayerIndex ()
static int	SDL_GetPlayerIndexForJoystickID (SDL_JoystickID instance_id)
static SDL_JoystickID	SDL_GetJoystickIDForPlayerIndex (int player_index)
static SDL_bool	SDL_SetJoystickIDForPlayerIndex (int player_index, SDL_JoystickID instance_id)
static void	SDL_JoystickAllowBackgroundEventsChanged (void *userdata, const char *name, const char *oldValue, const char *hint)
int	SDL_JoystickInit (void)
int	SDL_NumJoysticks (void)
SDL_JoystickID	SDL_GetNextJoystickInstanceID ()
SDL_bool	SDL_GetDriverAndJoystickIndex (int device_index, SDL_JoystickDriver **driver, int *driver_index)
const char *	SDL_JoystickNameForIndex (int device_index)
int	SDL_JoystickGetDevicePlayerIndex (int device_index)
static SDL_bool	SDL_JoystickAxesCenteredAtZero (SDL_Joystick *joystick)
SDL_Joystick *	SDL_JoystickOpen (int device_index)
int	SDL_JoystickAttachVirtual (SDL_JoystickType type, int naxes, int nbuttons, int nhats)
int	SDL_JoystickDetachVirtual (int device_index)
SDL_bool	SDL_JoystickIsVirtual (int device_index)
int	SDL_JoystickSetVirtualAxis (SDL_Joystick *joystick, int axis, Sint16 value)
int	SDL_JoystickSetVirtualButton (SDL_Joystick *joystick, int button, Uint8 value)
int	SDL_JoystickSetVirtualHat (SDL_Joystick *joystick, int hat, Uint8 value)
SDL_bool	SDL_PrivateJoystickValid (SDL_Joystick *joystick)
SDL_bool	SDL_PrivateJoystickGetAutoGamepadMapping (int device_index, SDL_GamepadMapping *out)
int	SDL_JoystickNumAxes (SDL_Joystick *joystick)
int	SDL_JoystickNumHats (SDL_Joystick *joystick)
int	SDL_JoystickNumBalls (SDL_Joystick *joystick)
int	SDL_JoystickNumButtons (SDL_Joystick *joystick)
Sint16	SDL_JoystickGetAxis (SDL_Joystick *joystick, int axis)
SDL_bool	SDL_JoystickGetAxisInitialState (SDL_Joystick *joystick, int axis, Sint16 *state)
Uint8	SDL_JoystickGetHat (SDL_Joystick *joystick, int hat)
int	SDL_JoystickGetBall (SDL_Joystick *joystick, int ball, int *dx, int *dy)
Uint8	SDL_JoystickGetButton (SDL_Joystick *joystick, int button)
SDL_bool	SDL_JoystickGetAttached (SDL_Joystick *joystick)
SDL_JoystickID	SDL_JoystickInstanceID (SDL_Joystick *joystick)
SDL_Joystick *	SDL_JoystickFromInstanceID (SDL_JoystickID instance_id)
SDL_Joystick *	SDL_JoystickFromPlayerIndex (int player_index)
const char *	SDL_JoystickName (SDL_Joystick *joystick)
int	SDL_JoystickGetPlayerIndex (SDL_Joystick *joystick)
void	SDL_JoystickSetPlayerIndex (SDL_Joystick *joystick, int player_index)
int	SDL_JoystickRumble (SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
int	SDL_JoystickRumbleTriggers (SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms)
SDL_bool	SDL_JoystickHasLED (SDL_Joystick *joystick)
int	SDL_JoystickSetLED (SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue)
void	SDL_JoystickClose (SDL_Joystick *joystick)
void	SDL_JoystickQuit (void)
static SDL_bool	SDL_PrivateJoystickShouldIgnoreEvent ()
void	SDL_PrivateJoystickAddTouchpad (SDL_Joystick *joystick, int nfingers)
void	SDL_PrivateJoystickAddSensor (SDL_Joystick *joystick, SDL_SensorType type)
void	SDL_PrivateJoystickAdded (SDL_JoystickID device_instance)
static void	UpdateEventsForDeviceRemoval (int device_index)
static void	SDL_PrivateJoystickForceRecentering (SDL_Joystick *joystick)
void	SDL_PrivateJoystickRemoved (SDL_JoystickID device_instance)
int	SDL_PrivateJoystickAxis (SDL_Joystick *joystick, Uint8 axis, Sint16 value)
int	SDL_PrivateJoystickHat (SDL_Joystick *joystick, Uint8 hat, Uint8 value)
int	SDL_PrivateJoystickBall (SDL_Joystick *joystick, Uint8 ball, Sint16 xrel, Sint16 yrel)
int	SDL_PrivateJoystickButton (SDL_Joystick *joystick, Uint8 button, Uint8 state)
void	SDL_JoystickUpdate (void)
int	SDL_JoystickEventState (int state)
void	SDL_GetJoystickGUIDInfo (SDL_JoystickGUID guid, Uint16 *vendor, Uint16 *product, Uint16 *version)
static int	PrefixMatch (const char *a, const char *b)
char *	SDL_CreateJoystickName (Uint16 vendor, Uint16 product, const char *vendor_name, const char *product_name)
SDL_GameControllerType	SDL_GetJoystickGameControllerTypeFromVIDPID (Uint16 vendor, Uint16 product)
SDL_GameControllerType	SDL_GetJoystickGameControllerTypeFromGUID (SDL_JoystickGUID guid, const char *name)
SDL_GameControllerType	SDL_GetJoystickGameControllerType (const char *name, Uint16 vendor, Uint16 product, int interface_number, int interface_class, int interface_subclass, int interface_protocol)
SDL_bool	SDL_IsJoystickXboxOneElite (Uint16 vendor_id, Uint16 product_id)
SDL_bool	SDL_IsJoystickXboxOneSeriesX (Uint16 vendor_id, Uint16 product_id)
SDL_bool	SDL_IsJoystickPS4 (Uint16 vendor_id, Uint16 product_id)
SDL_bool	SDL_IsJoystickPS5 (Uint16 vendor_id, Uint16 product_id)
SDL_bool	SDL_IsJoystickNintendoSwitchPro (Uint16 vendor_id, Uint16 product_id)
SDL_bool	SDL_IsJoystickNintendoSwitchProInputOnly (Uint16 vendor_id, Uint16 product_id)
SDL_bool	SDL_IsJoystickSteamController (Uint16 vendor_id, Uint16 product_id)
SDL_bool	SDL_IsJoystickXInput (SDL_JoystickGUID guid)
SDL_bool	SDL_IsJoystickWGI (SDL_JoystickGUID guid)
SDL_bool	SDL_IsJoystickHIDAPI (SDL_JoystickGUID guid)
SDL_bool	SDL_IsJoystickRAWINPUT (SDL_JoystickGUID guid)
SDL_bool	SDL_IsJoystickVirtual (SDL_JoystickGUID guid)
static SDL_bool	SDL_IsJoystickProductWheel (Uint32 vidpid)
static SDL_bool	SDL_IsJoystickProductFlightStick (Uint32 vidpid)
static SDL_bool	SDL_IsJoystickProductThrottle (Uint32 vidpid)
static SDL_JoystickType	SDL_GetJoystickGUIDType (SDL_JoystickGUID guid)
static SDL_bool	SDL_IsPS4RemapperRunning (void)
SDL_bool	SDL_ShouldIgnoreJoystick (const char *name, SDL_JoystickGUID guid)
SDL_JoystickGUID	SDL_JoystickGetDeviceGUID (int device_index)
Uint16	SDL_JoystickGetDeviceVendor (int device_index)
Uint16	SDL_JoystickGetDeviceProduct (int device_index)
Uint16	SDL_JoystickGetDeviceProductVersion (int device_index)
SDL_JoystickType	SDL_JoystickGetDeviceType (int device_index)
SDL_JoystickID	SDL_JoystickGetDeviceInstanceID (int device_index)
int	SDL_JoystickGetDeviceIndexFromInstanceID (SDL_JoystickID instance_id)
SDL_JoystickGUID	SDL_JoystickGetGUID (SDL_Joystick *joystick)
Uint16	SDL_JoystickGetVendor (SDL_Joystick *joystick)
Uint16	SDL_JoystickGetProduct (SDL_Joystick *joystick)
Uint16	SDL_JoystickGetProductVersion (SDL_Joystick *joystick)
const char *	SDL_JoystickGetSerial (SDL_Joystick *joystick)
SDL_JoystickType	SDL_JoystickGetType (SDL_Joystick *joystick)
void	SDL_JoystickGetGUIDString (SDL_JoystickGUID guid, char *pszGUID, int cbGUID)
static unsigned char	nibble (char c)
SDL_JoystickGUID	SDL_JoystickGetGUIDFromString (const char *pchGUID)
void	SDL_PrivateJoystickBatteryLevel (SDL_Joystick *joystick, SDL_JoystickPowerLevel ePowerLevel)
SDL_JoystickPowerLevel	SDL_JoystickCurrentPowerLevel (SDL_Joystick *joystick)
int	SDL_PrivateJoystickTouchpad (SDL_Joystick *joystick, int touchpad, int finger, Uint8 state, float x, float y, float pressure)
int	SDL_PrivateJoystickSensor (SDL_Joystick *joystick, SDL_SensorType type, const float *data, int num_values)

Variables
static SDL_JoystickDriver *	SDL_joystick_drivers []
static SDL_bool	SDL_joystick_allows_background_events = SDL_FALSE
static SDL_Joystick *	SDL_joysticks = NULL
static SDL_bool	SDL_updating_joystick = SDL_FALSE
static SDL_mutex *	SDL_joystick_lock = NULL
static SDL_atomic_t	SDL_next_joystick_instance_id
static int	SDL_joystick_player_count = 0
static SDL_JoystickID *	SDL_joystick_players = NULL

Function Documentation

nibble()

static unsigned char nibble ( char  c )

static

Definition at line 2445 of file SDL_joystick.c.

{
    if ((c >= '0') && (c <= '9')) {
        return (unsigned char)(c - '0');
    }
 
    if ((c >= 'A') && (c <= 'F')) {
        return (unsigned char)(c - 'A' + 0x0a);
    }
 
    if ((c >= 'a') && (c <= 'f')) {
        return (unsigned char)(c - 'a' + 0x0a);
    }
 
    /* received an invalid character, and no real way to return an error */
    /* AssertMsg1(false, "Q_nibble invalid hex character '%c' ", c); */
    return 0;
}

Referenced by LAW_Decode(), and SDL_JoystickGetGUIDFromString().

PrefixMatch()

static int PrefixMatch ( const char *  a, const char *  b  )

static

Definition at line 1635 of file SDL_joystick.c.

{
    int matchlen = 0;
    while (*a && *b) {
        if (SDL_tolower(*a++) == SDL_tolower(*b++)) {
            ++matchlen;
        } else {
            break;
        }
    }
    return matchlen;
}

References SDL_tolower.

Referenced by SDL_CreateJoystickName().

SDL_CreateJoystickName()

char* SDL_CreateJoystickName	(	Uint16	vendor,
		Uint16	product,
		const char *	vendor_name,
		const char *	product_name
	)

Definition at line 1649 of file SDL_joystick.c.

{
    static struct {
        const char *prefix;
        const char *replacement;
    } replacements[] = {
        { "NVIDIA Corporation ", "" },
        { "Performance Designed Products", "PDP" },
        { "HORI CO.,LTD.", "HORI" },
        { "HORI CO.,LTD", "HORI" },
    };
    const char *custom_name;
    char *name;
    size_t i, len;
 
    custom_name = GuessControllerName(vendor, product);
    if (custom_name) {
        return SDL_strdup(custom_name);
    }
 
    if (!vendor_name) {
        vendor_name = "";
    }
    if (!product_name) {
        product_name = "";
    }
 
    while (*vendor_name == ' ') {
        ++vendor_name;
    }
    while (*product_name == ' ') {
        ++product_name;
    }
 
    if (*vendor_name && *product_name) {
        len = (SDL_strlen(vendor_name) + 1 + SDL_strlen(product_name) + 1);
        name = (char *)SDL_malloc(len);
        if (!name) {
            return NULL;
        }
        SDL_snprintf(name, len, "%s %s", vendor_name, product_name);
    } else if (*product_name) {
        name = SDL_strdup(product_name);
    } else if (vendor || product) {
        len = (6 + 1 + 6 + 1);
        name = (char *)SDL_malloc(len);
        if (!name) {
            return NULL;
        }
        SDL_snprintf(name, len, "0x%.4x/0x%.4x", vendor, product);
    } else {
        name = SDL_strdup("Controller");
    }
 
    /* Trim trailing whitespace */
    for (len = SDL_strlen(name); (len > 0 && name[len - 1] == ' '); --len) {
        /* continue */
    }
    name[len] = '\0';
 
    /* Compress duplicate spaces */
    for (i = 0; i < (len - 1); ) {
        if (name[i] == ' ' && name[i+1] == ' ') {
            SDL_memmove(&name[i], &name[i+1], (len - i));
            --len;
        } else {
            ++i;
        }
    }
 
    /* Remove duplicate manufacturer or product in the name */
    for (i = 1; i < (len - 1); ++i) {
        int matchlen = PrefixMatch(name, &name[i]);
        if (matchlen > 0 && name[matchlen-1] == ' ') {
            SDL_memmove(name, name+matchlen, len-matchlen+1);
            len -= matchlen;
            break;
        } else if (matchlen > 0 && name[matchlen] == ' ') {
            SDL_memmove(name, name+matchlen+1, len-matchlen);
            len -= (matchlen + 1);
            break;
        }
    }
 
    /* Perform any manufacturer replacements */
    for (i = 0; i < SDL_arraysize(replacements); ++i) {
        size_t prefixlen = SDL_strlen(replacements[i].prefix);
        if (SDL_strncasecmp(name, replacements[i].prefix, prefixlen) == 0) {
            size_t replacementlen = SDL_strlen(replacements[i].replacement);
            SDL_memcpy(name, replacements[i].replacement, replacementlen);
            SDL_memmove(name+replacementlen, name+prefixlen, (len-prefixlen+1));
            break;
        }
    }
 
    return name;
}

References GuessControllerName(), i, NULL, PrefixMatch(), SDL_arraysize, SDL_malloc, SDL_memcpy, SDL_memmove, SDL_snprintf, SDL_strdup, SDL_strlen, and SDL_strncasecmp.

SDL_FindFreePlayerIndex()

static int SDL_FindFreePlayerIndex ( )

static

Definition at line 118 of file SDL_joystick.c.

{
    int player_index;
 
    for (player_index = 0; player_index < SDL_joystick_player_count; ++player_index) {
        if (SDL_joystick_players[player_index] == -1) {
            return player_index;
        }
    }
    return player_index;
}

References SDL_joystick_player_count, and SDL_joystick_players.

Referenced by SDL_PrivateJoystickAdded(), and SDL_SetJoystickIDForPlayerIndex().

SDL_GetDriverAndJoystickIndex()

SDL_bool SDL_GetDriverAndJoystickIndex	(	int	device_index,
		SDL_JoystickDriver **	driver,
		int *	driver_index
	)

Definition at line 272 of file SDL_joystick.c.

{
    int i, num_joysticks, total_joysticks = 0;
 
    if (device_index >= 0) {
        for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
            num_joysticks = SDL_joystick_drivers[i]->GetCount();
            if (device_index < num_joysticks) {
                *driver = SDL_joystick_drivers[i];
                *driver_index = device_index;
                return SDL_TRUE;
            }
            device_index -= num_joysticks;
            total_joysticks += num_joysticks;
        }
    }
 
    SDL_SetError("There are %d joysticks available", total_joysticks);
    return SDL_FALSE;
}

References SDL_JoystickDriver::GetCount, i, SDL_arraysize, SDL_FALSE, SDL_joystick_drivers, SDL_SetError, and SDL_TRUE.

Referenced by SDL_JoystickDetachVirtual(), SDL_JoystickGetDeviceGUID(), SDL_JoystickGetDeviceInstanceID(), SDL_JoystickIsVirtual(), SDL_JoystickNameForIndex(), SDL_JoystickOpen(), SDL_PrivateJoystickAdded(), SDL_PrivateJoystickGetAutoGamepadMapping(), and SDL_SetJoystickIDForPlayerIndex().

SDL_GetJoystickGameControllerType()

SDL_GameControllerType SDL_GetJoystickGameControllerType	(	const char *	name,
		Uint16	vendor,
		Uint16	product,
		int	interface_number,
		int	interface_class,
		int	interface_subclass,
		int	interface_protocol
	)

Definition at line 1771 of file SDL_joystick.c.

{
    static const int LIBUSB_CLASS_VENDOR_SPEC = 0xFF;
    static const int XB360_IFACE_SUBCLASS = 93;
    static const int XB360_IFACE_PROTOCOL = 1; /* Wired */
    static const int XB360W_IFACE_PROTOCOL = 129; /* Wireless */
    static const int XBONE_IFACE_SUBCLASS = 71;
    static const int XBONE_IFACE_PROTOCOL = 208;
 
    SDL_GameControllerType type = SDL_CONTROLLER_TYPE_UNKNOWN;
 
    /* This code should match the checks in libusb/hid.c and HIDDeviceManager.java */
    if (interface_class == LIBUSB_CLASS_VENDOR_SPEC &&
        interface_subclass == XB360_IFACE_SUBCLASS &&
        (interface_protocol == XB360_IFACE_PROTOCOL ||
         interface_protocol == XB360W_IFACE_PROTOCOL)) {
 
        static const int SUPPORTED_VENDORS[] = {
            0x0079, /* GPD Win 2 */
            0x044f, /* Thrustmaster */
            0x045e, /* Microsoft */
            0x046d, /* Logitech */
            0x056e, /* Elecom */
            0x06a3, /* Saitek */
            0x0738, /* Mad Catz */
            0x07ff, /* Mad Catz */
            0x0e6f, /* PDP */
            0x0f0d, /* Hori */
            0x1038, /* SteelSeries */
            0x11c9, /* Nacon */
            0x12ab, /* Unknown */
            0x1430, /* RedOctane */
            0x146b, /* BigBen */
            0x1532, /* Razer Sabertooth */
            0x15e4, /* Numark */
            0x162e, /* Joytech */
            0x1689, /* Razer Onza */
            0x1bad, /* Harmonix */
            0x24c6, /* PowerA */
        };
 
        int i;
        for (i = 0; i < SDL_arraysize(SUPPORTED_VENDORS); ++i) {
            if (vendor == SUPPORTED_VENDORS[i]) {
                type = SDL_CONTROLLER_TYPE_XBOX360;
                break;
            }
        }
    }
 
    if (interface_number == 0 &&
        interface_class == LIBUSB_CLASS_VENDOR_SPEC &&
        interface_subclass == XBONE_IFACE_SUBCLASS &&
        interface_protocol == XBONE_IFACE_PROTOCOL) {
 
        static const int SUPPORTED_VENDORS[] = {
            0x045e, /* Microsoft */
            0x0738, /* Mad Catz */
            0x0e6f, /* PDP */
            0x0f0d, /* Hori */
            0x1532, /* Razer Wildcat */
            0x24c6, /* PowerA */
            0x2e24, /* Hyperkin */
        };
 
        int i;
        for (i = 0; i < SDL_arraysize(SUPPORTED_VENDORS); ++i) {
            if (vendor == SUPPORTED_VENDORS[i]) {
                type = SDL_CONTROLLER_TYPE_XBOXONE;
                break;
            }
        }
    }
 
    if (type == SDL_CONTROLLER_TYPE_UNKNOWN) {
        if (vendor == 0x0000 && product == 0x0000) {
            /* Some devices are only identifiable by their name */
            if (name &&
                (SDL_strcmp(name, "Lic Pro Controller") == 0 ||
                 SDL_strcmp(name, "Nintendo Wireless Gamepad") == 0 ||
                 SDL_strcmp(name, "Wireless Gamepad") == 0)) {
                /* HORI or PowerA Switch Pro Controller clone */
                type = SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_PRO;
            } else if (name && SDL_strcmp(name, "Virtual Joystick") == 0) {
                type = SDL_CONTROLLER_TYPE_VIRTUAL;
            } else {
                type = SDL_CONTROLLER_TYPE_UNKNOWN;
            }
 
        } else if (vendor == 0x0001 && product == 0x0001) {
            type = SDL_CONTROLLER_TYPE_UNKNOWN;
 
        } else {
            switch (GuessControllerType(vendor, product)) {
            case k_eControllerType_XBox360Controller:
                type = SDL_CONTROLLER_TYPE_XBOX360;
                break;
            case k_eControllerType_XBoxOneController:
                type = SDL_CONTROLLER_TYPE_XBOXONE;
                break;
            case k_eControllerType_PS3Controller:
                type = SDL_CONTROLLER_TYPE_PS3;
                break;
            case k_eControllerType_PS4Controller:
                type = SDL_CONTROLLER_TYPE_PS4;
                break;
            case k_eControllerType_PS5Controller:
                type = SDL_CONTROLLER_TYPE_PS5;
                break;
            case k_eControllerType_SwitchProController:
            case k_eControllerType_SwitchInputOnlyController:
                type = SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_PRO;
                break;
            default:
                type = SDL_CONTROLLER_TYPE_UNKNOWN;
                break;
            }
        }
    }
    return type;
}

References GuessControllerType(), i, k_eControllerType_PS3Controller, k_eControllerType_PS4Controller, k_eControllerType_PS5Controller, k_eControllerType_SwitchInputOnlyController, k_eControllerType_SwitchProController, k_eControllerType_XBox360Controller, k_eControllerType_XBoxOneController, SDL_arraysize, SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_PRO, SDL_CONTROLLER_TYPE_PS3, SDL_CONTROLLER_TYPE_PS4, SDL_CONTROLLER_TYPE_PS5, SDL_CONTROLLER_TYPE_UNKNOWN, SDL_CONTROLLER_TYPE_VIRTUAL, SDL_CONTROLLER_TYPE_XBOX360, SDL_CONTROLLER_TYPE_XBOXONE, and SDL_strcmp.

Referenced by SDL_GetJoystickGameControllerTypeFromGUID(), SDL_GetJoystickGameControllerTypeFromVIDPID(), and SDL_ShouldIgnoreJoystick().

SDL_GetJoystickGameControllerTypeFromGUID()

SDL_GameControllerType SDL_GetJoystickGameControllerTypeFromGUID	(	SDL_JoystickGUID	guid,
		const char *	name
	)

Definition at line 1754 of file SDL_joystick.c.

{
    SDL_GameControllerType type;
    Uint16 vendor, product;
 
    SDL_GetJoystickGUIDInfo(guid, &vendor, &product, NULL);
    type = SDL_GetJoystickGameControllerType(name, vendor, product, -1, 0, 0, 0);
    if (type == SDL_CONTROLLER_TYPE_UNKNOWN) {
        if (SDL_IsJoystickXInput(guid)) {
            /* This is probably an Xbox One controller */
            return SDL_CONTROLLER_TYPE_XBOXONE;
        }
    }
    return type;
}

References NULL, SDL_CONTROLLER_TYPE_UNKNOWN, SDL_CONTROLLER_TYPE_XBOXONE, SDL_GetJoystickGameControllerType(), SDL_GetJoystickGUIDInfo(), and SDL_IsJoystickXInput().

Referenced by SDL_CreateMappingForHIDAPIController(), SDL_GameControllerGetType(), and SDL_GameControllerTypeForIndex().

SDL_GetJoystickGameControllerTypeFromVIDPID()

SDL_GameControllerType SDL_GetJoystickGameControllerTypeFromVIDPID	(	Uint16	vendor,
		Uint16	product
	)

Definition at line 1748 of file SDL_joystick.c.

{
    return SDL_GetJoystickGameControllerType(NULL, vendor, product, -1, 0, 0, 0);
}

References NULL, and SDL_GetJoystickGameControllerType().

SDL_GetJoystickGUIDInfo()

void SDL_GetJoystickGUIDInfo	(	SDL_JoystickGUID	guid,
		Uint16 *	vendor,
		Uint16 *	product,
		Uint16 *	version
	)

Definition at line 1599 of file SDL_joystick.c.

{
    Uint16 *guid16 = (Uint16 *)guid.data;
 
    /* If the GUID fits the form of BUS 0000 VENDOR 0000 PRODUCT 0000, return the data */
    if (/* guid16[0] is device bus type */
        guid16[1] == 0x0000 &&
        /* guid16[2] is vendor ID */
        guid16[3] == 0x0000 &&
        /* guid16[4] is product ID */
        guid16[5] == 0x0000
        /* guid16[6] is product version */
   ) {
        if (vendor) {
            *vendor = guid16[2];
        }
        if (product) {
            *product = guid16[4];
        }
        if (version) {
            *version = guid16[6];
        }
    } else {
        if (vendor) {
            *vendor = 0;
        }
        if (product) {
            *product = 0;
        }
        if (version) {
            *version = 0;
        }
    }
}

References SDL_JoystickGUID::data, and if.

Referenced by SDL_CreateMappingForHIDAPIController(), SDL_GetJoystickGameControllerTypeFromGUID(), SDL_GetJoystickGUIDType(), SDL_JoystickGetDeviceProduct(), SDL_JoystickGetDeviceProductVersion(), SDL_JoystickGetDeviceVendor(), SDL_JoystickGetProduct(), SDL_JoystickGetProductVersion(), SDL_JoystickGetVendor(), SDL_ShouldIgnoreGameController(), and SDL_ShouldIgnoreJoystick().

SDL_GetJoystickGUIDType()

static SDL_JoystickType SDL_GetJoystickGUIDType ( SDL_JoystickGUID  guid )

static

Definition at line 2045 of file SDL_joystick.c.

{
    Uint16 vendor;
    Uint16 product;
    Uint32 vidpid;
 
    if (SDL_IsJoystickXInput(guid)) {
        /* XInput GUID, get the type based on the XInput device subtype */
        switch (guid.data[15]) {
        case 0x01:  /* XINPUT_DEVSUBTYPE_GAMEPAD */
            return SDL_JOYSTICK_TYPE_GAMECONTROLLER;
        case 0x02:  /* XINPUT_DEVSUBTYPE_WHEEL */
            return SDL_JOYSTICK_TYPE_WHEEL;
        case 0x03:  /* XINPUT_DEVSUBTYPE_ARCADE_STICK */
            return SDL_JOYSTICK_TYPE_ARCADE_STICK;
        case 0x04:  /* XINPUT_DEVSUBTYPE_FLIGHT_STICK */
            return SDL_JOYSTICK_TYPE_FLIGHT_STICK;
        case 0x05:  /* XINPUT_DEVSUBTYPE_DANCE_PAD */
            return SDL_JOYSTICK_TYPE_DANCE_PAD;
        case 0x06:  /* XINPUT_DEVSUBTYPE_GUITAR */
        case 0x07:  /* XINPUT_DEVSUBTYPE_GUITAR_ALTERNATE */
        case 0x0B:  /* XINPUT_DEVSUBTYPE_GUITAR_BASS */
            return SDL_JOYSTICK_TYPE_GUITAR;
        case 0x08:  /* XINPUT_DEVSUBTYPE_DRUM_KIT */
            return SDL_JOYSTICK_TYPE_DRUM_KIT;
        case 0x13:  /* XINPUT_DEVSUBTYPE_ARCADE_PAD */
            return SDL_JOYSTICK_TYPE_ARCADE_PAD;
        default:
            return SDL_JOYSTICK_TYPE_UNKNOWN;
        }
    }
 
    if (SDL_IsJoystickWGI(guid)) {
        return (SDL_JoystickType)guid.data[15];
    }
 
    if (SDL_IsJoystickVirtual(guid)) {
        return (SDL_JoystickType)guid.data[15];
    }
 
    SDL_GetJoystickGUIDInfo(guid, &vendor, &product, NULL);
    vidpid = MAKE_VIDPID(vendor, product);
 
    if (SDL_IsJoystickProductWheel(vidpid)) {
        return SDL_JOYSTICK_TYPE_WHEEL;
    }
 
    if (SDL_IsJoystickProductFlightStick(vidpid)) {
        return SDL_JOYSTICK_TYPE_FLIGHT_STICK;
    }
 
    if (SDL_IsJoystickProductThrottle(vidpid)) {
        return SDL_JOYSTICK_TYPE_THROTTLE;
    }
 
    if (GuessControllerType(vendor, product) != k_eControllerType_UnknownNonSteamController) {
        return SDL_JOYSTICK_TYPE_GAMECONTROLLER;
    }
 
    return SDL_JOYSTICK_TYPE_UNKNOWN;
}

References SDL_JoystickGUID::data, GuessControllerType(), k_eControllerType_UnknownNonSteamController, MAKE_VIDPID, NULL, SDL_GetJoystickGUIDInfo(), SDL_IsJoystickProductFlightStick(), SDL_IsJoystickProductThrottle(), SDL_IsJoystickProductWheel(), SDL_IsJoystickVirtual(), SDL_IsJoystickWGI(), SDL_IsJoystickXInput(), SDL_JOYSTICK_TYPE_ARCADE_PAD, SDL_JOYSTICK_TYPE_ARCADE_STICK, SDL_JOYSTICK_TYPE_DANCE_PAD, SDL_JOYSTICK_TYPE_DRUM_KIT, SDL_JOYSTICK_TYPE_FLIGHT_STICK, SDL_JOYSTICK_TYPE_GAMECONTROLLER, SDL_JOYSTICK_TYPE_GUITAR, SDL_JOYSTICK_TYPE_THROTTLE, SDL_JOYSTICK_TYPE_UNKNOWN, and SDL_JOYSTICK_TYPE_WHEEL.

Referenced by SDL_JoystickGetDeviceType(), and SDL_JoystickGetType().

SDL_GetJoystickIDForPlayerIndex()

static SDL_JoystickID SDL_GetJoystickIDForPlayerIndex ( int  player_index )

static

Definition at line 147 of file SDL_joystick.c.

{
    if (player_index < 0 || player_index >= SDL_joystick_player_count) {
        return -1;
    }
    return SDL_joystick_players[player_index];
}

References SDL_joystick_player_count, and SDL_joystick_players.

Referenced by SDL_JoystickFromPlayerIndex(), and SDL_SetJoystickIDForPlayerIndex().

SDL_GetNextJoystickInstanceID()

SDL_JoystickID SDL_GetNextJoystickInstanceID

(

void

)

Definition at line 262 of file SDL_joystick.c.

{
    return SDL_AtomicIncRef(&SDL_next_joystick_instance_id);
}

References SDL_AtomicIncRef, and SDL_next_joystick_instance_id.

SDL_GetPlayerIndexForJoystickID()

static int SDL_GetPlayerIndexForJoystickID ( SDL_JoystickID  instance_id )

static

Definition at line 131 of file SDL_joystick.c.

{
    int player_index;
 
    for (player_index = 0; player_index < SDL_joystick_player_count; ++player_index) {
        if (instance_id == SDL_joystick_players[player_index]) {
            break;
        }
    }
    if (player_index == SDL_joystick_player_count) {
        player_index = -1;
    }
    return player_index;
}

References SDL_joystick_player_count, and SDL_joystick_players.

Referenced by SDL_JoystickGetDevicePlayerIndex(), SDL_JoystickGetPlayerIndex(), SDL_PrivateJoystickRemoved(), and SDL_SetJoystickIDForPlayerIndex().

SDL_IsJoystickHIDAPI()

SDL_bool SDL_IsJoystickHIDAPI

(

SDL_JoystickGUID

guid

)

Definition at line 1968 of file SDL_joystick.c.

{
    return (guid.data[14] == 'h') ? SDL_TRUE : SDL_FALSE;
}

References SDL_JoystickGUID::data, SDL_FALSE, and SDL_TRUE.

Referenced by SDL_PrivateGetControllerMappingForGUID().

SDL_IsJoystickNintendoSwitchPro()

SDL_bool SDL_IsJoystickNintendoSwitchPro	(	Uint16	vendor_id,
		Uint16	product_id
	)

Definition at line 1933 of file SDL_joystick.c.

{
    EControllerType eType = GuessControllerType(vendor_id, product_id);
    return (eType == k_eControllerType_SwitchProController ||
            eType == k_eControllerType_SwitchInputOnlyController);
}

References GuessControllerType(), k_eControllerType_SwitchInputOnlyController, and k_eControllerType_SwitchProController.

Referenced by SDL_CreateMappingForHIDAPIController().

SDL_IsJoystickNintendoSwitchProInputOnly()

SDL_bool SDL_IsJoystickNintendoSwitchProInputOnly	(	Uint16	vendor_id,
		Uint16	product_id
	)

Definition at line 1941 of file SDL_joystick.c.

{
    EControllerType eType = GuessControllerType(vendor_id, product_id);
    return (eType == k_eControllerType_SwitchInputOnlyController);
}

References GuessControllerType(), and k_eControllerType_SwitchInputOnlyController.

SDL_IsJoystickProductFlightStick()

static SDL_bool SDL_IsJoystickProductFlightStick ( Uint32  vidpid )

static

Definition at line 2013 of file SDL_joystick.c.

{
    static Uint32 flightstick_joysticks[] = {
        MAKE_VIDPID(0x044f, 0x0402),    /* HOTAS Warthog Joystick */
        MAKE_VIDPID(0x0738, 0x2221),    /* Saitek Pro Flight X-56 Rhino Stick */
    };
    int i;
 
    for (i = 0; i < SDL_arraysize(flightstick_joysticks); ++i) {
        if (vidpid == flightstick_joysticks[i]) {
            return SDL_TRUE;
        }
    }
    return SDL_FALSE;
}

References i, MAKE_VIDPID, SDL_arraysize, SDL_FALSE, and SDL_TRUE.

Referenced by SDL_GetJoystickGUIDType().

SDL_IsJoystickProductThrottle()

static SDL_bool SDL_IsJoystickProductThrottle ( Uint32  vidpid )

static

Definition at line 2029 of file SDL_joystick.c.

{
    static Uint32 throttle_joysticks[] = {
        MAKE_VIDPID(0x044f, 0x0404),    /* HOTAS Warthog Throttle */
        MAKE_VIDPID(0x0738, 0xa221),    /* Saitek Pro Flight X-56 Rhino Throttle */
    };
    int i;
 
    for (i = 0; i < SDL_arraysize(throttle_joysticks); ++i) {
        if (vidpid == throttle_joysticks[i]) {
            return SDL_TRUE;
        }
    }
    return SDL_FALSE;
}

References i, MAKE_VIDPID, SDL_arraysize, SDL_FALSE, and SDL_TRUE.

Referenced by SDL_GetJoystickGUIDType().

SDL_IsJoystickProductWheel()

static SDL_bool SDL_IsJoystickProductWheel ( Uint32  vidpid )

static

Definition at line 1985 of file SDL_joystick.c.

{
    static Uint32 wheel_joysticks[] = {
        MAKE_VIDPID(0x046d, 0xc294),    /* Logitech generic wheel */
        MAKE_VIDPID(0x046d, 0xc295),    /* Logitech Momo Force */
        MAKE_VIDPID(0x046d, 0xc298),    /* Logitech Driving Force Pro */
        MAKE_VIDPID(0x046d, 0xc299),    /* Logitech G25 */
        MAKE_VIDPID(0x046d, 0xc29a),    /* Logitech Driving Force GT */
        MAKE_VIDPID(0x046d, 0xc29b),    /* Logitech G27 */
        MAKE_VIDPID(0x046d, 0xc24f),    /* Logitech G29 */
        MAKE_VIDPID(0x046d, 0xc261),    /* Logitech G920 (initial mode) */
        MAKE_VIDPID(0x046d, 0xc262),    /* Logitech G920 (active mode) */
        MAKE_VIDPID(0x044f, 0xb65d),    /* Thrustmaster Wheel FFB */
        MAKE_VIDPID(0x044f, 0xb66d),    /* Thrustmaster Wheel FFB */
        MAKE_VIDPID(0x044f, 0xb677),    /* Thrustmaster T150 */
        MAKE_VIDPID(0x044f, 0xb664),    /* Thrustmaster TX (initial mode) */
        MAKE_VIDPID(0x044f, 0xb669),    /* Thrustmaster TX (active mode) */
    };
    int i;
 
    for (i = 0; i < SDL_arraysize(wheel_joysticks); ++i) {
        if (vidpid == wheel_joysticks[i]) {
            return SDL_TRUE;
        }
    }
    return SDL_FALSE;
}

References i, MAKE_VIDPID, SDL_arraysize, SDL_FALSE, and SDL_TRUE.

Referenced by SDL_GetJoystickGUIDType().

SDL_IsJoystickPS4()

SDL_bool SDL_IsJoystickPS4	(	Uint16	vendor_id,
		Uint16	product_id
	)

Definition at line 1919 of file SDL_joystick.c.

{
    EControllerType eType = GuessControllerType(vendor_id, product_id);
    return (eType == k_eControllerType_PS4Controller);
}

References GuessControllerType(), and k_eControllerType_PS4Controller.

SDL_IsJoystickPS5()

SDL_bool SDL_IsJoystickPS5	(	Uint16	vendor_id,
		Uint16	product_id
	)

Definition at line 1926 of file SDL_joystick.c.

{
    EControllerType eType = GuessControllerType(vendor_id, product_id);
    return (eType == k_eControllerType_PS5Controller);
}

References GuessControllerType(), and k_eControllerType_PS5Controller.

SDL_IsJoystickRAWINPUT()

SDL_bool SDL_IsJoystickRAWINPUT

(

SDL_JoystickGUID

guid

)

Definition at line 1974 of file SDL_joystick.c.

{
    return (guid.data[14] == 'r') ? SDL_TRUE : SDL_FALSE;
}

References SDL_JoystickGUID::data, SDL_FALSE, and SDL_TRUE.

Referenced by SDL_PrivateGetControllerMappingForGUID().

SDL_IsJoystickSteamController()

SDL_bool SDL_IsJoystickSteamController	(	Uint16	vendor_id,
		Uint16	product_id
	)

Definition at line 1948 of file SDL_joystick.c.

{
    EControllerType eType = GuessControllerType(vendor_id, product_id);
    return (eType == k_eControllerType_SteamController ||
            eType == k_eControllerType_SteamControllerV2);
}

References GuessControllerType(), k_eControllerType_SteamController, and k_eControllerType_SteamControllerV2.

Referenced by SDL_CreateMappingForHIDAPIController().

SDL_IsJoystickVirtual()

SDL_bool SDL_IsJoystickVirtual

(

SDL_JoystickGUID

guid

)

Definition at line 1980 of file SDL_joystick.c.

{
    return (guid.data[14] == 'v') ? SDL_TRUE : SDL_FALSE;
}

References SDL_JoystickGUID::data, SDL_FALSE, and SDL_TRUE.

Referenced by SDL_GetJoystickGUIDType().

SDL_IsJoystickWGI()

SDL_bool SDL_IsJoystickWGI

(

SDL_JoystickGUID

guid

)

Definition at line 1962 of file SDL_joystick.c.

{
    return (guid.data[14] == 'w') ? SDL_TRUE : SDL_FALSE;
}

References SDL_JoystickGUID::data, SDL_FALSE, and SDL_TRUE.

Referenced by SDL_GetJoystickGUIDType(), and SDL_PrivateGetControllerMappingForNameAndGUID().

SDL_IsJoystickXboxOneElite()

SDL_bool SDL_IsJoystickXboxOneElite	(	Uint16	vendor_id,
		Uint16	product_id
	)

Definition at line 1894 of file SDL_joystick.c.

{
    if (vendor_id == USB_VENDOR_MICROSOFT) {
        if (product_id == USB_PRODUCT_XBOX_ONE_ELITE_SERIES_1 ||
            product_id == USB_PRODUCT_XBOX_ONE_ELITE_SERIES_2 ||
            product_id == USB_PRODUCT_XBOX_ONE_ELITE_SERIES_2_BLUETOOTH) {
            return SDL_TRUE;
        }
    }
    return SDL_FALSE;
}

References SDL_FALSE, SDL_TRUE, USB_PRODUCT_XBOX_ONE_ELITE_SERIES_1, USB_PRODUCT_XBOX_ONE_ELITE_SERIES_2, USB_PRODUCT_XBOX_ONE_ELITE_SERIES_2_BLUETOOTH, and USB_VENDOR_MICROSOFT.

Referenced by SDL_CreateMappingForHIDAPIController().

SDL_IsJoystickXboxOneSeriesX()

SDL_bool SDL_IsJoystickXboxOneSeriesX	(	Uint16	vendor_id,
		Uint16	product_id
	)

Definition at line 1907 of file SDL_joystick.c.

{
    if (vendor_id == USB_VENDOR_MICROSOFT) {
        if (product_id == USB_PRODUCT_XBOX_ONE_SERIES_X ||
            product_id == USB_PRODUCT_XBOX_ONE_SERIES_X_BLUETOOTH) {
            return SDL_TRUE;
        }
    }
    return SDL_FALSE;
}

References SDL_FALSE, SDL_TRUE, USB_PRODUCT_XBOX_ONE_SERIES_X, USB_PRODUCT_XBOX_ONE_SERIES_X_BLUETOOTH, and USB_VENDOR_MICROSOFT.

Referenced by SDL_CreateMappingForHIDAPIController().

SDL_IsJoystickXInput()

SDL_bool SDL_IsJoystickXInput

(

SDL_JoystickGUID

guid

)

Definition at line 1956 of file SDL_joystick.c.

{
    return (guid.data[14] == 'x') ? SDL_TRUE : SDL_FALSE;
}

References SDL_JoystickGUID::data, SDL_FALSE, and SDL_TRUE.

Referenced by SDL_GetJoystickGameControllerTypeFromGUID(), SDL_GetJoystickGUIDType(), and SDL_PrivateGetControllerMappingForGUID().

SDL_IsPS4RemapperRunning()

static SDL_bool SDL_IsPS4RemapperRunning ( void  )

static

Definition at line 2107 of file SDL_joystick.c.

{
#ifdef __WIN32__
    const char *mapper_processes[] = {
        "DS4Windows.exe",
        "InputMapper.exe",
    };
    int i;
    PROCESSENTRY32 pe32;
    SDL_bool found = SDL_FALSE;
 
    /* Take a snapshot of all processes in the system */
    HANDLE hProcessSnap = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);
    if (hProcessSnap != INVALID_HANDLE_VALUE) {
        pe32.dwSize = sizeof(PROCESSENTRY32);
        if (Process32First(hProcessSnap, &pe32)) {
            do
            {
                for (i = 0; i < SDL_arraysize(mapper_processes); ++i) {
                    if (SDL_strcasecmp(pe32.szExeFile, mapper_processes[i]) == 0) {
                        found = SDL_TRUE;
                    }
                }
            } while (Process32Next(hProcessSnap, &pe32) && !found);
        }
        CloseHandle(hProcessSnap);
    }
    return found;
#else
    return SDL_FALSE;
#endif
}

References i, SDL_arraysize, SDL_FALSE, SDL_strcasecmp, and SDL_TRUE.

Referenced by SDL_ShouldIgnoreJoystick().

SDL_JoystickAllowBackgroundEventsChanged()

static void SDL_JoystickAllowBackgroundEventsChanged ( void *  userdata, const char *  name, const char *  oldValue, const char *  hint  )

static

Definition at line 203 of file SDL_joystick.c.

{
    if (hint && *hint == '1') {
        SDL_joystick_allows_background_events = SDL_TRUE;
    } else {
        SDL_joystick_allows_background_events = SDL_FALSE;
    }
}

References SDL_FALSE, SDL_joystick_allows_background_events, and SDL_TRUE.

Referenced by SDL_JoystickInit(), and SDL_JoystickQuit().

SDL_JoystickAttachVirtual()

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.

Definition at line 471 of file SDL_joystick.c.

{
#if SDL_JOYSTICK_VIRTUAL
    return SDL_JoystickAttachVirtualInner(type, naxes, nbuttons, nhats);
#else
    return SDL_SetError("SDL not built with virtual-joystick support");
#endif
}

References SDL_SetError.

SDL_JoystickAxesCenteredAtZero()

static SDL_bool SDL_JoystickAxesCenteredAtZero ( SDL_Joystick *  joystick )

static

Definition at line 333 of file SDL_joystick.c.

{
    static Uint32 zero_centered_joysticks[] = {
        MAKE_VIDPID(0x0e8f, 0x3013),    /* HuiJia SNES USB adapter */
        MAKE_VIDPID(0x05a0, 0x3232),    /* 8Bitdo Zero Gamepad */
    };
 
    int i;
    Uint32 id = MAKE_VIDPID(SDL_JoystickGetVendor(joystick),
                            SDL_JoystickGetProduct(joystick));
 
/*printf("JOYSTICK '%s' VID/PID 0x%.4x/0x%.4x AXES: %d\n", joystick->name, vendor, product, joystick->naxes);*/
 
    if (joystick->naxes == 2) {
        /* Assume D-pad or thumbstick style axes are centered at 0 */
        return SDL_TRUE;
    }
 
    for (i = 0; i < SDL_arraysize(zero_centered_joysticks); ++i) {
        if (id == zero_centered_joysticks[i]) {
            return SDL_TRUE;
        }
    }
    return SDL_FALSE;
}

References i, joystick, MAKE_VIDPID, SDL_arraysize, SDL_FALSE, SDL_JoystickGetProduct(), SDL_JoystickGetVendor(), and SDL_TRUE.

Referenced by SDL_JoystickOpen().

SDL_JoystickClose()

void SDL_JoystickClose

(

SDL_Joystick *

joystick

)

Close a joystick previously opened with SDL_JoystickOpen().

Definition at line 976 of file SDL_joystick.c.

{
    SDL_Joystick *joysticklist;
    SDL_Joystick *joysticklistprev;
    int i;
 
    if (!SDL_PrivateJoystickValid(joystick)) {
        return;
    }
 
    SDL_LockJoysticks();
 
    /* First decrement ref count */
    if (--joystick->ref_count > 0) {
        SDL_UnlockJoysticks();
        return;
    }
 
    if (SDL_updating_joystick) {
        SDL_UnlockJoysticks();
        return;
    }
 
    if (joystick->rumble_expiration) {
        SDL_JoystickRumble(joystick, 0, 0, 0);
    }
    if (joystick->trigger_rumble_expiration) {
        SDL_JoystickRumbleTriggers(joystick, 0, 0, 0);
    }
 
    joystick->driver->Close(joystick);
    joystick->hwdata = NULL;
 
    joysticklist = SDL_joysticks;
    joysticklistprev = NULL;
    while (joysticklist) {
        if (joystick == joysticklist) {
            if (joysticklistprev) {
                /* unlink this entry */
                joysticklistprev->next = joysticklist->next;
            } else {
                SDL_joysticks = joystick->next;
            }
            break;
        }
        joysticklistprev = joysticklist;
        joysticklist = joysticklist->next;
    }
 
    SDL_free(joystick->name);
    SDL_free(joystick->serial);
 
    /* Free the data associated with this joystick */
    SDL_free(joystick->axes);
    SDL_free(joystick->hats);
    SDL_free(joystick->balls);
    SDL_free(joystick->buttons);
    for (i = 0; i < joystick->ntouchpads; i++) {
        SDL_JoystickTouchpadInfo *touchpad = &joystick->touchpads[i];
        SDL_free(touchpad->fingers);
    }
    SDL_free(joystick->touchpads);
    SDL_free(joystick->sensors);
    SDL_free(joystick);
 
    SDL_UnlockJoysticks();
}

References SDL_JoystickTouchpadInfo::fingers, i, joystick, NULL, SDL_free, SDL_JoystickRumble(), SDL_JoystickRumbleTriggers(), SDL_joysticks, SDL_LockJoysticks(), SDL_PrivateJoystickValid(), SDL_UnlockJoysticks(), and SDL_updating_joystick.

Referenced by SDL_JoystickOpen(), SDL_JoystickQuit(), and SDL_JoystickUpdate().

SDL_JoystickCurrentPowerLevel()

SDL_JoystickPowerLevel SDL_JoystickCurrentPowerLevel

(

SDL_Joystick *

joystick

)

Return the battery level of this joystick

Definition at line 2493 of file SDL_joystick.c.

{
    if (!SDL_PrivateJoystickValid(joystick)) {
        return SDL_JOYSTICK_POWER_UNKNOWN;
    }
    return joystick->epowerlevel;
}

References joystick, SDL_JOYSTICK_POWER_UNKNOWN, and SDL_PrivateJoystickValid().

SDL_JoystickDetachVirtual()

int SDL_JoystickDetachVirtual

(

int

device_index

)

Detaches a virtual joystick Returns 0 on success, or -1 if an error occurred.

Definition at line 482 of file SDL_joystick.c.

{
#if SDL_JOYSTICK_VIRTUAL
    SDL_JoystickDriver *driver;
 
    SDL_LockJoysticks();
    if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
        if (driver == &SDL_VIRTUAL_JoystickDriver) {
            const int result = SDL_JoystickDetachVirtualInner(device_index);
            SDL_UnlockJoysticks();
            return result;
        }
    }
    SDL_UnlockJoysticks();
 
    return SDL_SetError("Virtual joystick not found at provided index");
#else
    return SDL_SetError("SDL not built with virtual-joystick support");
#endif
}

References SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), SDL_SetError, SDL_UnlockJoysticks(), and SDL_VIRTUAL_JoystickDriver.

SDL_JoystickEventState()

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.

Definition at line 1568 of file SDL_joystick.c.

{
#if SDL_EVENTS_DISABLED
    return SDL_DISABLE;
#else
    const Uint32 event_list[] = {
        SDL_JOYAXISMOTION, SDL_JOYBALLMOTION, SDL_JOYHATMOTION,
        SDL_JOYBUTTONDOWN, SDL_JOYBUTTONUP, SDL_JOYDEVICEADDED, SDL_JOYDEVICEREMOVED
    };
    unsigned int i;
 
    switch (state) {
    case SDL_QUERY:
        state = SDL_DISABLE;
        for (i = 0; i < SDL_arraysize(event_list); ++i) {
            state = SDL_EventState(event_list[i], SDL_QUERY);
            if (state == SDL_ENABLE) {
                break;
            }
        }
        break;
    default:
        for (i = 0; i < SDL_arraysize(event_list); ++i) {
            SDL_EventState(event_list[i], state);
        }
        break;
    }
    return state;
#endif /* SDL_EVENTS_DISABLED */
}

References i, SDL_arraysize, SDL_DISABLE, SDL_ENABLE, SDL_EventState, SDL_JOYAXISMOTION, SDL_JOYBALLMOTION, SDL_JOYBUTTONDOWN, SDL_JOYBUTTONUP, SDL_JOYDEVICEADDED, SDL_JOYDEVICEREMOVED, SDL_JOYHATMOTION, SDL_QUERY, and state.

SDL_JoystickFromInstanceID()

SDL_Joystick* SDL_JoystickFromInstanceID

(

SDL_JoystickID

instance_id

)

Return the SDL_Joystick associated with an instance id.

Definition at line 774 of file SDL_joystick.c.

{
    SDL_Joystick *joystick;
 
    SDL_LockJoysticks();
    for (joystick = SDL_joysticks; joystick; joystick = joystick->next) {
        if (joystick->instance_id == instance_id) {
            break;
        }
    }
    SDL_UnlockJoysticks();
    return joystick;
}

References joystick, SDL_joysticks, SDL_LockJoysticks(), and SDL_UnlockJoysticks().

SDL_JoystickFromPlayerIndex()

SDL_Joystick* SDL_JoystickFromPlayerIndex

(

int

player_index

)

Return the SDL_Joystick associated with a player index.

Definition at line 792 of file SDL_joystick.c.

{
    SDL_JoystickID instance_id;
    SDL_Joystick *joystick;
 
    SDL_LockJoysticks();
    instance_id = SDL_GetJoystickIDForPlayerIndex(player_index);
    for (joystick = SDL_joysticks; joystick; joystick = joystick->next) {
        if (joystick->instance_id == instance_id) {
            break;
        }
    }
    SDL_UnlockJoysticks();
    return joystick;
}

References joystick, SDL_GetJoystickIDForPlayerIndex(), SDL_joysticks, SDL_LockJoysticks(), and SDL_UnlockJoysticks().

SDL_JoystickGetAttached()

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.

Definition at line 748 of file SDL_joystick.c.

{
    if (!SDL_PrivateJoystickValid(joystick)) {
        return SDL_FALSE;
    }
 
    return joystick->attached;
}

References joystick, SDL_FALSE, and SDL_PrivateJoystickValid().

SDL_JoystickGetAxis()

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.

Definition at line 640 of file SDL_joystick.c.

{
    Sint16 state;
 
    if (!SDL_PrivateJoystickValid(joystick)) {
        return 0;
    }
    if (axis < joystick->naxes) {
        state = joystick->axes[axis].value;
    } else {
        SDL_SetError("Joystick only has %d axes", joystick->naxes);
        state = 0;
    }
    return state;
}

References axis, joystick, SDL_PrivateJoystickValid(), SDL_SetError, and state.

SDL_JoystickGetAxisInitialState()

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.

Returns

SDL_TRUE if this axis has any initial value, or SDL_FALSE if not.

Definition at line 660 of file SDL_joystick.c.

{
    if (!SDL_PrivateJoystickValid(joystick)) {
        return SDL_FALSE;
    }
    if (axis >= joystick->naxes) {
        SDL_SetError("Joystick only has %d axes", joystick->naxes);
        return SDL_FALSE;
    }
    if (state) {
        *state = joystick->axes[axis].initial_value;
    }
    return joystick->axes[axis].has_initial_value;
}

References axis, joystick, SDL_FALSE, SDL_PrivateJoystickValid(), SDL_SetError, and state.

SDL_JoystickGetBall()

int SDL_JoystickGetBall	(	SDL_Joystick *	joystick,
		int	ball,
		int *	dx,
		int *	dy
	)

Get the ball axis change since the last poll.

Returns

0, or -1 if you passed it invalid parameters.

The ball indices start at index 0.

Definition at line 699 of file SDL_joystick.c.

{
    int retval;
 
    if (!SDL_PrivateJoystickValid(joystick)) {
        return -1;
    }
 
    retval = 0;
    if (ball < joystick->nballs) {
        if (dx) {
            *dx = joystick->balls[ball].dx;
        }
        if (dy) {
            *dy = joystick->balls[ball].dy;
        }
        joystick->balls[ball].dx = 0;
        joystick->balls[ball].dy = 0;
    } else {
        return SDL_SetError("Joystick only has %d balls", joystick->nballs);
    }
    return retval;
}

References joystick, retval, SDL_PrivateJoystickValid(), and SDL_SetError.

SDL_JoystickGetButton()

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.

Definition at line 727 of file SDL_joystick.c.

{
    Uint8 state;
 
    if (!SDL_PrivateJoystickValid(joystick)) {
        return 0;
    }
    if (button < joystick->nbuttons) {
        state = joystick->buttons[button];
    } else {
        SDL_SetError("Joystick only has %d buttons", joystick->nbuttons);
        state = 0;
    }
    return state;
}

References button, joystick, SDL_PrivateJoystickValid(), SDL_SetError, and state.

SDL_JoystickGetDeviceGUID()

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.

Definition at line 2272 of file SDL_joystick.c.

{
    SDL_JoystickDriver *driver;
    SDL_JoystickGUID guid;
 
    SDL_LockJoysticks();
    if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
        guid = driver->GetDeviceGUID(device_index);
    } else {
        SDL_zero(guid);
    }
    SDL_UnlockJoysticks();
 
    return guid;
}

References SDL_JoystickDriver::GetDeviceGUID, SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), SDL_UnlockJoysticks(), and SDL_zero.

Referenced by SDL_JoystickGetDeviceProduct(), SDL_JoystickGetDeviceProductVersion(), SDL_JoystickGetDeviceType(), and SDL_JoystickGetDeviceVendor().

SDL_JoystickGetDeviceIndexFromInstanceID()

int SDL_JoystickGetDeviceIndexFromInstanceID

(

SDL_JoystickID

instance_id

)

Definition at line 2343 of file SDL_joystick.c.

{
    int i, num_joysticks, device_index = -1;
 
    SDL_LockJoysticks();
    num_joysticks = SDL_NumJoysticks();
    for (i = 0; i < num_joysticks; ++i) {
        if (SDL_JoystickGetDeviceInstanceID(i) == instance_id) {
            device_index = i;
            break;
        }
    }
    SDL_UnlockJoysticks();
 
    return device_index;
}

References i, SDL_JoystickGetDeviceInstanceID(), SDL_LockJoysticks(), SDL_NumJoysticks(), and SDL_UnlockJoysticks().

Referenced by SDL_PrivateJoystickAdded(), and SDL_SetJoystickIDForPlayerIndex().

SDL_JoystickGetDeviceInstanceID()

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.

Definition at line 2329 of file SDL_joystick.c.

{
    SDL_JoystickDriver *driver;
    SDL_JoystickID instance_id = -1;
 
    SDL_LockJoysticks();
    if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
        instance_id = driver->GetDeviceInstanceID(device_index);
    }
    SDL_UnlockJoysticks();
 
    return instance_id;
}

References SDL_JoystickDriver::GetDeviceInstanceID, SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), and SDL_UnlockJoysticks().

Referenced by SDL_JoystickGetDeviceIndexFromInstanceID(), and SDL_JoystickGetDevicePlayerIndex().

SDL_JoystickGetDevicePlayerIndex()

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.

Definition at line 316 of file SDL_joystick.c.

{
    int player_index;
 
    SDL_LockJoysticks();
    player_index = SDL_GetPlayerIndexForJoystickID(SDL_JoystickGetDeviceInstanceID(device_index));
    SDL_UnlockJoysticks();
 
    return player_index;
}

References SDL_GetPlayerIndexForJoystickID(), SDL_JoystickGetDeviceInstanceID(), SDL_LockJoysticks(), and SDL_UnlockJoysticks().

SDL_JoystickGetDeviceProduct()

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.

Definition at line 2297 of file SDL_joystick.c.

{
    Uint16 product;
    SDL_JoystickGUID guid = SDL_JoystickGetDeviceGUID(device_index);
 
    SDL_GetJoystickGUIDInfo(guid, NULL, &product, NULL);
    return product;
}

References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetDeviceGUID().

SDL_JoystickGetDeviceProductVersion()

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.

Definition at line 2306 of file SDL_joystick.c.

{
    Uint16 version;
    SDL_JoystickGUID guid = SDL_JoystickGetDeviceGUID(device_index);
 
    SDL_GetJoystickGUIDInfo(guid, NULL, NULL, &version);
    return version;
}

References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetDeviceGUID().

SDL_JoystickGetDeviceType()

SDL_JoystickType SDL_JoystickGetDeviceType

(

int

device_index

)

Get the type of a joystick, if available. This can be called before any joysticks are opened.

Definition at line 2315 of file SDL_joystick.c.

{
    SDL_JoystickType type;
    SDL_JoystickGUID guid = SDL_JoystickGetDeviceGUID(device_index);
 
    type = SDL_GetJoystickGUIDType(guid);
    if (type == SDL_JOYSTICK_TYPE_UNKNOWN) {
        if (SDL_IsGameController(device_index)) {
            type = SDL_JOYSTICK_TYPE_GAMECONTROLLER;
        }
    }
    return type;
}

References SDL_GetJoystickGUIDType(), SDL_IsGameController, SDL_JOYSTICK_TYPE_GAMECONTROLLER, SDL_JOYSTICK_TYPE_UNKNOWN, and SDL_JoystickGetDeviceGUID().

SDL_JoystickGetDeviceVendor()

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.

Definition at line 2288 of file SDL_joystick.c.

{
    Uint16 vendor;
    SDL_JoystickGUID guid = SDL_JoystickGetDeviceGUID(device_index);
 
    SDL_GetJoystickGUIDInfo(guid, &vendor, NULL, NULL);
    return vendor;
}

References NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetDeviceGUID().

SDL_JoystickGetGUID()

SDL_JoystickGUID SDL_JoystickGetGUID

(

SDL_Joystick *

joystick

)

Return the GUID for this opened joystick

Definition at line 2360 of file SDL_joystick.c.

{
    if (!SDL_PrivateJoystickValid(joystick)) {
        SDL_JoystickGUID emptyGUID;
        SDL_zero(emptyGUID);
        return emptyGUID;
    }
    return joystick->guid;
}

References joystick, SDL_PrivateJoystickValid(), and SDL_zero.

Referenced by SDL_JoystickGetProduct(), SDL_JoystickGetProductVersion(), SDL_JoystickGetType(), and SDL_JoystickGetVendor().

SDL_JoystickGetGUIDFromString()

SDL_JoystickGUID SDL_JoystickGetGUIDFromString

(

const char *

pchGUID

)

Convert a string into a joystick guid

Definition at line 2465 of file SDL_joystick.c.

{
    SDL_JoystickGUID guid;
    int maxoutputbytes= sizeof(guid);
    size_t len = SDL_strlen(pchGUID);
    Uint8 *p;
    size_t i;
 
    /* Make sure it's even */
    len = (len) & ~0x1;
 
    SDL_memset(&guid, 0x00, sizeof(guid));
 
    p = (Uint8 *)&guid;
    for (i = 0; (i < len) && ((p - (Uint8 *)&guid) < maxoutputbytes); i+=2, p++) {
        *p = (nibble(pchGUID[i]) << 4) | nibble(pchGUID[i+1]);
    }
 
    return guid;
}

References i, nibble(), SDL_memset, and SDL_strlen.

SDL_JoystickGetGUIDString()

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).

Definition at line 2420 of file SDL_joystick.c.

{
    static const char k_rgchHexToASCII[] = "0123456789abcdef";
    int i;
 
    if ((pszGUID == NULL) || (cbGUID <= 0)) {
        return;
    }
 
    for (i = 0; i < sizeof(guid.data) && i < (cbGUID-1)/2; i++) {
        /* each input byte writes 2 ascii chars, and might write a null byte. */
        /* If we don't have room for next input byte, stop */
        unsigned char c = guid.data[i];
 
        *pszGUID++ = k_rgchHexToASCII[c >> 4];
        *pszGUID++ = k_rgchHexToASCII[c & 0x0F];
    }
    *pszGUID = '\0';
}

References SDL_JoystickGUID::data, i, and NULL.

SDL_JoystickGetHat()

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.

Returns

The return value is one of the following positions:

• SDL_HAT_CENTERED
• SDL_HAT_UP
• SDL_HAT_RIGHT
• SDL_HAT_DOWN
• SDL_HAT_LEFT
• SDL_HAT_RIGHTUP
• SDL_HAT_RIGHTDOWN
• SDL_HAT_LEFTUP
• SDL_HAT_LEFTDOWN

Definition at line 679 of file SDL_joystick.c.

{
    Uint8 state;
 
    if (!SDL_PrivateJoystickValid(joystick)) {
        return 0;
    }
    if (hat < joystick->nhats) {
        state = joystick->hats[hat];
    } else {
        SDL_SetError("Joystick only has %d hats", joystick->nhats);
        state = 0;
    }
    return state;
}

References joystick, SDL_PrivateJoystickValid(), SDL_SetError, and state.

SDL_JoystickGetPlayerIndex()

int SDL_JoystickGetPlayerIndex

(

SDL_Joystick *

joystick

)

Get the player index of an opened joystick, or -1 if it's not available

Definition at line 825 of file SDL_joystick.c.

{
    int player_index;
 
    if (!SDL_PrivateJoystickValid(joystick)) {
        return -1;
    }
 
    SDL_LockJoysticks();
    player_index = SDL_GetPlayerIndexForJoystickID(joystick->instance_id);
    SDL_UnlockJoysticks();
 
    return player_index;
}

References joystick, SDL_GetPlayerIndexForJoystickID(), SDL_LockJoysticks(), SDL_PrivateJoystickValid(), and SDL_UnlockJoysticks().

SDL_JoystickGetProduct()

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.

Definition at line 2379 of file SDL_joystick.c.

{
    Uint16 product;
    SDL_JoystickGUID guid = SDL_JoystickGetGUID(joystick);
 
    SDL_GetJoystickGUIDInfo(guid, NULL, &product, NULL);
    return product;
}

References joystick, NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetGUID().

Referenced by SDL_JoystickAxesCenteredAtZero().

SDL_JoystickGetProductVersion()

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.

Definition at line 2388 of file SDL_joystick.c.

{
    Uint16 version;
    SDL_JoystickGUID guid = SDL_JoystickGetGUID(joystick);
 
    SDL_GetJoystickGUIDInfo(guid, NULL, NULL, &version);
    return version;
}

References joystick, NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetGUID().

SDL_JoystickGetSerial()

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.

Definition at line 2397 of file SDL_joystick.c.

{
    if (!SDL_PrivateJoystickValid(joystick)) {
        return NULL;
    }
    return joystick->serial;
}

References joystick, NULL, and SDL_PrivateJoystickValid().

SDL_JoystickGetType()

SDL_JoystickType SDL_JoystickGetType

(

SDL_Joystick *

joystick

)

Get the type of an opened joystick.

Definition at line 2405 of file SDL_joystick.c.

{
    SDL_JoystickType type;
    SDL_JoystickGUID guid = SDL_JoystickGetGUID(joystick);
 
    type = SDL_GetJoystickGUIDType(guid);
    if (type == SDL_JOYSTICK_TYPE_UNKNOWN) {
        if (joystick && joystick->is_game_controller) {
            type = SDL_JOYSTICK_TYPE_GAMECONTROLLER;
        }
    }
    return type;
}

References joystick, SDL_GetJoystickGUIDType(), SDL_JOYSTICK_TYPE_GAMECONTROLLER, SDL_JOYSTICK_TYPE_UNKNOWN, and SDL_JoystickGetGUID().

SDL_JoystickGetVendor()

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.

Definition at line 2370 of file SDL_joystick.c.

{
    Uint16 vendor;
    SDL_JoystickGUID guid = SDL_JoystickGetGUID(joystick);
 
    SDL_GetJoystickGUIDInfo(guid, &vendor, NULL, NULL);
    return vendor;
}

References joystick, NULL, SDL_GetJoystickGUIDInfo(), and SDL_JoystickGetGUID().

Referenced by SDL_JoystickAxesCenteredAtZero().

SDL_JoystickHasLED()

SDL_bool SDL_JoystickHasLED

(

SDL_Joystick *

joystick

)

Return whether a joystick has an LED

Parameters

joystick

The joystick to query

Returns

SDL_TRUE, or SDL_FALSE if this joystick does not have a modifiable LED

Definition at line 925 of file SDL_joystick.c.

{
    SDL_bool result;
 
    if (!SDL_PrivateJoystickValid(joystick)) {
        return SDL_FALSE;
    }
 
    SDL_LockJoysticks();
 
    result = joystick->driver->HasLED(joystick);
 
    SDL_UnlockJoysticks();
 
    return result;
}

References joystick, SDL_FALSE, SDL_LockJoysticks(), SDL_PrivateJoystickValid(), and SDL_UnlockJoysticks().

SDL_JoystickInit()

int SDL_JoystickInit

(

void

)

Definition at line 213 of file SDL_joystick.c.

{
    int i, status;
 
    SDL_GameControllerInitMappings();
 
    /* Create the joystick list lock */
    if (!SDL_joystick_lock) {
        SDL_joystick_lock = SDL_CreateMutex();
    }
 
    /* See if we should allow joystick events while in the background */
    SDL_AddHintCallback(SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS,
                        SDL_JoystickAllowBackgroundEventsChanged, NULL);
 
#if !SDL_EVENTS_DISABLED
    if (SDL_InitSubSystem(SDL_INIT_EVENTS) < 0) {
        return -1;
    }
#endif /* !SDL_EVENTS_DISABLED */
 
    status = -1;
    for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
        if (SDL_joystick_drivers[i]->Init() >= 0) {
            status = 0;
        }
    }
    return status;
}

References i, NULL, SDL_AddHintCallback, SDL_arraysize, SDL_CreateMutex, SDL_GameControllerInitMappings(), SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS, SDL_INIT_EVENTS, SDL_InitSubSystem, SDL_joystick_drivers, SDL_joystick_lock, and SDL_JoystickAllowBackgroundEventsChanged().

Referenced by SDL_InitSubSystem().

SDL_JoystickInstanceID()

SDL_JoystickID SDL_JoystickInstanceID

(

SDL_Joystick *

joystick

)

Get the instance ID of an opened joystick or -1 if the joystick is invalid.

Definition at line 761 of file SDL_joystick.c.

{
    if (!SDL_PrivateJoystickValid(joystick)) {
        return -1;
    }
 
    return joystick->instance_id;
}

References joystick, and SDL_PrivateJoystickValid().

SDL_JoystickIsVirtual()

SDL_bool SDL_JoystickIsVirtual

(

int

device_index

)

Indicates whether or not a virtual-joystick is at a given device index.

Definition at line 504 of file SDL_joystick.c.

{
#if SDL_JOYSTICK_VIRTUAL
    SDL_JoystickDriver *driver;
    int driver_device_index;
    SDL_bool is_virtual = SDL_FALSE;
 
    SDL_LockJoysticks();
    if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &driver_device_index)) {
        if (driver == &SDL_VIRTUAL_JoystickDriver) {
            is_virtual = SDL_TRUE;
        }
    }
    SDL_UnlockJoysticks();
 
    return is_virtual;
#else
    return SDL_FALSE;
#endif
}

References SDL_FALSE, SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), SDL_TRUE, SDL_UnlockJoysticks(), and SDL_VIRTUAL_JoystickDriver.

SDL_JoystickName()

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.

Definition at line 812 of file SDL_joystick.c.

{
    if (!SDL_PrivateJoystickValid(joystick)) {
        return NULL;
    }
 
    return joystick->name;
}

References joystick, NULL, and SDL_PrivateJoystickValid().

SDL_JoystickNameForIndex()

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.

Definition at line 297 of file SDL_joystick.c.

{
    SDL_JoystickDriver *driver;
    const char *name = NULL;
 
    SDL_LockJoysticks();
    if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
        name = driver->GetDeviceName(device_index);
    }
    SDL_UnlockJoysticks();
 
    /* FIXME: Really we should reference count this name so it doesn't go away after unlock */
    return name;
}

References SDL_JoystickDriver::GetDeviceName, NULL, SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), and SDL_UnlockJoysticks().

SDL_JoystickNumAxes()

int SDL_JoystickNumAxes

(

SDL_Joystick *

joystick

)

Get the number of general axis controls on a joystick.

Definition at line 592 of file SDL_joystick.c.

{
    if (!SDL_PrivateJoystickValid(joystick)) {
        return -1;
    }
    return joystick->naxes;
}

References joystick, and SDL_PrivateJoystickValid().

SDL_JoystickNumBalls()

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.

Definition at line 616 of file SDL_joystick.c.

{
    if (!SDL_PrivateJoystickValid(joystick)) {
        return -1;
    }
    return joystick->nballs;
}

References joystick, and SDL_PrivateJoystickValid().

SDL_JoystickNumButtons()

int SDL_JoystickNumButtons

(

SDL_Joystick *

joystick

)

Get the number of buttons on a joystick.

Definition at line 628 of file SDL_joystick.c.

{
    if (!SDL_PrivateJoystickValid(joystick)) {
        return -1;
    }
    return joystick->nbuttons;
}

References joystick, and SDL_PrivateJoystickValid().

SDL_JoystickNumHats()

int SDL_JoystickNumHats

(

SDL_Joystick *

joystick

)

Get the number of POV hats on a joystick.

Definition at line 604 of file SDL_joystick.c.

{
    if (!SDL_PrivateJoystickValid(joystick)) {
        return -1;
    }
    return joystick->nhats;
}

References joystick, and SDL_PrivateJoystickValid().

SDL_JoystickOpen()

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.

Returns

A joystick identifier, or NULL if an error occurred.

Definition at line 367 of file SDL_joystick.c.

{
    SDL_JoystickDriver *driver;
    SDL_JoystickID instance_id;
    SDL_Joystick *joystick;
    SDL_Joystick *joysticklist;
    const char *joystickname = NULL;
 
    SDL_LockJoysticks();
 
    if (!SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
        SDL_UnlockJoysticks();
        return NULL;
    }
 
    joysticklist = SDL_joysticks;
    /* If the joystick is already open, return it
     * it is important that we have a single joystick * for each instance id
     */
    instance_id = driver->GetDeviceInstanceID(device_index);
    while (joysticklist) {
        if (instance_id == joysticklist->instance_id) {
                joystick = joysticklist;
                ++joystick->ref_count;
                SDL_UnlockJoysticks();
                return joystick;
        }
        joysticklist = joysticklist->next;
    }
 
    /* Create and initialize the joystick */
    joystick = (SDL_Joystick *) SDL_calloc(sizeof(*joystick), 1);
    if (joystick == NULL) {
        SDL_OutOfMemory();
        SDL_UnlockJoysticks();
        return NULL;
    }
    joystick->driver = driver;
    joystick->instance_id = instance_id;
    joystick->attached = SDL_TRUE;
    joystick->epowerlevel = SDL_JOYSTICK_POWER_UNKNOWN;
 
    if (driver->Open(joystick, device_index) < 0) {
        SDL_free(joystick);
        SDL_UnlockJoysticks();
        return NULL;
    }
 
    joystickname = driver->GetDeviceName(device_index);
    if (joystickname) {
        joystick->name = SDL_strdup(joystickname);
    } else {
        joystick->name = NULL;
    }
 
    joystick->guid = driver->GetDeviceGUID(device_index);
 
    if (joystick->naxes > 0) {
        joystick->axes = (SDL_JoystickAxisInfo *) SDL_calloc(joystick->naxes, sizeof(SDL_JoystickAxisInfo));
    }
    if (joystick->nhats > 0) {
        joystick->hats = (Uint8 *) SDL_calloc(joystick->nhats, sizeof(Uint8));
    }
    if (joystick->nballs > 0) {
        joystick->balls = (struct balldelta *) SDL_calloc(joystick->nballs, sizeof(*joystick->balls));
    }
    if (joystick->nbuttons > 0) {
        joystick->buttons = (Uint8 *) SDL_calloc(joystick->nbuttons, sizeof(Uint8));
    }
    if (((joystick->naxes > 0) && !joystick->axes)
        || ((joystick->nhats > 0) && !joystick->hats)
        || ((joystick->nballs > 0) && !joystick->balls)
        || ((joystick->nbuttons > 0) && !joystick->buttons)) {
        SDL_OutOfMemory();
        SDL_JoystickClose(joystick);
        SDL_UnlockJoysticks();
        return NULL;
    }
 
    /* If this joystick is known to have all zero centered axes, skip the auto-centering code */
    if (SDL_JoystickAxesCenteredAtZero(joystick)) {
        int i;
 
        for (i = 0; i < joystick->naxes; ++i) {
            joystick->axes[i].has_initial_value = SDL_TRUE;
        }
    }
 
    joystick->is_game_controller = SDL_IsGameController(device_index);
 
    /* Add joystick to list */
    ++joystick->ref_count;
    /* Link the joystick in the list */
    joystick->next = SDL_joysticks;
    SDL_joysticks = joystick;
 
    SDL_UnlockJoysticks();
 
    driver->Update(joystick);
 
    return joystick;
}

References SDL_JoystickDriver::GetDeviceGUID, SDL_JoystickDriver::GetDeviceInstanceID, SDL_JoystickDriver::GetDeviceName, i, joystick, NULL, SDL_JoystickDriver::Open, SDL_calloc, SDL_free, SDL_GetDriverAndJoystickIndex(), SDL_IsGameController, SDL_JOYSTICK_POWER_UNKNOWN, SDL_JoystickAxesCenteredAtZero(), SDL_JoystickClose(), SDL_joysticks, SDL_LockJoysticks(), SDL_OutOfMemory, SDL_strdup, SDL_TRUE, SDL_UnlockJoysticks(), and SDL_JoystickDriver::Update.

SDL_JoystickQuit()

void SDL_JoystickQuit

(

void

)

Definition at line 1045 of file SDL_joystick.c.

{
    int i;
 
    /* Make sure we're not getting called in the middle of updating joysticks */
    SDL_LockJoysticks();
    while (SDL_updating_joystick) {
        SDL_UnlockJoysticks();
        SDL_Delay(1);
        SDL_LockJoysticks();
    }
 
    /* Stop the event polling */
    while (SDL_joysticks) {
        SDL_joysticks->ref_count = 1;
        SDL_JoystickClose(SDL_joysticks);
    }
 
    /* Quit the joystick setup */
    for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
       SDL_joystick_drivers[i]->Quit();
    }
 
    if (SDL_joystick_players) {
        SDL_free(SDL_joystick_players);
        SDL_joystick_players = NULL;
        SDL_joystick_player_count = 0;
    }
    SDL_UnlockJoysticks();
 
#if !SDL_EVENTS_DISABLED
    SDL_QuitSubSystem(SDL_INIT_EVENTS);
#endif
 
    SDL_DelHintCallback(SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS,
                        SDL_JoystickAllowBackgroundEventsChanged, NULL);
 
    if (SDL_joystick_lock) {
        SDL_mutex *mutex = SDL_joystick_lock;
        SDL_joystick_lock = NULL;
        SDL_DestroyMutex(mutex);
    }
 
    SDL_GameControllerQuitMappings();
}

References i, mutex, NULL, SDL_JoystickDriver::Quit, SDL_arraysize, SDL_Delay, SDL_DelHintCallback, SDL_DestroyMutex, SDL_free, SDL_GameControllerQuitMappings(), SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS, SDL_INIT_EVENTS, SDL_joystick_drivers, SDL_joystick_lock, SDL_joystick_player_count, SDL_joystick_players, SDL_JoystickAllowBackgroundEventsChanged(), SDL_JoystickClose(), SDL_joysticks, SDL_LockJoysticks(), SDL_QuitSubSystem, SDL_UnlockJoysticks(), and SDL_updating_joystick.

Referenced by SDL_QuitSubSystem().

SDL_JoystickRumble()

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.

Parameters

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

Returns

0, or -1 if rumble isn't supported on this joystick

Definition at line 856 of file SDL_joystick.c.

{
    int result;
 
    if (!SDL_PrivateJoystickValid(joystick)) {
        return -1;
    }
 
    SDL_LockJoysticks();
    if (low_frequency_rumble == joystick->low_frequency_rumble &&
        high_frequency_rumble == joystick->high_frequency_rumble) {
        /* Just update the expiration */
        result = 0;
    } else {
        result = joystick->driver->Rumble(joystick, low_frequency_rumble, high_frequency_rumble);
    }
 
    /* Save the rumble value regardless of success, so we don't spam the driver */
    joystick->low_frequency_rumble = low_frequency_rumble;
    joystick->high_frequency_rumble = high_frequency_rumble;
 
    if ((low_frequency_rumble || high_frequency_rumble) && duration_ms) {
        joystick->rumble_expiration = SDL_GetTicks() + SDL_min(duration_ms, SDL_MAX_RUMBLE_DURATION_MS);
        if (!joystick->rumble_expiration) {
            joystick->rumble_expiration = 1;
        }
    } else {
        joystick->rumble_expiration = 0;
    }
    SDL_UnlockJoysticks();
 
    return result;
}

References joystick, SDL_GetTicks(), SDL_LockJoysticks(), SDL_MAX_RUMBLE_DURATION_MS, SDL_min, SDL_PrivateJoystickValid(), and SDL_UnlockJoysticks().

Referenced by SDL_JoystickClose(), and SDL_JoystickUpdate().

SDL_JoystickRumbleTriggers()

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.

Parameters

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

Returns

0, or -1 if trigger rumble isn't supported on this joystick

Definition at line 891 of file SDL_joystick.c.

{
    int result;
 
    if (!SDL_PrivateJoystickValid(joystick)) {
        return -1;
    }
 
    SDL_LockJoysticks();
    if (left_rumble == joystick->left_trigger_rumble && right_rumble == joystick->right_trigger_rumble) {
        /* Just update the expiration */
        result = 0;
    } else {
        result = joystick->driver->RumbleTriggers(joystick, left_rumble, right_rumble);
    }
 
    /* Save the rumble value regardless of success, so we don't spam the driver */
    joystick->left_trigger_rumble = left_rumble;
    joystick->right_trigger_rumble = right_rumble;
 
    if ((left_rumble || right_rumble) && duration_ms) {
        joystick->trigger_rumble_expiration = SDL_GetTicks() + SDL_min(duration_ms, SDL_MAX_RUMBLE_DURATION_MS);
        if (!joystick->trigger_rumble_expiration) {
            joystick->trigger_rumble_expiration = 1;
        }
    } else {
        joystick->trigger_rumble_expiration = 0;
    }
    SDL_UnlockJoysticks();
 
    return result;
}

References joystick, SDL_GetTicks(), SDL_LockJoysticks(), SDL_MAX_RUMBLE_DURATION_MS, SDL_min, SDL_PrivateJoystickValid(), and SDL_UnlockJoysticks().

Referenced by SDL_JoystickClose(), and SDL_JoystickUpdate().

SDL_JoystickSetLED()

int SDL_JoystickSetLED	(	SDL_Joystick *	joystick,
		Uint8	red,
		Uint8	green,
		Uint8	blue
	)

Update a joystick's LED color.

Parameters

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

Returns

0, or -1 if this joystick does not have a modifiable LED

Definition at line 943 of file SDL_joystick.c.

{
    int result;
 
    if (!SDL_PrivateJoystickValid(joystick)) {
        return -1;
    }
 
    SDL_LockJoysticks();
 
    if (red == joystick->led_red &&
        green == joystick->led_green &&
        blue == joystick->led_blue) {
        /* Avoid spamming the driver */
        result = 0;
    } else {
        result = joystick->driver->SetLED(joystick, red, green, blue);
    }
 
    /* Save the LED value regardless of success, so we don't spam the driver */
    joystick->led_red = red;
    joystick->led_green = green;
    joystick->led_blue = blue;
 
    SDL_UnlockJoysticks();
 
    return result;
}

References joystick, red, SDL_LockJoysticks(), SDL_PrivateJoystickValid(), and SDL_UnlockJoysticks().

SDL_JoystickSetPlayerIndex()

void SDL_JoystickSetPlayerIndex	(	SDL_Joystick *	joystick,
		int	player_index
	)

Set the player index of an opened joystick

Definition at line 844 of file SDL_joystick.c.

{
    if (!SDL_PrivateJoystickValid(joystick)) {
        return;
    }
 
    SDL_LockJoysticks();
    SDL_SetJoystickIDForPlayerIndex(player_index, joystick->instance_id);
    SDL_UnlockJoysticks();
}

References joystick, SDL_LockJoysticks(), SDL_PrivateJoystickValid(), SDL_SetJoystickIDForPlayerIndex(), and SDL_UnlockJoysticks().

SDL_JoystickSetVirtualAxis()

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.

Definition at line 526 of file SDL_joystick.c.

{
#if SDL_JOYSTICK_VIRTUAL
    return SDL_JoystickSetVirtualAxisInner(joystick, axis, value);
#else
    return SDL_SetError("SDL not built with virtual-joystick support");
#endif
}

References axis, joystick, and SDL_SetError.

SDL_JoystickSetVirtualButton()

int SDL_JoystickSetVirtualButton	(	SDL_Joystick *	joystick,
		int	button,
		Uint8	value
	)

Definition at line 536 of file SDL_joystick.c.

{
#if SDL_JOYSTICK_VIRTUAL
    return SDL_JoystickSetVirtualButtonInner(joystick, button, value);
#else
    return SDL_SetError("SDL not built with virtual-joystick support");
#endif
}

References button, joystick, and SDL_SetError.

SDL_JoystickSetVirtualHat()

int SDL_JoystickSetVirtualHat	(	SDL_Joystick *	joystick,
		int	hat,
		Uint8	value
	)

Definition at line 546 of file SDL_joystick.c.

{
#if SDL_JOYSTICK_VIRTUAL
    return SDL_JoystickSetVirtualHatInner(joystick, hat, value);
#else
    return SDL_SetError("SDL not built with virtual-joystick support");
#endif
}

References joystick, and SDL_SetError.

SDL_JoystickUpdate()

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.

Definition at line 1485 of file SDL_joystick.c.

{
    int i;
    SDL_Joystick *joystick, *next;
 
    if (!SDL_WasInit(SDL_INIT_JOYSTICK)) {
        return;
    }
 
    SDL_LockJoysticks();
 
    if (SDL_updating_joystick) {
        /* The joysticks are already being updated */
        SDL_UnlockJoysticks();
        return;
    }
 
    SDL_updating_joystick = SDL_TRUE;
 
    /* Make sure the list is unlocked while dispatching events to prevent application deadlocks */
    SDL_UnlockJoysticks();
 
#ifdef SDL_JOYSTICK_HIDAPI
    /* Special function for HIDAPI devices, as a single device can provide multiple SDL_Joysticks */
    HIDAPI_UpdateDevices();
#endif /* SDL_JOYSTICK_HIDAPI */
 
    for (joystick = SDL_joysticks; joystick; joystick = joystick->next) {
        if (joystick->attached) {
            /* This should always be true, but seeing a crash in the wild...? */
            if (joystick->driver) {
                joystick->driver->Update(joystick);
            }
 
            if (joystick->delayed_guide_button) {
                SDL_GameControllerHandleDelayedGuideButton(joystick);
            }
        }
 
        if (joystick->rumble_expiration) {
            SDL_LockJoysticks();
            /* Double check now that the lock is held */
            if (joystick->rumble_expiration &&
                SDL_TICKS_PASSED(SDL_GetTicks(), joystick->rumble_expiration)) {
                SDL_JoystickRumble(joystick, 0, 0, 0);
            }
            SDL_UnlockJoysticks();
        }
 
        if (joystick->trigger_rumble_expiration) {
            SDL_LockJoysticks();
            /* Double check now that the lock is held */
            if (joystick->trigger_rumble_expiration &&
                SDL_TICKS_PASSED(SDL_GetTicks(), joystick->trigger_rumble_expiration)) {
                SDL_JoystickRumbleTriggers(joystick, 0, 0, 0);
            }
            SDL_UnlockJoysticks();
        }
    }
 
    SDL_LockJoysticks();
 
    SDL_updating_joystick = SDL_FALSE;
 
    /* If any joysticks were closed while updating, free them here */
    for (joystick = SDL_joysticks; joystick; joystick = next) {
        next = joystick->next;
        if (joystick->ref_count <= 0) {
            SDL_JoystickClose(joystick);
        }
    }
 
    /* this needs to happen AFTER walking the joystick list above, so that any
       dangling hardware data from removed devices can be free'd
     */
    for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
        SDL_joystick_drivers[i]->Detect();
    }
 
    SDL_UnlockJoysticks();
}

References SDL_JoystickDriver::Detect, HIDAPI_UpdateDevices(), i, joystick, SDL_arraysize, SDL_FALSE, SDL_GameControllerHandleDelayedGuideButton(), SDL_GetTicks(), SDL_INIT_JOYSTICK, SDL_joystick_drivers, SDL_JoystickClose(), SDL_JoystickRumble(), SDL_JoystickRumbleTriggers(), SDL_joysticks, SDL_LockJoysticks(), SDL_TICKS_PASSED, SDL_TRUE, SDL_UnlockJoysticks(), SDL_updating_joystick, and SDL_WasInit.

SDL_LockJoysticks()

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.

Definition at line 102 of file SDL_joystick.c.

{
    if (SDL_joystick_lock) {
        SDL_LockMutex(SDL_joystick_lock);
    }
}

References SDL_joystick_lock, and SDL_LockMutex.

Referenced by SDL_JoystickClose(), SDL_JoystickDetachVirtual(), SDL_JoystickFromInstanceID(), SDL_JoystickFromPlayerIndex(), SDL_JoystickGetDeviceGUID(), SDL_JoystickGetDeviceIndexFromInstanceID(), SDL_JoystickGetDeviceInstanceID(), SDL_JoystickGetDevicePlayerIndex(), SDL_JoystickGetPlayerIndex(), SDL_JoystickHasLED(), SDL_JoystickIsVirtual(), SDL_JoystickNameForIndex(), SDL_JoystickOpen(), SDL_JoystickQuit(), SDL_JoystickRumble(), SDL_JoystickRumbleTriggers(), SDL_JoystickSetLED(), SDL_JoystickSetPlayerIndex(), SDL_JoystickUpdate(), SDL_NumJoysticks(), SDL_PrivateJoystickAdded(), SDL_PrivateJoystickGetAutoGamepadMapping(), and SDL_PrivateJoystickRemoved().

SDL_NumJoysticks()

int SDL_NumJoysticks

(

void

)

Count the number of joysticks attached to the system right now

Definition at line 247 of file SDL_joystick.c.

{
    int i, total_joysticks = 0;
    SDL_LockJoysticks();
    for (i = 0; i < SDL_arraysize(SDL_joystick_drivers); ++i) {
        total_joysticks += SDL_joystick_drivers[i]->GetCount();
    }
    SDL_UnlockJoysticks();
    return total_joysticks;
}

References SDL_JoystickDriver::GetCount, i, SDL_arraysize, SDL_joystick_drivers, SDL_LockJoysticks(), and SDL_UnlockJoysticks().

Referenced by SDL_JoystickGetDeviceIndexFromInstanceID().

SDL_PrivateJoystickAdded()

void SDL_PrivateJoystickAdded

(

SDL_JoystickID

device_instance

)

Definition at line 1145 of file SDL_joystick.c.

{
    SDL_JoystickDriver *driver;
    int driver_device_index;
    int player_index = -1;
    int device_index = SDL_JoystickGetDeviceIndexFromInstanceID(device_instance);
    if (device_index < 0) {
        return;
    }
 
    SDL_LockJoysticks();
    if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &driver_device_index)) {
        player_index = driver->GetDevicePlayerIndex(driver_device_index);
    }
    if (player_index < 0 && SDL_IsGameController(device_index)) {
        player_index = SDL_FindFreePlayerIndex();
    }
    if (player_index >= 0) {
        SDL_SetJoystickIDForPlayerIndex(player_index, device_instance);
    }
    SDL_UnlockJoysticks();
 
#if !SDL_EVENTS_DISABLED
    {
        SDL_Event event;
 
        event.type = SDL_JOYDEVICEADDED;
 
        if (SDL_GetEventState(event.type) == SDL_ENABLE) {
            event.jdevice.which = device_index;
            SDL_PushEvent(&event);
        }
    }
#endif /* !SDL_EVENTS_DISABLED */
}

References SDL_JoystickDriver::GetDevicePlayerIndex, SDL_ENABLE, SDL_FindFreePlayerIndex(), SDL_GetDriverAndJoystickIndex(), SDL_GetEventState, SDL_IsGameController, SDL_JOYDEVICEADDED, SDL_JoystickGetDeviceIndexFromInstanceID(), SDL_LockJoysticks(), SDL_PushEvent, SDL_SetJoystickIDForPlayerIndex(), and SDL_UnlockJoysticks().

SDL_PrivateJoystickAddSensor()

void SDL_PrivateJoystickAddSensor	(	SDL_Joystick *	joystick,
		SDL_SensorType	type
	)

Definition at line 1130 of file SDL_joystick.c.

{
    int nsensors = joystick->nsensors + 1;
    SDL_JoystickSensorInfo *sensors = (SDL_JoystickSensorInfo *)SDL_realloc(joystick->sensors, (nsensors * sizeof(SDL_JoystickSensorInfo)));
    if (sensors) {
        SDL_JoystickSensorInfo *sensor = &sensors[nsensors - 1];
 
        SDL_zerop(sensor);
        sensor->type = type;
 
        joystick->nsensors = nsensors;
        joystick->sensors = sensors;
    }
}

References joystick, SDL_realloc, SDL_zerop, and SDL_JoystickSensorInfo::type.

Referenced by IOS_JoystickOpen().

SDL_PrivateJoystickAddTouchpad()

void SDL_PrivateJoystickAddTouchpad	(	SDL_Joystick *	joystick,
		int	nfingers
	)

Definition at line 1108 of file SDL_joystick.c.

{
    int ntouchpads = joystick->ntouchpads + 1;
    SDL_JoystickTouchpadInfo *touchpads = (SDL_JoystickTouchpadInfo *)SDL_realloc(joystick->touchpads, (ntouchpads * sizeof(SDL_JoystickTouchpadInfo)));
    if (touchpads) {
        SDL_JoystickTouchpadInfo *touchpad = &touchpads[ntouchpads - 1];
        SDL_JoystickTouchpadFingerInfo *fingers = (SDL_JoystickTouchpadFingerInfo *)SDL_calloc(nfingers, sizeof(SDL_JoystickTouchpadFingerInfo));
 
        if (fingers) {
            touchpad->nfingers = nfingers;
            touchpad->fingers = fingers;
        } else {
            /* Out of memory, this touchpad won't be active */
            touchpad->nfingers = 0;
            touchpad->fingers = NULL;
        }
 
        joystick->ntouchpads = ntouchpads;
        joystick->touchpads = touchpads;
    }
}

References SDL_JoystickTouchpadInfo::fingers, joystick, SDL_JoystickTouchpadInfo::nfingers, NULL, SDL_calloc, and SDL_realloc.

Referenced by IOS_JoystickOpen().

SDL_PrivateJoystickAxis()

int SDL_PrivateJoystickAxis	(	SDL_Joystick *	joystick,
		Uint8	axis,
		Sint16	value
	)

Definition at line 1295 of file SDL_joystick.c.

{
    int posted;
    SDL_JoystickAxisInfo *info;
 
    /* Make sure we're not getting garbage or duplicate events */
    if (axis >= joystick->naxes) {
        return 0;
    }
 
    info = &joystick->axes[axis];
    if (!info->has_initial_value ||
        (!info->has_second_value && (info->initial_value <= -32767 || info->initial_value == 32767) && SDL_abs(value) < (SDL_JOYSTICK_AXIS_MAX / 4))) {
        info->initial_value = value;
        info->value = value;
        info->zero = value;
        info->has_initial_value = SDL_TRUE;
    } else if (value == info->value) {
        return 0;
    } else {
        info->has_second_value = SDL_TRUE;
    }
    if (!info->sent_initial_value) {
        /* Make sure we don't send motion until there's real activity on this axis */
        const int MAX_ALLOWED_JITTER = SDL_JOYSTICK_AXIS_MAX / 80;  /* ShanWan PS3 controller needed 96 */
        if (SDL_abs(value - info->value) <= MAX_ALLOWED_JITTER) {
            return 0;
        }
        info->sent_initial_value = SDL_TRUE;
        info->value = ~value; /* Just so we pass the check above */
        SDL_PrivateJoystickAxis(joystick, axis, info->initial_value);
    }
 
    /* We ignore events if we don't have keyboard focus, except for centering
     * events.
     */
    if (SDL_PrivateJoystickShouldIgnoreEvent()) {
        if ((value > info->zero && value >= info->value) ||
            (value < info->zero && value <= info->value)) {
            return 0;
        }
    }
 
    /* Update internal joystick state */
    info->value = value;
 
    /* Post the event, if desired */
    posted = 0;
#if !SDL_EVENTS_DISABLED
    if (SDL_GetEventState(SDL_JOYAXISMOTION) == SDL_ENABLE) {
        SDL_Event event;
        event.type = SDL_JOYAXISMOTION;
        event.jaxis.which = joystick->instance_id;
        event.jaxis.axis = axis;
        event.jaxis.value = value;
        posted = SDL_PushEvent(&event) == 1;
    }
#endif /* !SDL_EVENTS_DISABLED */
    return posted;
}

References axis, SDL_JoystickAxisInfo::has_initial_value, SDL_JoystickAxisInfo::has_second_value, SDL_JoystickAxisInfo::initial_value, joystick, SDL_abs, SDL_ENABLE, SDL_GetEventState, SDL_JOYAXISMOTION, SDL_JOYSTICK_AXIS_MAX, SDL_PrivateJoystickShouldIgnoreEvent(), SDL_PushEvent, SDL_TRUE, SDL_JoystickAxisInfo::sent_initial_value, SDL_JoystickAxisInfo::value, SDL_JoystickAxisInfo::zero, and zero.

Referenced by IOS_AccelerometerUpdate(), IOS_MFIJoystickUpdate(), and SDL_PrivateJoystickForceRecentering().

SDL_PrivateJoystickBall()

int SDL_PrivateJoystickBall	(	SDL_Joystick *	joystick,
		Uint8	ball,
		Sint16	xrel,
		Sint16	yrel
	)

Definition at line 1397 of file SDL_joystick.c.

{
    int posted;
 
    /* Make sure we're not getting garbage events */
    if (ball >= joystick->nballs) {
        return 0;
    }
 
    /* We ignore events if we don't have keyboard focus. */
    if (SDL_PrivateJoystickShouldIgnoreEvent()) {
        return 0;
    }
 
    /* Update internal mouse state */
    joystick->balls[ball].dx += xrel;
    joystick->balls[ball].dy += yrel;
 
    /* Post the event, if desired */
    posted = 0;
#if !SDL_EVENTS_DISABLED
    if (SDL_GetEventState(SDL_JOYBALLMOTION) == SDL_ENABLE) {
        SDL_Event event;
        event.jball.type = SDL_JOYBALLMOTION;
        event.jball.which = joystick->instance_id;
        event.jball.ball = ball;
        event.jball.xrel = xrel;
        event.jball.yrel = yrel;
        posted = SDL_PushEvent(&event) == 1;
    }
#endif /* !SDL_EVENTS_DISABLED */
    return posted;
}

References joystick, SDL_ENABLE, SDL_GetEventState, SDL_JOYBALLMOTION, SDL_PrivateJoystickShouldIgnoreEvent(), and SDL_PushEvent.

SDL_PrivateJoystickBatteryLevel()

void SDL_PrivateJoystickBatteryLevel	(	SDL_Joystick *	joystick,
		SDL_JoystickPowerLevel	ePowerLevel
	)

Definition at line 2487 of file SDL_joystick.c.

{
    joystick->epowerlevel = ePowerLevel;
}

References joystick.

Referenced by IOS_MFIJoystickUpdate().

SDL_PrivateJoystickButton()

int SDL_PrivateJoystickButton	(	SDL_Joystick *	joystick,
		Uint8	button,
		Uint8	state
	)

Definition at line 1433 of file SDL_joystick.c.

{
    int posted;
#if !SDL_EVENTS_DISABLED
    SDL_Event event;
 
    switch (state) {
    case SDL_PRESSED:
        event.type = SDL_JOYBUTTONDOWN;
        break;
    case SDL_RELEASED:
        event.type = SDL_JOYBUTTONUP;
        break;
    default:
        /* Invalid state -- bail */
        return 0;
    }
#endif /* !SDL_EVENTS_DISABLED */
 
    /* Make sure we're not getting garbage or duplicate events */
    if (button >= joystick->nbuttons) {
        return 0;
    }
    if (state == joystick->buttons[button]) {
        return 0;
    }
 
    /* We ignore events if we don't have keyboard focus, except for button
     * release. */
    if (SDL_PrivateJoystickShouldIgnoreEvent()) {
        if (state == SDL_PRESSED) {
            return 0;
        }
    }
 
    /* Update internal joystick state */
    joystick->buttons[button] = state;
 
    /* Post the event, if desired */
    posted = 0;
#if !SDL_EVENTS_DISABLED
    if (SDL_GetEventState(event.type) == SDL_ENABLE) {
        event.jbutton.which = joystick->instance_id;
        event.jbutton.button = button;
        event.jbutton.state = state;
        posted = SDL_PushEvent(&event) == 1;
    }
#endif /* !SDL_EVENTS_DISABLED */
    return posted;
}

References button, joystick, SDL_ENABLE, SDL_GetEventState, SDL_JOYBUTTONDOWN, SDL_JOYBUTTONUP, SDL_PRESSED, SDL_PrivateJoystickShouldIgnoreEvent(), SDL_PushEvent, SDL_RELEASED, and state.

Referenced by IOS_MFIJoystickUpdate(), and SDL_PrivateJoystickForceRecentering().

SDL_PrivateJoystickForceRecentering()

static void SDL_PrivateJoystickForceRecentering ( SDL_Joystick *  joystick )

static

Definition at line 1224 of file SDL_joystick.c.

{
    int i, j;
 
    /* Tell the app that everything is centered/unpressed... */
    for (i = 0; i < joystick->naxes; i++) {
        if (joystick->axes[i].has_initial_value) {
            SDL_PrivateJoystickAxis(joystick, i, joystick->axes[i].zero);
        }
    }
 
    for (i = 0; i < joystick->nbuttons; i++) {
        SDL_PrivateJoystickButton(joystick, i, SDL_RELEASED);
    }
 
    for (i = 0; i < joystick->nhats; i++) {
        SDL_PrivateJoystickHat(joystick, i, SDL_HAT_CENTERED);
    }
 
    for (i = 0; i < joystick->ntouchpads; i++) {
        SDL_JoystickTouchpadInfo *touchpad = &joystick->touchpads[i];
 
        for (j = 0; j < touchpad->nfingers; ++j) {
            SDL_PrivateJoystickTouchpad(joystick, i, j, SDL_RELEASED, 0.0f, 0.0f, 0.0f);
        }
    }
 
}

References i, j, joystick, SDL_JoystickTouchpadInfo::nfingers, SDL_HAT_CENTERED, SDL_PrivateJoystickAxis(), SDL_PrivateJoystickButton(), SDL_PrivateJoystickHat(), SDL_PrivateJoystickTouchpad(), and SDL_RELEASED.

Referenced by SDL_PrivateJoystickRemoved().

SDL_PrivateJoystickGetAutoGamepadMapping()

SDL_bool SDL_PrivateJoystickGetAutoGamepadMapping	(	int	device_index,
		SDL_GamepadMapping *	out
	)

Definition at line 574 of file SDL_joystick.c.

{
    SDL_JoystickDriver *driver;
    SDL_bool is_ok = SDL_FALSE;
 
    SDL_LockJoysticks();
    if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
        is_ok = driver->GetGamepadMapping(device_index, out);
    }
    SDL_UnlockJoysticks();
 
    return is_ok;
}

References SDL_JoystickDriver::GetGamepadMapping, SDL_FALSE, SDL_GetDriverAndJoystickIndex(), SDL_LockJoysticks(), and SDL_UnlockJoysticks().

Referenced by SDL_PrivateGetControllerMapping().

SDL_PrivateJoystickHat()

int SDL_PrivateJoystickHat	(	SDL_Joystick *	joystick,
		Uint8	hat,
		Uint8	value
	)

Definition at line 1357 of file SDL_joystick.c.

{
    int posted;
 
    /* Make sure we're not getting garbage or duplicate events */
    if (hat >= joystick->nhats) {
        return 0;
    }
    if (value == joystick->hats[hat]) {
        return 0;
    }
 
    /* We ignore events if we don't have keyboard focus, except for centering
     * events.
     */
    if (SDL_PrivateJoystickShouldIgnoreEvent()) {
        if (value != SDL_HAT_CENTERED) {
            return 0;
        }
    }
 
    /* Update internal joystick state */
    joystick->hats[hat] = value;
 
    /* Post the event, if desired */
    posted = 0;
#if !SDL_EVENTS_DISABLED
    if (SDL_GetEventState(SDL_JOYHATMOTION) == SDL_ENABLE) {
        SDL_Event event;
        event.jhat.type = SDL_JOYHATMOTION;
        event.jhat.which = joystick->instance_id;
        event.jhat.hat = hat;
        event.jhat.value = value;
        posted = SDL_PushEvent(&event) == 1;
    }
#endif /* !SDL_EVENTS_DISABLED */
    return posted;
}

References joystick, SDL_ENABLE, SDL_GetEventState, SDL_HAT_CENTERED, SDL_JOYHATMOTION, SDL_PrivateJoystickShouldIgnoreEvent(), and SDL_PushEvent.

Referenced by IOS_MFIJoystickUpdate(), and SDL_PrivateJoystickForceRecentering().

SDL_PrivateJoystickRemoved()

void SDL_PrivateJoystickRemoved

(

SDL_JoystickID

device_instance

)

Definition at line 1253 of file SDL_joystick.c.

{
    SDL_Joystick *joystick = NULL;
    int player_index;
    int device_index;
#if !SDL_EVENTS_DISABLED
    SDL_Event event;
#endif
 
    /* Find this joystick... */
    device_index = 0;
    for (joystick = SDL_joysticks; joystick; joystick = joystick->next) {
        if (joystick->instance_id == device_instance) {
            SDL_PrivateJoystickForceRecentering(joystick);
            joystick->attached = SDL_FALSE;
            break;
        }
 
        ++device_index;
    }
 
#if !SDL_EVENTS_DISABLED
    SDL_zero(event);
    event.type = SDL_JOYDEVICEREMOVED;
 
    if (SDL_GetEventState(event.type) == SDL_ENABLE) {
        event.jdevice.which = device_instance;
        SDL_PushEvent(&event);
    }
 
    UpdateEventsForDeviceRemoval(device_index);
#endif /* !SDL_EVENTS_DISABLED */
 
    SDL_LockJoysticks();
    player_index = SDL_GetPlayerIndexForJoystickID(device_instance);
    if (player_index >= 0) {
        SDL_joystick_players[player_index] = -1;
    }
    SDL_UnlockJoysticks();
}

References joystick, NULL, SDL_ENABLE, SDL_FALSE, SDL_GetEventState, SDL_GetPlayerIndexForJoystickID(), SDL_JOYDEVICEREMOVED, SDL_joystick_players, SDL_joysticks, SDL_LockJoysticks(), SDL_PrivateJoystickForceRecentering(), SDL_PushEvent, SDL_UnlockJoysticks(), SDL_zero, and UpdateEventsForDeviceRemoval().

Referenced by IOS_RemoveJoystickDevice().

SDL_PrivateJoystickSensor()

int SDL_PrivateJoystickSensor	(	SDL_Joystick *	joystick,
		SDL_SensorType	type,
		const float *	data,
		int	num_values
	)

Definition at line 2586 of file SDL_joystick.c.

{
    int i;
    int posted = 0;
 
    for (i = 0; i < joystick->nsensors; ++i) {
        SDL_JoystickSensorInfo *sensor = &joystick->sensors[i];
 
        if (sensor->type == type) {
            if (sensor->enabled) {
                num_values = SDL_min(num_values, SDL_arraysize(sensor->data));
                if (SDL_memcmp(data, sensor->data, num_values*sizeof(*data)) != 0) {
 
                    /* Update internal sensor state */
                    SDL_memcpy(sensor->data, data, num_values*sizeof(*data));
 
                    /* Post the event, if desired */
#if !SDL_EVENTS_DISABLED
                    if (SDL_GetEventState(SDL_CONTROLLERSENSORUPDATE) == SDL_ENABLE) {
                        SDL_Event event;
                        event.type = SDL_CONTROLLERSENSORUPDATE;
                        event.csensor.which = joystick->instance_id;
                        event.csensor.sensor = type;
                        num_values = SDL_min(num_values, SDL_arraysize(event.csensor.data));
                        SDL_memset(event.csensor.data, 0, sizeof(event.csensor.data));
                        SDL_memcpy(event.csensor.data, data, num_values*sizeof(*data));
                        posted = SDL_PushEvent(&event) == 1;
                    }
#endif /* !SDL_EVENTS_DISABLED */
                }
            }
            break;
        }
    }
    return posted;
}

References SDL_JoystickSensorInfo::data, SDL_JoystickSensorInfo::enabled, i, joystick, SDL_arraysize, SDL_CONTROLLERSENSORUPDATE, SDL_ENABLE, SDL_GetEventState, SDL_memcmp, SDL_memcpy, SDL_memset, SDL_min, SDL_PushEvent, and SDL_JoystickSensorInfo::type.

Referenced by IOS_MFIJoystickUpdate().

SDL_PrivateJoystickShouldIgnoreEvent()

static SDL_bool SDL_PrivateJoystickShouldIgnoreEvent ( )

static

Definition at line 1093 of file SDL_joystick.c.

{
    if (SDL_joystick_allows_background_events) {
        return SDL_FALSE;
    }
 
    if (SDL_HasWindows() && SDL_GetKeyboardFocus() == NULL) {
        /* We have windows but we don't have focus, ignore the event. */
        return SDL_TRUE;
    }
    return SDL_FALSE;
}

References NULL, SDL_FALSE, SDL_GetKeyboardFocus, SDL_HasWindows(), SDL_joystick_allows_background_events, and SDL_TRUE.

Referenced by SDL_PrivateJoystickAxis(), SDL_PrivateJoystickBall(), SDL_PrivateJoystickButton(), and SDL_PrivateJoystickHat().

SDL_PrivateJoystickTouchpad()

int SDL_PrivateJoystickTouchpad	(	SDL_Joystick *	joystick,
		int	touchpad,
		int	finger,
		Uint8	state,
		float	x,
		float	y,
		float	pressure
	)

Definition at line 2501 of file SDL_joystick.c.

{
    SDL_JoystickTouchpadInfo *touchpad_info;
    SDL_JoystickTouchpadFingerInfo *finger_info;
    int posted;
#if !SDL_EVENTS_DISABLED
    Uint32 event_type;
#endif
 
    if (touchpad < 0 || touchpad >= joystick->ntouchpads) {
        return 0;
    }
 
    touchpad_info = &joystick->touchpads[touchpad];
    if (finger < 0 || finger >= touchpad_info->nfingers) {
        return 0;
    }
 
    finger_info = &touchpad_info->fingers[finger];
 
    if (!state) {
        if (x == 0.0f && y == 0.0f) {
            x = finger_info->x;
            y = finger_info->y;
        }
        pressure = 0.0f;
    }
 
    if (x < 0.0f) {
        x = 0.0f;
    } else if (x > 1.0f) {
        x = 1.0f;
    }
    if (y < 0.0f) {
        y = 0.0f;
    } else if (y > 1.0f) {
        y = 1.0f;
    }
    if (pressure < 0.0f) {
        pressure = 0.0f;
    } else if (pressure > 1.0f) {
        pressure = 1.0f;
    }
 
    if (state == finger_info->state) {
        if (!state ||
            (x == finger_info->x && y == finger_info->y && pressure == finger_info->pressure)) {
            return 0;
        }
    }
 
#if !SDL_EVENTS_DISABLED
    if (state == finger_info->state) {
        event_type = SDL_CONTROLLERTOUCHPADMOTION;
    } else if (state) {
        event_type = SDL_CONTROLLERTOUCHPADDOWN;
    } else {
        event_type = SDL_CONTROLLERTOUCHPADUP;
    }
#endif
 
    /* Update internal joystick state */
    finger_info->state = state;
    finger_info->x = x;
    finger_info->y = y;
    finger_info->pressure = pressure;
 
    /* Post the event, if desired */
    posted = 0;
#if !SDL_EVENTS_DISABLED
    if (SDL_GetEventState(event_type) == SDL_ENABLE) {
        SDL_Event event;
        event.type = event_type;
        event.ctouchpad.which = joystick->instance_id;
        event.ctouchpad.touchpad = touchpad;
        event.ctouchpad.finger = finger;
        event.ctouchpad.x = x;
        event.ctouchpad.y = y;
        event.ctouchpad.pressure = pressure;
        posted = SDL_PushEvent(&event) == 1;
    }
#endif /* !SDL_EVENTS_DISABLED */
    return posted;
}

References SDL_JoystickTouchpadInfo::fingers, joystick, SDL_JoystickTouchpadInfo::nfingers, SDL_JoystickTouchpadFingerInfo::pressure, SDL_CONTROLLERTOUCHPADDOWN, SDL_CONTROLLERTOUCHPADMOTION, SDL_CONTROLLERTOUCHPADUP, SDL_ENABLE, SDL_GetEventState, SDL_PushEvent, SDL_JoystickTouchpadFingerInfo::state, state, SDL_JoystickTouchpadFingerInfo::x, and SDL_JoystickTouchpadFingerInfo::y.

Referenced by IOS_MFIJoystickUpdate(), and SDL_PrivateJoystickForceRecentering().

SDL_PrivateJoystickValid()

SDL_bool SDL_PrivateJoystickValid

(

SDL_Joystick *

joystick

)

Definition at line 559 of file SDL_joystick.c.

{
    SDL_bool valid;
 
    if (joystick == NULL) {
        SDL_SetError("Joystick hasn't been opened yet");
        valid = SDL_FALSE;
    } else {
        valid = SDL_TRUE;
    }
 
    return valid;
}

References joystick, NULL, SDL_FALSE, SDL_SetError, and SDL_TRUE.

Referenced by SDL_HapticOpenFromJoystick(), SDL_JoystickClose(), SDL_JoystickCurrentPowerLevel(), SDL_JoystickGetAttached(), SDL_JoystickGetAxis(), SDL_JoystickGetAxisInitialState(), SDL_JoystickGetBall(), SDL_JoystickGetButton(), SDL_JoystickGetGUID(), SDL_JoystickGetHat(), SDL_JoystickGetPlayerIndex(), SDL_JoystickGetSerial(), SDL_JoystickHasLED(), SDL_JoystickInstanceID(), SDL_JoystickIsHaptic(), SDL_JoystickName(), SDL_JoystickNumAxes(), SDL_JoystickNumBalls(), SDL_JoystickNumButtons(), SDL_JoystickNumHats(), SDL_JoystickRumble(), SDL_JoystickRumbleTriggers(), SDL_JoystickSetLED(), and SDL_JoystickSetPlayerIndex().

SDL_SetJoystickIDForPlayerIndex()

static SDL_bool SDL_SetJoystickIDForPlayerIndex ( int  player_index, SDL_JoystickID  instance_id  )

static

Definition at line 156 of file SDL_joystick.c.

{
    SDL_JoystickID existing_instance = SDL_GetJoystickIDForPlayerIndex(player_index);
    SDL_JoystickDriver *driver;
    int device_index;
    int existing_player_index;
 
    if (player_index < 0) {
        return SDL_FALSE;
    }
    if (player_index >= SDL_joystick_player_count) {
        SDL_JoystickID *new_players = (SDL_JoystickID *)SDL_realloc(SDL_joystick_players, (player_index + 1)*sizeof(*SDL_joystick_players));
        if (!new_players) {
            SDL_OutOfMemory();
            return SDL_FALSE;
        }
 
        SDL_joystick_players = new_players;
        SDL_memset(&SDL_joystick_players[SDL_joystick_player_count], 0xFF, (player_index - SDL_joystick_player_count + 1) * sizeof(SDL_joystick_players[0]));
        SDL_joystick_player_count = player_index + 1;
    } else if (SDL_joystick_players[player_index] == instance_id) {
        /* Joystick is already assigned the requested player index */
        return SDL_TRUE;
    }
 
    /* Clear the old player index */
    existing_player_index = SDL_GetPlayerIndexForJoystickID(instance_id);
    if (existing_player_index >= 0) {
        SDL_joystick_players[existing_player_index] = -1;
    }
 
    SDL_joystick_players[player_index] = instance_id;
 
    /* Update the driver with the new index */
    device_index = SDL_JoystickGetDeviceIndexFromInstanceID(instance_id);
    if (SDL_GetDriverAndJoystickIndex(device_index, &driver, &device_index)) {
        driver->SetDevicePlayerIndex(device_index, player_index);
    }
 
    /* Move any existing joystick to another slot */
    if (existing_instance >= 0) {
        SDL_SetJoystickIDForPlayerIndex(SDL_FindFreePlayerIndex(), existing_instance);
    }
    return SDL_TRUE;
}

References SDL_FALSE, SDL_FindFreePlayerIndex(), SDL_GetDriverAndJoystickIndex(), SDL_GetJoystickIDForPlayerIndex(), SDL_GetPlayerIndexForJoystickID(), SDL_joystick_player_count, SDL_joystick_players, SDL_JoystickGetDeviceIndexFromInstanceID(), SDL_memset, SDL_OutOfMemory, SDL_realloc, SDL_TRUE, and SDL_JoystickDriver::SetDevicePlayerIndex.

Referenced by SDL_JoystickSetPlayerIndex(), and SDL_PrivateJoystickAdded().

SDL_ShouldIgnoreJoystick()

SDL_bool SDL_ShouldIgnoreJoystick	(	const char *	name,
		SDL_JoystickGUID	guid
	)

Definition at line 2140 of file SDL_joystick.c.

{
    /* This list is taken from:
       https://raw.githubusercontent.com/denilsonsa/udev-joystick-blacklist/master/generate_rules.py
     */
    static Uint32 joystick_blacklist[] = {
        /* Microsoft Microsoft Wireless Optical Desktop 2.10 */
        /* Microsoft Wireless Desktop - Comfort Edition */
        MAKE_VIDPID(0x045e, 0x009d),
 
        /* Microsoft Microsoft Digital Media Pro Keyboard */
        /* Microsoft Corp. Digital Media Pro Keyboard */
        MAKE_VIDPID(0x045e, 0x00b0),
 
        /* Microsoft Microsoft Digital Media Keyboard */
        /* Microsoft Corp. Digital Media Keyboard 1.0A */
        MAKE_VIDPID(0x045e, 0x00b4),
 
        /* Microsoft Microsoft Digital Media Keyboard 3000 */
        MAKE_VIDPID(0x045e, 0x0730),
 
        /* Microsoft Microsoft 2.4GHz Transceiver v6.0 */
        /* Microsoft Microsoft 2.4GHz Transceiver v8.0 */
        /* Microsoft Corp. Nano Transceiver v1.0 for Bluetooth */
        /* Microsoft Wireless Mobile Mouse 1000 */
        /* Microsoft Wireless Desktop 3000 */
        MAKE_VIDPID(0x045e, 0x0745),
 
        /* Microsoft SideWinder(TM) 2.4GHz Transceiver */
        MAKE_VIDPID(0x045e, 0x0748),
 
        /* Microsoft Corp. Wired Keyboard 600 */
        MAKE_VIDPID(0x045e, 0x0750),
 
        /* Microsoft Corp. Sidewinder X4 keyboard */
        MAKE_VIDPID(0x045e, 0x0768),
 
        /* Microsoft Corp. Arc Touch Mouse Transceiver */
        MAKE_VIDPID(0x045e, 0x0773),
 
        /* Microsoft 2.4GHz Transceiver v9.0 */
        /* Microsoft Nano Transceiver v2.1 */
        /* Microsoft Sculpt Ergonomic Keyboard (5KV-00001) */
        MAKE_VIDPID(0x045e, 0x07a5),
 
        /* Microsoft Nano Transceiver v1.0 */
        /* Microsoft Wireless Keyboard 800 */
        MAKE_VIDPID(0x045e, 0x07b2),
 
        /* Microsoft Nano Transceiver v2.0 */
        MAKE_VIDPID(0x045e, 0x0800),
 
        MAKE_VIDPID(0x046d, 0xc30a),  /* Logitech, Inc. iTouch Composite keboard */
 
        MAKE_VIDPID(0x04d9, 0xa0df),  /* Tek Syndicate Mouse (E-Signal USB Gaming Mouse) */
 
        /* List of Wacom devices at: http://linuxwacom.sourceforge.net/wiki/index.php/Device_IDs */
        MAKE_VIDPID(0x056a, 0x0010),  /* Wacom ET-0405 Graphire */
        MAKE_VIDPID(0x056a, 0x0011),  /* Wacom ET-0405A Graphire2 (4x5) */
        MAKE_VIDPID(0x056a, 0x0012),  /* Wacom ET-0507A Graphire2 (5x7) */
        MAKE_VIDPID(0x056a, 0x0013),  /* Wacom CTE-430 Graphire3 (4x5) */
        MAKE_VIDPID(0x056a, 0x0014),  /* Wacom CTE-630 Graphire3 (6x8) */
        MAKE_VIDPID(0x056a, 0x0015),  /* Wacom CTE-440 Graphire4 (4x5) */
        MAKE_VIDPID(0x056a, 0x0016),  /* Wacom CTE-640 Graphire4 (6x8) */
        MAKE_VIDPID(0x056a, 0x0017),  /* Wacom CTE-450 Bamboo Fun (4x5) */
        MAKE_VIDPID(0x056a, 0x0018),  /* Wacom CTE-650 Bamboo Fun 6x8 */
        MAKE_VIDPID(0x056a, 0x0019),  /* Wacom CTE-631 Bamboo One */
        MAKE_VIDPID(0x056a, 0x00d1),  /* Wacom Bamboo Pen and Touch CTH-460 */
        MAKE_VIDPID(0x056a, 0x030e),  /* Wacom Intuos Pen (S) CTL-480 */
 
        MAKE_VIDPID(0x09da, 0x054f),  /* A4 Tech Co., G7 750 mouse */
        MAKE_VIDPID(0x09da, 0x1410),  /* A4 Tech Co., Ltd Bloody AL9 mouse */
        MAKE_VIDPID(0x09da, 0x3043),  /* A4 Tech Co., Ltd Bloody R8A Gaming Mouse */
        MAKE_VIDPID(0x09da, 0x31b5),  /* A4 Tech Co., Ltd Bloody TL80 Terminator Laser Gaming Mouse */
        MAKE_VIDPID(0x09da, 0x3997),  /* A4 Tech Co., Ltd Bloody RT7 Terminator Wireless */
        MAKE_VIDPID(0x09da, 0x3f8b),  /* A4 Tech Co., Ltd Bloody V8 mouse */
        MAKE_VIDPID(0x09da, 0x51f4),  /* Modecom MC-5006 Keyboard */
        MAKE_VIDPID(0x09da, 0x5589),  /* A4 Tech Co., Ltd Terminator TL9 Laser Gaming Mouse */
        MAKE_VIDPID(0x09da, 0x7b22),  /* A4 Tech Co., Ltd Bloody V5 */
        MAKE_VIDPID(0x09da, 0x7f2d),  /* A4 Tech Co., Ltd Bloody R3 mouse */
        MAKE_VIDPID(0x09da, 0x8090),  /* A4 Tech Co., Ltd X-718BK Oscar Optical Gaming Mouse */
        MAKE_VIDPID(0x09da, 0x9033),  /* A4 Tech Co., X7 X-705K */
        MAKE_VIDPID(0x09da, 0x9066),  /* A4 Tech Co., Sharkoon Fireglider Optical */
        MAKE_VIDPID(0x09da, 0x9090),  /* A4 Tech Co., Ltd XL-730K / XL-750BK / XL-755BK Laser Mouse */
        MAKE_VIDPID(0x09da, 0x90c0),  /* A4 Tech Co., Ltd X7 G800V keyboard */
        MAKE_VIDPID(0x09da, 0xf012),  /* A4 Tech Co., Ltd Bloody V7 mouse */
        MAKE_VIDPID(0x09da, 0xf32a),  /* A4 Tech Co., Ltd Bloody B540 keyboard */
        MAKE_VIDPID(0x09da, 0xf613),  /* A4 Tech Co., Ltd Bloody V2 mouse */
        MAKE_VIDPID(0x09da, 0xf624),  /* A4 Tech Co., Ltd Bloody B120 Keyboard */
 
        MAKE_VIDPID(0x1b1c, 0x1b3c),  /* Corsair Harpoon RGB gaming mouse */
 
        MAKE_VIDPID(0x1d57, 0xad03),  /* [T3] 2.4GHz and IR Air Mouse Remote Control */
 
        MAKE_VIDPID(0x1e7d, 0x2e4a),  /* Roccat Tyon Mouse */
 
        MAKE_VIDPID(0x20a0, 0x422d),  /* Winkeyless.kr Keyboards */
 
        MAKE_VIDPID(0x2516, 0x001f),  /* Cooler Master Storm Mizar Mouse */
        MAKE_VIDPID(0x2516, 0x0028),  /* Cooler Master Storm Alcor Mouse */
    };
 
    unsigned int i;
    Uint32 id;
    Uint16 vendor;
    Uint16 product;
    SDL_GameControllerType type;
 
    SDL_GetJoystickGUIDInfo(guid, &vendor, &product, NULL);
 
    /* Check the joystick blacklist */
    id = MAKE_VIDPID(vendor, product);
    for (i = 0; i < SDL_arraysize(joystick_blacklist); ++i) {
        if (id == joystick_blacklist[i]) {
            return SDL_TRUE;
        }
    }
 
    type = SDL_GetJoystickGameControllerType(name, vendor, product, -1, 0, 0, 0);
    if ((type == SDL_CONTROLLER_TYPE_PS4 || type == SDL_CONTROLLER_TYPE_PS5) && SDL_IsPS4RemapperRunning()) {
        return SDL_TRUE;
    }
 
    if (SDL_IsGameControllerNameAndGUID(name, guid) &&
        SDL_ShouldIgnoreGameController(name, guid)) {
        return SDL_TRUE;
    }
 
    return SDL_FALSE;
}

References i, MAKE_VIDPID, NULL, SDL_arraysize, SDL_CONTROLLER_TYPE_PS4, SDL_CONTROLLER_TYPE_PS5, SDL_FALSE, SDL_GetJoystickGameControllerType(), SDL_GetJoystickGUIDInfo(), SDL_IsGameControllerNameAndGUID(), SDL_IsPS4RemapperRunning(), SDL_ShouldIgnoreGameController(), and SDL_TRUE.

SDL_UnlockJoysticks()

void SDL_UnlockJoysticks

(

void

)

Definition at line 110 of file SDL_joystick.c.

{
    if (SDL_joystick_lock) {
        SDL_UnlockMutex(SDL_joystick_lock);
    }
}

References SDL_joystick_lock, and SDL_UnlockMutex.

Referenced by SDL_JoystickClose(), SDL_JoystickDetachVirtual(), SDL_JoystickFromInstanceID(), SDL_JoystickFromPlayerIndex(), SDL_JoystickGetDeviceGUID(), SDL_JoystickGetDeviceIndexFromInstanceID(), SDL_JoystickGetDeviceInstanceID(), SDL_JoystickGetDevicePlayerIndex(), SDL_JoystickGetPlayerIndex(), SDL_JoystickHasLED(), SDL_JoystickIsVirtual(), SDL_JoystickNameForIndex(), SDL_JoystickOpen(), SDL_JoystickQuit(), SDL_JoystickRumble(), SDL_JoystickRumbleTriggers(), SDL_JoystickSetLED(), SDL_JoystickSetPlayerIndex(), SDL_JoystickUpdate(), SDL_NumJoysticks(), SDL_PrivateJoystickAdded(), SDL_PrivateJoystickGetAutoGamepadMapping(), and SDL_PrivateJoystickRemoved().

UpdateEventsForDeviceRemoval()

static void UpdateEventsForDeviceRemoval ( int  device_index )

static

Definition at line 1186 of file SDL_joystick.c.

{
    int i, num_events;
    SDL_Event *events;
    SDL_bool isstack;
 
    num_events = SDL_PeepEvents(NULL, 0, SDL_PEEKEVENT, SDL_JOYDEVICEADDED, SDL_JOYDEVICEADDED);
    if (num_events <= 0) {
        return;
    }
 
    events = SDL_small_alloc(SDL_Event, num_events, &isstack);
    if (!events) {
        return;
    }
 
    num_events = SDL_PeepEvents(events, num_events, SDL_GETEVENT, SDL_JOYDEVICEADDED, SDL_JOYDEVICEADDED);
    for (i = 0; i < num_events; ++i) {
        if (events[i].cdevice.which < device_index) {
            /* No change for index values lower than the removed device */
        }
        else if (events[i].cdevice.which == device_index) {
            /* Drop this event entirely */
            SDL_memmove(&events[i], &events[i + 1], sizeof(*events) * (num_events - (i + 1)));
            --num_events;
            --i;
        }
        else {
            /* Fix up the device index if greater than the removed device */
            --events[i].cdevice.which;
        }
    }
    SDL_PeepEvents(events, num_events, SDL_ADDEVENT, 0, 0);
 
    SDL_small_free(events, isstack);
}

References SDL_Event::cdevice, events, i, NULL, SDL_ADDEVENT, SDL_GETEVENT, SDL_JOYDEVICEADDED, SDL_memmove, SDL_PEEKEVENT, SDL_PeepEvents, SDL_small_alloc, SDL_small_free, and SDL_ControllerDeviceEvent::which.

Referenced by SDL_PrivateJoystickRemoved().

Variable Documentation

SDL_joystick_allows_background_events

SDL_bool SDL_joystick_allows_background_events = SDL_FALSE

static

Definition at line 93 of file SDL_joystick.c.

Referenced by SDL_JoystickAllowBackgroundEventsChanged(), and SDL_PrivateJoystickShouldIgnoreEvent().

SDL_joystick_drivers

SDL_JoystickDriver* SDL_joystick_drivers[]

static

Definition at line 52 of file SDL_joystick.c.

Referenced by SDL_GetDriverAndJoystickIndex(), SDL_JoystickInit(), SDL_JoystickQuit(), SDL_JoystickUpdate(), and SDL_NumJoysticks().

SDL_joystick_lock

SDL_mutex* SDL_joystick_lock = NULL

static

Definition at line 96 of file SDL_joystick.c.

Referenced by SDL_JoystickInit(), SDL_JoystickQuit(), SDL_LockJoysticks(), and SDL_UnlockJoysticks().

SDL_joystick_player_count

int SDL_joystick_player_count = 0

static

Definition at line 98 of file SDL_joystick.c.

Referenced by SDL_FindFreePlayerIndex(), SDL_GetJoystickIDForPlayerIndex(), SDL_GetPlayerIndexForJoystickID(), SDL_JoystickQuit(), and SDL_SetJoystickIDForPlayerIndex().

SDL_joystick_players

SDL_JoystickID* SDL_joystick_players = NULL

static

Definition at line 99 of file SDL_joystick.c.

Referenced by SDL_FindFreePlayerIndex(), SDL_GetJoystickIDForPlayerIndex(), SDL_GetPlayerIndexForJoystickID(), SDL_JoystickQuit(), SDL_PrivateJoystickRemoved(), and SDL_SetJoystickIDForPlayerIndex().

SDL_joysticks

SDL_Joystick* SDL_joysticks = NULL

static

Definition at line 94 of file SDL_joystick.c.

Referenced by SDL_JoystickClose(), SDL_JoystickFromInstanceID(), SDL_JoystickFromPlayerIndex(), SDL_JoystickOpen(), SDL_JoystickQuit(), SDL_JoystickUpdate(), and SDL_PrivateJoystickRemoved().

SDL_next_joystick_instance_id

SDL_atomic_t SDL_next_joystick_instance_id

static

Definition at line 97 of file SDL_joystick.c.

Referenced by SDL_GetNextJoystickInstanceID().

SDL_updating_joystick

SDL_bool SDL_updating_joystick = SDL_FALSE

static

Definition at line 95 of file SDL_joystick.c.

Referenced by SDL_JoystickClose(), SDL_JoystickQuit(), and SDL_JoystickUpdate().