`tecs.platform.events`

Typed platform events produced by the Rust host.

Every kind is its own nupp.events declaration, so a world delivers a key press to the observers of KeyDown and nothing else, and the twelve shapes the kinds share are unions of the declarations that carry them. Kind strings are a stable external data surface used by recordings and tools. Rust translates winit events into these records and passes one ordered batch to tecs.application.Application:iterate.

Module contents

Types

Type	Kind	Description
`Event`	type	An event in one sealed host batch.
`FingerCanceled`	record	A touch the platform cancelled.
`FingerDown`	record	A finger touching the surface.
`FingerMotion`	record	A finger moving on the surface.
`FingerUp`	record	A finger leaving the surface.
`FocusEvent`	type	A window focus transition.
`GamepadAdded`	record	A gamepad appearing.
`GamepadAxis`	record	A gamepad axis reading.
`GamepadAxisEvent`	type	A gamepad axis reading.
`GamepadButtonDown`	record	A gamepad button going down.
`GamepadButtonEvent`	type	A gamepad button transition.
`GamepadButtonUp`	record	A gamepad button coming up.
`GamepadDeviceEvent`	type	A gamepad appearing or going away.
`GamepadRemoved`	record	A gamepad going away.
`KeyDown`	record	A key going down.
`KeyEvent`	type	A physical and logical keyboard transition.
`KeyUp`	record	A key coming up.
`Kind`	type	A platform event kind supported by the Rust host.
`MouseDown`	record	A pointer button going down.
`MouseMotion`	record	An absolute pointer position and optional relative movement.
`MouseUp`	record	A pointer button coming up.
`MouseWheel`	record	A normalized pointer wheel movement.
`PointerButtonEvent`	type	A pointer button transition.
`PointerMoveEvent`	type	An absolute pointer position and optional relative movement.
`Quit`	record	A process quit request.
`QuitEvent`	type	A process or window close request.
`ResizeEvent`	type	A logical window size change.
`TextEvent`	type	Text committed by the platform input method.
`TextInput`	record	Text committed by the platform input method.
`TouchEvent`	type	One finger on a touch surface.
`WheelEvent`	type	A normalized pointer wheel movement.
`WindowCloseRequested`	record	A close request for one window.
`WindowFocusGained`	record	A window gaining focus.
`WindowFocusLost`	record	A window losing focus.
`WindowResized`	record	A logical window resize.
`WindowScaleChanged`	record	A scale-factor change with the resulting logical size.

Functions

Function	Kind	Description
`closeRequested`	function	Constructs a close request for one window.
`dispatch`	function	Delivers one translated event to the world's observers of its kind.
`focused`	function	Constructs a window focus transition.
`gamepadAxis`	function	Constructs a gamepad axis reading.
`gamepadButton`	function	Constructs a gamepad button transition.
`gamepadDevice`	function	Constructs a gamepad appearing or going away.
`key`	function	Constructs a keyboard transition.
`kinds`	function	Returns every platform event kind, in the union's declared order.
`pointerButton`	function	Constructs a pointer button transition.
`pointerMoved`	function	Constructs an absolute pointer movement.
`quit`	function	Constructs a process or window close request.
`resized`	function	Constructs a logical window resize.
`scaleChanged`	function	Constructs a scale-factor change with the resulting logical size.
`text`	function	Constructs committed text input.
`touch`	function	Constructs one finger's transition or movement.
`wheel`	function	Constructs normalized pointer wheel movement.

Types#

`Event`type#

type Event = Quit
| WindowCloseRequested
| WindowResized
| WindowScaleChanged
| WindowFocusGained
| WindowFocusLost
| KeyDown
| KeyUp
| MouseMotion
| MouseDown
| MouseUp
| MouseWheel
| TextInput
| FingerDown
| FingerUp
| FingerMotion
| FingerCanceled
| GamepadAdded
| GamepadRemoved
| GamepadButtonDown
| GamepadButtonUp
| GamepadAxis

An event in one sealed host batch.

`FingerCanceled`record#

record FingerCanceled ...

@derive(events.Event)@event(name="tecs.platform.events.fingerCanceled")

A touch the platform cancelled.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`touchDevice`	field
`finger`	field
`x`	field
`y`	field
`dx`	field
`dy`	field
`normalX`	field
`normalY`	field
`pressure`	field
`down`	field

`kind`field#

kind: "fingerCanceled"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`touchDevice`field#

touchDevice: string

`finger`field#

finger: string

`x`field#

x: number

`y`field#

y: number

`dx`field#

dx: number

`dy`field#

dy: number

`normalX`field#

normalX: number

`normalY`field#

normalY: number

`pressure`field#

pressure: number

`down`field#

down: boolean

`FingerDown`record#

record FingerDown ...

@derive(events.Event)@event(name="tecs.platform.events.fingerDown")

A finger touching the surface.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`touchDevice`	field
`finger`	field
`x`	field
`y`	field
`dx`	field
`dy`	field
`normalX`	field
`normalY`	field
`pressure`	field
`down`	field

`kind`field#

kind: "fingerDown"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`touchDevice`field#

touchDevice: string

`finger`field#

finger: string

`x`field#

x: number

`y`field#

y: number

`dx`field#

dx: number

`dy`field#

dy: number

`normalX`field#

normalX: number

`normalY`field#

normalY: number

`pressure`field#

pressure: number

`down`field#

down: boolean

`FingerMotion`record#

record FingerMotion ...

@derive(events.Event)@event(name="tecs.platform.events.fingerMotion")

A finger moving on the surface.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`touchDevice`	field
`finger`	field
`x`	field
`y`	field
`dx`	field
`dy`	field
`normalX`	field
`normalY`	field
`pressure`	field
`down`	field

`kind`field#

kind: "fingerMotion"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`touchDevice`field#

touchDevice: string

`finger`field#

finger: string

`x`field#

x: number

`y`field#

y: number

`dx`field#

dx: number

`dy`field#

dy: number

`normalX`field#

normalX: number

`normalY`field#

normalY: number

`pressure`field#

pressure: number

`down`field#

down: boolean

`FingerUp`record#

record FingerUp ...

@derive(events.Event)@event(name="tecs.platform.events.fingerUp")

A finger leaving the surface.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`touchDevice`	field
`finger`	field
`x`	field
`y`	field
`dx`	field
`dy`	field
`normalX`	field
`normalY`	field
`pressure`	field
`down`	field

`kind`field#

kind: "fingerUp"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`touchDevice`field#

touchDevice: string

`finger`field#

finger: string

`x`field#

x: number

`y`field#

y: number

`dx`field#

dx: number

`dy`field#

dy: number

`normalX`field#

normalX: number

`normalY`field#

normalY: number

`pressure`field#

pressure: number

`down`field#

down: boolean

`FocusEvent`type#

type FocusEvent = WindowFocusGained | WindowFocusLost

A window focus transition.

Whichever kind carries this shape; an observer written against it fits any of them.

`GamepadAdded`record#

record GamepadAdded ...

@derive(events.Event)@event(name="tecs.platform.events.gamepadAdded")

A gamepad appearing.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`which`	field

`kind`field#

kind: "gamepadAdded"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`which`field#

which: integer

`GamepadAxis`record#

record GamepadAxis ...

@derive(events.Event)@event(name="tecs.platform.events.gamepadAxis")

A gamepad axis reading.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`which`	field
`axis`	field
`value`	field

`kind`field#

kind: "gamepadAxis"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`which`field#

which: integer

`axis`field#

axis: integer

`value`field#

value: number

`GamepadAxisEvent`type#

type GamepadAxisEvent = GamepadAxis

A gamepad axis reading.

`GamepadButtonDown`record#

record GamepadButtonDown ...

@derive(events.Event)@event(name="tecs.platform.events.gamepadButtonDown")

A gamepad button going down.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`which`	field
`button`	field
`down`	field

`kind`field#

kind: "gamepadButtonDown"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`which`field#

which: integer

`button`field#

button: integer

`down`field#

down: boolean

`GamepadButtonEvent`type#

type GamepadButtonEvent = GamepadButtonDown | GamepadButtonUp

A gamepad button transition.

Whichever kind carries this shape; an observer written against it fits any of them.

`GamepadButtonUp`record#

record GamepadButtonUp ...

@derive(events.Event)@event(name="tecs.platform.events.gamepadButtonUp")

A gamepad button coming up.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`which`	field
`button`	field
`down`	field

`kind`field#

kind: "gamepadButtonUp"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`which`field#

which: integer

`button`field#

button: integer

`down`field#

down: boolean

`GamepadDeviceEvent`type#

type GamepadDeviceEvent = GamepadAdded | GamepadRemoved

A gamepad appearing or going away.

Compatibility surface: which names the device rather than the window. window is zero because a gamepad belongs to no window.

Whichever kind carries this shape; an observer written against it fits any of them.

`GamepadRemoved`record#

record GamepadRemoved ...

@derive(events.Event)@event(name="tecs.platform.events.gamepadRemoved")

A gamepad going away.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`which`	field

`kind`field#

kind: "gamepadRemoved"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`which`field#

which: integer

`KeyDown`record#

record KeyDown ...

@derive(events.Event)@event(name="tecs.platform.events.keyDown")

A key going down.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`physicalKey`	field
`logicalKey`	field
`text`	field
`modifiers`	field
`repeated`	field
`down`	field

`kind`field#

kind: "keyDown"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`physicalKey`field#

physicalKey: string

`logicalKey`field#

logicalKey: string?

`text`field#

text: string?

`modifiers`field#

modifiers: integer

`repeated`field#

repeated: boolean

`down`field#

down: boolean

`KeyEvent`type#

type KeyEvent = KeyDown | KeyUp

A physical and logical keyboard transition.

Whichever kind carries this shape; an observer written against it fits any of them.

`KeyUp`record#

record KeyUp ...

@derive(events.Event)@event(name="tecs.platform.events.keyUp")

A key coming up.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`physicalKey`	field
`logicalKey`	field
`text`	field
`modifiers`	field
`repeated`	field
`down`	field

`kind`field#

kind: "keyUp"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`physicalKey`field#

physicalKey: string

`logicalKey`field#

logicalKey: string?

`text`field#

text: string?

`modifiers`field#

modifiers: integer

`repeated`field#

repeated: boolean

`down`field#

down: boolean

`Kind`type#

type Kind = "quit"
| "windowCloseRequested"
| "windowResized"
| "windowScaleChanged"
| "windowFocusGained"
| "windowFocusLost"
| "keyDown"
| "keyUp"
| "mouseMotion"
| "mouseDown"
| "mouseUp"
| "mouseWheel"
| "textInput"
| "fingerDown"
| "fingerUp"
| "fingerMotion"
| "fingerCanceled"
| "gamepadAdded"
| "gamepadRemoved"
| "gamepadButtonDown"
| "gamepadButtonUp"
| "gamepadAxis"

A platform event kind supported by the Rust host.

`MouseDown`record#

record MouseDown ...

@derive(events.Event)@event(name="tecs.platform.events.mouseDown")

A pointer button going down.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`x`	field
`y`	field
`button`	field
`clicks`	field
`down`	field

`kind`field#

kind: "mouseDown"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`x`field#

x: number

`y`field#

y: number

`button`field#

button: integer

`clicks`field#

clicks: integer

`down`field#

down: boolean

`MouseMotion`record#

record MouseMotion ...

@derive(events.Event)@event(name="tecs.platform.events.mouseMotion")

An absolute pointer position and optional relative movement.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`x`	field
`y`	field
`dx`	field
`dy`	field

`kind`field#

kind: "mouseMotion"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`x`field#

x: number

`y`field#

y: number

`dx`field#

dx: number

`dy`field#

dy: number

`MouseUp`record#

record MouseUp ...

@derive(events.Event)@event(name="tecs.platform.events.mouseUp")

A pointer button coming up.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`x`	field
`y`	field
`button`	field
`clicks`	field
`down`	field

`kind`field#

kind: "mouseUp"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`x`field#

x: number

`y`field#

y: number

`button`field#

button: integer

`clicks`field#

clicks: integer

`down`field#

down: boolean

`MouseWheel`record#

record MouseWheel ...

@derive(events.Event)@event(name="tecs.platform.events.mouseWheel")

A normalized pointer wheel movement.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`x`	field
`y`	field
`wheelX`	field
`wheelY`	field
`wheelTicksX`	field
`wheelTicksY`	field

`kind`field#

kind: "mouseWheel"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`x`field#

x: number

`y`field#

y: number

`wheelX`field#

wheelX: number

`wheelY`field#

wheelY: number

`wheelTicksX`field#

wheelTicksX: integer

`wheelTicksY`field#

wheelTicksY: integer

`PointerButtonEvent`type#

type PointerButtonEvent = MouseDown | MouseUp

A pointer button transition.

Whichever kind carries this shape; an observer written against it fits any of them.

`PointerMoveEvent`type#

type PointerMoveEvent = MouseMotion

An absolute pointer position and optional relative movement.

`Quit`record#

record Quit ...

@derive(events.Event)@event(name="tecs.platform.events.quit")

A process quit request.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field

`kind`field#

kind: "quit"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`QuitEvent`type#

type QuitEvent = Quit | WindowCloseRequested

A process or window close request.

Whichever kind carries this shape; an observer written against it fits any of them.

`ResizeEvent`type#

type ResizeEvent = WindowResized | WindowScaleChanged

A logical window size change.

Whichever kind carries this shape; an observer written against it fits any of them.

`TextEvent`type#

type TextEvent = TextInput

Text committed by the platform input method.

`TextInput`record#

record TextInput ...

@derive(events.Event)@event(name="tecs.platform.events.textInput")

Text committed by the platform input method.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`text`	field

`kind`field#

kind: "textInput"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`text`field#

text: string

`TouchEvent`type#

type TouchEvent = FingerDown | FingerUp | FingerMotion | FingerCanceled

One finger on a touch surface.

Compatibility surface: touchDevice and finger are stable field names, and both stay strings because a device and a finger are 64-bit identities that a Lua number would round together.

Whichever kind carries this shape; an observer written against it fits any of them.

`WheelEvent`type#

type WheelEvent = MouseWheel

A normalized pointer wheel movement.

`WindowCloseRequested`record#

record WindowCloseRequested ...

@derive(events.Event)@event(name="tecs.platform.events.windowCloseRequested")

A close request for one window.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field

`kind`field#

kind: "windowCloseRequested"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`WindowFocusGained`record#

record WindowFocusGained ...

@derive(events.Event)@event(name="tecs.platform.events.windowFocusGained")

A window gaining focus.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`focused`	field

`kind`field#

kind: "windowFocusGained"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`focused`field#

focused: boolean

`WindowFocusLost`record#

record WindowFocusLost ...

@derive(events.Event)@event(name="tecs.platform.events.windowFocusLost")

A window losing focus.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`focused`	field

`kind`field#

kind: "windowFocusLost"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`focused`field#

focused: boolean

`WindowResized`record#

record WindowResized ...

@derive(events.Event)@event(name="tecs.platform.events.windowResized")

A logical window resize.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`width`	field
`height`	field
`pixelWidth`	field
`pixelHeight`	field
`scaleFactor`	field

`kind`field#

kind: "windowResized"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`width`field#

width: integer

`height`field#

height: integer

`pixelWidth`field#

pixelWidth: integer

`pixelHeight`field#

pixelHeight: integer

`scaleFactor`field#

scaleFactor: number

`WindowScaleChanged`record#

record WindowScaleChanged ...

@derive(events.Event)@event(name="tecs.platform.events.windowScaleChanged")

A scale-factor change with the resulting logical size.

Members

Name	Kind	Description
`kind`	field
`timestamp`	field
`sequence`	field
`window`	field
`width`	field
`height`	field
`pixelWidth`	field
`pixelHeight`	field
`scaleFactor`	field

`kind`field#

kind: "windowScaleChanged"

`timestamp`field#

timestamp: number

`sequence`field#

sequence: integer

`window`field#

window: integer

`width`field#

width: integer

`height`field#

height: integer

`pixelWidth`field#

pixelWidth: integer

`pixelHeight`field#

pixelHeight: integer

`scaleFactor`field#

scaleFactor: number

Functions#

`closeRequested`function#

function closeRequested(window: integer?, timestamp: number?, sequence: integer?): QuitEvent

Constructs a close request for one window.

Arguments

Name	Type	Description
`window`	`integer?`
`timestamp`	`number?`
`sequence`	`integer?`

Returns

Type	Description
`QuitEvent`

`dispatch`function#

function dispatch(exclusive world: ecs.World, event: Event): nil

Delivers one translated event to the world's observers of its kind.

The host's instance is delivered as it is: nothing is copied or constructed, and observers receive it as a borrow for the call.

Arguments

Name	Type	Description
`exclusive world`	`ecs.World`	the receiving world
`event`	`Event`	the translated platform event

Returns

Type	Description
`nil`

`focused`function#

function focused(focused: boolean, window: integer?, timestamp: number?, sequence: integer?): FocusEvent

Constructs a window focus transition.

Arguments

Name	Type	Description
`focused`	`boolean`
`window`	`integer?`
`timestamp`	`number?`
`sequence`	`integer?`

Returns

Type	Description
`FocusEvent`

`gamepadAxis`function#

function gamepadAxis(which: integer, axis: integer, value: number, timestamp: number?, sequence: integer?): GamepadAxisEvent

Constructs a gamepad axis reading.

Arguments

Name	Type	Description
`which`	`integer`	the device identifier the backend issued
`axis`	`integer`	the axis code `tecs.input` resolves a name to
`value`	`number`	the reading from -1 to 1, with a trigger running zero to one
`timestamp`	`number?`	the host time the platform reported
`sequence`	`integer?`	the host's ordering number for the batch

Returns

Type	Description
`GamepadAxisEvent`	the constructed axis event

Raises

Type	Condition
`string`	when the axis code is not positive

`gamepadButton`function#

function gamepadButton(down: boolean, which: integer, button: integer, timestamp: number?, sequence: integer?): GamepadButtonEvent

Constructs a gamepad button transition.

Arguments

Name	Type	Description
`down`	`boolean`	whether the button went down rather than came up
`which`	`integer`	the device identifier the backend issued
`button`	`integer`	the positional button code `tecs.input` resolves a name to
`timestamp`	`number?`	the host time the platform reported
`sequence`	`integer?`	the host's ordering number for the batch

Returns

Type	Description
`GamepadButtonEvent`	the constructed button event

Raises

Type	Condition
`string`	when the button code is not positive

`gamepadDevice`function#

function gamepadDevice(added: boolean, which: integer, timestamp: number?, sequence: integer?): GamepadDeviceEvent

Constructs a gamepad appearing or going away.

Arguments

Name	Type	Description
`added`	`boolean`	whether the device appeared rather than went away
`which`	`integer`	the device identifier the backend issued
`timestamp`	`number?`	the host time the platform reported
`sequence`	`integer?`	the host's ordering number for the batch

Returns

Type	Description
`GamepadDeviceEvent`	the constructed device event

`key`function#

function key(down: boolean, physicalKey: string, logicalKey: string?, text: string?, modifiers: integer?, repeated: boolean?, window: integer?, timestamp: number?, sequence: integer?): KeyEvent

Constructs a keyboard transition.

Arguments

Name	Type	Description
`down`	`boolean`
`physicalKey`	`string`
`logicalKey`	`string?`
`text`	`string?`
`modifiers`	`integer?`
`repeated`	`boolean?`
`window`	`integer?`
`timestamp`	`number?`
`sequence`	`integer?`

Returns

Type	Description
`KeyEvent`

`kinds`function#

function kinds(): {string}

Returns every platform event kind, in the union's declared order.

Compatibility surface: each string is the externally typed kind an agent names over the debug protocol, so the spellings here are the same ones Kind declares and must not change with a module move. The union is a type and cannot be read at run time, so a caller that needs the kinds as data reads them here rather than keeping a second copy that drifts.

Returns

Type	Description
`{string}`	a fresh caller-owned list of the twenty-two kind strings

`pointerButton`function#

function pointerButton(down: boolean, button: integer, x: number, y: number, clicks: integer?, window: integer?, timestamp: number?, sequence: integer?): PointerButtonEvent

Constructs a pointer button transition.

Arguments

Name	Type	Description
`down`	`boolean`
`button`	`integer`
`x`	`number`
`y`	`number`
`clicks`	`integer?`
`window`	`integer?`
`timestamp`	`number?`
`sequence`	`integer?`

Returns

Type	Description
`PointerButtonEvent`

`pointerMoved`function#

function pointerMoved(x: number, y: number, dx: number?, dy: number?, window: integer?, timestamp: number?, sequence: integer?): PointerMoveEvent

Constructs an absolute pointer movement.

Arguments

Name	Type	Description
`x`	`number`
`y`	`number`
`dx`	`number?`
`dy`	`number?`
`window`	`integer?`
`timestamp`	`number?`
`sequence`	`integer?`

Returns

Type	Description
`PointerMoveEvent`

`quit`function#

function quit(window: integer?, timestamp: number?, sequence: integer?): QuitEvent

Constructs a process or window close request.

Arguments

Name	Type	Description
`window`	`integer?`
`timestamp`	`number?`
`sequence`	`integer?`

Returns

Type	Description
`QuitEvent`

`resized`function#

function resized(width: integer, height: integer, window: integer?, scaleFactor: number?, timestamp: number?, sequence: integer?, pixelWidth: integer?, pixelHeight: integer?): ResizeEvent

Constructs a logical window resize.

Arguments

Name	Type	Description
`width`	`integer`
`height`	`integer`
`window`	`integer?`
`scaleFactor`	`number?`
`timestamp`	`number?`
`sequence`	`integer?`
`pixelWidth`	`integer?`
`pixelHeight`	`integer?`

Returns

Type	Description
`ResizeEvent`

`scaleChanged`function#

function scaleChanged(scaleFactor: number, width: integer, height: integer, window: integer?, timestamp: number?, sequence: integer?, pixelWidth: integer?, pixelHeight: integer?): ResizeEvent

Constructs a scale-factor change with the resulting logical size.

Arguments

Name	Type	Description
`scaleFactor`	`number`
`width`	`integer`
`height`	`integer`
`window`	`integer?`
`timestamp`	`number?`
`sequence`	`integer?`
`pixelWidth`	`integer?`
`pixelHeight`	`integer?`

Returns

Type	Description
`ResizeEvent`

`text`function#

function text(text: string, window: integer?, timestamp: number?, sequence: integer?): TextEvent

Constructs committed text input.

Arguments

Name	Type	Description
`text`	`string`
`window`	`integer?`
`timestamp`	`number?`
`sequence`	`integer?`

Returns

Type	Description
`TextEvent`

`touch`function#

function touch(phase: "fingerDown" | "fingerUp" | "fingerMotion" | "fingerCanceled", touchDevice: string, finger: string, x: number, y: number, normalX: number?, normalY: number?, pressure: number?, dx: number?, dy: number?, window: integer?, timestamp: number?, sequence: integer?): TouchEvent

Constructs one finger's transition or movement.

x and y are in the window's logical coordinates, normalX and normalY run from zero to one across the touch surface, and pressure runs from zero to one where the surface reports it and is one where it does not.

Arguments

Name	Type	Description
`phase`	`"fingerDown" \| "fingerUp" \| "fingerMotion" \| "fingerCanceled"`	the finger's transition, spelled as the event kind
`touchDevice`	`string`	the touch surface's opaque identity
`finger`	`string`	the finger's opaque identity on that surface
`x`	`number`	the position in logical window coordinates
`y`	`number`	the position in logical window coordinates
`normalX`	`number?`	the position across the surface, from zero to one
`normalY`	`number?`	the position down the surface, from zero to one
`pressure`	`number?`	the reported pressure from zero to one
`dx`	`number?`	the movement since the previous event, in logical coordinates
`dy`	`number?`	the movement since the previous event, in logical coordinates
`window`	`integer?`	the window the touch is over
`timestamp`	`number?`	the host time the platform reported
`sequence`	`integer?`	the host's ordering number for the batch

Returns

Type	Description
`TouchEvent`	the constructed touch event

Raises

Type	Condition
`string`	when the finger identity is empty

`wheel`function#

function wheel(wheelX: number, wheelY: number, ticksX: integer?, ticksY: integer?, x: number?, y: number?, window: integer?, timestamp: number?, sequence: integer?): WheelEvent

Constructs normalized pointer wheel movement.

Arguments

Name	Type	Description
`wheelX`	`number`
`wheelY`	`number`
`ticksX`	`integer?`
`ticksY`	`integer?`
`x`	`number?`
`y`	`number?`
`window`	`integer?`
`timestamp`	`number?`
`sequence`	`integer?`

Returns

Type	Description
`WheelEvent`

tecs.platform.events

Module contents

Types

Functions

Types#

Eventtype#

FingerCanceledrecord#

Members

kindfield#

timestampfield#

sequencefield#

windowfield#

touchDevicefield#

fingerfield#

xfield#

yfield#

dxfield#

dyfield#

normalXfield#

normalYfield#

pressurefield#

downfield#

FingerDownrecord#

Members

kindfield#

timestampfield#

sequencefield#

windowfield#

touchDevicefield#

fingerfield#

xfield#

yfield#

dxfield#

dyfield#

normalXfield#

normalYfield#

pressurefield#

downfield#

FingerMotionrecord#

Members

kindfield#

timestampfield#

sequencefield#

windowfield#

touchDevicefield#

fingerfield#

xfield#

yfield#

dxfield#

dyfield#

normalXfield#

normalYfield#

pressurefield#

downfield#

FingerUprecord#

Members

kindfield#

timestampfield#

sequencefield#

windowfield#

touchDevicefield#

fingerfield#

xfield#

yfield#

dxfield#

dyfield#

normalXfield#

normalYfield#

pressurefield#

downfield#

FocusEventtype#

GamepadAddedrecord#

Members

kindfield#

timestampfield#

sequencefield#

windowfield#

whichfield#

GamepadAxisrecord#

Members

`tecs.platform.events`

`Event`type#

`FingerCanceled`record#

`kind`field#

`timestamp`field#

`sequence`field#

`window`field#

`touchDevice`field#

`finger`field#

`x`field#

`y`field#

`dx`field#

`dy`field#

`normalX`field#

`normalY`field#

`pressure`field#

`down`field#

`FingerDown`record#

`kind`field#

`timestamp`field#

`sequence`field#

`window`field#

`touchDevice`field#

`finger`field#

`x`field#

`y`field#

`dx`field#

`dy`field#

`normalX`field#

`normalY`field#

`pressure`field#

`down`field#

`FingerMotion`record#

`kind`field#

`timestamp`field#

`sequence`field#

`window`field#

`touchDevice`field#

`finger`field#

`x`field#

`y`field#

`dx`field#

`dy`field#

`normalX`field#

`normalY`field#

`pressure`field#

`down`field#

`FingerUp`record#

`kind`field#

`timestamp`field#

`sequence`field#

`window`field#

`touchDevice`field#

`finger`field#

`x`field#

`y`field#

`dx`field#

`dy`field#

`normalX`field#

`normalY`field#

`pressure`field#

`down`field#

`FocusEvent`type#

`GamepadAdded`record#

`kind`field#

`timestamp`field#

`sequence`field#

`window`field#

`which`field#

`GamepadAxis`record#

`kind`field#

`timestamp`field#

`sequence`field#

`window`field#

`which`field#

`axis`field#

`value`field#

`GamepadAxisEvent`type#

`GamepadButtonDown`record#

`kind`field#