`tecs.platform.window`

Host-neutral state and commands for one application window.

Nupp owns the requested configuration and the last state observed from the host. Rust owns the winit window. Game-facing setters enqueue typed commands; they do not update getters optimistically because a compositor may reject or defer a request. The host drains commands, applies them, and reports a complete state snapshot or a failure for the originating serial.

Module contents

Types

Type	Kind	Description
`Command`	type	One command drained by the Rust winit adapter.
`CommandFailure`	record	A host rejection associated with one command serial.
`CreateOptions`	record	The validated creation request read by the Rust host.
`CursorGrab`	type	A pointer confinement mode understood by winit.
`HostState`	record	A complete host observation applied atomically to a window.
`Options`	type	Optional settings copied when the application is constructed.
`RequestRedrawCommand`	record	A request for a redraw callback on the next suitable host turn.
`SetCursorGrabCommand`	record	A request to change pointer confinement.
`SetCursorVisibleCommand`	record	A request to show or hide the pointer.
`SetFullscreenCommand`	record	A request to enter or leave borderless desktop fullscreen.
`SetPositionCommand`	record	A request to move the top-left client position.
`SetResizableCommand`	record	A request to enable or disable edge resizing.
`SetSizeCommand`	record	A request to change the logical client size.
`SetTitleCommand`	record	A request to change the desktop title.
`SetVisibleCommand`	record	A request to map or unmap the window.
`Window`	record	The game-facing handle for one Rust-owned window.

Functions

Function	Kind	Description
`applyState`	function	Replaces observed state after the host applies commands or reads the OS.
`attach`	function	Attaches the OS window and atomically installs its initial observed state.
`detach`	function	Detaches an OS window after host teardown.
`drainCommands`	function	Removes the current pending command batch for the host to process.
`handleEvent`	function	Folds a translated window event before game observers receive it.
`newWindow`	function	Creates a detached window contract without opening an OS window.
`reportFailure`	function	Records a non-empty operational failure for one command.
`takeFailures`	function	Removes the current command failures for game-side diagnostics.

Types#

`Command`type#

type Command = SetTitleCommand
| SetSizeCommand
| SetPositionCommand
| SetVisibleCommand
| SetResizableCommand
| SetFullscreenCommand
| SetCursorVisibleCommand
| SetCursorGrabCommand
| RequestRedrawCommand

One command drained by the Rust winit adapter.

`CommandFailure`record#

record CommandFailure ...

A host rejection associated with one command serial.

Members

Name	Kind	Description
`serial`	field
`reason`	field

`serial`field#

serial: integer

`reason`field#

reason: string

`CreateOptions`record#

record CreateOptions ...

The validated creation request read by the Rust host.

Members

Name	Kind	Description
`title`	field
`width`	field
`height`	field
`resizable`	field
`fullscreen`	field
`decorations`	field
`visible`	field
`alwaysOnTop`	field
`transparent`	field
`x`	field
`y`	field
`minWidth`	field
`minHeight`	field
`maxWidth`	field
`maxHeight`	field

`title`field#

title: string

`width`field#

width: integer

`height`field#

height: integer

`resizable`field#

resizable: boolean

`fullscreen`field#

fullscreen: boolean

`decorations`field#

decorations: boolean

`visible`field#

visible: boolean

`alwaysOnTop`field#

alwaysOnTop: boolean

`transparent`field#

transparent: boolean

`x`field#

x: integer?

`y`field#

y: integer?

`minWidth`field#

minWidth: integer?

`minHeight`field#

minHeight: integer?

`maxWidth`field#

maxWidth: integer?

`maxHeight`field#

maxHeight: integer?

`CursorGrab`type#

type CursorGrab = "none" | "confined" | "locked"

A pointer confinement mode understood by winit.

`HostState`record#

record HostState ...

A complete host observation applied atomically to a window.

Members

Name	Kind	Description
`id`	field
`title`	field
`width`	field
`height`	field
`pixelWidth`	field
`pixelHeight`	field
`scaleFactor`	field
`x`	field
`y`	field
`focused`	field
`visible`	field
`minimized`	field
`maximized`	field
`fullscreen`	field
`occluded`	field
`resizable`	field
`cursorVisible`	field
`cursorGrab`	field

`id`field#

id: integer

`title`field#

title: string

`width`field#

width: integer

`height`field#

height: integer

`pixelWidth`field#

pixelWidth: integer

`pixelHeight`field#

pixelHeight: integer

`scaleFactor`field#

scaleFactor: number

`x`field#

x: integer

`y`field#

y: integer

`focused`field#

focused: boolean

`visible`field#

visible: boolean

`minimized`field#

minimized: boolean

`maximized`field#

maximized: boolean

`fullscreen`field#

fullscreen: boolean

`occluded`field#

occluded: boolean

`resizable`field#

resizable: boolean

`cursorVisible`field#

cursorVisible: boolean

`cursorGrab`field#

cursorGrab: CursorGrab

`Options`type#

type Options = {
    title: string?,
    width: integer?,
    height: integer?,
    resizable: boolean?,
    fullscreen: boolean?,
    borderless: boolean?,
    hidden: boolean?,
    alwaysOnTop: boolean?,
    transparent: boolean?,
    x: integer?,
    y: integer?,
    minWidth: integer?,
    minHeight: integer?,
    maxWidth: integer?,
    maxHeight: integer?
}

Optional settings copied when the application is constructed.

`RequestRedrawCommand`record#

record RequestRedrawCommand ...

A request for a redraw callback on the next suitable host turn.

Members

Name	Kind	Description
`kind`	field
`serial`	field

`kind`field#

kind: "requestRedraw"

`serial`field#

serial: integer

`SetCursorGrabCommand`record#

record SetCursorGrabCommand ...

A request to change pointer confinement.

Members

Name	Kind	Description
`kind`	field
`serial`	field
`mode`	field

`kind`field#

kind: "setCursorGrab"

`serial`field#

serial: integer

`mode`field#

mode: CursorGrab

`SetCursorVisibleCommand`record#

record SetCursorVisibleCommand ...

A request to show or hide the pointer.

Members

Name	Kind	Description
`kind`	field
`serial`	field
`visible`	field

`kind`field#

kind: "setCursorVisible"

`serial`field#

serial: integer

`visible`field#

visible: boolean

`SetFullscreenCommand`record#

record SetFullscreenCommand ...

A request to enter or leave borderless desktop fullscreen.

Members

Name	Kind	Description
`kind`	field
`serial`	field
`fullscreen`	field

`kind`field#

kind: "setFullscreen"

`serial`field#

serial: integer

`fullscreen`field#

fullscreen: boolean

`SetPositionCommand`record#

record SetPositionCommand ...

A request to move the top-left client position.

Members

Name	Kind	Description
`kind`	field
`serial`	field
`x`	field
`y`	field

`kind`field#

kind: "setPosition"

`serial`field#

serial: integer

`x`field#

x: integer

`y`field#

y: integer

`SetResizableCommand`record#

record SetResizableCommand ...

A request to enable or disable edge resizing.

Members

Name	Kind	Description
`kind`	field
`serial`	field
`resizable`	field

`kind`field#

kind: "setResizable"

`serial`field#

serial: integer

`resizable`field#

resizable: boolean

`SetSizeCommand`record#

record SetSizeCommand ...

A request to change the logical client size.

Members

Name	Kind	Description
`kind`	field
`serial`	field
`width`	field
`height`	field

`kind`field#

kind: "setSize"

`serial`field#

serial: integer

`width`field#

width: integer

`height`field#

height: integer

`SetTitleCommand`record#

record SetTitleCommand ...

A request to change the desktop title.

Members

Name	Kind	Description
`kind`	field
`serial`	field
`title`	field

`kind`field#

kind: "setTitle"

`serial`field#

serial: integer

`title`field#

title: string

`SetVisibleCommand`record#

record SetVisibleCommand ...

A request to map or unmap the window.

Members

Name	Kind	Description
`kind`	field
`serial`	field
`visible`	field

`kind`field#

kind: "setVisible"

`serial`field#

serial: integer

`visible`field#

visible: boolean

`Window`record#

record Window ...

The game-facing handle for one Rust-owned window.

Members

Name	Kind	Description
`create`	field
`state`	field
`attached`	field
`nextSerial`	field
`pending`	field
`failures`	field
`creationOptions`	method
`isAttached`	method
`id`	method
`title`	method
`getSize`	method
`getPixelSize`	method
`scaleFactor`	method
`position`	method
`hasFocus`	method
`isVisible`	method
`isMinimized`	method
`isMaximized`	method
`isFullscreen`	method
`isOccluded`	method
`isResizable`	method
`isCursorVisible`	method
`cursorGrab`	method
`setTitle`	method
`setSize`	method
`setPosition`	method
`setVisible`	method
`setResizable`	method
`setFullscreen`	method
`setCursorVisible`	method
`setCursorGrab`	method
`requestRedraw`	method

`create`field#

create: CreateOptions

@private

`state`field#

state: HostState

@private

`attached`field#

attached: boolean

@private

`nextSerial`field#

nextSerial: integer

@private

`pending`field#

pending: {Command}

@private

`failures`field#

failures: {CommandFailure}

@private

`creationOptions`method#

creationOptions: function(borrows self: Window): CreateOptions

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`CreateOptions`

`isAttached`method#

isAttached: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`id`method#

id: function(borrows self: Window): integer

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`integer`

`title`method#

title: function(borrows self: Window): string

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`string`

`getSize`method#

getSize: function(borrows self: Window): (integer, integer)

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`integer`
`integer`

`getPixelSize`method#

getPixelSize: function(borrows self: Window): (integer, integer)

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`integer`
`integer`

`scaleFactor`method#

scaleFactor: function(borrows self: Window): number

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`number`

`position`method#

position: function(borrows self: Window): (integer, integer)

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`integer`
`integer`

`hasFocus`method#

hasFocus: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isVisible`method#

isVisible: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isMinimized`method#

isMinimized: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isMaximized`method#

isMaximized: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isFullscreen`method#

isFullscreen: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isOccluded`method#

isOccluded: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isResizable`method#

isResizable: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isCursorVisible`method#

isCursorVisible: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`cursorGrab`method#

cursorGrab: function(borrows self: Window): CursorGrab

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`CursorGrab`

`setTitle`method#

setTitle: function(exclusive self: Window, title: string): integer

Arguments

Name	Type	Description
`exclusive self`	`Window`
`title`	`string`

Returns

Type	Description
`integer`

`setSize`method#

setSize: function(exclusive self: Window, width: integer, height: integer): integer

Arguments

Name	Type	Description
`exclusive self`	`Window`
`width`	`integer`
`height`	`integer`

Returns

Type	Description
`integer`

`setPosition`method#

setPosition: function(exclusive self: Window, x: integer, y: integer): integer

Arguments

Name	Type	Description
`exclusive self`	`Window`
`x`	`integer`
`y`	`integer`

Returns

Type	Description
`integer`

`setVisible`method#

setVisible: function(exclusive self: Window, visible: boolean): integer

Arguments

Name	Type	Description
`exclusive self`	`Window`
`visible`	`boolean`

Returns

Type	Description
`integer`

`setResizable`method#

setResizable: function(exclusive self: Window, resizable: boolean): integer

Arguments

Name	Type	Description
`exclusive self`	`Window`
`resizable`	`boolean`

Returns

Type	Description
`integer`

`setFullscreen`method#

setFullscreen: function(exclusive self: Window, fullscreen: boolean): integer

Arguments

Name	Type	Description
`exclusive self`	`Window`
`fullscreen`	`boolean`

Returns

Type	Description
`integer`

`setCursorVisible`method#

setCursorVisible: function(exclusive self: Window, visible: boolean): integer

Arguments

Name	Type	Description
`exclusive self`	`Window`
`visible`	`boolean`

Returns

Type	Description
`integer`

`setCursorGrab`method#

setCursorGrab: function(exclusive self: Window, mode: CursorGrab): integer

Arguments

Name	Type	Description
`exclusive self`	`Window`
`mode`	`CursorGrab`

Returns

Type	Description
`integer`

`requestRedraw`method#

requestRedraw: function(exclusive self: Window): integer

Arguments

Name	Type	Description
`exclusive self`	`Window`

Returns

Type	Description
`integer`

Functions#

`applyState`function#

function applyState(exclusive window: Window, state: HostState): nil

Replaces observed state after the host applies commands or reads the OS.

Arguments

Name	Type	Description
`exclusive window`	`Window`	the attached window contract
`state`	`HostState`	the complete new state

Returns

Type	Description
`nil`

`attach`function#

function attach(exclusive window: Window, state: HostState): nil

Attaches the OS window and atomically installs its initial observed state.

Arguments

Name	Type	Description
`exclusive window`	`Window`	the contract the host created the OS window for
`state`	`HostState`	the complete initial state

Returns

Type	Description
`nil`

Raises

Type	Condition
`string`	when already attached or when the state is invalid

`detach`function#

function detach(exclusive window: Window): nil

Detaches an OS window after host teardown.

Arguments

Name	Type	Description
`exclusive window`	`Window`	the contract to detach

Returns

Type	Description
`nil`

`drainCommands`function#

function drainCommands(exclusive window: Window): {Command}

Removes the current pending command batch for the host to process.

Arguments

Name	Type	Description
`exclusive window`	`Window`	the window whose requests the host is draining

Returns

Type	Description
`{Command}`	the ordered command batch, which the caller owns

`handleEvent`function#

function handleEvent(exclusive window: Window, event: platformevents.Event): nil

Folds a translated window event before game observers receive it.

Arguments

Name	Type	Description
`exclusive window`	`Window`	the window contract receiving the event
`event`	`platformevents.Event`	the ordered platform event

Returns

Type	Description
`nil`

`newWindow`function#

function newWindow(options: Options?): Window

Creates a detached window contract without opening an OS window.

Arguments

Name	Type	Description
`options`	`Options?`	the copied and validated creation options

Returns

Type	Description
`Window`	a window ready for the Rust host to attach

`reportFailure`function#

function reportFailure(exclusive window: Window, serial: integer, reason: string): nil

Records a non-empty operational failure for one command.

Arguments

Name	Type	Description
`exclusive window`	`Window`	the originating window
`serial`	`integer`	the rejected command serial
`reason`	`string`	the host failure suitable for diagnostics

Returns

Type	Description
`nil`

`takeFailures`function#

function takeFailures(exclusive window: Window): {CommandFailure}

Removes the current command failures for game-side diagnostics.

Arguments

Name	Type	Description
`exclusive window`	`Window`	the window whose failures are consumed

Returns

Type	Description
`{CommandFailure}`	the ordered failure batch, which the caller owns

tecs.platform.window

Module contents

Types

Functions

Types#

Commandtype#

CommandFailurerecord#

Members

serialfield#

reasonfield#

CreateOptionsrecord#

Members

titlefield#

widthfield#

heightfield#

resizablefield#

fullscreenfield#

decorationsfield#

visiblefield#

alwaysOnTopfield#

transparentfield#

xfield#

yfield#

minWidthfield#

minHeightfield#

maxWidthfield#

maxHeightfield#

CursorGrabtype#

HostStaterecord#

Members

idfield#

titlefield#

widthfield#

heightfield#

pixelWidthfield#

pixelHeightfield#

scaleFactorfield#

xfield#

yfield#

focusedfield#

visiblefield#

minimizedfield#

maximizedfield#

fullscreenfield#

occludedfield#

resizablefield#

cursorVisiblefield#

cursorGrabfield#

Optionstype#

RequestRedrawCommandrecord#

Members

kindfield#

serialfield#

SetCursorGrabCommandrecord#

Members

kindfield#

serialfield#

modefield#

SetCursorVisibleCommandrecord#

Members

kindfield#

serialfield#

visiblefield#

SetFullscreenCommandrecord#

Members

kindfield#

serialfield#

fullscreenfield#

SetPositionCommandrecord#

Members

kindfield#

serialfield#

xfield#

yfield#

SetResizableCommandrecord#

Members

kindfield#

serialfield#

resizablefield#

SetSizeCommandrecord#

`tecs.platform.window`

`Command`type#

`CommandFailure`record#

`serial`field#

`reason`field#

`CreateOptions`record#

`title`field#

`width`field#

`height`field#

`resizable`field#

`fullscreen`field#

`decorations`field#

`visible`field#

`alwaysOnTop`field#

`transparent`field#

`x`field#

`y`field#

`minWidth`field#

`minHeight`field#

`maxWidth`field#

`maxHeight`field#

`CursorGrab`type#

`HostState`record#

`id`field#

`title`field#

`width`field#

`height`field#

`pixelWidth`field#

`pixelHeight`field#

`scaleFactor`field#

`x`field#

`y`field#

`focused`field#

`visible`field#

`minimized`field#

`maximized`field#

`fullscreen`field#

`occluded`field#

`resizable`field#

`cursorVisible`field#

`cursorGrab`field#

`Options`type#

`RequestRedrawCommand`record#

`kind`field#

`serial`field#

`SetCursorGrabCommand`record#

`kind`field#

`serial`field#

`mode`field#

`SetCursorVisibleCommand`record#

`kind`field#

`serial`field#

`visible`field#

`SetFullscreenCommand`record#

`kind`field#

`serial`field#

`fullscreen`field#

`SetPositionCommand`record#

`kind`field#

`serial`field#

`x`field#

`y`field#

`SetResizableCommand`record#

`kind`field#

`serial`field#

`resizable`field#

`SetSizeCommand`record#

`kind`field#

`serial`field#

`width`field#

`height`field#

`SetTitleCommand`record#

`kind`field#

`serial`field#

`title`field#

`SetVisibleCommand`record#

`kind`field#

`serial`field#

`visible`field#

`Window`record#