SDL_gamecontroller.h File Reference

#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_rwops.h"
#include "SDL_sensor.h"
#include "SDL_joystick.h"
#include "begin_code.h"
#include "close_code.h"

Include dependency graph for SDL_gamecontroller.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	SDL_GameControllerButtonBind

Macros
#define	SDL_GameControllerAddMappingsFromFile(file)   SDL_GameControllerAddMappingsFromRW(SDL_RWFromFile(file, "rb"), 1)

Enumerations
enum	SDL_GameControllerType {   SDL_CONTROLLER_TYPE_UNKNOWN = 0 ,   SDL_CONTROLLER_TYPE_XBOX360 ,   SDL_CONTROLLER_TYPE_XBOXONE ,   SDL_CONTROLLER_TYPE_PS3 ,   SDL_CONTROLLER_TYPE_PS4 ,   SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_PRO ,   SDL_CONTROLLER_TYPE_VIRTUAL ,   SDL_CONTROLLER_TYPE_PS5 }
enum	SDL_GameControllerBindType {   SDL_CONTROLLER_BINDTYPE_NONE = 0 ,   SDL_CONTROLLER_BINDTYPE_BUTTON ,   SDL_CONTROLLER_BINDTYPE_AXIS ,   SDL_CONTROLLER_BINDTYPE_HAT }
enum	SDL_GameControllerAxis {   SDL_CONTROLLER_AXIS_INVALID = -1 ,   SDL_CONTROLLER_AXIS_LEFTX ,   SDL_CONTROLLER_AXIS_LEFTY ,   SDL_CONTROLLER_AXIS_RIGHTX ,   SDL_CONTROLLER_AXIS_RIGHTY ,   SDL_CONTROLLER_AXIS_TRIGGERLEFT ,   SDL_CONTROLLER_AXIS_TRIGGERRIGHT ,   SDL_CONTROLLER_AXIS_MAX }
enum	SDL_GameControllerButton {   SDL_CONTROLLER_BUTTON_INVALID = -1 ,   SDL_CONTROLLER_BUTTON_A ,   SDL_CONTROLLER_BUTTON_B ,   SDL_CONTROLLER_BUTTON_X ,   SDL_CONTROLLER_BUTTON_Y ,   SDL_CONTROLLER_BUTTON_BACK ,   SDL_CONTROLLER_BUTTON_GUIDE ,   SDL_CONTROLLER_BUTTON_START ,   SDL_CONTROLLER_BUTTON_LEFTSTICK ,   SDL_CONTROLLER_BUTTON_RIGHTSTICK ,   SDL_CONTROLLER_BUTTON_LEFTSHOULDER ,   SDL_CONTROLLER_BUTTON_RIGHTSHOULDER ,   SDL_CONTROLLER_BUTTON_DPAD_UP ,   SDL_CONTROLLER_BUTTON_DPAD_DOWN ,   SDL_CONTROLLER_BUTTON_DPAD_LEFT ,   SDL_CONTROLLER_BUTTON_DPAD_RIGHT ,   SDL_CONTROLLER_BUTTON_MISC1 ,   SDL_CONTROLLER_BUTTON_PADDLE1 ,   SDL_CONTROLLER_BUTTON_PADDLE2 ,   SDL_CONTROLLER_BUTTON_PADDLE3 ,   SDL_CONTROLLER_BUTTON_PADDLE4 ,   SDL_CONTROLLER_BUTTON_TOUCHPAD ,   SDL_CONTROLLER_BUTTON_MAX }

Functions
int	SDL_GameControllerAddMappingsFromRW (SDL_RWops *rw, int freerw)
int	SDL_GameControllerAddMapping (const char *mappingString)
int	SDL_GameControllerNumMappings (void)
char *	SDL_GameControllerMappingForIndex (int mapping_index)
char *	SDL_GameControllerMappingForGUID (SDL_JoystickGUID guid)
char *	SDL_GameControllerMapping (SDL_GameController *gamecontroller)
SDL_bool	SDL_IsGameController (int joystick_index)
const char *	SDL_GameControllerNameForIndex (int joystick_index)
SDL_GameControllerType	SDL_GameControllerTypeForIndex (int joystick_index)
char *	SDL_GameControllerMappingForDeviceIndex (int joystick_index)
SDL_GameController *	SDL_GameControllerOpen (int joystick_index)
SDL_GameController *	SDL_GameControllerFromInstanceID (SDL_JoystickID joyid)
SDL_GameController *	SDL_GameControllerFromPlayerIndex (int player_index)
const char *	SDL_GameControllerName (SDL_GameController *gamecontroller)
SDL_GameControllerType	SDL_GameControllerGetType (SDL_GameController *gamecontroller)
int	SDL_GameControllerGetPlayerIndex (SDL_GameController *gamecontroller)
void	SDL_GameControllerSetPlayerIndex (SDL_GameController *gamecontroller, int player_index)
Uint16	SDL_GameControllerGetVendor (SDL_GameController *gamecontroller)
Uint16	SDL_GameControllerGetProduct (SDL_GameController *gamecontroller)
Uint16	SDL_GameControllerGetProductVersion (SDL_GameController *gamecontroller)
const char *	SDL_GameControllerGetSerial (SDL_GameController *gamecontroller)
SDL_bool	SDL_GameControllerGetAttached (SDL_GameController *gamecontroller)
SDL_Joystick *	SDL_GameControllerGetJoystick (SDL_GameController *gamecontroller)
int	SDL_GameControllerEventState (int state)
void	SDL_GameControllerUpdate (void)
SDL_GameControllerAxis	SDL_GameControllerGetAxisFromString (const char *pchString)
const char *	SDL_GameControllerGetStringForAxis (SDL_GameControllerAxis axis)
SDL_GameControllerButtonBind	SDL_GameControllerGetBindForAxis (SDL_GameController *gamecontroller, SDL_GameControllerAxis axis)
SDL_bool	SDL_GameControllerHasAxis (SDL_GameController *gamecontroller, SDL_GameControllerAxis axis)
Sint16	SDL_GameControllerGetAxis (SDL_GameController *gamecontroller, SDL_GameControllerAxis axis)
SDL_GameControllerButton	SDL_GameControllerGetButtonFromString (const char *pchString)
const char *	SDL_GameControllerGetStringForButton (SDL_GameControllerButton button)
SDL_GameControllerButtonBind	SDL_GameControllerGetBindForButton (SDL_GameController *gamecontroller, SDL_GameControllerButton button)
SDL_bool	SDL_GameControllerHasButton (SDL_GameController *gamecontroller, SDL_GameControllerButton button)
Uint8	SDL_GameControllerGetButton (SDL_GameController *gamecontroller, SDL_GameControllerButton button)
int	SDL_GameControllerGetNumTouchpads (SDL_GameController *gamecontroller)
int	SDL_GameControllerGetNumTouchpadFingers (SDL_GameController *gamecontroller, int touchpad)
int	SDL_GameControllerGetTouchpadFinger (SDL_GameController *gamecontroller, int touchpad, int finger, Uint8 *state, float *x, float *y, float *pressure)
SDL_bool	SDL_GameControllerHasSensor (SDL_GameController *gamecontroller, SDL_SensorType type)
int	SDL_GameControllerSetSensorEnabled (SDL_GameController *gamecontroller, SDL_SensorType type, SDL_bool enabled)
SDL_bool	SDL_GameControllerIsSensorEnabled (SDL_GameController *gamecontroller, SDL_SensorType type)
int	SDL_GameControllerGetSensorData (SDL_GameController *gamecontroller, SDL_SensorType type, float *data, int num_values)
int	SDL_GameControllerRumble (SDL_GameController *gamecontroller, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)
int	SDL_GameControllerRumbleTriggers (SDL_GameController *gamecontroller, Uint16 left_rumble, Uint16 right_rumble, Uint32 duration_ms)
SDL_bool	SDL_GameControllerHasLED (SDL_GameController *gamecontroller)
int	SDL_GameControllerSetLED (SDL_GameController *gamecontroller, Uint8 red, Uint8 green, Uint8 blue)
void	SDL_GameControllerClose (SDL_GameController *gamecontroller)

Detailed Description

Include file for SDL game controller event handling

In order to use these functions, SDL_Init() must have been called with the SDL_INIT_GAMECONTROLLER flag. This causes SDL to scan the system for game controllers, and load appropriate drivers.

If you would like to receive controller updates while the application is in the background, you should set the following hint before calling SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS

Definition in file SDL_gamecontroller.h.

Macro Definition Documentation

SDL_GameControllerAddMappingsFromFile

#define SDL_GameControllerAddMappingsFromFile

(

file

)

SDL_GameControllerAddMappingsFromRW(SDL_RWFromFile(file, "rb"), 1)

Load a set of mappings from a file, filtered by the current SDL_GetPlatform()

Convenience macro.

Definition at line 141 of file SDL_gamecontroller.h.

Enumeration Type Documentation

SDL_GameControllerAxis

enum SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char const char SDL_SCANF_FORMAT_STRING const char return SDL_ThreadFunction const char void return Uint32 return Uint32 SDL_AssertionHandler void SDL_SpinLock SDL_atomic_t int int return SDL_atomic_t return void void void return void return int return SDL_AudioSpec SDL_AudioSpec return int int return return int SDL_RWops int SDL_AudioSpec Uint8 Uint32 return SDL_AudioCVT SDL_AudioFormat Uint8 int SDL_AudioFormat Uint8 int return Uint8 const Uint8 Uint32 int const char return return return return return return return return Uint32 return Uint32 SDL_Event return SDL_Event int return SDL_EventFilter void SDL_EventFilter void SDL_EventFilter void int return const char const char return SDL_JoystickGUID return int return int return SDL_GameController return int return const char return SDL_GameController SDL_GameControllerAxis return const char return SDL_GameController SDL_GameControllerButton return SDL_GameController SDL_RWops return SDL_TouchID SDL_RWops return int return int return return SDL_Joystick return SDL_Haptic SDL_Haptic return SDL_Haptic return SDL_Haptic SDL_HapticEffect return SDL_Haptic int Uint32 return SDL_Haptic int SDL_Haptic int return SDL_Haptic return SDL_Haptic return SDL_Haptic return SDL_Haptic return const char const char return const char SDL_HintCallback void int return SDL_Joystick return SDL_Joystick return const char return SDL_Joystick return SDL_Joystick return SDL_Joystick return int return SDL_Joystick int return SDL_Joystick int return return return SDL_Scancode return SDL_Scancode return SDL_Keycode return return const char return void int SDL_LogPriority SDL_LogOutputFunction void Uint32 const char const char SDL_Window return int int return SDL_Window int int return SDL_Surface int int return SDL_Cursor return int return SDL_mutex return SDL_mutex return Uint32 return SDL_sem return SDL_sem Uint32 return SDL_sem return SDL_cond SDL_cond return SDL_cond SDL_mutex Uint32 return Uint32 int Uint32 Uint32 Uint32 Uint32 return Uint32 return int return SDL_Palette const SDL_Color int int return const SDL_PixelFormat Uint8 Uint8 Uint8 return Uint32 const SDL_PixelFormat Uint8 Uint8 Uint8 float Uint16 int int return const SDL_Rect const SDL_Rect SDL_Rect return const SDL_Point int const SDL_Rect SDL_Rect return return int int Uint32 SDL_Window SDL_Renderer return SDL_Surface return SDL_Renderer SDL_RendererInfo return SDL_Renderer Uint32 int int int return SDL_Texture Uint32 int int int return SDL_Texture Uint8 Uint8 Uint8 return SDL_Texture Uint8 return SDL_Texture SDL_BlendMode return SDL_Texture const SDL_Rect const Uint8 int const Uint8 int const Uint8 int return SDL_Texture SDL_Renderer SDL_Texture return SDL_Renderer int int return SDL_Renderer const SDL_Rect return SDL_Renderer const SDL_Rect return SDL_Renderer float float return SDL_Renderer Uint8 Uint8 Uint8 Uint8 return SDL_Renderer SDL_BlendMode return SDL_Renderer return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Point int return SDL_Renderer const SDL_Rect int return SDL_Renderer const SDL_Rect int return SDL_Renderer SDL_Texture const SDL_Rect const SDL_Rect const double const SDL_Point const SDL_RendererFlip return SDL_Renderer SDL_Renderer SDL_Texture return void int return return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops return SDL_RWops Uint16 return SDL_RWops Uint32 return SDL_RWops Uint64 return const char unsigned int unsigned int unsigned int unsigned int Uint32 return SDL_Window SDL_Surface SDL_WindowShapeMode return size_t return void size_t return const char return void size_t size_t int(*) b int return int return int size_t return size_t return const wchar_t return const wchar_t size_t return const char size_t return const char size_t return char return char return const char int return int char int return long char int return Sint64 char int return const char return const char char int return const char char int return const char char return const char const char size_t return const char const char size_t return double return double return double return double return double return double return double int return float return const char const char return SDL_iconv_t const char size_t char size_t return Uint32 int int int Uint32 Uint32 Uint32 Uint32 return SDL_Surface SDL_Surface return SDL_RWops int return SDL_Surface int return SDL_Surface Uint32 return SDL_Surface Uint8 Uint8 Uint8 return SDL_Surface Uint8 return SDL_Surface SDL_BlendMode return SDL_Surface SDL_Rect SDL_Surface Uint32 Uint32 return SDL_Surface const SDL_Rect Uint32 return SDL_Surface const SDL_Rect SDL_Surface SDL_Rect return SDL_Surface const SDL_Rect SDL_Surface const SDL_Rect return SDL_Surface SDL_Rect SDL_Surface SDL_Rect return SDL_Thread return SDL_Thread return SDL_Thread int return SDL_TLSID const void void(*) return return Uint32 SDL_TimerID return int return SDL_TouchID int return return return const char return return int return int return int SDL_DisplayMode return int const SDL_DisplayMode SDL_DisplayMode return SDL_Window const SDL_DisplayMode return SDL_Window return const void return Uint32 return SDL_Window const char SDL_Window SDL_Surface SDL_Window const char return SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window int int SDL_Window SDL_Window SDL_Window SDL_Window Uint32 return SDL_Window return SDL_Window SDL_bool SDL_Window float return SDL_Window const Uint16 const Uint16 const Uint16 return SDL_Window const char return SDL_GLattr int return SDL_Window return return SDL_Window int int return SDL_GLContext SDL_RWops int return return void return int int return double return SDL_bool return int int return SDL_AudioDeviceID const void Uint32 return SDL_AudioDeviceID int float float float return SDL_JoystickID return int SDL_Rect return SDL_Window float return SDL_Window return SDL_Renderer SDL_bool return SDL_AudioDeviceID void Uint32 return Uint32 int int int Uint32 return const char SDL_bool return int return SDL_Joystick return SDL_Joystick return SDL_GameController return return int return int return int return SDL_RWops size_t int return SDL_BlendFactor SDL_BlendFactor SDL_BlendOperation SDL_BlendFactor SDL_BlendFactor SDL_BlendOperation return const char return SDL_Window VkInstance VkSurfaceKHR return SDL_malloc_func SDL_calloc_func SDL_realloc_func SDL_free_func return SDL_AudioStream const void int return SDL_AudioStream SDL_AudioStream float return float return float return float return float return float int return float float return return SDL_Renderer return double return int return double return const wchar_t return SDL_Joystick Uint16 Uint16 Uint32 return int return int return int return SDL_Sensor return SDL_Sensor return SDL_Sensor float int return int return SDL_ThreadFunction const char const size_t void return SDL_Joystick return SDL_Renderer return SDL_Renderer const SDL_FPoint int return SDL_Renderer const SDL_FPoint int return SDL_Renderer const SDL_FRect int return SDL_Renderer const SDL_FRect int return SDL_Renderer SDL_Texture const SDL_Rect const SDL_FRect const double const SDL_FPoint const SDL_RendererFlip return return void SDL_RWops Sint64 int return SDL_RWops void size_t size_t return SDL_RWops return SDL_Window return SDL_Texture const SDL_Rect SDL_Surface return char const char char return const wchar_t const wchar_t size_t return SDL_GameController return SDL_GameController int SDL_Joystick int SDL_Texture SDL_ScaleMode return int return int return SDL_Joystick int Sint16 return SDL_Joystick int Uint8 return SDL_MetalView return double return return const char return SDL_GameController return SDL_Joystick return SDL_GameController Uint16 Uint16 Uint32 return SDL_GameController SDL_GameControllerAxis

The list of axes available from a controller

Thumbstick axis values range from SDL_JOYSTICK_AXIS_MIN to SDL_JOYSTICK_AXIS_MAX, and are centered within ~8000 of zero, though advanced UI will allow users to set or autodetect the dead zone, which varies between controllers.

Trigger axis values range from 0 to SDL_JOYSTICK_AXIS_MAX.

Enumerator
SDL_CONTROLLER_AXIS_INVALID
SDL_CONTROLLER_AXIS_LEFTX
SDL_CONTROLLER_AXIS_LEFTY
SDL_CONTROLLER_AXIS_RIGHTX
SDL_CONTROLLER_AXIS_RIGHTY
SDL_CONTROLLER_AXIS_TRIGGERLEFT
SDL_CONTROLLER_AXIS_TRIGGERRIGHT
SDL_CONTROLLER_AXIS_MAX

Definition at line 312 of file SDL_gamecontroller.h.

{
    SDL_CONTROLLER_AXIS_INVALID = -1,
    SDL_CONTROLLER_AXIS_LEFTX,
    SDL_CONTROLLER_AXIS_LEFTY,
    SDL_CONTROLLER_AXIS_RIGHTX,
    SDL_CONTROLLER_AXIS_RIGHTY,
    SDL_CONTROLLER_AXIS_TRIGGERLEFT,
    SDL_CONTROLLER_AXIS_TRIGGERRIGHT,
    SDL_CONTROLLER_AXIS_MAX
} SDL_GameControllerAxis;

SDL_GameControllerBindType

enum SDL_GameControllerBindType

Enumerator
SDL_CONTROLLER_BINDTYPE_NONE
SDL_CONTROLLER_BINDTYPE_BUTTON
SDL_CONTROLLER_BINDTYPE_AXIS
SDL_CONTROLLER_BINDTYPE_HAT

Definition at line 73 of file SDL_gamecontroller.h.

{
    SDL_CONTROLLER_BINDTYPE_NONE = 0,
    SDL_CONTROLLER_BINDTYPE_BUTTON,
    SDL_CONTROLLER_BINDTYPE_AXIS,
    SDL_CONTROLLER_BINDTYPE_HAT
} SDL_GameControllerBindType;

SDL_GameControllerButton

enum SDL_GameControllerButton

The list of buttons available from a controller

Enumerator
SDL_CONTROLLER_BUTTON_INVALID
SDL_CONTROLLER_BUTTON_A
SDL_CONTROLLER_BUTTON_B
SDL_CONTROLLER_BUTTON_X
SDL_CONTROLLER_BUTTON_Y
SDL_CONTROLLER_BUTTON_BACK
SDL_CONTROLLER_BUTTON_GUIDE
SDL_CONTROLLER_BUTTON_START
SDL_CONTROLLER_BUTTON_LEFTSTICK
SDL_CONTROLLER_BUTTON_RIGHTSTICK
SDL_CONTROLLER_BUTTON_LEFTSHOULDER
SDL_CONTROLLER_BUTTON_RIGHTSHOULDER
SDL_CONTROLLER_BUTTON_DPAD_UP
SDL_CONTROLLER_BUTTON_DPAD_DOWN
SDL_CONTROLLER_BUTTON_DPAD_LEFT
SDL_CONTROLLER_BUTTON_DPAD_RIGHT
SDL_CONTROLLER_BUTTON_MISC1
SDL_CONTROLLER_BUTTON_PADDLE1
SDL_CONTROLLER_BUTTON_PADDLE2
SDL_CONTROLLER_BUTTON_PADDLE3
SDL_CONTROLLER_BUTTON_PADDLE4
SDL_CONTROLLER_BUTTON_TOUCHPAD
SDL_CONTROLLER_BUTTON_MAX

Definition at line 361 of file SDL_gamecontroller.h.

{
    SDL_CONTROLLER_BUTTON_INVALID = -1,
    SDL_CONTROLLER_BUTTON_A,
    SDL_CONTROLLER_BUTTON_B,
    SDL_CONTROLLER_BUTTON_X,
    SDL_CONTROLLER_BUTTON_Y,
    SDL_CONTROLLER_BUTTON_BACK,
    SDL_CONTROLLER_BUTTON_GUIDE,
    SDL_CONTROLLER_BUTTON_START,
    SDL_CONTROLLER_BUTTON_LEFTSTICK,
    SDL_CONTROLLER_BUTTON_RIGHTSTICK,
    SDL_CONTROLLER_BUTTON_LEFTSHOULDER,
    SDL_CONTROLLER_BUTTON_RIGHTSHOULDER,
    SDL_CONTROLLER_BUTTON_DPAD_UP,
    SDL_CONTROLLER_BUTTON_DPAD_DOWN,
    SDL_CONTROLLER_BUTTON_DPAD_LEFT,
    SDL_CONTROLLER_BUTTON_DPAD_RIGHT,
    SDL_CONTROLLER_BUTTON_MISC1,    /* Xbox Series X share button, PS5 microphone button, Nintendo Switch Pro capture button */
    SDL_CONTROLLER_BUTTON_PADDLE1,  /* Xbox Elite paddle P1 */
    SDL_CONTROLLER_BUTTON_PADDLE2,  /* Xbox Elite paddle P3 */
    SDL_CONTROLLER_BUTTON_PADDLE3,  /* Xbox Elite paddle P2 */
    SDL_CONTROLLER_BUTTON_PADDLE4,  /* Xbox Elite paddle P4 */
    SDL_CONTROLLER_BUTTON_TOUCHPAD, /* PS4/PS5 touchpad button */
    SDL_CONTROLLER_BUTTON_MAX
} SDL_GameControllerButton;

SDL_GameControllerType

enum SDL_GameControllerType

Enumerator
SDL_CONTROLLER_TYPE_UNKNOWN
SDL_CONTROLLER_TYPE_XBOX360
SDL_CONTROLLER_TYPE_XBOXONE
SDL_CONTROLLER_TYPE_PS3
SDL_CONTROLLER_TYPE_PS4
SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_PRO
SDL_CONTROLLER_TYPE_VIRTUAL
SDL_CONTROLLER_TYPE_PS5

Definition at line 61 of file SDL_gamecontroller.h.

{
    SDL_CONTROLLER_TYPE_UNKNOWN = 0,
    SDL_CONTROLLER_TYPE_XBOX360,
    SDL_CONTROLLER_TYPE_XBOXONE,
    SDL_CONTROLLER_TYPE_PS3,
    SDL_CONTROLLER_TYPE_PS4,
    SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_PRO,
    SDL_CONTROLLER_TYPE_VIRTUAL,
    SDL_CONTROLLER_TYPE_PS5
} SDL_GameControllerType;

Function Documentation

SDL_GameControllerAddMapping()

int SDL_GameControllerAddMapping

(

const char *

mappingString

)

Add or update an existing mapping configuration

Returns

1 if mapping is added, 0 if updated, -1 on error

Definition at line 1455 of file SDL_gamecontroller.c.

{
    return SDL_PrivateGameControllerAddMapping(mappingString, SDL_CONTROLLER_MAPPING_PRIORITY_API);
}

References SDL_CONTROLLER_MAPPING_PRIORITY_API, and SDL_PrivateGameControllerAddMapping().

Referenced by SDL_GameControllerAddMappingsFromRW().

SDL_GameControllerAddMappingsFromRW()

int SDL_GameControllerAddMappingsFromRW	(	SDL_RWops *	rw,
		int	freerw
	)

To count the number of game controllers in the system for the following: int nJoysticks = SDL_NumJoysticks(); int nGameControllers = 0; for (int i = 0; i < nJoysticks; i++) { if (SDL_IsGameController(i)) { nGameControllers++; } }

Using the SDL_HINT_GAMECONTROLLERCONFIG hint or the SDL_GameControllerAddMapping() you can add support for controllers SDL is unaware of or cause an existing controller to have a different binding. The format is: guid,name,mappings

Where GUID is the string value from SDL_JoystickGetGUIDString(), name is the human readable string for the device and mappings are controller mappings to joystick ones. Under Windows there is a reserved GUID of "xinput" that covers any XInput devices. The mapping format for joystick is: bX - a joystick button, index X hX.Y - hat X with value Y aX - axis X of the joystick Buttons can be used as a controller axis and vice versa.

This string shows an example of a valid mapping for a controller "03000000341a00003608000000000000,PS3 Controller,a:b1,b:b2,y:b3,x:b0,start:b9,guide:b12,back:b8,dpup:h0.1,dpleft:h0.8,dpdown:h0.4,dpright:h0.2,leftshoulder:b4,rightshoulder:b5,leftstick:b10,rightstick:b11,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:b6,righttrigger:b7", Load a set of mappings from a seekable SDL data stream (memory or file), filtered by the current SDL_GetPlatform() A community sourced database of controllers is available at https://raw.github.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt

If freerw is non-zero, the stream will be closed after being read.

Returns

number of mappings added, -1 on error

Definition at line 1276 of file SDL_gamecontroller.c.

{
    const char *platform = SDL_GetPlatform();
    int controllers = 0;
    char *buf, *line, *line_end, *tmp, *comma, line_platform[64];
    size_t db_size, platform_len;
    
    if (rw == NULL) {
        return SDL_SetError("Invalid RWops");
    }
    db_size = (size_t)SDL_RWsize(rw);
    
    buf = (char *)SDL_malloc(db_size + 1);
    if (buf == NULL) {
        if (freerw) {
            SDL_RWclose(rw);
        }
        return SDL_SetError("Could not allocate space to read DB into memory");
    }
    
    if (SDL_RWread(rw, buf, db_size, 1) != 1) {
        if (freerw) {
            SDL_RWclose(rw);
        }
        SDL_free(buf);
        return SDL_SetError("Could not read DB");
    }
    
    if (freerw) {
        SDL_RWclose(rw);
    }
    
    buf[db_size] = '\0';
    line = buf;
    
    while (line < buf + db_size) {
        line_end = SDL_strchr(line, '\n');
        if (line_end != NULL) {
            *line_end = '\0';
        } else {
            line_end = buf + db_size;
        }
        
        /* Extract and verify the platform */
        tmp = SDL_strstr(line, SDL_CONTROLLER_PLATFORM_FIELD);
        if (tmp != NULL) {
            tmp += SDL_strlen(SDL_CONTROLLER_PLATFORM_FIELD);
            comma = SDL_strchr(tmp, ',');
            if (comma != NULL) {
                platform_len = comma - tmp + 1;
                if (platform_len + 1 < SDL_arraysize(line_platform)) {
                    SDL_strlcpy(line_platform, tmp, platform_len);
                    if (SDL_strncasecmp(line_platform, platform, platform_len) == 0 &&
                        SDL_GameControllerAddMapping(line) > 0) {
                        controllers++;
                    }
                }
            }
        }
 
        line = line_end + 1;
    }
 
    SDL_free(buf);
    return controllers;
}

References sort_controllers::controllers, NULL, SDL_arraysize, SDL_CONTROLLER_PLATFORM_FIELD, SDL_free, SDL_GameControllerAddMapping(), SDL_GetPlatform, SDL_malloc, SDL_RWclose, SDL_RWread, SDL_RWsize, SDL_SetError, SDL_strchr, SDL_strlcpy, SDL_strlen, SDL_strncasecmp, and SDL_strstr.

SDL_GameControllerClose()

void SDL_GameControllerClose

(

SDL_GameController *

gamecontroller

)

Close a controller previously opened with SDL_GameControllerOpen().

Definition at line 2393 of file SDL_gamecontroller.c.

{
    SDL_GameController *gamecontrollerlist, *gamecontrollerlistprev;
 
    if (!gamecontroller)
        return;
 
    SDL_LockJoysticks();
 
    /* First decrement ref count */
    if (--gamecontroller->ref_count > 0) {
        SDL_UnlockJoysticks();
        return;
    }
 
    SDL_JoystickClose(gamecontroller->joystick);
 
    gamecontrollerlist = SDL_gamecontrollers;
    gamecontrollerlistprev = NULL;
    while (gamecontrollerlist) {
        if (gamecontroller == gamecontrollerlist) {
            if (gamecontrollerlistprev) {
                /* unlink this entry */
                gamecontrollerlistprev->next = gamecontrollerlist->next;
            } else {
                SDL_gamecontrollers = gamecontroller->next;
            }
            break;
        }
        gamecontrollerlistprev = gamecontrollerlist;
        gamecontrollerlist = gamecontrollerlist->next;
    }
 
    SDL_free(gamecontroller->bindings);
    SDL_free(gamecontroller->last_match_axis);
    SDL_free(gamecontroller->last_hat_mask);
    SDL_free(gamecontroller);
 
    SDL_UnlockJoysticks();
}

References gamecontroller, NULL, SDL_free, SDL_gamecontrollers, SDL_JoystickClose, SDL_LockJoysticks, and SDL_UnlockJoysticks.

Referenced by SDL_GameControllerQuit().

SDL_GameControllerEventState()

int SDL_GameControllerEventState

(

int

state

)

Enable/disable controller event polling.

If controller events are disabled, you must call SDL_GameControllerUpdate() yourself and check the state of the controller when you want controller information.

The state can be one of SDL_QUERY, SDL_ENABLE or SDL_IGNORE.

Definition at line 2564 of file SDL_gamecontroller.c.

{
#if SDL_EVENTS_DISABLED
    return SDL_IGNORE;
#else
    const Uint32 event_list[] = {
        SDL_CONTROLLERAXISMOTION, SDL_CONTROLLERBUTTONDOWN, SDL_CONTROLLERBUTTONUP,
        SDL_CONTROLLERDEVICEADDED, SDL_CONTROLLERDEVICEREMOVED, SDL_CONTROLLERDEVICEREMAPPED,
    };
    unsigned int i;
 
    switch (state) {
    case SDL_QUERY:
        state = SDL_IGNORE;
        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_CONTROLLERAXISMOTION, SDL_CONTROLLERBUTTONDOWN, SDL_CONTROLLERBUTTONUP, SDL_CONTROLLERDEVICEADDED, SDL_CONTROLLERDEVICEREMAPPED, SDL_CONTROLLERDEVICEREMOVED, SDL_ENABLE, SDL_EventState, SDL_IGNORE, SDL_QUERY, and state.

SDL_GameControllerFromInstanceID()

SDL_GameController* SDL_GameControllerFromInstanceID

(

SDL_JoystickID

joyid

)

Return the SDL_GameController associated with an instance id.

Definition at line 2274 of file SDL_gamecontroller.c.

{
    SDL_GameController *gamecontroller;
 
    SDL_LockJoysticks();
    gamecontroller = SDL_gamecontrollers;
    while (gamecontroller) {
        if (gamecontroller->joystick->instance_id == joyid) {
            SDL_UnlockJoysticks();
            return gamecontroller;
        }
        gamecontroller = gamecontroller->next;
    }
    SDL_UnlockJoysticks();
    return NULL;
}

References gamecontroller, NULL, SDL_gamecontrollers, SDL_LockJoysticks, and SDL_UnlockJoysticks.

Referenced by SDL_GameControllerFromPlayerIndex().

SDL_GameControllerFromPlayerIndex()

SDL_GameController* SDL_GameControllerFromPlayerIndex

(

int

player_index

)

Return the SDL_GameController associated with a player index.

Definition at line 2295 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_JoystickFromPlayerIndex(player_index);
    if (joystick) {
        return SDL_GameControllerFromInstanceID(joystick->instance_id);
    }
    return NULL;
}

References joystick, NULL, SDL_GameControllerFromInstanceID(), and SDL_JoystickFromPlayerIndex.

SDL_GameControllerGetAttached()

SDL_bool SDL_GameControllerGetAttached

(

SDL_GameController *

gamecontroller

)

Returns SDL_TRUE if the controller has been opened and currently connected, or SDL_FALSE if it has not.

Definition at line 2249 of file SDL_gamecontroller.c.

{
    if (!gamecontroller)
        return SDL_FALSE;
 
    return SDL_JoystickGetAttached(gamecontroller->joystick);
}

References gamecontroller, SDL_FALSE, and SDL_JoystickGetAttached.

SDL_GameControllerGetAxis()

Sint16 SDL_GameControllerGetAxis	(	SDL_GameController *	gamecontroller,
		SDL_GameControllerAxis	axis
	)

Get the current state of an axis control on a game controller.

The state is a value ranging from -32768 to 32767 (except for the triggers, which range from 0 to 32767).

The axis indices start at index 0.

Definition at line 1910 of file SDL_gamecontroller.c.

{
    int i;
 
    if (!gamecontroller)
        return 0;
 
    for (i = 0; i < gamecontroller->num_bindings; ++i) {
        SDL_ExtendedGameControllerBind *binding = &gamecontroller->bindings[i];
        if (binding->outputType == SDL_CONTROLLER_BINDTYPE_AXIS && binding->output.axis.axis == axis) {
            int value = 0;
            SDL_bool valid_input_range;
            SDL_bool valid_output_range;
 
            if (binding->inputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
                value = SDL_JoystickGetAxis(gamecontroller->joystick, binding->input.axis.axis);
                if (binding->input.axis.axis_min < binding->input.axis.axis_max) {
                    valid_input_range = (value >= binding->input.axis.axis_min && value <= binding->input.axis.axis_max);
                } else {
                    valid_input_range = (value >= binding->input.axis.axis_max && value <= binding->input.axis.axis_min);
                }
                if (valid_input_range) {
                    if (binding->input.axis.axis_min != binding->output.axis.axis_min || binding->input.axis.axis_max != binding->output.axis.axis_max) {
                        float normalized_value = (float)(value - binding->input.axis.axis_min) / (binding->input.axis.axis_max - binding->input.axis.axis_min);
                        value = binding->output.axis.axis_min + (int)(normalized_value * (binding->output.axis.axis_max - binding->output.axis.axis_min));
                    }
                } else {
                    value = 0;
                }
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_BUTTON) {
                value = SDL_JoystickGetButton(gamecontroller->joystick, binding->input.button);
                if (value == SDL_PRESSED) {
                    value = binding->output.axis.axis_max;
                }
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_HAT) {
                int hat_mask = SDL_JoystickGetHat(gamecontroller->joystick, binding->input.hat.hat);
                if (hat_mask & binding->input.hat.hat_mask) {
                    value = binding->output.axis.axis_max;
                }
            }
 
            if (binding->output.axis.axis_min < binding->output.axis.axis_max) {
                valid_output_range = (value >= binding->output.axis.axis_min && value <= binding->output.axis.axis_max);
            } else {
                valid_output_range = (value >= binding->output.axis.axis_max && value <= binding->output.axis.axis_min);
            }
            /* If the value is zero, there might be another binding that makes it non-zero */
            if (value != 0 && valid_output_range) {
                return (Sint16)value;
            }
        }
    }
    return 0;
}

References SDL_ExtendedGameControllerBind::axis, axis, SDL_ExtendedGameControllerBind::button, gamecontroller, SDL_ExtendedGameControllerBind::hat, i, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, int(), SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_BUTTON, SDL_CONTROLLER_BINDTYPE_HAT, SDL_JoystickGetAxis, SDL_JoystickGetButton, SDL_JoystickGetHat, and SDL_PRESSED.

Referenced by RecenterGameController().

SDL_GameControllerGetAxisFromString()

SDL_GameControllerAxis SDL_GameControllerGetAxisFromString

(

const char *

pchString

)

turn this string into a axis mapping

Definition at line 687 of file SDL_gamecontroller.c.

{
    int entry;
 
    if (pchString && (*pchString == '+' || *pchString == '-')) {
        ++pchString;
    }
 
    if (!pchString || !pchString[0]) {
        return SDL_CONTROLLER_AXIS_INVALID;
    }
 
    for (entry = 0; map_StringForControllerAxis[entry]; ++entry) {
        if (!SDL_strcasecmp(pchString, map_StringForControllerAxis[entry]))
            return (SDL_GameControllerAxis) entry;
    }
    return SDL_CONTROLLER_AXIS_INVALID;
}

References map_StringForControllerAxis, SDL_CONTROLLER_AXIS_INVALID, and SDL_strcasecmp.

Referenced by SDL_PrivateGameControllerParseElement().

SDL_GameControllerGetBindForAxis()

SDL_GameControllerButtonBind SDL_GameControllerGetBindForAxis	(	SDL_GameController *	gamecontroller,
		SDL_GameControllerAxis	axis
	)

Get the SDL joystick layer binding for this controller button mapping

Definition at line 2308 of file SDL_gamecontroller.c.

{
    int i;
    SDL_GameControllerButtonBind bind;
    SDL_zero(bind);
 
    if (!gamecontroller || axis == SDL_CONTROLLER_AXIS_INVALID)
        return bind;
 
    for (i = 0; i < gamecontroller->num_bindings; ++i) {
        SDL_ExtendedGameControllerBind *binding = &gamecontroller->bindings[i];
        if (binding->outputType == SDL_CONTROLLER_BINDTYPE_AXIS && binding->output.axis.axis == axis) {
            bind.bindType = binding->inputType;
            if (binding->inputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
                /* FIXME: There might be multiple axes bound now that we have axis ranges... */
                bind.value.axis = binding->input.axis.axis;
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_BUTTON) {
                bind.value.button = binding->input.button;
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_HAT) {
                bind.value.hat.hat = binding->input.hat.hat;
                bind.value.hat.hat_mask = binding->input.hat.hat_mask;
            }
            break;
        }
    }
    return bind;
}

References SDL_GameControllerButtonBind::axis, SDL_ExtendedGameControllerBind::axis, axis, SDL_GameControllerButtonBind::bindType, SDL_GameControllerButtonBind::button, SDL_ExtendedGameControllerBind::button, gamecontroller, SDL_GameControllerButtonBind::hat, SDL_ExtendedGameControllerBind::hat, i, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, SDL_CONTROLLER_AXIS_INVALID, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_BUTTON, SDL_CONTROLLER_BINDTYPE_HAT, SDL_zero, and SDL_GameControllerButtonBind::value.

Referenced by SDL_GameControllerHasAxis().

SDL_GameControllerGetBindForButton()

SDL_GameControllerButtonBind SDL_GameControllerGetBindForButton	(	SDL_GameController *	gamecontroller,
		SDL_GameControllerButton	button
	)

Get the SDL joystick layer binding for this controller button mapping

Definition at line 2340 of file SDL_gamecontroller.c.

{
    int i;
    SDL_GameControllerButtonBind bind;
    SDL_zero(bind);
 
    if (!gamecontroller || button == SDL_CONTROLLER_BUTTON_INVALID)
        return bind;
 
    for (i = 0; i < gamecontroller->num_bindings; ++i) {
        SDL_ExtendedGameControllerBind *binding = &gamecontroller->bindings[i];
        if (binding->outputType == SDL_CONTROLLER_BINDTYPE_BUTTON && binding->output.button == button) {
            bind.bindType = binding->inputType;
            if (binding->inputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
                bind.value.axis = binding->input.axis.axis;
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_BUTTON) {
                bind.value.button = binding->input.button;
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_HAT) {
                bind.value.hat.hat = binding->input.hat.hat;
                bind.value.hat.hat_mask = binding->input.hat.hat_mask;
            }
            break;
        }
    }
    return bind;
}

References SDL_GameControllerButtonBind::axis, SDL_ExtendedGameControllerBind::axis, SDL_GameControllerButtonBind::bindType, SDL_GameControllerButtonBind::button, SDL_ExtendedGameControllerBind::button, button, gamecontroller, SDL_GameControllerButtonBind::hat, SDL_ExtendedGameControllerBind::hat, i, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_BUTTON, SDL_CONTROLLER_BINDTYPE_HAT, SDL_CONTROLLER_BUTTON_INVALID, SDL_zero, and SDL_GameControllerButtonBind::value.

Referenced by SDL_GameControllerHasButton().

SDL_GameControllerGetButton()

Uint8 SDL_GameControllerGetButton	(	SDL_GameController *	gamecontroller,
		SDL_GameControllerButton	button
	)

Get the current state of a button on a game controller.

The button indices start at index 0.

Definition at line 1979 of file SDL_gamecontroller.c.

{
    int i;
 
    if (!gamecontroller)
        return 0;
 
    for (i = 0; i < gamecontroller->num_bindings; ++i) {
        SDL_ExtendedGameControllerBind *binding = &gamecontroller->bindings[i];
        if (binding->outputType == SDL_CONTROLLER_BINDTYPE_BUTTON && binding->output.button == button) {
            if (binding->inputType == SDL_CONTROLLER_BINDTYPE_AXIS) {
                SDL_bool valid_input_range;
 
                int value = SDL_JoystickGetAxis(gamecontroller->joystick, binding->input.axis.axis);
                int threshold = binding->input.axis.axis_min + (binding->input.axis.axis_max - binding->input.axis.axis_min) / 2;
                if (binding->input.axis.axis_min < binding->input.axis.axis_max) {
                    valid_input_range = (value >= binding->input.axis.axis_min && value <= binding->input.axis.axis_max);
                    if (valid_input_range) {
                        return (value >= threshold) ? SDL_PRESSED : SDL_RELEASED;
                    }
                } else {
                    valid_input_range = (value >= binding->input.axis.axis_max && value <= binding->input.axis.axis_min);
                    if (valid_input_range) {
                        return (value <= threshold) ? SDL_PRESSED : SDL_RELEASED;
                    }
                }
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_BUTTON) {
                return SDL_JoystickGetButton(gamecontroller->joystick, binding->input.button);
            } else if (binding->inputType == SDL_CONTROLLER_BINDTYPE_HAT) {
                int hat_mask = SDL_JoystickGetHat(gamecontroller->joystick, binding->input.hat.hat);
                return (hat_mask & binding->input.hat.hat_mask) ? SDL_PRESSED : SDL_RELEASED;
            }
        }
    }
    return SDL_RELEASED;
}

References SDL_ExtendedGameControllerBind::axis, SDL_ExtendedGameControllerBind::button, button, gamecontroller, SDL_ExtendedGameControllerBind::hat, i, SDL_ExtendedGameControllerBind::input, SDL_ExtendedGameControllerBind::inputType, SDL_ExtendedGameControllerBind::output, SDL_ExtendedGameControllerBind::outputType, SDL_CONTROLLER_BINDTYPE_AXIS, SDL_CONTROLLER_BINDTYPE_BUTTON, SDL_CONTROLLER_BINDTYPE_HAT, SDL_JoystickGetAxis, SDL_JoystickGetButton, SDL_JoystickGetHat, SDL_PRESSED, and SDL_RELEASED.

Referenced by RecenterGameController().

SDL_GameControllerGetButtonFromString()

SDL_GameControllerButton SDL_GameControllerGetButtonFromString

(

const char *

pchString

)

turn this string into a button mapping

Definition at line 745 of file SDL_gamecontroller.c.

{
    int entry;
    if (!pchString || !pchString[0])
        return SDL_CONTROLLER_BUTTON_INVALID;
 
    for (entry = 0; map_StringForControllerButton[entry]; ++entry) {
        if (SDL_strcasecmp(pchString, map_StringForControllerButton[entry]) == 0)
            return (SDL_GameControllerButton) entry;
    }
    return SDL_CONTROLLER_BUTTON_INVALID;
}

References map_StringForControllerButton, SDL_CONTROLLER_BUTTON_INVALID, and SDL_strcasecmp.

Referenced by SDL_PrivateGameControllerParseElement().

SDL_GameControllerGetJoystick()

SDL_Joystick* SDL_GameControllerGetJoystick

(

SDL_GameController *

gamecontroller

)

Get the underlying joystick object used by a controller

Definition at line 2261 of file SDL_gamecontroller.c.

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

References gamecontroller, and NULL.

Referenced by SDL_GameControllerGetNumTouchpadFingers(), SDL_GameControllerGetNumTouchpads(), SDL_GameControllerGetPlayerIndex(), SDL_GameControllerGetProduct(), SDL_GameControllerGetProductVersion(), SDL_GameControllerGetSensorData(), SDL_GameControllerGetSerial(), SDL_GameControllerGetTouchpadFinger(), SDL_GameControllerGetType(), SDL_GameControllerGetVendor(), SDL_GameControllerHasLED(), SDL_GameControllerHasSensor(), SDL_GameControllerIsSensorEnabled(), SDL_GameControllerName(), SDL_GameControllerRumble(), SDL_GameControllerRumbleTriggers(), SDL_GameControllerSetLED(), SDL_GameControllerSetPlayerIndex(), and SDL_GameControllerSetSensorEnabled().

SDL_GameControllerGetNumTouchpadFingers()

int SDL_GameControllerGetNumTouchpadFingers	(	SDL_GameController *	gamecontroller,
		int	touchpad
	)

Get the number of supported simultaneous fingers on a touchpad on a game controller.

Definition at line 2033 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
 
    if (joystick && touchpad >= 0 && touchpad < joystick->ntouchpads) {
        return joystick->touchpads[touchpad].nfingers;
    }
    return 0;
}

References gamecontroller, joystick, and SDL_GameControllerGetJoystick().

SDL_GameControllerGetNumTouchpads()

int SDL_GameControllerGetNumTouchpads

(

SDL_GameController *

gamecontroller

)

Get the number of touchpads on a game controller.

Definition at line 2020 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
 
    if (joystick) {
        return joystick->ntouchpads;
    }
    return 0;
}

References gamecontroller, joystick, and SDL_GameControllerGetJoystick().

SDL_GameControllerGetPlayerIndex()

int SDL_GameControllerGetPlayerIndex

(

SDL_GameController *

gamecontroller

)

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

For XInput controllers this returns the XInput user index.

Definition at line 2206 of file SDL_gamecontroller.c.

{
    return SDL_JoystickGetPlayerIndex(SDL_GameControllerGetJoystick(gamecontroller));
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickGetPlayerIndex.

SDL_GameControllerGetProduct()

Uint16 SDL_GameControllerGetProduct

(

SDL_GameController *

gamecontroller

)

Get the USB product ID of an opened controller, if available. If the product ID isn't available this function returns 0.

Definition at line 2227 of file SDL_gamecontroller.c.

{
    return SDL_JoystickGetProduct(SDL_GameControllerGetJoystick(gamecontroller));
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickGetProduct.

SDL_GameControllerGetProductVersion()

Uint16 SDL_GameControllerGetProductVersion

(

SDL_GameController *

gamecontroller

)

Get the product version of an opened controller, if available. If the product version isn't available this function returns 0.

Definition at line 2233 of file SDL_gamecontroller.c.

{
    return SDL_JoystickGetProductVersion(SDL_GameControllerGetJoystick(gamecontroller));
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickGetProductVersion.

SDL_GameControllerGetSensorData()

int SDL_GameControllerGetSensorData	(	SDL_GameController *	gamecontroller,
		SDL_SensorType	type,
		float *	data,
		int	num_values
	)

Get the current state of a game controller sensor.

The number of values and interpretation of the data is sensor dependent. See SDL_sensor.h for the details for each type of sensor.

Parameters

gamecontroller	The controller to query
type	The type of sensor to query
data	A pointer filled with the current sensor state
num_values	The number of values to write to data

Returns

0 or -1 if an error occurred.

Definition at line 2165 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
    int i;
 
    if (!joystick) {
        return SDL_InvalidParamError("gamecontroller");
    }
 
    for (i = 0; i < joystick->nsensors; ++i) {
        SDL_JoystickSensorInfo *sensor = &joystick->sensors[i];
 
        if (sensor->type == type) {
            num_values = SDL_min(num_values, SDL_arraysize(sensor->data));
            SDL_memcpy(data, sensor->data, num_values*sizeof(*data));
            return 0;
        }
    }
    return SDL_Unsupported();
}

References SDL_JoystickSensorInfo::data, gamecontroller, i, joystick, SDL_arraysize, SDL_GameControllerGetJoystick(), SDL_InvalidParamError, SDL_memcpy, SDL_min, SDL_Unsupported, and SDL_JoystickSensorInfo::type.

SDL_GameControllerGetSerial()

const char* SDL_GameControllerGetSerial

(

SDL_GameController *

gamecontroller

)

Get the serial number of an opened controller, if available.

Returns the serial number of the controller, or NULL if it is not available.

Definition at line 2239 of file SDL_gamecontroller.c.

{
    return SDL_JoystickGetSerial(SDL_GameControllerGetJoystick(gamecontroller));
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickGetSerial.

SDL_GameControllerGetStringForAxis()

const char* SDL_GameControllerGetStringForAxis

(

SDL_GameControllerAxis

axis

)

turn this axis enum into a string mapping

Definition at line 709 of file SDL_gamecontroller.c.

{
    if (axis > SDL_CONTROLLER_AXIS_INVALID && axis < SDL_CONTROLLER_AXIS_MAX) {
        return map_StringForControllerAxis[axis];
    }
    return NULL;
}

References axis, map_StringForControllerAxis, NULL, SDL_CONTROLLER_AXIS_INVALID, and SDL_CONTROLLER_AXIS_MAX.

SDL_GameControllerGetStringForButton()

const char* SDL_GameControllerGetStringForButton

(

SDL_GameControllerButton

button

)

turn this button enum into a string mapping

Definition at line 761 of file SDL_gamecontroller.c.

{
    if (axis > SDL_CONTROLLER_BUTTON_INVALID && axis < SDL_CONTROLLER_BUTTON_MAX) {
        return map_StringForControllerButton[axis];
    }
    return NULL;
}

References axis, map_StringForControllerButton, NULL, SDL_CONTROLLER_BUTTON_INVALID, and SDL_CONTROLLER_BUTTON_MAX.

SDL_GameControllerGetTouchpadFinger()

int SDL_GameControllerGetTouchpadFinger	(	SDL_GameController *	gamecontroller,
		int	touchpad,
		int	finger,
		Uint8 *	state,
		float *	x,
		float *	y,
		float *	pressure
	)

Get the current state of a finger on a touchpad on a game controller.

Definition at line 2047 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
 
    if (joystick ) {
        if (touchpad >= 0 && touchpad < joystick->ntouchpads) {
            SDL_JoystickTouchpadInfo *touchpad_info = &joystick->touchpads[touchpad];
            if (finger >= 0 && finger < touchpad_info->nfingers) {
                SDL_JoystickTouchpadFingerInfo *info = &touchpad_info->fingers[finger];
 
                if (state) {
                    *state = info->state;
                }
                if (x) {
                    *x = info->x;
                }
                if (y) {
                    *y = info->y;
                }
                if (pressure) {
                    *pressure = info->pressure;
                }
                return 0;
            } else {
                return SDL_InvalidParamError("finger");
            }
        } else {
            return SDL_InvalidParamError("touchpad");
        }
    } else {
        return SDL_InvalidParamError("gamecontroller");
    }
}

References SDL_JoystickTouchpadInfo::fingers, gamecontroller, joystick, SDL_JoystickTouchpadFingerInfo::pressure, SDL_GameControllerGetJoystick(), SDL_InvalidParamError, SDL_JoystickTouchpadFingerInfo::state, state, SDL_JoystickTouchpadFingerInfo::x, and SDL_JoystickTouchpadFingerInfo::y.

SDL_GameControllerGetType()

SDL_GameControllerType SDL_GameControllerGetType

(

SDL_GameController *

gamecontroller

)

Return the type of this currently opened controller

Definition at line 2200 of file SDL_gamecontroller.c.

{
    return SDL_GetJoystickGameControllerTypeFromGUID(SDL_JoystickGetGUID(SDL_GameControllerGetJoystick(gamecontroller)), SDL_JoystickName(SDL_GameControllerGetJoystick(gamecontroller)));
}

References gamecontroller, SDL_GameControllerGetJoystick(), SDL_GetJoystickGameControllerTypeFromGUID(), SDL_JoystickGetGUID, and SDL_JoystickName.

SDL_GameControllerGetVendor()

Uint16 SDL_GameControllerGetVendor

(

SDL_GameController *

gamecontroller

)

Get the USB vendor ID of an opened controller, if available. If the vendor ID isn't available this function returns 0.

Definition at line 2221 of file SDL_gamecontroller.c.

{
    return SDL_JoystickGetVendor(SDL_GameControllerGetJoystick(gamecontroller));
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickGetVendor.

SDL_GameControllerHasAxis()

SDL_bool SDL_GameControllerHasAxis	(	SDL_GameController *	gamecontroller,
		SDL_GameControllerAxis	axis
	)

Return whether a game controller has a given axis

Definition at line 1900 of file SDL_gamecontroller.c.

{
    SDL_GameControllerButtonBind bind = SDL_GameControllerGetBindForAxis(gamecontroller, axis);
    return (bind.bindType != SDL_CONTROLLER_BINDTYPE_NONE) ? SDL_TRUE : SDL_FALSE;
}

References axis, SDL_GameControllerButtonBind::bindType, gamecontroller, SDL_CONTROLLER_BINDTYPE_NONE, SDL_FALSE, SDL_GameControllerGetBindForAxis(), and SDL_TRUE.

SDL_GameControllerHasButton()

SDL_bool SDL_GameControllerHasButton	(	SDL_GameController *	gamecontroller,
		SDL_GameControllerButton	button
	)

Return whether a game controller has a given button

Definition at line 1969 of file SDL_gamecontroller.c.

{
    SDL_GameControllerButtonBind bind = SDL_GameControllerGetBindForButton(gamecontroller, button);
    return (bind.bindType != SDL_CONTROLLER_BINDTYPE_NONE) ? SDL_TRUE : SDL_FALSE;
}

References SDL_GameControllerButtonBind::bindType, button, gamecontroller, SDL_CONTROLLER_BINDTYPE_NONE, SDL_FALSE, SDL_GameControllerGetBindForButton(), and SDL_TRUE.

SDL_GameControllerHasLED()

SDL_bool SDL_GameControllerHasLED

(

SDL_GameController *

gamecontroller

)

Return whether a controller has an LED

Parameters

gamecontroller

The controller to query

Returns

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

Definition at line 2381 of file SDL_gamecontroller.c.

{
    return SDL_JoystickHasLED(SDL_GameControllerGetJoystick(gamecontroller));
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickHasLED.

SDL_GameControllerHasSensor()

SDL_bool SDL_GameControllerHasSensor	(	SDL_GameController *	gamecontroller,
		SDL_SensorType	type
	)

Return whether a game controller has a particular sensor.

Parameters

gamecontroller	The controller to query
type	The type of sensor to query

Returns

SDL_TRUE if the sensor exists, SDL_FALSE otherwise.

Return whether a game controller has a particular sensor.

Definition at line 2085 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
    int i;
 
    if (joystick) {
        for (i = 0; i < joystick->nsensors; ++i) {
            if (joystick->sensors[i].type == type) {
                return SDL_TRUE;
            }
        }
    }
    return SDL_FALSE;
}

References gamecontroller, i, joystick, SDL_FALSE, SDL_GameControllerGetJoystick(), and SDL_TRUE.

SDL_GameControllerIsSensorEnabled()

SDL_bool SDL_GameControllerIsSensorEnabled	(	SDL_GameController *	gamecontroller,
		SDL_SensorType	type
	)

Query whether sensor data reporting is enabled for a game controller

Parameters

gamecontroller	The controller to query
type	The type of sensor to query

Returns

SDL_TRUE if the sensor is enabled, SDL_FALSE otherwise.

Definition at line 2146 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
    int i;
 
    if (joystick) {
        for (i = 0; i < joystick->nsensors; ++i) {
            if (joystick->sensors[i].type == type) {
                return joystick->sensors[i].enabled;
            }
        }
    }
    return SDL_FALSE;
}

References gamecontroller, i, joystick, SDL_FALSE, and SDL_GameControllerGetJoystick().

SDL_GameControllerMapping()

char* SDL_GameControllerMapping

(

SDL_GameController *

gamecontroller

)

Get a mapping string for an open GameController

Returns

the mapping string. Must be freed with SDL_free(). Returns NULL if no mapping is available

Definition at line 1539 of file SDL_gamecontroller.c.

{
    if (!gamecontroller) {
        return NULL;
    }
 
    return SDL_GameControllerMappingForGUID(gamecontroller->joystick->guid);
}

References gamecontroller, NULL, and SDL_GameControllerMappingForGUID().

SDL_GameControllerMappingForDeviceIndex()

char* SDL_GameControllerMappingForDeviceIndex

(

int

joystick_index

)

Get the mapping of a game controller. This can be called before any controllers are opened.

Returns

the mapping string. Must be freed with SDL_free(). Returns NULL if no mapping is available

Get the mapping of a game controller. This can be called before any controllers are opened. If no mapping can be found, this function returns NULL.

Definition at line 1684 of file SDL_gamecontroller.c.

{
    char *pMappingString = NULL;
    ControllerMapping_t *mapping;
 
    SDL_LockJoysticks();
    mapping = SDL_PrivateGetControllerMapping(joystick_index);
    if (mapping) {
        SDL_JoystickGUID guid;
        char pchGUID[33];
        size_t needed;
        guid = SDL_JoystickGetDeviceGUID(joystick_index);
        SDL_JoystickGetGUIDString(guid, pchGUID, sizeof(pchGUID));
        /* allocate enough memory for GUID + ',' + name + ',' + mapping + \0 */
        needed = SDL_strlen(pchGUID) + 1 + SDL_strlen(mapping->name) + 1 + SDL_strlen(mapping->mapping) + 1;
        pMappingString = SDL_malloc(needed);
        if (!pMappingString) {
            SDL_OutOfMemory();
            SDL_UnlockJoysticks();
            return NULL;
        }
        SDL_snprintf(pMappingString, needed, "%s,%s,%s", pchGUID, mapping->name, mapping->mapping);
    }
    SDL_UnlockJoysticks();
    return pMappingString;
}

References NULL, SDL_JoystickGetDeviceGUID, SDL_JoystickGetGUIDString, SDL_LockJoysticks, SDL_malloc, SDL_OutOfMemory, SDL_PrivateGetControllerMapping(), SDL_snprintf, SDL_strlen, and SDL_UnlockJoysticks.

SDL_GameControllerMappingForGUID()

char* SDL_GameControllerMappingForGUID

(

SDL_JoystickGUID

guid

)

Get a mapping string for a GUID

Returns

the mapping string. Must be freed with SDL_free(). Returns NULL if no mapping is available

Definition at line 1515 of file SDL_gamecontroller.c.

{
    char *pMappingString = NULL;
    ControllerMapping_t *mapping = SDL_PrivateGetControllerMappingForGUID(guid, SDL_FALSE);
    if (mapping) {
        char pchGUID[33];
        size_t needed;
        SDL_JoystickGetGUIDString(guid, pchGUID, sizeof(pchGUID));
        /* allocate enough memory for GUID + ',' + name + ',' + mapping + \0 */
        needed = SDL_strlen(pchGUID) + 1 + SDL_strlen(mapping->name) + 1 + SDL_strlen(mapping->mapping) + 1;
        pMappingString = SDL_malloc(needed);
        if (!pMappingString) {
            SDL_OutOfMemory();
            return NULL;
        }
        SDL_snprintf(pMappingString, needed, "%s,%s,%s", pchGUID, mapping->name, mapping->mapping);
    }
    return pMappingString;
}

References NULL, SDL_FALSE, SDL_JoystickGetGUIDString, SDL_malloc, SDL_OutOfMemory, SDL_PrivateGetControllerMappingForGUID(), SDL_snprintf, and SDL_strlen.

Referenced by SDL_GameControllerMapping().

SDL_GameControllerMappingForIndex()

char* SDL_GameControllerMappingForIndex

(

int

mapping_index

)

Get the mapping at a particular index.

Returns

the mapping string. Must be freed with SDL_free(). Returns NULL if the index is out of range.

Definition at line 1482 of file SDL_gamecontroller.c.

{
    ControllerMapping_t *mapping;
 
    for (mapping = s_pSupportedControllers; mapping; mapping = mapping->next) {
        if (SDL_memcmp(&mapping->guid, &s_zeroGUID, sizeof(mapping->guid)) == 0) {
            continue;
        }
        if (mapping_index == 0) {
            char *pMappingString;
            char pchGUID[33];
            size_t needed;
 
            SDL_JoystickGetGUIDString(mapping->guid, pchGUID, sizeof(pchGUID));
            /* allocate enough memory for GUID + ',' + name + ',' + mapping + \0 */
            needed = SDL_strlen(pchGUID) + 1 + SDL_strlen(mapping->name) + 1 + SDL_strlen(mapping->mapping) + 1;
            pMappingString = SDL_malloc(needed);
            if (!pMappingString) {
                SDL_OutOfMemory();
                return NULL;
            }
            SDL_snprintf(pMappingString, needed, "%s,%s,%s", pchGUID, mapping->name, mapping->mapping);
            return pMappingString;
        }
        --mapping_index;
    }
    return NULL;
}

References NULL, s_pSupportedControllers, s_zeroGUID, SDL_JoystickGetGUIDString, SDL_malloc, SDL_memcmp, SDL_OutOfMemory, SDL_snprintf, and SDL_strlen.

SDL_GameControllerName()

const char* SDL_GameControllerName

(

SDL_GameController *

gamecontroller

)

Return the name for this currently opened controller

Definition at line 2187 of file SDL_gamecontroller.c.

{
    if (!gamecontroller)
        return NULL;
 
    if (SDL_strcmp(gamecontroller->name, "*") == 0) {
        return SDL_JoystickName(SDL_GameControllerGetJoystick(gamecontroller));
    } else {
        return gamecontroller->name;
    }
}

References gamecontroller, NULL, SDL_GameControllerGetJoystick(), SDL_JoystickName, and SDL_strcmp.

SDL_GameControllerNameForIndex()

const char* SDL_GameControllerNameForIndex

(

int

joystick_index

)

Get the implementation dependent name of a game controller. This can be called before any controllers are opened. If no name can be found, this function returns NULL.

Definition at line 1654 of file SDL_gamecontroller.c.

{
    ControllerMapping_t *pSupportedController = SDL_PrivateGetControllerMapping(device_index);
    if (pSupportedController) {
        if (SDL_strcmp(pSupportedController->name, "*") == 0) {
            return SDL_JoystickNameForIndex(device_index);
        } else {
            return pSupportedController->name;
        }
    }
    return NULL;
}

References ControllerMapping_t::name, NULL, SDL_JoystickNameForIndex, SDL_PrivateGetControllerMapping(), and SDL_strcmp.

SDL_GameControllerNumMappings()

int SDL_GameControllerNumMappings

(

void

)

Get the number of mappings installed

Returns

the number of mappings

Definition at line 1464 of file SDL_gamecontroller.c.

{
    int num_mappings = 0;
    ControllerMapping_t *mapping;
 
    for (mapping = s_pSupportedControllers; mapping; mapping = mapping->next) {
        if (SDL_memcmp(&mapping->guid, &s_zeroGUID, sizeof(mapping->guid)) == 0) {
            continue;
        }
        ++num_mappings;
    }
    return num_mappings;
}

References s_pSupportedControllers, s_zeroGUID, and SDL_memcmp.

SDL_GameControllerOpen()

SDL_GameController* SDL_GameControllerOpen

(

int

joystick_index

)

Open a game controller for use. The index passed as an argument refers to the N'th game controller on the system. This index is not the value which will identify this controller in future controller events. The joystick's instance id (SDL_JoystickID) will be used there instead.

Returns

A controller identifier, or NULL if an error occurred.

Definition at line 1806 of file SDL_gamecontroller.c.

{
    SDL_JoystickID instance_id;
    SDL_GameController *gamecontroller;
    SDL_GameController *gamecontrollerlist;
    ControllerMapping_t *pSupportedController = NULL;
 
    SDL_LockJoysticks();
 
    gamecontrollerlist = SDL_gamecontrollers;
    /* If the controller is already open, return it */
    instance_id = SDL_JoystickGetDeviceInstanceID(device_index);
    while (gamecontrollerlist) {
        if (instance_id == gamecontrollerlist->joystick->instance_id) {
                gamecontroller = gamecontrollerlist;
                ++gamecontroller->ref_count;
                SDL_UnlockJoysticks();
                return (gamecontroller);
        }
        gamecontrollerlist = gamecontrollerlist->next;
    }
 
    /* Find a controller mapping */
    pSupportedController =  SDL_PrivateGetControllerMapping(device_index);
    if (!pSupportedController) {
        SDL_SetError("Couldn't find mapping for device (%d)", device_index);
        SDL_UnlockJoysticks();
        return NULL;
    }
 
    /* Create and initialize the controller */
    gamecontroller = (SDL_GameController *) SDL_calloc(1, sizeof(*gamecontroller));
    if (gamecontroller == NULL) {
        SDL_OutOfMemory();
        SDL_UnlockJoysticks();
        return NULL;
    }
 
    gamecontroller->joystick = SDL_JoystickOpen(device_index);
    if (!gamecontroller->joystick) {
        SDL_free(gamecontroller);
        SDL_UnlockJoysticks();
        return NULL;
    }
 
    if (gamecontroller->joystick->naxes) {
        gamecontroller->last_match_axis = (SDL_ExtendedGameControllerBind **)SDL_calloc(gamecontroller->joystick->naxes, sizeof(*gamecontroller->last_match_axis));
        if (!gamecontroller->last_match_axis) {
            SDL_OutOfMemory();
            SDL_JoystickClose(gamecontroller->joystick);
            SDL_free(gamecontroller);
            SDL_UnlockJoysticks();
            return NULL;
        }
    }
    if (gamecontroller->joystick->nhats) {
        gamecontroller->last_hat_mask = (Uint8 *)SDL_calloc(gamecontroller->joystick->nhats, sizeof(*gamecontroller->last_hat_mask));
        if (!gamecontroller->last_hat_mask) {
            SDL_OutOfMemory();
            SDL_JoystickClose(gamecontroller->joystick);
            SDL_free(gamecontroller->last_match_axis);
            SDL_free(gamecontroller);
            SDL_UnlockJoysticks();
            return NULL;
        }
    }
 
    SDL_PrivateLoadButtonMapping(gamecontroller, pSupportedController->name, pSupportedController->mapping);
 
    /* Add the controller to list */
    ++gamecontroller->ref_count;
    /* Link the controller in the list */
    gamecontroller->next = SDL_gamecontrollers;
    SDL_gamecontrollers = gamecontroller;
 
    SDL_UnlockJoysticks();
 
    return (gamecontroller);
}

References gamecontroller, ControllerMapping_t::mapping, ControllerMapping_t::name, NULL, SDL_calloc, SDL_free, SDL_gamecontrollers, SDL_JoystickClose, SDL_JoystickGetDeviceInstanceID, SDL_JoystickOpen, SDL_LockJoysticks, SDL_OutOfMemory, SDL_PrivateGetControllerMapping(), SDL_PrivateLoadButtonMapping(), SDL_SetError, and SDL_UnlockJoysticks.

SDL_GameControllerRumble()

int SDL_GameControllerRumble	(	SDL_GameController *	gamecontroller,
		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

gamecontroller	The controller 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 controller

Definition at line 2369 of file SDL_gamecontroller.c.

{
    return SDL_JoystickRumble(SDL_GameControllerGetJoystick(gamecontroller), low_frequency_rumble, high_frequency_rumble, duration_ms);
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickRumble.

SDL_GameControllerRumbleTriggers()

int SDL_GameControllerRumbleTriggers	(	SDL_GameController *	gamecontroller,
		Uint16	left_rumble,
		Uint16	right_rumble,
		Uint32	duration_ms
	)

Start a rumble effect in the game controller's triggers Each call to this function cancels any previous trigger rumble effect, and calling it with 0 intensity stops any rumbling.

Parameters

gamecontroller	The controller 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 rumble isn't supported on this controller

Definition at line 2375 of file SDL_gamecontroller.c.

{
    return SDL_JoystickRumbleTriggers(SDL_GameControllerGetJoystick(gamecontroller), left_rumble, right_rumble, duration_ms);
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickRumbleTriggers.

SDL_GameControllerSetLED()

int SDL_GameControllerSetLED	(	SDL_GameController *	gamecontroller,
		Uint8	red,
		Uint8	green,
		Uint8	blue
	)

Update a controller's LED color.

Parameters

gamecontroller	The controller 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 controller does not have a modifiable LED

Definition at line 2387 of file SDL_gamecontroller.c.

{
    return SDL_JoystickSetLED(SDL_GameControllerGetJoystick(gamecontroller), red, green, blue);
}

References gamecontroller, red, SDL_GameControllerGetJoystick(), and SDL_JoystickSetLED.

SDL_GameControllerSetPlayerIndex()

void SDL_GameControllerSetPlayerIndex	(	SDL_GameController *	gamecontroller,
		int	player_index
	)

Set the player index of an opened game controller

Definition at line 2215 of file SDL_gamecontroller.c.

{
    SDL_JoystickSetPlayerIndex(SDL_GameControllerGetJoystick(gamecontroller), player_index);
}

References gamecontroller, SDL_GameControllerGetJoystick(), and SDL_JoystickSetPlayerIndex.

SDL_GameControllerSetSensorEnabled()

int SDL_GameControllerSetSensorEnabled	(	SDL_GameController *	gamecontroller,
		SDL_SensorType	type,
		SDL_bool	enabled
	)

Set whether data reporting for a game controller sensor is enabled

Parameters

gamecontroller	The controller to update
type	The type of sensor to enable/disable
enabled	Whether data reporting should be enabled

Returns

0 or -1 if an error occurred.

Definition at line 2103 of file SDL_gamecontroller.c.

{
    SDL_Joystick *joystick = SDL_GameControllerGetJoystick(gamecontroller);
    int i;
 
    if (!joystick) {
        return SDL_InvalidParamError("gamecontroller");
    }
 
    for (i = 0; i < joystick->nsensors; ++i) {
        SDL_JoystickSensorInfo *sensor = &joystick->sensors[i];
 
        if (sensor->type == type) {
            if (sensor->enabled == enabled) {
                return 0;
            }
 
            if (enabled) {
                if (joystick->nsensors_enabled == 0) {
                    if (joystick->driver->SetSensorsEnabled(joystick, SDL_TRUE) < 0) {
                        return -1;
                    }
                }
                ++joystick->nsensors_enabled;
            } else {
                if (joystick->nsensors_enabled == 1) {
                    if (joystick->driver->SetSensorsEnabled(joystick, SDL_FALSE) < 0) {
                        return -1;
                    }
                }
                --joystick->nsensors_enabled;
            }
 
            sensor->enabled = enabled;
            return 0;
        }
    }
    return SDL_Unsupported();
}

References SDL_JoystickSensorInfo::enabled, gamecontroller, i, joystick, SDL_FALSE, SDL_GameControllerGetJoystick(), SDL_InvalidParamError, SDL_TRUE, SDL_Unsupported, and SDL_JoystickSensorInfo::type.

SDL_GameControllerTypeForIndex()

SDL_GameControllerType SDL_GameControllerTypeForIndex

(

int

joystick_index

)

Get the type of a game controller. This can be called before any controllers are opened.

Get the type of a game controller.

Definition at line 1672 of file SDL_gamecontroller.c.

{
    return SDL_GetJoystickGameControllerTypeFromGUID(SDL_JoystickGetDeviceGUID(joystick_index), SDL_JoystickNameForIndex(joystick_index));
}

References SDL_GetJoystickGameControllerTypeFromGUID(), SDL_JoystickGetDeviceGUID, and SDL_JoystickNameForIndex.

SDL_GameControllerUpdate()

void SDL_GameControllerUpdate

(

void

)

Update the current state of the open game controllers.

This is called automatically by the event loop if any game controller events are enabled.

Definition at line 1890 of file SDL_gamecontroller.c.

{
    /* Just for API completeness; the joystick API does all the work. */
    SDL_JoystickUpdate();
}

References SDL_JoystickUpdate.

SDL_IsGameController()

SDL_bool SDL_IsGameController

(

int

joystick_index

)

Is the joystick on this index supported by the game controller interface?

Definition at line 1729 of file SDL_gamecontroller.c.

{
    ControllerMapping_t *pSupportedController = SDL_PrivateGetControllerMapping(device_index);
    if (pSupportedController) {
        return SDL_TRUE;
    }
    return SDL_FALSE;
}

References SDL_FALSE, SDL_PrivateGetControllerMapping(), and SDL_TRUE.

Referenced by SDL_GameControllerEventWatcher(), and SDL_GameControllerInit().