gamepaddb

Documentation

Index

• Constants
• func AxisValue(id string, axis StandardAxis, state GamepadState) float64
• func ButtonValue(id string, button StandardButton, state GamepadState) float64
• func HasStandardAxis(id string, axis StandardAxis) bool
• func HasStandardButton(id string, button StandardButton) bool
• func HasStandardLayoutMapping(id string) bool
• func IsButtonPressed(id string, button StandardButton, state GamepadState) bool
• func Name(id string) string
• func Update(mappingData []byte) error
• type GamepadState
• type StandardAxis
• type StandardButton

Constants

const (
	HatUp    = 1
	HatRight = 2
	HatDown  = 4
	HatLeft  = 8
)

const (
	SDLControllerButtonA             = 0
	SDLControllerButtonB             = 1
	SDLControllerButtonX             = 2
	SDLControllerButtonY             = 3
	SDLControllerButtonBack          = 4
	SDLControllerButtonGuide         = 5
	SDLControllerButtonStart         = 6
	SDLControllerButtonLeftStick     = 7
	SDLControllerButtonRightStick    = 8
	SDLControllerButtonLeftShoulder  = 9
	SDLControllerButtonRightShoulder = 10
	SDLControllerButtonDpadUp        = 11
	SDLControllerButtonDpadDown      = 12
	SDLControllerButtonDpadLeft      = 13
	SDLControllerButtonDpadRight     = 14
	SDLControllerButtonMisc1         = 15
	SDLControllerButtonPaddle1       = 16
	SDLControllerButtonPaddle2       = 17
	SDLControllerButtonPaddle3       = 18
	SDLControllerButtonPaddle4       = 19
	SDLControllerButtonTouchpad      = 20
	SDLControllerButtonMax           = SDLControllerButtonTouchpad // This is different from the original SDL_CONTROLLER_BUTTON_MAX.
)

See https://github.com/libsdl-org/SDL/blob/120c76c84bbce4c1bfed4e9eb74e10678bd83120/include/SDL_gamecontroller.h#L655-L680

const (
	SDLControllerAxisLeftX        = 0
	SDLControllerAxisLeftY        = 1
	SDLControllerAxisRightX       = 2
	SDLControllerAxisRightY       = 3
	SDLControllerAxisTriggerLeft  = 4
	SDLControllerAxisTriggerRight = 5
)

See https://github.com/libsdl-org/SDL/blob/120c76c84bbce4c1bfed4e9eb74e10678bd83120/include/SDL_gamecontroller.h#L550-L560

Functions

func AxisValue

func AxisValue(id string, axis StandardAxis, state GamepadState) float64

func ButtonValue

func ButtonValue(id string, button StandardButton, state GamepadState) float64

func HasStandardAxis

func HasStandardAxis(id string, axis StandardAxis) bool

func HasStandardButton

func HasStandardButton(id string, button StandardButton) bool

func HasStandardLayoutMapping

func HasStandardLayoutMapping(id string) bool

func IsButtonPressed

func IsButtonPressed(id string, button StandardButton, state GamepadState) bool

func Name

func Name(id string) string

func Update

func Update(mappingData []byte) error

Update adds new gamepad mappings. The string must be in the format of SDL_GameControllerDB.

Update works atomically. If an error happens, nothing is updated.

Types

type GamepadState

type GamepadState interface {
	Axis(index int) float64
	Button(index int) bool
	Hat(index int) int
}

type StandardAxis

type StandardAxis int

const (
	StandardAxisLeftStickHorizontal StandardAxis = iota
	StandardAxisLeftStickVertical
	StandardAxisRightStickHorizontal
	StandardAxisRightStickVertical

	StandardAxisMax = StandardAxisRightStickVertical
)

https://www.w3.org/TR/gamepad/#remapping

type StandardButton

type StandardButton int

const (
	StandardButtonRightBottom StandardButton = iota
	StandardButtonRightRight
	StandardButtonRightLeft
	StandardButtonRightTop
	StandardButtonFrontTopLeft
	StandardButtonFrontTopRight
	StandardButtonFrontBottomLeft
	StandardButtonFrontBottomRight
	StandardButtonCenterLeft
	StandardButtonCenterRight
	StandardButtonLeftStick
	StandardButtonRightStick
	StandardButtonLeftTop
	StandardButtonLeftBottom
	StandardButtonLeftLeft
	StandardButtonLeftRight
	StandardButtonCenterCenter

	StandardButtonMax = StandardButtonCenterCenter
)

https://www.w3.org/TR/gamepad/#remapping