README
¶
we
This package specifies commonly used types and constants for window events. It is heavily inspired by glfw and go.wde.
The goal is to make window event handling interoperate well between various packages, even though this may be a self-defeating purpose.
Documentation
¶
Overview ¶
Package we specifies commonly used types and constants for window events. An overview of the various event types is given at http://pkg.go.dev/github.com/mewspring/we#Event
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Button ¶
type Button int
Button represent a bitfield of mouse buttons.
type Event ¶
type Event interface{}
An Event represents a window, keyboard or mouse event.
Window events ¶
The following window events are defined by this package.
http://pkg.go.dev/github.com/mewspring/we#Close http://pkg.go.dev/github.com/mewspring/we#Resize
Keyboard events ¶
The following keyboard events are defined by this package.
http://pkg.go.dev/github.com/mewspring/we#KeyPress http://pkg.go.dev/github.com/mewspring/we#KeyRelease http://pkg.go.dev/github.com/mewspring/we#KeyRepeat http://pkg.go.dev/github.com/mewspring/we#KeyRune
Mouse events ¶
The following mouse events are defined by this package.
http://pkg.go.dev/github.com/mewspring/we#MousePress http://pkg.go.dev/github.com/mewspring/we#MouseRelease http://pkg.go.dev/github.com/mewspring/we#MouseMove http://pkg.go.dev/github.com/mewspring/we#MouseDrag http://pkg.go.dev/github.com/mewspring/we#MouseEnter http://pkg.go.dev/github.com/mewspring/we#ScrollX http://pkg.go.dev/github.com/mewspring/we#ScrollY
type Key ¶
type Key int
Key corresponds to a keyboard key.
const ( // Printable keys. KeySpace Key = 32 KeyApostrophe Key = 39 // ' KeyComma Key = 44 // , KeyMinus Key = 45 // - KeyPeriod Key = 46 // . KeySlash Key = 47 // / Key0 Key = 48 Key1 Key = 49 Key2 Key = 50 Key3 Key = 51 Key4 Key = 52 Key5 Key = 53 Key6 Key = 54 Key7 Key = 55 Key8 Key = 56 Key9 Key = 57 KeySemicolon Key = 59 // ; KeyEqual Key = 61 // = KeyA Key = 65 KeyB Key = 66 KeyC Key = 67 KeyD Key = 68 KeyE Key = 69 KeyF Key = 70 KeyG Key = 71 KeyH Key = 72 KeyI Key = 73 KeyJ Key = 74 KeyK Key = 75 KeyL Key = 76 KeyM Key = 77 KeyN Key = 78 KeyO Key = 79 KeyP Key = 80 KeyQ Key = 81 KeyR Key = 82 KeyS Key = 83 KeyT Key = 84 KeyU Key = 85 KeyV Key = 86 KeyW Key = 87 KeyX Key = 88 KeyY Key = 89 KeyZ Key = 90 KeyLeftBracket Key = 91 // [ KeyBackslash Key = 92 // \ KeyRightBracket Key = 93 // ] KeyGraveAccent Key = 96 // ` KeyWorld1 Key = 161 // non-US #1 KeyWorld2 Key = 162 // non-US #2 // Function keys. KeyEscape Key = 256 KeyEnter Key = 257 KeyTab Key = 258 KeyBackspace Key = 259 KeyInsert Key = 260 KeyDelete Key = 261 KeyRight Key = 262 KeyLeft Key = 263 KeyDown Key = 264 KeyUp Key = 265 KeyPageUp Key = 266 KeyPageDown Key = 267 KeyHome Key = 268 KeyEnd Key = 269 KeyCapsLock Key = 280 KeyScrollLock Key = 281 KeyNumLock Key = 282 KeyPrintScreen Key = 283 KeyPause Key = 284 KeyF1 Key = 290 KeyF2 Key = 291 KeyF3 Key = 292 KeyF4 Key = 293 KeyF5 Key = 294 KeyF6 Key = 295 KeyF7 Key = 296 KeyF8 Key = 297 KeyF9 Key = 298 KeyF10 Key = 299 KeyF11 Key = 300 KeyF12 Key = 301 KeyF13 Key = 302 KeyF14 Key = 303 KeyF15 Key = 304 KeyF16 Key = 305 KeyF17 Key = 306 KeyF18 Key = 307 KeyF19 Key = 308 KeyF20 Key = 309 KeyF21 Key = 310 KeyF22 Key = 311 KeyF23 Key = 312 KeyF24 Key = 313 KeyF25 Key = 314 KeyKp0 Key = 320 KeyKp1 Key = 321 KeyKp2 Key = 322 KeyKp3 Key = 323 KeyKp4 Key = 324 KeyKp5 Key = 325 KeyKp6 Key = 326 KeyKp7 Key = 327 KeyKp8 Key = 328 KeyKp9 Key = 329 KeyKpDecimal Key = 330 KeyKpDivide Key = 331 KeyKpMultiply Key = 332 KeyKpSubtract Key = 333 KeyKpAdd Key = 334 KeyKpEnter Key = 335 KeyKpEqual Key = 336 KeyLeftShift Key = 340 KeyLeftControl Key = 341 KeyLeftAlt Key = 342 KeyLeftSuper Key = 343 KeyRightShift Key = 344 KeyRightControl Key = 345 KeyRightAlt Key = 346 KeyRightSuper Key = 347 KeyMenu Key = 348 )
Keyboard keys.
These key codes are equivalent to those used in GLFW 3.0. They are inspired by the USB HID Usage Tables v1.12 1 (p. 53-60), but re-arranged to map to 7-bit ASCII for printable keys (function keys are put in the 256+ range).
type KeyRelease ¶
A KeyRelease event is triggered when a keyboard key is released.
type KeyRepeat ¶
A KeyRepeat event is triggered when a keyboard key was held down until it repeated.
type KeyRune ¶
type KeyRune rune
A KeyRune event is triggered when a unicode character is typed on the keyboard. For instance if `a` and `shift` are held down on the keyboard KeyRune will correspond to 'A'.
type Mod ¶
type Mod int
Mod represent a bitfield of key modifiers.
const ( // ModShift means one or more Shift keys were held down. ModShift Mod = 1 << iota // ModControl means one or more Control keys were held down. ModControl // ModAlt means one or more Alt keys were held down. ModAlt // ModSuper means one or more Super keys were held down. ModSuper )
Key modifier bitfield values.
type MouseDrag ¶
type MouseDrag struct {
// Coordinates of the mouse cursor.
image.Point
// Coordinates of the mouse cursor at the beginning of the drag event.
From image.Point
// Bitfield of mouse buttons that were held down.
Button Button
// Bitfield of key modifiers.
Mod Mod
}
A MouseDrag event is triggered when the mouse is moved from one location to another while one or more mouse buttons are held down.
type MouseEnter ¶
type MouseEnter bool
A MouseEnter event is triggered when the mouse enters or leaves the window. On mouse enter the value is true, otherwise it is false.
func (MouseEnter) String ¶
func (enter MouseEnter) String() string
type MouseMove ¶
type MouseMove struct {
// Coordinates of the mouse cursor.
image.Point
// Coordinates of the mouse cursor at the beginning of the move event.
From image.Point
}
A MouseMove event is triggered when the mouse is moved from one location to another.
type MousePress ¶
type MousePress struct {
// Coordinates of the mouse cursor.
image.Point
// Bitfield of pressed mouse buttons.
Button Button
// Bitfield of key modifiers.
Mod Mod
}
A MousePress event is triggered when one or more mouse buttons are pressed.
func (MousePress) String ¶
func (e MousePress) String() string
type MouseRelease ¶
type MouseRelease struct {
// Coordinates of the mouse cursor.
image.Point
// Bitfield of released mouse buttons.
Button Button
// Bitfield of key modifiers.
Mod Mod
}
A MouseRelease event is triggered when one or more mouse buttons are released.
func (MouseRelease) String ¶
func (e MouseRelease) String() string
type Resize ¶
type Resize struct {
// New window dimensions.
Width, Height int
}
A Resize event is triggered when the window is resized.
type ScrollX ¶
type ScrollX struct {
// Coordinates of the mouse cursor.
image.Point
// Horizontal scroll offset.
Off int
// Bitfield of key modifiers.
Mod Mod
}
A ScrollX event is triggered when the mouse wheel is scrolled on the horizontal axis.
Source Files