Skip to main content

Module pump_host

Module pump_host 

Source
Expand description

Desktop pump-mode FFI for macOS bundle launchers and other GUI hosts.

A bundle UI can own its process/UI lifecycle and drive Siglus with siglus_pump_step rather than entering winit’s blocking run_app.

Structs§

SiglusPumpHandle

Functions§

run_game
Runs a game in its own window until it ends. With physical_pixels, the window is sized in physical pixels and input is mapped without the display’s HiDPI scale (what the launcher app uses for every engine).
siglus_pump_create⚠
Create a host to drive with siglus_pump_step, or return null on failure.
siglus_pump_destroy⚠
Destroy a pump host. A null pointer is ignored.
siglus_pump_ime_preedit⚠
Update IME composition, or disable IME if the text pointer is null.
siglus_pump_key_down⚠
Send a key press to the host.
siglus_pump_key_up⚠
Send a key release to the host.
siglus_pump_set_native_messagebox_callback⚠
Set the callback used to display native message boxes.
siglus_pump_step⚠
Pump pending events and return the host status.
siglus_pump_submit_messagebox_result⚠
Submit the result of a native message box.
siglus_pump_text_input⚠
Send committed text to the host.
siglus_run_entry⚠
Run the host event loop until exit.