S or /
egui output

SourceClass PlatformOutput

from egui import PlatformOutput
class PlatformOutput:

The non-rendering part of what egui emits each frame.

You can access (and modify) this with egui.Context.output.

The backend should use this.

Properties§

@property def copied_image(self, /) -> ColorImage |None§
@property def copied_text(self, /) -> str§
@copied_text.setter def copied_text(self, /, copied_text: str) -> None§
@property def cursor_icon(self, /) -> CursorIcon§
@cursor_icon.setter def cursor_icon(self, /, cursor_icon: CursorIcon) -> None§
@property def cursor_image(self, /) -> CustomCursorImage |None§
@cursor_image.setter def cursor_image(self, /, cursor_image: CustomCursorImage |None) -> None§
@property def ime(self, /) -> IMEOutput |None§
@ime.setter def ime(self, /, ime: IMEOutput |None) -> None§
@property def mutable_text_under_cursor(self, /) -> bool§
@mutable_text_under_cursor.setter def mutable_text_under_cursor(self, /, mutable_text_under_cursor: bool) -> None§
@property def num_completed_passes(self, /) -> int§
@num_completed_passes.setter def num_completed_passes(self, /, num_completed_passes: int) -> None§
@property def open_url(self, /) -> OpenUrl |None§
@open_url.setter def open_url(self, /, open_url: OpenUrl |None) -> None§

Methods§

Sourcedef append(self, /, newer: PlatformOutput) -> None§

Add on new output.

def commands(self, /) -> list[OutputCommand]§
def commands_len(self, /) -> int§
@staticmethod def default() -> PlatformOutput§
def events(self, /) -> list[OutputEvent]§
Sourcedef events_description(self, /) -> str§

This can be used by a text-to-speech system to describe the events (if any).

def events_len(self, /) -> int§
def has_ime(self, /) -> bool§
def push_command(self, /, command: OutputCommand) -> None§
def push_event(self, /, event: OutputEvent) -> None§
Sourcedef requested_discard(self, /) -> bool§

Was egui.Context.request_discard called?

def set_commands(self, /, commands: Sequence[OutputCommand]) -> None§
def set_events(self, /, events: Sequence[OutputEvent]) -> None§
Sourcedef take(self, /) -> PlatformOutput§

Take everything ephemeral (everything except cursor_icon and cursor_image currently)