Struct ViewportInfo

pub struct ViewportInfo {
    pub parent: Option<ViewportId>,
    pub title: Option<String>,
    pub events: Vec<ViewportEvent>,
    pub native_pixels_per_point: Option<f32>,
    pub monitor_size: Option<Vec2>,
    pub inner_rect: Option<Rect>,
    pub outer_rect: Option<Rect>,
    pub minimized: Option<bool>,
    pub maximized: Option<bool>,
    pub fullscreen: Option<bool>,
    pub focused: Option<bool>,
}

Information about the current viewport, given as input each frame.

None means “unknown”.

All units are in ui “points”, which can be calculated from native physical pixels using pixels_per_point = crate::Context::zoom_factor * [Self::native_pixels_per_point];

Fields

parent: Option<ViewportId>

Parent viewport, if known.

title: Option<String>

Name of the viewport, if known.

events: Vec<ViewportEvent>

native_pixels_per_point: Option<f32>

The OS native pixels-per-point.

This should always be set, if known.

On web this takes browser scaling into account, and corresponds to window.devicePixelRatio in JavaScript.

monitor_size: Option<Vec2>

Current monitor size in egui points.

inner_rect: Option<Rect>

The inner rectangle of the native window, in monitor space and ui points scale.

This is the content rectangle of the viewport.

eframe notes:

On Android / Wayland, this will always be None since getting the position of the window is not possible.

outer_rect: Option<Rect>

The outer rectangle of the native window, in monitor space and ui points scale.

This is the content rectangle plus decoration chrome.

eframe notes:

On Android / Wayland, this will always be None since getting the position of the window is not possible.

minimized: Option<bool>

Are we minimized?

maximized: Option<bool>

Are we maximized?

fullscreen: Option<bool>

Are we in fullscreen mode?

focused: Option<bool>

Is the window focused and able to receive input?

This should be the same as RawInput::focused.

Implementations

impl ViewportInfo

pub fn close_requested(&self) -> bool

This viewport has been told to close.

If this is the root viewport, the application will exit after this frame unless you send a crate::ViewportCommand::CancelClose command.

If this is not the root viewport, it is up to the user to hide this viewport the next frame.

pub fn take(&mut self) -> Self

Helper: move Self::events, clone the other fields.

pub fn ui(&self, ui: &mut Ui)

Trait Implementations

impl Clone for ViewportInfo

fn clone(&self) -> ViewportInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewportInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ViewportInfo

fn default() -> ViewportInfo

Returns the “default value” for a type.

impl PartialEq for ViewportInfo

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ViewportInfo