pub enum ViewportCommand {
Show 32 variants Close, CancelClose, Title(String), Transparent(bool), Visible(bool), StartDrag, OuterPosition(Pos2), InnerSize(Vec2), MinInnerSize(Vec2), MaxInnerSize(Vec2), ResizeIncrements(Option<Vec2>), BeginResize(ResizeDirection), Resizable(bool), EnableButtons { close: bool, minimized: bool, maximize: bool, }, Minimized(bool), Maximized(bool), Fullscreen(bool), Decorations(bool), WindowLevel(WindowLevel), Icon(Option<Arc<IconData>>), IMERect(Rect), IMEAllowed(bool), IMEPurpose(IMEPurpose), Focus, RequestUserAttention(UserAttentionType), SetTheme(SystemTheme), ContentProtected(bool), CursorPosition(Pos2), CursorGrab(CursorGrab), CursorVisible(bool), MousePassthrough(bool), Screenshot,
}
Expand description

An output viewport-command from egui to the backend, e.g. to change the window title or size.

You can send a ViewportCommand to the viewport with Context::send_viewport_cmd.

See crate::viewport for how to build new viewports (native windows).

All coordinates are in logical points.

This is essentially a way to diff ViewportBuilder.

Variants§

§

Close

Request this viewport to be closed.

For the root viewport, this usually results in the application shutting down. For other viewports, the crate::ViewportInfo::close_requested flag will be set.

§

CancelClose

Cancel the closing that was signaled by crate::ViewportInfo::close_requested.

§

Title(String)

Set the window title.

§

Transparent(bool)

Turn the window transparent or not.

§

Visible(bool)

Set the visibility of the window.

§

StartDrag

Moves the window with the left mouse button until the button is released.

There’s no guarantee that this will work unless the left mouse button was pressed immediately before this function is called.

§

OuterPosition(Pos2)

Set the outer position of the viewport, i.e. moves the window.

§

InnerSize(Vec2)

Should be bigger than 0

§

MinInnerSize(Vec2)

Should be bigger than 0

§

MaxInnerSize(Vec2)

Should be bigger than 0

§

ResizeIncrements(Option<Vec2>)

Should be bigger than 0

§

BeginResize(ResizeDirection)

Begin resizing the viewport with the left mouse button until the button is released.

There’s no guarantee that this will work unless the left mouse button was pressed immediately before this function is called.

§

Resizable(bool)

Can the window be resized?

§

EnableButtons

Fields

§close: bool
§minimized: bool
§maximize: bool

Set which window buttons are enabled

§

Minimized(bool)

§

Maximized(bool)

Maximize or unmaximize window.

§

Fullscreen(bool)

Turn borderless fullscreen on/off.

§

Decorations(bool)

Show window decorations, i.e. the chrome around the content with the title bar, close buttons, resize handles, etc.

§

WindowLevel(WindowLevel)

Set window to be always-on-top, always-on-bottom, or neither.

§

Icon(Option<Arc<IconData>>)

The the window icon.

§

IMERect(Rect)

Set the IME cursor editing area.

§

IMEAllowed(bool)

§

IMEPurpose(IMEPurpose)

§

Focus

Bring the window into focus (native only).

This command puts the window on top of other applications and takes input focus away from them, which, if unexpected, will disturb the user.

Has no effect on Wayland, or if the window is minimized or invisible.

§

RequestUserAttention(UserAttentionType)

If the window is unfocused, attract the user’s attention (native only).

Typically, this means that the window will flash on the taskbar, or bounce, until it is interacted with.

When the window comes into focus, or if None is passed, the attention request will be automatically reset.

See winit’s documentation for platform-specific effect details.

§

SetTheme(SystemTheme)

§

ContentProtected(bool)

§

CursorPosition(Pos2)

Will probably not work as expected!

§

CursorGrab(CursorGrab)

§

CursorVisible(bool)

§

MousePassthrough(bool)

Enable mouse pass-through: mouse clicks pass through the window, used for non-interactable overlays.

§

Screenshot

Take a screenshot.

The results are returned in crate::Event::Screenshot.

Implementations§

source§

impl ViewportCommand

source

pub fn center_on_screen(ctx: &Context) -> Option<Self>

Construct a command to center the viewport on the monitor, if possible.

source

pub fn requires_parent_repaint(&self) -> bool

This command requires the parent viewport to repaint.

Trait Implementations§

source§

impl Clone for ViewportCommand

source§

fn clone(&self) -> ViewportCommand

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 ViewportCommand

source§

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

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

impl PartialEq for ViewportCommand

source§

fn eq(&self, other: &ViewportCommand) -> 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 Eq for ViewportCommand

source§

impl StructuralEq for ViewportCommand

source§

impl StructuralPartialEq for ViewportCommand

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,