Struct PlatformOutput 

pub struct PlatformOutput {
    pub commands: Vec<OutputCommand>,
    pub cursor_icon: CursorIcon,
    pub cursor_image: Option<CustomCursorImage>,
    pub events: Vec<OutputEvent>,
    pub mutable_text_under_cursor: bool,
    pub ime: Option<IMEOutput>,
    pub accesskit_update: Option<TreeUpdate>,
    pub num_completed_passes: usize,
    pub request_discard_reasons: Vec<RepaintCause>,
}

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

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

The backend should use this.

Fields

commands: Vec<OutputCommand>

Commands that the egui integration should execute at the end of a frame.

cursor_icon: CursorIcon

Set the cursor to this icon.

cursor_image: Option<CustomCursorImage>

If set, the integration should display this RGBA image as the OS cursor (via e.g. winit::window::CustomCursor) instead of the standard cursor_icon. Set per frame; integrations that don’t support custom cursors fall back to cursor_icon.

Skipped from serde because the bitmap is ephemeral and shouldn’t roundtrip through persisted state.

events: Vec<OutputEvent>

Events that may be useful to e.g. a screen reader.

mutable_text_under_cursor: bool

Is there a mutable TextEdit under the cursor? Use by eframe web to show/hide mobile keyboard and IME agent.

ime: Option<IMEOutput>

This is set if, and only if, the user is currently editing text.

Useful for IME.

This field should only be set by the widget that currently owns IME events (see crate::Memory::owns_ime_events).

accesskit_update: Option<TreeUpdate>

The difference in the widget tree since last frame.

NOTE: this needs to be per-viewport.

num_completed_passes: usize

How many ui passes is this the sum of?

See crate::Context::request_discard for details.

This is incremented at the END of each frame, so this will be 0 for the first pass.

request_discard_reasons: Vec<RepaintCause>

Was crate::Context::request_discard called during the latest pass?

If so, what was the reason(s) for it?

If empty, there was never any calls.

Implementations

impl PlatformOutput

pub fn events_description(&self) -> String

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

pub fn append(&mut self, newer: Self)

Add on new output.

pub fn take(&mut self) -> Self

Take everything ephemeral (everything except cursor_icon and cursor_image currently)

pub fn requested_discard(&self) -> bool

Was crate::Context::request_discard called?

Trait Implementations

impl Clone for PlatformOutput

fn clone(&self) -> PlatformOutput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for PlatformOutput

fn default() -> PlatformOutput

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PlatformOutput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PlatformOutput

fn eq(&self, other: &PlatformOutput) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PlatformOutput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PlatformOutput