Module rokol::app[][src]

Expand description

Application (FFI)

Rokol::run runs an implementation of RApp.

Structs

Rokol modifier keys as bitflags

Enums

Traits

rokol::app callbacks

rokol::app callbacks for C

Functions

Cancel a pending quit (when SAPP_EVENTTYPE_QUIT_REQUESTED has been received)

(Clipboard) Read string from clipboard (usually during SAPP_EVENTTYPE_CLIPBOARD_PASTED)

TODO: use crate::gfx::PixelFormat as return value

Call from inside event callback to consume the current event (don’t forward to platform)

Dpi scaling factor (window pixels to framebuffer pixels)

(Drag) The dropped file paths

Current frame counter (for comparison with sapp_event.frame_count)

Frame duration in seconds averaged over a number of frames to smooth out any jittering spikes

Height of the current frame buffer in pixels

True when high_dpi was requested and actually running in a high-dpi scenario

(Mobile) True if the mobile device onscreen keyboard is currently shown

True if in mouse-pointer-lock mode (this may toggle a few frames later)

Show or hide the mouse cursor

Returns true after Rokol app is initialized

(Drag) The total number of dropped files (after an SAPP_EVENTTYPE_FILES_DROPPED event)

Initiate a “hard quit” (quit application without sending SAPP_EVENTTYPE_QUIT_REQUSTED)

Initiate a “soft quit” (sends SAPP_EVENTTYPE_QUIT_REQUESTED)

Default frame buffer count

(Clipboard) Write string into clipboard

(Mobile) Show or hide the mobile device onscreen keyboard

Show or hide the mouse cursor

(Desktop) Set the window title (only on desktop platforms)

(Non-Sokol) size of the current frame buffer in pixels

(Non-Sokol) size of the current frame buffer in pixels

(Non-Sokol) size of the window (not the frame buffer)

Width of the current frame buffer in pixels

Type Definitions

rokol::app application event