input

Documentation

Overview

Package input processes button presses from a gamepad or keyboard.

Index

• type Context
  • func GetContext(ctx context.Context) *Context
  • func NewContext(ctx context.Context, fetch func() ([]arcade.Button, float32, float32, bool)) (context.Context, *Context)
  • func (c *Context) Consume(btn arcade.Button) bool
  • func (c *Context) ConsumeAllowRepeat(btn arcade.Button, delayTicks uint64) bool
  • func (c *Context) Held(btn arcade.Button) bool
  • func (c *Context) LoadState(s State)
  • func (c *Context) Mouse() (x, y float32, click bool)
  • func (c *Context) SaveState() State
  • func (c *Context) Tick()
• type State

Types

type Context

type Context struct {
	// contains filtered or unexported fields
}

Context is an input context.

func GetContext

func GetContext(ctx context.Context) *Context

GetContext returns the Context created using NewContext.

It panics if no context was created.

func NewContext

func NewContext(ctx context.Context, fetch func() ([]arcade.Button, float32, float32, bool)) (context.Context, *Context)

NewContext creates a new input context.

func (*Context) Consume

func (c *Context) Consume(btn arcade.Button) bool

Consume returns true if a button is pressed, and consumes the button press indefinitely.

func (*Context) ConsumeAllowRepeat

func (c *Context) ConsumeAllowRepeat(btn arcade.Button, delayTicks uint64) bool

ConsumeAllowRepeat returns true if a button is pressed, and consumes the button press for delayTicks.

func (*Context) Held

func (c *Context) Held(btn arcade.Button) bool

Held returns true if a button is currently held.

func (*Context) LoadState

func (c *Context) LoadState(s State)

LoadState loads the input state from a snapshot.

func (*Context) Mouse

func (c *Context) Mouse() (x, y float32, click bool)

Mouse returns the current mouse position in [0, 1] and whether the button is held.

func (*Context) SaveState

func (c *Context) SaveState() State

SaveState takes a snapshot of the input state.

func (*Context) Tick

func (c *Context) Tick()

Tick updates the input context.

type State

type State struct {
	// contains filtered or unexported fields
}

State is a snapshot of the input context state.