events

Documentation

Overview

Package events manages mouse and keyboard SDL events for Doodle.

Index

• Variables
• type BoolTick
  • func (bs *BoolTick) Pressed() bool
  • func (bs *BoolTick) Push(v bool)
  • func (bs *BoolTick) Read() bool
• type Int32Tick
  • func (is *Int32Tick) Push(v int32)
• type State
  • func New() *State
  • func (ev *State) ReadKey() string
• type StringTick
  • func (s *StringTick) Push(v string)
  • func (s *StringTick) Read() string

Variables

var (
	DebugMouseEvents = false
	DebugClickEvents = true
)

Debug constants, toggle on or off for SUPER VERBOSE debugging.

Types

type BoolTick

type BoolTick struct {
	Now  bool
	Last bool
}

BoolTick holds boolean state between this frame and the previous.

func (*BoolTick) Pressed

func (bs *BoolTick) Pressed() bool

Pressed returns true if the button was pressed THIS tick.

func (*BoolTick) Push

func (bs *BoolTick) Push(v bool)

Push a bool state, copying the current Now value to Last.

func (*BoolTick) Read

func (bs *BoolTick) Read() bool

Read a bool state, resetting its value to false.

type Int32Tick

type Int32Tick struct {
	Now  int32
	Last int32
}

Int32Tick manages int32 state between this frame and the previous.

func (*Int32Tick) Push

func (is *Int32Tick) Push(v int32)

Push an int32 state, copying the current Now value to Last.

type State

type State struct {
	// Mouse buttons.
	Button1 *BoolTick // left
	Button2 *BoolTick // right
	Button3 *BoolTick // middle

	EscapeKey     *BoolTick
	EnterKey      *BoolTick
	ShiftActive   *BoolTick
	ControlActive *BoolTick
	KeyName       *StringTick
	Up            *BoolTick
	Left          *BoolTick
	Right         *BoolTick
	Down          *BoolTick

	// Cursor positions.
	CursorX *Int32Tick
	CursorY *Int32Tick

	// Window events: window has changed size.
	Resized *BoolTick
}

State keeps track of event states.

func New

func New() *State

New creates a new event state manager.

func (*State) ReadKey

func (ev *State) ReadKey() string

ReadKey returns the normalized key symbol being pressed, taking the Shift key into account. QWERTY keyboard only, probably.

type StringTick

type StringTick struct {
	Now  string
	Last string
}

StringTick manages strings between this frame and the previous.

func (*StringTick) Push

func (s *StringTick) Push(v string)

Push a string state.

func (*StringTick) Read

func (s *StringTick) Read() string

Read a string state, resetting its value.