Skip to main content

Crate sui_platform

Crate sui_platform 

Source

Structs§

AccessibilityIssue
AccessibilitySnapshot
DebugCaptureTicket
Identifies a requested capture until its result is collected.
DesktopAutomationConfig
DesktopExtensionContext
Read-only state supplied to a DesktopExtension update.
DesktopFramePresented
DesktopPlatform
DesktopWindow
A live winit window exposed to a desktop extension.
FileDialogFilter
FileDialogRequest
FileDialogSelection
HeadlessPlatform
NativeFileDialogs
OsClipboardBackend
OS-clipboard bridge backed by arboard, installed into the runtime by the desktop platform so widget copy/paste interoperates with other applications.
OsUrlOpenerBackend
Opens URLs with the program the system registers for their scheme, using the open crate. The desktop platform installs it into the runtime.
PlatformFile
A file the user chose in a file dialog, or found in a chosen folder.
PlatformFolder
A folder the user chose in a folder dialog, or found inside one.
PlatformWindow
PresentedFrame
What presenting a frame produced, for the host’s own bookkeeping.
PumpedDesktop
A desktop application that its host drives one event-loop turn at a time with pump, instead of blocking in DesktopPlatform::run_with.
WakeSignal
Background-thread signal that wakes the desktop event loop (carried as a winit user event).
Waker
A cheap, cloneable, Send handle that wakes the running desktop UI from any thread. Pending wake calls are coalesced into one event-loop signal. This is a scheduler primitive: it does not synthesize or route a widget event.
WindowOutputDiagnostics

Enums§

AccessibilityIssueSeverity
AccessibilityIssueTarget
DesktopAutomationAction
DesktopPumpStatus
What a host should do after PumpedDesktop::pump.
FileDialogMode
FolderEntry
A file or folder inside a PlatformFolder.

Traits§

DesktopExtension
Optional integration driven alongside SUI’s desktop event loop.
FileDialogService

Functions§

clear_window_output_diagnostics
clear_window_output_diagnostics_all
detect_window_display_capabilities
has_pending_window_debug_captures
Whether window_id has captures waiting for a redraw or being copied back.
present_window_frame
Render window_id’s next frame and present it with renderer.
publish_frame_performance
publish_window_output_diagnostics
Record the output diagnostics of the frame just presented for window_id. Widgets observing window_output_diagnostics_signal are invalidated when they differ from the last frame’s.
request_window_debug_capture
Ask for a capture of window_id after its next redraw. When it is done, wake (if any) is delivered to the widget that registered it; collect the artifact with take_window_debug_capture.
resolve_sdr_content_brightness_nits
service_window_debug_captures
Begin every capture waiting for window_id from the frame renderer last drew for it, collect the ones that are back, and return the wake tokens to deliver with Runtime::wake_async.
show_file_dialog
Show a dialog from an async context.
take_window_debug_capture
The capture for ticket, once the platform has made it. Returns None while it is pending; each result is handed out once.
validate_accessibility_snapshot
Validate a semantic snapshot using the shared accessibility contract used by inspectors, terminal rendering, and test tooling.
window_output_diagnostics
The output diagnostics of the last frame presented for window_id.
window_output_diagnostics_signal
The output diagnostics of window_id as a signal, for widgets that show them: observe it with MeasureCtx::observe or PaintCtx::observe to be invalidated when a presented frame’s diagnostics change. It holds None until the window’s first frame is presented.

Type Aliases§

FileDialogFuture