Struct egui::ViewportInfo

source ·
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>,
}
Expand description

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 orresponds 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.

§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.

§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§

source§

impl ViewportInfo

source

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.

source

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

Trait Implementations§

source§

impl Clone for ViewportInfo

source§

fn clone(&self) -> ViewportInfo

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ViewportInfo

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ViewportInfo

source§

fn default() -> ViewportInfo

Returns the “default value” for a type. Read more
source§

impl PartialEq for ViewportInfo

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for ViewportInfo

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,