gamecontroller.nim

Include file for SDL game controller event handling.

In order to use these functions, init() must have been called with the 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 init(): HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS

To count the number of game controllers in the system for the following:

var nJoysticks: int = numJoysticks()
var nGameControllers: int = 0
for i in 0..nJoysticks-1:
  if isGameController(i):
    inc(nGameControllers)

Using the HINT_GAMECONTROLLERCONFIG hint or the 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 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

"341a3608000000000000504944564944,Afterglow 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"

Types

GameController* = pointer
GameControllerBindType* {.size: sizeof(cint).} = enum CONTROLLER_BINDTYPE_NONE = 0, CONTROLLER_BINDTYPE_BUTTON, CONTROLLER_BINDTYPE_AXIS, CONTROLLER_BINDTYPE_HAT
GameControllerButtonBindValueHat* = object hat*: cint hat_mask*: cint
GameControllerButtonBindValue* = object {.union.} button*: cint axis*: cint hat*: GameControllerButtonBindValueHat
GameControllerButtonBind* = object bindType*: GameControllerBindType value*: GameControllerButtonBindValue: Get the SDL joystick layer binding for this controller button/axis mapping
GameControllerAxis* {.size: sizeof(cint).} = enum CONTROLLER_AXIS_INVALID = - 1, CONTROLLER_AXIS_LEFTX, CONTROLLER_AXIS_LEFTY, CONTROLLER_AXIS_RIGHTX, CONTROLLER_AXIS_RIGHTY, CONTROLLER_AXIS_TRIGGERLEFT, CONTROLLER_AXIS_TRIGGERRIGHT, CONTROLLER_AXIS_MAX: The list of axes available from a controller
GameControllerButton* {.size: sizeof(cint).} = enum CONTROLLER_BUTTON_INVALID = - 1, CONTROLLER_BUTTON_A, CONTROLLER_BUTTON_B, CONTROLLER_BUTTON_X, CONTROLLER_BUTTON_Y, CONTROLLER_BUTTON_BACK, CONTROLLER_BUTTON_GUIDE, CONTROLLER_BUTTON_START, CONTROLLER_BUTTON_LEFTSTICK, CONTROLLER_BUTTON_RIGHTSTICK, CONTROLLER_BUTTON_LEFTSHOULDER, CONTROLLER_BUTTON_RIGHTSHOULDER, CONTROLLER_BUTTON_DPAD_UP, CONTROLLER_BUTTON_DPAD_DOWN, CONTROLLER_BUTTON_DPAD_LEFT, CONTROLLER_BUTTON_DPAD_RIGHT, CONTROLLER_BUTTON_MAX: The list of buttons available from a controller

Procs

proc gameControllerAddMappingsFromRW*(rw: ptr RWops; freerw: cint): cint {.cdecl, importc: "SDL_GameControllerAddMappingsFromRW", dynlib: SDL2_LIB.}

Load a set of mappings from a seekable SDL data stream (memory or file), filtered by the current 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.

Return number of mappings added, -1 on error

proc gameControllerAddMapping*(mappingString: cstring): cint {.cdecl, importc: "SDL_GameControllerAddMapping", dynlib: SDL2_LIB.}

Add or update an existing mapping configuration.

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

proc gameControllerMappingForGUID*(guid: JoystickGUID): cstring {.cdecl, importc: "SDL_GameControllerMappingForGUID", dynlib: SDL2_LIB.}

Get a mapping string for a GUID.

Return the mapping string. Must be freed with free(). Returns nil if no mapping is available

proc gameControllerMapping*(gamecontroller: GameController): cstring {.cdecl, importc: "SDL_GameControllerMapping", dynlib: SDL2_LIB.}

Get a mapping string for an open GameController.

Return the mapping string. Must be freed with free(). Returns nil if no mapping is available

proc isGameController*(joystick_index: cint): bool {.cdecl, importc: "SDL_IsGameController", dynlib: SDL2_LIB.}

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

proc gameControllerNameForIndex*(joystick_index: cint): cstring {.cdecl, importc: "SDL_GameControllerNameForIndex", dynlib: SDL2_LIB.}

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

proc gameControllerOpen*(joystick_index: cint): GameController {.cdecl, importc: "SDL_GameControllerOpen", dynlib: SDL2_LIB.}

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 (JoystickID) will be used there instead.

Return a controller identifier, or nil if an error occurred.

proc gameControllerFromInstanceID*(joyid: JoystickID): GameController {.cdecl, importc: "SDL_GameControllerFromInstanceID", dynlib: SDL2_LIB.}

Return the GameController associated with an instance id.

proc gameControllerName*(gamecontroller: GameController): cstring {.cdecl, importc: "SDL_GameControllerName", dynlib: SDL2_LIB.}

Return the name for this currently opened controller.

proc gameControllerGetAttached*(gamecontroller: GameController): bool {.cdecl, importc: "SDL_GameControllerGetAttached", dynlib: SDL2_LIB.}

Returns true if the controller has been opened and currently connected, or false if it has not.

proc gameControllerGetJoystick*(gamecontroller: GameController): ptr Joystick {. cdecl, importc: "SDL_GameControllerGetJoystick", dynlib: SDL2_LIB.}

Get the underlying joystick object used by a controller.

proc gameControllerEventState*(state: cint): cint {.cdecl, importc: "SDL_GameControllerEventState", dynlib: SDL2_LIB.}

Enable/disable controller event polling.

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

The state can be one of QUERY, ENABLE or IGNORE.

proc gameControllerUpdate*() {.cdecl, importc: "SDL_GameControllerUpdate", dynlib: SDL2_LIB.}

Update the current state of the open game controllers.

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

proc gameControllerGetAxisFromString*(pchString: cstring): GameControllerAxis {. cdecl, importc: "SDL_GameControllerGetAxisFromString", dynlib: SDL2_LIB.}

Turn this string into a axis mapping.

proc gameControllerGetStringForAxis*(axis: GameControllerAxis): cstring {.cdecl, importc: "SDL_GameControllerGetStringForAxis", dynlib: SDL2_LIB.}

Turn this axis enum into a string mapping.

proc gameControllerGetBindForAxis*(gamecontroller: GameController; axis: GameControllerAxis): GameControllerButtonBind {. cdecl, importc: "SDL_GameControllerGetBindForAxis", dynlib: SDL2_LIB.}

Get the SDL joystick layer binding for this controller button mapping.

proc gameControllerGetAxis*(gamecontroller: GameController; axis: GameControllerAxis): int16 {.cdecl, importc: "SDL_GameControllerGetAxis", dynlib: SDL2_LIB.}

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.

proc gameControllerGetButtonFromString*(pchString: cstring): GameControllerButton {. cdecl, importc: "SDL_GameControllerGetButtonFromString", dynlib: SDL2_LIB.}

Turn this string into a button mapping.

proc gameControllerGetStringForButton*(button: GameControllerButton): cstring {. cdecl, importc: "SDL_GameControllerGetStringForButton", dynlib: SDL2_LIB.}

Turn this button enum into a string mapping.

proc gameControllerGetBindForButton*(gamecontroller: GameController; button: GameControllerButton): GameControllerButtonBind {. cdecl, importc: "SDL_GameControllerGetBindForButton", dynlib: SDL2_LIB.}

Get the SDL joystick layer binding for this controller button mapping.

proc gameControllerGetButton*(gamecontroller: GameController; button: GameControllerButton): uint8 {.cdecl, importc: "SDL_GameControllerGetButton", dynlib: SDL2_LIB.}

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

The button indices start at index 0.

proc gameControllerClose*(gamecontroller: GameController) {.cdecl, importc: "SDL_GameControllerClose", dynlib: SDL2_LIB.}

Close a controller previously opened with gameControllerOpen().

Templates

template gameControllerAddMappingsFromFile*(file: expr): expr: Load a set of mappings from a file, filtered by the current getPlatform().

Module gamecontroller

gamecontroller.nim

Types

Procs

Templates