XU XUv0.13.1
EN

#window

导入方式: #window

公开 API: 3 函数, 23 方法, 4 类型, 0 常量, 0 方法集

窗口生命周期与事件循环

#window 提供轻量化窗口创建、生命周期管理与输入事件轮询(键盘、指针、滚轮、文本/IME)。跨平台事件结构体与常量定义在纯 Xu 包 window/events 中。

每个主循环帧调用 window.pump() 抽取系统事件,并对各窗口调用 target.poll() 消耗事件直至 EVENT_NONE。窗口关闭请求通过 state().close_requested 捕获。

@main
#window
#window/events

fn main() {
    options := window.Options{
        title: "Hello Window",
        width: 640,
        height: 360,
        resizable: true,
        high_pixel_density: true,
        hidden: false,
    }
    $target := window.open(&options) or {
        println("Failed to open window")
        return
    }
    println("Window opened: id=", target.id())
    window.pump() or >>
    state := target.state() or >>
    println("Window size:", state.logical_width, "x", state.logical_height)
    target.close() or >>
}

预期输出包含窗口 ID 与初始逻辑分辨率尺寸。

struct Options

XuAPI
pub struct Options {
    pub title string
    pub width int
    pub height int
    pub resizable bool
    pub high_pixel_density bool
    pub hidden bool
}

用途

Window 配置参数与选项集合。

公开字段

title string
字段(string)
width int
字段(int)
height int
字段(int)
resizable bool
字段(bool)
high_pixel_density bool
字段(bool)
hidden bool
字段(bool)

struct Window

XuAPI
pub struct Window {

}

用途

Window 上下文或状态结构体。

公开字段

此类型没有公开字段。

struct State

XuAPI
pub struct State {
    pub width int
    pub height int
    pub pixel_width int
    pub pixel_height int
    pub close_requested bool
    pub minimized bool
    pub visible bool
    pub focused bool
}

用途

承载 width、height、pixel_width、pixel_height、close_requested 等属性的结构体。

公开字段

width int
字段(int)
height int
字段(int)
pixel_width int
字段(int)
pixel_height int
字段(int)
close_requested bool
字段(bool)
minimized bool
字段(bool)
visible bool
字段(bool)
focused bool
字段(bool)

struct SafeArea

XuAPI
pub struct SafeArea {
    pub x int
    pub y int
    pub width int
    pub height int
}

用途

承载 x、y、width、height 等属性的结构体。

公开字段

x int
值
y int
值
width int
字段(int)
height int
字段(int)

open

XuAPI
pub fn open(options &Options) Window

用途

打开资源或建立网络连接。失败时抛出错误,调用方需处理或继续传播。

参数

options &Options
options(只读借用,调用方仍持有原值;类型 &Options)

返回值

Window — 该类型的值

(&Window) id

XuAPI
pub fn (window &Window) id() int

用途

返回当前控件、元素或节点的唯一标识 ID。

参数

window &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

pump

XuAPI
pub fn pump() int

用途

执行 pump 处理。失败时抛出错误,调用方需处理或继续传播。

参数

无需传入参数。

返回值

int — 该类型的值

live_count

XuAPI
pub fn live_count() int

用途

执行 live count 操作。失败时抛出错误,调用方需处理或继续传播。

参数

无需传入参数。

返回值

int — 该类型的值

(&Window) state

XuAPI
pub fn (window &Window) state() State

用途

在 &Window 上执行 state 操作。失败时抛出错误,调用方需处理或继续传播。

参数

window &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

State — 该类型的值

(&Window) safe_area

XuAPI
pub fn (window &Window) safe_area() SafeArea

用途

&Window 上的操作:执行 safe area 操作。失败时抛出错误,调用方需处理或继续传播。

参数

window &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

SafeArea — 该类型的值

(&Window) resize

XuAPI
pub fn (window &Window) resize(width int, height int) int

用途

在 &Window 上执行 resize 操作。失败时抛出错误,调用方需处理或继续传播。

参数

window &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。
width int
width(int)
height int
height(int)

返回值

int — 该类型的值

(&Window) show

XuAPI
pub fn (window &Window) show() int

用途

在 &Window 上执行 show 操作。失败时抛出错误,调用方需处理或继续传播。

参数

window &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Window) hide

XuAPI
pub fn (window &Window) hide() int

用途

在 &Window 上执行 hide 操作。失败时抛出错误,调用方需处理或继续传播。

参数

window &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Window) minimize

XuAPI
pub fn (window &Window) minimize() int

用途

在 &Window 上执行 minimize 操作。失败时抛出错误,调用方需处理或继续传播。

参数

window &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Window) restore

XuAPI
pub fn (window &Window) restore() int

用途

在 &Window 上执行 restore 操作。失败时抛出错误,调用方需处理或继续传播。

参数

window &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Window) present_rgba

XuAPI
pub fn (window &Window) present_rgba(pixels &[]u8, width int, height int) int

用途

&Window 上的操作:执行 present rgba 操作。失败时抛出错误,调用方需处理或继续传播。

参数

window &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。
pixels &[]u8
pixels(只读借用,调用方仍持有原值;类型 &[]u8)
width int
width(int)
height int
height(int)

返回值

int — 该类型的值

($&Window) close

XuAPI
pub fn (window $&Window) close() int

用途

$&Window 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

window $&Window
本次调用使用的 Window 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

int — 该类型的值

(&Window) poll

XuAPI
pub fn (target &Window) poll() events.Event

用途

在 &Window 上执行 poll 操作。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

events.Event — 该类型的值

(&Window) pending_events

XuAPI
pub fn (target &Window) pending_events() int

用途

&Window 上的操作:执行 pending events 操作。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Window) key_down

XuAPI
pub fn (target &Window) key_down(physical_key int) bool

用途

&Window 上的操作:执行 key down 操作。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。
physical_key int
physical_key(int)

返回值

bool — 是否成立

(&Window) pointer_state

XuAPI
pub fn (target &Window) pointer_state() events.PointerState

用途

&Window 上的操作:执行 pointer state 操作。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

events.PointerState — 该类型的值

(&Window) start_text_input

XuAPI
pub fn (target &Window) start_text_input() int

用途

&Window 上的操作:执行 start text input 操作。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Window) stop_text_input

XuAPI
pub fn (target &Window) stop_text_input() int

用途

&Window 上的操作:执行 stop text input 操作。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Window) text_input_active

XuAPI
pub fn (target &Window) text_input_active() bool

用途

&Window 上的操作:执行 text input active 操作。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&Window) text_input_area

XuAPI
pub fn (target &Window) text_input_area(x int, y int, width int, height int, cursor int) int

用途

&Window 上的操作:执行 text input area 操作。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。
x int
值(int)
y int
值(int)
width int
width(int)
height int
height(int)
cursor int
cursor(int)

返回值

int — 该类型的值

(&Window) clear_text_input_area

XuAPI
pub fn (target &Window) clear_text_input_area() int

用途

&Window 上的操作:执行 clear text input area 操作。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&Window) set_relative_pointer

XuAPI
pub fn (target &Window) set_relative_pointer(enabled bool) int

用途

&Window 上的操作:设置 relative pointer。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。
enabled bool
enabled(bool)

返回值

int — 该类型的值

(&Window) relative_pointer

XuAPI
pub fn (target &Window) relative_pointer() bool

用途

&Window 上的操作:执行 relative pointer 操作。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&Window) set_pointer_grab

XuAPI
pub fn (target &Window) set_pointer_grab(enabled bool) int

用途

&Window 上的操作:设置 pointer grab。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。
enabled bool
enabled(bool)

返回值

int — 该类型的值

(&Window) pointer_grab

XuAPI
pub fn (target &Window) pointer_grab() bool

用途

&Window 上的操作:执行 pointer grab 操作。失败时抛出错误,调用方需处理或继续传播。

参数

target &Window
本次调用使用的 Window 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立