joystick

Documentation

Index

• Variables
• func Port() *joystick
• func UseSettings(def Definitions, rxHandlerFunc func(b []byte), ...) *joystick
• type AxisValue
• type Constraint
• type Definitions
  • func DefaultDefinitions() Definitions
  • func (c Definitions) Descriptor() []byte
  • func (c Definitions) NewState() State
• type HatDirection
• type State
  • func (s State) Axis(index int) int
  • func (s State) Button(index int) bool
  • func (s State) Hat(index int) HatDirection
  • func (s State) MarshalBinary() ([]byte, error)
  • func (s State) SetAxis(index int, v int)
  • func (s State) SetButton(index int, push bool)
  • func (s State) SetHat(index int, dir HatDirection)

Variables

var Joystick *joystick

Functions

func Port

func Port() *joystick

Port returns the USB Joystick port.

func UseSettings

func UseSettings(def Definitions, rxHandlerFunc func(b []byte), setupFunc func(setup usb.Setup) bool, hidDesc []byte) *joystick

UseSettings overrides the Joystick settings. This function must be called from init().

Types

type AxisValue

type AxisValue struct {
	Value int
	// contains filtered or unexported fields
}

type Constraint

type Constraint struct {
	MinIn  int
	MaxIn  int
	MinOut int16
	MaxOut int16
}

type Definitions

type Definitions struct {
	ReportID     byte
	ButtonCnt    int
	HatSwitchCnt int
	AxisDefs     []Constraint
	// contains filtered or unexported fields
}

func DefaultDefinitions

func DefaultDefinitions() Definitions

func (Definitions) Descriptor

func (c Definitions) Descriptor() []byte

func (Definitions) NewState

func (c Definitions) NewState() State

type HatDirection

type HatDirection uint8

const (
	HatUp HatDirection = iota
	HatRightUp
	HatRight
	HatRightDown
	HatDown
	HatLeftDown
	HatLeft
	HatLeftUp
	HatCenter
)

type State

type State struct {
	Buttons     []byte
	HatSwitches []HatDirection
	Axises      []*AxisValue
	// contains filtered or unexported fields
}

func (State) Axis

func (s State) Axis(index int) int

func (State) Button

func (s State) Button(index int) bool

func (State) Hat

func (s State) Hat(index int) HatDirection

func (State) MarshalBinary

func (s State) MarshalBinary() ([]byte, error)

func (State) SetAxis

func (s State) SetAxis(index int, v int)

func (State) SetButton

func (s State) SetButton(index int, push bool)

func (State) SetHat

func (s State) SetHat(index int, dir HatDirection)