v0.0.0-...-fd97e0e Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Mar 16, 2016 License: Apache-2.0, BSD-3-Clause Imports: 2 Imported by: 0



Package mouse defines an event for mouse input.

See the package for details on the event model.



This section is empty.


This section is empty.


This section is empty.


type Button

type Button int32

Button is a mouse button.

const (
	ButtonNone      Button = +0
	ButtonLeft      Button = +1
	ButtonMiddle    Button = +2
	ButtonRight     Button = +3
	ButtonWheelUp   Button = -1
	ButtonWheelDown Button = -2

type Direction

type Direction uint8

Direction is the direction of the mouse event.

const (
	DirNone    Direction = 0
	DirPress   Direction = 1
	DirRelease Direction = 2

func (Direction) String

func (d Direction) String() string

type Event

type Event struct {
	// X and Y are the mouse location, in pixels.
	X, Y float32

	// Button is the mouse button being pressed or released. Its value may be
	// zero, for a mouse move or drag without any button change.
	Button Button

	// Modifiers is a bitmask representing a set of modifier keys:
	// key.ModShift, key.ModAlt, etc.
	Modifiers key.Modifiers

	// Direction is the direction of the mouse event: DirPress, DirRelease,
	// or DirNone (for mouse moves or drags).
	Direction Direction

Event is a mouse event.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL