event

package
v1.10.5 Latest Latest
Warning

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

Go to latest
Published: Mar 4, 2020 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Key0            = driver.Key0
	Key1            = driver.Key1
	Key2            = driver.Key2
	Key3            = driver.Key3
	Key4            = driver.Key4
	Key5            = driver.Key5
	Key6            = driver.Key6
	Key7            = driver.Key7
	Key8            = driver.Key8
	Key9            = driver.Key9
	KeyA            = driver.KeyA
	KeyB            = driver.KeyB
	KeyC            = driver.KeyC
	KeyD            = driver.KeyD
	KeyE            = driver.KeyE
	KeyF            = driver.KeyF
	KeyG            = driver.KeyG
	KeyH            = driver.KeyH
	KeyI            = driver.KeyI
	KeyJ            = driver.KeyJ
	KeyK            = driver.KeyK
	KeyL            = driver.KeyL
	KeyM            = driver.KeyM
	KeyN            = driver.KeyN
	KeyO            = driver.KeyO
	KeyP            = driver.KeyP
	KeyQ            = driver.KeyQ
	KeyR            = driver.KeyR
	KeyS            = driver.KeyS
	KeyT            = driver.KeyT
	KeyU            = driver.KeyU
	KeyV            = driver.KeyV
	KeyW            = driver.KeyW
	KeyX            = driver.KeyX
	KeyY            = driver.KeyY
	KeyZ            = driver.KeyZ
	KeyApostrophe   = driver.KeyApostrophe
	KeyBackslash    = driver.KeyBackslash
	KeyBackspace    = driver.KeyBackspace
	KeyCapsLock     = driver.KeyCapsLock
	KeyComma        = driver.KeyComma
	KeyDelete       = driver.KeyDelete
	KeyDown         = driver.KeyDown
	KeyEnd          = driver.KeyEnd
	KeyEnter        = driver.KeyEnter
	KeyEqual        = driver.KeyEqual
	KeyEscape       = driver.KeyEscape
	KeyF1           = driver.KeyF1
	KeyF2           = driver.KeyF2
	KeyF3           = driver.KeyF3
	KeyF4           = driver.KeyF4
	KeyF5           = driver.KeyF5
	KeyF6           = driver.KeyF6
	KeyF7           = driver.KeyF7
	KeyF8           = driver.KeyF8
	KeyF9           = driver.KeyF9
	KeyF10          = driver.KeyF10
	KeyF11          = driver.KeyF11
	KeyF12          = driver.KeyF12
	KeyGraveAccent  = driver.KeyGraveAccent
	KeyHome         = driver.KeyHome
	KeyInsert       = driver.KeyInsert
	KeyKP0          = driver.KeyKP0
	KeyKP1          = driver.KeyKP1
	KeyKP2          = driver.KeyKP2
	KeyKP3          = driver.KeyKP3
	KeyKP4          = driver.KeyKP4
	KeyKP5          = driver.KeyKP5
	KeyKP6          = driver.KeyKP6
	KeyKP7          = driver.KeyKP7
	KeyKP8          = driver.KeyKP8
	KeyKP9          = driver.KeyKP9
	KeyKPAdd        = driver.KeyKPAdd
	KeyKPDecimal    = driver.KeyKPDecimal
	KeyKPDivide     = driver.KeyKPDivide
	KeyKPEnter      = driver.KeyKPEnter
	KeyKPEqual      = driver.KeyKPEqual
	KeyKPMultiply   = driver.KeyKPMultiply
	KeyKPSubtract   = driver.KeyKPSubtract
	KeyLeft         = driver.KeyLeft
	KeyLeftAlt      = driver.KeyLeftAlt
	KeyLeftBracket  = driver.KeyLeftBracket
	KeyLeftControl  = driver.KeyLeftControl
	KeyLeftShift    = driver.KeyLeftShift
	KeyMenu         = driver.KeyMenu
	KeyMinus        = driver.KeyMinus
	KeyNumLock      = driver.KeyNumLock
	KeyPageDown     = driver.KeyPageDown
	KeyPageUp       = driver.KeyPageUp
	KeyPause        = driver.KeyPause
	KeyPeriod       = driver.KeyPeriod
	KeyPrintScreen  = driver.KeyPrintScreen
	KeyRight        = driver.KeyRight
	KeyRightAlt     = driver.KeyRightAlt
	KeyRightBracket = driver.KeyRightBracket
	KeyRightControl = driver.KeyRightControl
	KeyRightShift   = driver.KeyRightShift
	KeyScrollLock   = driver.KeyScrollLock
	KeySemicolon    = driver.KeySemicolon
	KeySlash        = driver.KeySlash
	KeySpace        = driver.KeySpace
	KeyTab          = driver.KeyTab
	KeyUp           = driver.KeyUp
)
View Source
const (
	ModifierShift    = driver.ModifierShift
	ModifierControl  = driver.ModifierControl
	ModifierAlt      = driver.ModifierAlt
	ModifierCapsLock = driver.ModifierCapsLock
	ModifierNumLock  = driver.ModifierNumLock
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Event

type Event interface{}

type GamepadAttach

type GamepadAttach struct {
	// ID represents which gamepad caused the event.
	ID int

	// Axes represents the amount of axes the gamepad has.
	Axes int

	// Buttons represents the amount of buttons the gamepad has.
	Buttons int
}

GamepadAttach happens when a new gamepad is attached.

type GamepadAxis

type GamepadAxis struct {
	// ID represents which gamepad caused the event.
	ID int

	// Axis is the axis of the game pad that changed position.
	Axis int

	// Position is the position of the axis after the change. It varies between -1.0 and 1.0.
	Position float32
}

GamepadAxis is for event where an axis on a gamepad changes.

type GamepadButtonDown

type GamepadButtonDown struct {
	// ID represents which gamepad caused the event.
	ID int

	// Button is the button that was pressed on the game pad.
	Button int

	// Pressure is the pressure that is applied to the gamepad button. It varies between 0.0 for not pressed, and 1.0 for completely pressed.
	Pressure float32
}

GamepadButtonDown is a gamepad button press event.

type GamepadButtonUp

type GamepadButtonUp struct {
	// ID represents which gamepad caused the event.
	ID int

	// Button is the button that was pressed on the game pad.
	Button int

	// Pressure is the pressure that is applied to the gamepad button. It varies between 0.0 for not pressed, and 1.0 for completely pressed.
	Pressure float32
}

GamepadButtonUp is a gamepad button release event.

type GamepadDetach

type GamepadDetach struct {
	// ID represents which gamepad caused the event.
	ID int
}

GamepadDetach happens when a gamepad is detached.

type Key

type Key = driver.Key

type KeyboardKeyCharacter

type KeyboardKeyCharacter struct {
	// Key is the key code of the key typed.
	Key Key

	// Modifier is the logical-or value of the modifiers pressed together with the key.
	Modifier Modifier

	// Character is the character that was typed.
	Character rune
}

KeyboardKeyCharacter is an event that occurs when a character is actually typed on the keyboard. This may be provided by an input method.

type KeyboardKeyDown

type KeyboardKeyDown struct {
	// Key is the key code of the key pressed or released.
	Key Key

	// Modifier is the logical-or value of the modifiers pressed together with the key.
	Modifier Modifier
}

KeyboardKeyDown is an event that occurs when a key is pressed on the keyboard.

type KeyboardKeyUp

type KeyboardKeyUp struct {
	// Key is the key code of the key pressed or released.
	Key Key

	// Modifier is the logical-or value of the modifiers pressed together with the key.
	Modifier Modifier
}

KeyboardKeyUp is an event that occurs when a key is released on the keyboard.

type Modifier

type Modifier = driver.Modifier

Modifier is a bit set of modifier keys on a keyboard.

type MouseButtonDown

type MouseButtonDown struct {
	// X is the X position of the mouse pointer. This value is expressed in device independent pixels.
	X float32

	// Y is the Y position of the mouse pointer. This value is expressed in device independent pixels.
	Y float32

	// Button is the button on the mouse that was pressed. TODO: this should change later from an int to an enumeration type.
	Button int

	// Pressure is the pressure applied on the mouse button. It varies between 0.0 for not pressed, and 1.0 for completely pressed.
	Pressure float32
}

MouseButtonDown is a mouse button press event.

type MouseButtonUp

type MouseButtonUp struct {
	// X is the X position of the mouse pointer. This value is expressed in device independent pixels.
	X float32

	// Y is the Y position of the mouse pointer. This value is expressed in device independent pixels.
	Y float32

	// Button is the button on the mouse that was pressed. TODO: this should change later from an int to an enumeration type.
	Button int

	// Pressure is the pressure applied on the mouse button. It varies between 0.0 for not pressed, and 1.0 for completely pressed.
	Pressure float32
}

MouseButtonUp is a mouse button release event.

type MouseEnter

type MouseEnter struct {
	// X is the X position of the mouse pointer. This value is expressed in device independent pixels.
	X float32

	// Y is the Y position of the mouse pointer. This value is expressed in device independent pixels.
	Y float32
}

MouseEnter occurs when the mouse enters the view window.

type MouseLeave

type MouseLeave struct {
	// X is the X position of the mouse pointer. This value is expressed in device independent pixels.
	X float32

	// Y is the Y position of the mouse pointer. This value is expressed in device independent pixels.
	Y float32
}

MouseLeave occurs when the mouse leaves the view window.

type MouseMove

type MouseMove struct {
	// X is the X position of the mouse pointer. This value is expressed in device independent pixels.
	X float32

	// Y is the Y position of the mouse pointer. This value is expressed in device independent pixels.
	Y float32

	// DeltaX is the change in X since the last MouseMove event. This value is expressed in device independent pixels.
	DeltaX float32

	// DeltaY is the change in Y since the last MouseMove event. This value is expressed in device independent pixels.
	DeltaY float32
}

MouseMove is a mouse movement event.

type MouseWheel

type MouseWheel struct {
	// X is the X position of the mouse wheel. This value is expressed in arbitrary units. It increases when the mouse wheel is scrolled downwards, and decreases when the mouse is scrolled upwards.
	X float32

	// Y is the Y position of the mouse wheel. This value is expressed in arbitrary units. It increases when the mouse wheel is scrolled to the right, and decreases when the mouse is scrolled to the left.
	Y float32

	// DeltaX is the change in X since the last MouseWheel event. This value is expressed in arbitrary units. It is positive when the mouse wheel is scrolled downwards, and negative when the mouse is scrolled upwards.
	DeltaX float32

	// DeltaY is the change in Y since the last MouseWheel event. This value is expressed in arbitrary units. It is positive when the mouse wheel is scrolled to the right, and negative when the mouse is scrolled to the left.
	DeltaY float32
}

MouseWheel is a mouse wheel event.

type TouchBegin

type TouchBegin struct {
	// ID identifies the touch that caused the touch event.
	ID int

	// X is the X position of the touch. This value is expressed in device independent pixels.
	X float32

	// Y is the Y position of the touch. This value is expressed in device independent pixels.
	Y float32

	// DeltaX is the change in X since last touch event. This value is expressed in device independent pixels.
	DeltaX float32

	// Deltay is the change in Y since last touch event. This value is expressed in device independent pixels.
	Deltay float32

	// Pressure of applied touch. It varies between 0.0 for not pressed, and 1.0 for completely pressed.
	Pressure float32

	// Primary represents whether the touch event is the primary touch or not. If it is true, then it is a primary touch. If it is false then it is not.
	Primary bool
}

TouchBegin occurs when a touch begins.

type TouchCancel

type TouchCancel struct {
	// ID identifies the touch that caused the touch event.
	ID int
}

TouchCancel occurs when a touch is canceled. This can happen in various situations, depending on the underlying platform, for example when the application loses focus.

type TouchEnd

type TouchEnd struct {
	// ID identifies the touch that caused the touch event.
	ID int

	// X is the X position of the touch. This value is expressed in device independent pixels.
	X float32

	// Y is the Y position of the touch. This value is expressed in device independent pixels.
	Y float32

	// DeltaX is the change in X since last touch event. This value is expressed in device independent pixels.
	DeltaX float32

	// Deltay is the change in Y since last touch event. This value is expressed in device independent pixels.
	Deltay float32

	// Pressure of applied touch. It varies between 0.0 for not pressed, and 1.0 for completely pressed.
	Pressure float32

	// Primary represents whether the touch event is the primary touch or not. If it is true, then it is a primary touch. If it is false then it is not.
	Primary bool
}

TouchEnd occurs when a touch ends.

type TouchMove

type TouchMove struct {
	// ID identifies the touch that caused the touch event.
	ID int

	// X is the X position of the touch. This value is expressed in device independent pixels.
	X float32

	// Y is the Y position of the touch. This value is expressed in device independent pixels.
	Y float32

	// DeltaX is the change in X since last touch event. This value is expressed in device independent pixels.
	DeltaX float32

	// Deltay is the change in Y since last touch event. This value is expressed in device independent pixels.
	Deltay float32

	// Pressure of applied touch. It varies between 0.0 for not pressed, and 1.0 for completely pressed.
	Pressure float32

	// Primary represents whether the touch event is the primary touch or not. If it is true, then it is a primary touch. If it is false then it is not.
	Primary bool
}

TouchMove occurs when a touch moved, or in other words, is dragged.

type ViewSize

type ViewSize struct {
	// Width is the width of the view. This value is expressed in device independent pixels.
	Width int

	// Height is the height of the view. This value is expressed in device independent pixels.
	Height int
}

ViewSize occurs when the size of the application's view port changes.

type ViewUpdate

type ViewUpdate struct {
}

ViewUpdate occurs when the application is ready to update the next frame on the view port.

Jump to

Keyboard shortcuts

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