`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

Constructors

Constructor	Description
`newWindow`	Creates a detached window contract without opening an OS window.

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.
`reportFailure`	function	Records a non-empty operational failure for one command.
`takeFailures`	function	Removes the current command failures for game-side diagnostics.

Constructors#

`newWindow`constructor#

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

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
    serial: integer
    reason: string
end

A host rejection associated with one command serial.

Fields

`serial`#

serial: integer

`reason`#

reason: string

`CreateOptions`record#

record CreateOptions
    title: string
    width: integer
    height: integer
    resizable: boolean
    fullscreen: boolean
    decorations: boolean
    visible: boolean
    alwaysOnTop: boolean
    transparent: boolean
    x: integer?
    y: integer?
    minWidth: integer?
    minHeight: integer?
    maxWidth: integer?
    maxHeight: integer?
end

The validated creation request read by the Rust host.

Fields

`title`#

title: string

`width`#

width: integer

`height`#

height: integer

`resizable`#

resizable: boolean

`fullscreen`#

fullscreen: boolean

`decorations`#

decorations: boolean

`visible`#

visible: boolean

`alwaysOnTop`#

alwaysOnTop: boolean

`transparent`#

transparent: boolean

`x`#

x: integer?

`y`#

y: integer?

`minWidth`#

minWidth: integer?

`minHeight`#

minHeight: integer?

`maxWidth`#

maxWidth: integer?

`maxHeight`#

maxHeight: integer?

`CursorGrab`type#

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

A pointer confinement mode understood by winit.

`HostState`record#

record HostState
    id: integer
    title: string
    width: integer
    height: integer
    pixelWidth: integer
    pixelHeight: integer
    scaleFactor: number
    x: integer
    y: integer
    focused: boolean
    visible: boolean
    minimized: boolean
    maximized: boolean
    fullscreen: boolean
    occluded: boolean
    resizable: boolean
    cursorVisible: boolean
    cursorGrab: CursorGrab
end

A complete host observation applied atomically to a window.

Fields

`id`#

id: integer

`title`#

title: string

`width`#

width: integer

`height`#

height: integer

`pixelWidth`#

pixelWidth: integer

`pixelHeight`#

pixelHeight: integer

`scaleFactor`#

scaleFactor: number

`x`#

x: integer

`y`#

y: integer

`focused`#

focused: boolean

`visible`#

visible: boolean

`minimized`#

minimized: boolean

`maximized`#

maximized: boolean

`fullscreen`#

fullscreen: boolean

`occluded`#

occluded: boolean

`resizable`#

resizable: boolean

`cursorVisible`#

cursorVisible: boolean

`cursorGrab`#

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
    kind: "requestRedraw"
    serial: integer
end

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

Fields

`kind`#

kind: "requestRedraw"

`serial`#

serial: integer

`SetCursorGrabCommand`record#

record SetCursorGrabCommand
    kind: "setCursorGrab"
    serial: integer
    mode: CursorGrab
end

A request to change pointer confinement.

Fields

`kind`#

kind: "setCursorGrab"

`serial`#

serial: integer

`mode`#

mode: CursorGrab

`SetCursorVisibleCommand`record#

record SetCursorVisibleCommand
    kind: "setCursorVisible"
    serial: integer
    visible: boolean
end

A request to show or hide the pointer.

Fields

`kind`#

kind: "setCursorVisible"

`serial`#

serial: integer

`visible`#

visible: boolean

`SetFullscreenCommand`record#

record SetFullscreenCommand
    kind: "setFullscreen"
    serial: integer
    fullscreen: boolean
end

A request to enter or leave borderless desktop fullscreen.

Fields

`kind`#

kind: "setFullscreen"

`serial`#

serial: integer

`fullscreen`#

fullscreen: boolean

`SetPositionCommand`record#

record SetPositionCommand
    kind: "setPosition"
    serial: integer
    x: integer
    y: integer
end

A request to move the top-left client position.

Fields

`kind`#

kind: "setPosition"

`serial`#

serial: integer

`x`#

x: integer

`y`#

y: integer

`SetResizableCommand`record#

record SetResizableCommand
    kind: "setResizable"
    serial: integer
    resizable: boolean
end

A request to enable or disable edge resizing.

Fields

`kind`#

kind: "setResizable"

`serial`#

serial: integer

`resizable`#

resizable: boolean

`SetSizeCommand`record#

record SetSizeCommand
    kind: "setSize"
    serial: integer
    width: integer
    height: integer
end

A request to change the logical client size.

Fields

`kind`#

kind: "setSize"

`serial`#

serial: integer

`width`#

width: integer

`height`#

height: integer

`SetTitleCommand`record#

record SetTitleCommand
    kind: "setTitle"
    serial: integer
    title: string
end

A request to change the desktop title.

Fields

`kind`#

kind: "setTitle"

`serial`#

serial: integer

`title`#

title: string

`SetVisibleCommand`record#

record SetVisibleCommand
    kind: "setVisible"
    serial: integer
    visible: boolean
end

A request to map or unmap the window.

Fields

`kind`#

kind: "setVisible"

`serial`#

serial: integer

`visible`#

visible: boolean

`Window`record#

record Window

    creationOptions: function(borrows self: Window): CreateOptions
    isAttached: function(borrows self: Window): boolean
    id: function(borrows self: Window): integer
    title: function(borrows self: Window): string
    getSize: function(borrows self: Window): (integer, integer)
    getPixelSize: function(borrows self: Window): (integer, integer)
    scaleFactor: function(borrows self: Window): number
    position: function(borrows self: Window): (integer, integer)
    hasFocus: function(borrows self: Window): boolean
    isVisible: function(borrows self: Window): boolean
    isMinimized: function(borrows self: Window): boolean
    isMaximized: function(borrows self: Window): boolean
    isFullscreen: function(borrows self: Window): boolean
    isOccluded: function(borrows self: Window): boolean
    isResizable: function(borrows self: Window): boolean
    isCursorVisible: function(borrows self: Window): boolean
    cursorGrab: function(borrows self: Window): CursorGrab
    setTitle: function(exclusive self: Window, title: string): integer
    setSize: function(exclusive self: Window, width: integer, height: integer): integer
    setPosition: function(exclusive self: Window, x: integer, y: integer): integer
    setVisible: function(exclusive self: Window, visible: boolean): integer
    setResizable: function(exclusive self: Window, resizable: boolean): integer
    setFullscreen: function(exclusive self: Window, fullscreen: boolean): integer
    setCursorVisible: function(exclusive self: Window, visible: boolean): integer
    setCursorGrab: function(exclusive self: Window, mode: CursorGrab): integer
    requestRedraw: function(exclusive self: Window): integer
end

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

Methods

`creationOptions`#

creationOptions: function(borrows self: Window): CreateOptions

Returns a detached copy of the validated creation request.

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`CreateOptions`

`isAttached`#

isAttached: function(borrows self: Window): boolean

Reports whether the Rust host has attached an OS window.

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`id`#

id: function(borrows self: Window): integer

Returns the application-local host window id, or zero before attachment.

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`integer`

`title`#

title: function(borrows self: Window): string

Returns the last title acknowledged by the host.

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`string`

`getSize`#

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

Returns the last logical client size observed from the host.

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`integer`
`integer`

`getPixelSize`#

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

Returns the last physical drawable size observed from the host.

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`integer`
`integer`

`scaleFactor`#

scaleFactor: function(borrows self: Window): number

Returns the current physical-pixels-per-logical-unit ratio.

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`number`

`position`#

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

Returns the last desktop position observed from the host.

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`integer`
`integer`

`hasFocus`#

hasFocus: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isVisible`#

isVisible: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isMinimized`#

isMinimized: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isMaximized`#

isMaximized: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isFullscreen`#

isFullscreen: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isOccluded`#

isOccluded: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isResizable`#

isResizable: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`isCursorVisible`#

isCursorVisible: function(borrows self: Window): boolean

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`boolean`

`cursorGrab`#

cursorGrab: function(borrows self: Window): CursorGrab

Arguments

Name	Type	Description
`borrows self`	`Window`

Returns

Type	Description
`CursorGrab`

`setTitle`#

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

Arguments

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

Returns

Type	Description
`integer`

`setSize`#

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`#

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`#

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

Arguments

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

Returns

Type	Description
`integer`

`setResizable`#

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

Arguments

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

Returns

Type	Description
`integer`

`setFullscreen`#

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

Arguments

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

Returns

Type	Description
`integer`

`setCursorVisible`#

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

Arguments

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

Returns

Type	Description
`integer`

`setCursorGrab`#

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

Arguments

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

Returns

Type	Description
`integer`

`requestRedraw`#

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

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`

`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

Constructors

Types

Functions

Constructors#

newWindowconstructor#

Arguments

Returns

Types#

Commandtype#

CommandFailurerecord#

Fields

serial#

reason#

CreateOptionsrecord#

Fields

title#

width#

height#

resizable#

fullscreen#

decorations#

visible#

alwaysOnTop#

transparent#

x#

y#

minWidth#

minHeight#

maxWidth#

maxHeight#

CursorGrabtype#

HostStaterecord#

Fields

id#

title#

width#

height#

pixelWidth#

pixelHeight#

scaleFactor#

x#

y#

focused#

visible#

minimized#

maximized#

fullscreen#

occluded#

resizable#

cursorVisible#

cursorGrab#

Optionstype#

RequestRedrawCommandrecord#

Fields

kind#

serial#

SetCursorGrabCommandrecord#

Fields

kind#

serial#

mode#

SetCursorVisibleCommandrecord#

Fields

kind#

serial#

visible#

SetFullscreenCommandrecord#

Fields

kind#

serial#

fullscreen#

SetPositionCommandrecord#

Fields

kind#

serial#

x#

y#

SetResizableCommandrecord#

`tecs.platform.window`

`newWindow`constructor#

`Command`type#

`CommandFailure`record#

`serial`#

`reason`#

`CreateOptions`record#

`title`#

`width`#

`height`#

`resizable`#

`fullscreen`#

`decorations`#

`visible`#

`alwaysOnTop`#

`transparent`#

`x`#

`y`#

`minWidth`#

`minHeight`#

`maxWidth`#

`maxHeight`#

`CursorGrab`type#

`HostState`record#

`id`#

`title`#

`width`#

`height`#

`pixelWidth`#

`pixelHeight`#

`scaleFactor`#

`x`#

`y`#

`focused`#

`visible`#

`minimized`#

`maximized`#

`fullscreen`#

`occluded`#

`resizable`#

`cursorVisible`#

`cursorGrab`#

`Options`type#

`RequestRedrawCommand`record#

`kind`#

`serial`#

`SetCursorGrabCommand`record#

`kind`#

`serial`#

`mode`#

`SetCursorVisibleCommand`record#

`kind`#

`serial`#

`visible`#

`SetFullscreenCommand`record#

`kind`#

`serial`#

`fullscreen`#

`SetPositionCommand`record#

`kind`#

`serial`#

`x`#

`y`#

`SetResizableCommand`record#

`kind`#

`serial`#

`resizable`#

`SetSizeCommand`record#

`kind`#

`serial`#

`width`#

`height`#

`SetTitleCommand`record#

`kind`#

`serial`#

`title`#

`SetVisibleCommand`record#

`kind`#

`serial`#

`visible`#