Struct eframe::NativeOptions

source ·
pub struct NativeOptions {
Show 28 fields pub always_on_top: bool, pub maximized: bool, pub decorated: bool, pub fullscreen: bool, pub drag_and_drop_support: bool, pub icon_data: Option<IconData>, pub initial_window_pos: Option<Pos2>, pub initial_window_size: Option<Vec2>, pub min_window_size: Option<Vec2>, pub max_window_size: Option<Vec2>, pub resizable: bool, pub transparent: bool, pub mouse_passthrough: bool, pub active: bool, pub vsync: bool, pub multisampling: u16, pub depth_buffer: u8, pub stencil_buffer: u8, pub hardware_acceleration: HardwareAcceleration, pub renderer: Renderer, pub follow_system_theme: bool, pub default_theme: Theme, pub run_and_return: bool, pub event_loop_builder: Option<EventLoopBuilderHook>, pub shader_version: Option<ShaderVersion>, pub centered: bool, pub wgpu_options: WgpuConfiguration, pub app_id: Option<String>,
}
Expand description

Options controlling the behavior of a native window.

Only a single native window is currently supported.

Fields§

§always_on_top: bool

Sets whether or not the window will always be on top of other windows at initialization.

§maximized: bool

Show window in maximized mode

§decorated: bool

On desktop: add window decorations (i.e. a frame around your app)? If false it will be difficult to move and resize the app.

§fullscreen: bool

Start in (borderless) fullscreen?

Default: false.

§drag_and_drop_support: bool

On Windows: enable drag and drop support. Drag and drop can not be disabled on other platforms.

See winit’s documentation for information on why you might want to disable this on windows.

§icon_data: Option<IconData>

The application icon, e.g. in the Windows task bar or the alt-tab menu.

The default icon is a white e on a black background (for “egui” or “eframe”). If you prefer the OS default, set this to None.

§initial_window_pos: Option<Pos2>

The initial (inner) position of the native window in points (logical pixels).

§initial_window_size: Option<Vec2>

The initial inner size of the native window in points (logical pixels).

§min_window_size: Option<Vec2>

The minimum inner window size in points (logical pixels).

§max_window_size: Option<Vec2>

The maximum inner window size in points (logical pixels).

§resizable: bool

Should the app window be resizable?

§transparent: bool

On desktop: make the window transparent. You control the transparency with App::clear_color(). You should avoid having a egui::CentralPanel, or make sure its frame is also transparent.

§mouse_passthrough: bool

On desktop: mouse clicks pass through the window, used for non-interactable overlays Generally you would use this in conjunction with always_on_top

§active: bool

Whether grant focus when window initially opened. True by default.

§vsync: bool

Turn on vertical syncing, limiting the FPS to the display refresh rate.

The default is true.

§multisampling: u16

Set the level of the multisampling anti-aliasing (MSAA).

Must be a power-of-two. Higher = more smooth 3D.

A value of 0 turns it off (default).

egui already performs anti-aliasing via “feathering” (controlled by [egui::epaint::TessellationOptions]), but if you are embedding 3D in egui you may want to turn on multisampling.

§depth_buffer: u8

Sets the number of bits in the depth buffer.

egui doesn’t need the depth buffer, so the default value is 0.

§stencil_buffer: u8

Sets the number of bits in the stencil buffer.

egui doesn’t need the stencil buffer, so the default value is 0.

§hardware_acceleration: HardwareAcceleration

Specify whether or not hardware acceleration is preferred, required, or not.

Default: HardwareAcceleration::Preferred.

§renderer: Renderer

What rendering backend to use.

§follow_system_theme: bool

Try to detect and follow the system preferred setting for dark vs light mode.

The theme will automatically change when the dark vs light mode preference is changed.

Does not work on Linux (see https://github.com/rust-windowing/winit/issues/1549).

See also Self::default_theme.

§default_theme: Theme

Which theme to use in case Self::follow_system_theme is false or eframe fails to detect the system theme.

Default: Theme::Dark.

§run_and_return: bool

This controls what happens when you close the main eframe window.

If true, execution will continue after the eframe window is closed. If false, the app will close once the eframe window is closed.

This is true by default, and the false option is only there so we can revert if we find any bugs.

This feature was introduced in https://github.com/emilk/egui/pull/1889.

When true, winit::platform::run_return::EventLoopExtRunReturn::run_return is used. When false, winit::event_loop::EventLoop::run is used.

§event_loop_builder: Option<EventLoopBuilderHook>

Hook into the building of an event loop before it is run.

Specify a callback here in case you need to make platform specific changes to the event loop before it is run.

Note: A NativeOptions clone will not include any event_loop_builder hook.

§shader_version: Option<ShaderVersion>

Needed for cross compiling for VirtualBox VMSVGA driver with OpenGL ES 2.0 and OpenGL 2.1 which doesn’t support SRGB texture. See https://github.com/emilk/egui/pull/1993.

For OpenGL ES 2.0: set this to egui_glow::ShaderVersion::Es100 to solve blank texture problem (by using the “fallback shader”).

§centered: bool

On desktop: make the window position to be centered at initialization.

Platform specific:

Wayland desktop currently not supported.

§wgpu_options: WgpuConfiguration

Configures wgpu instance/device/adapter/surface creation and renderloop.

§app_id: Option<String>

The application id, used for determining the folder to persist the app to.

On native the path is picked using directories_next::ProjectDirs::data_dir which is:

  • Linux: /home/UserName/.local/share/APP_ID
  • macOS: /Users/UserName/Library/Application Support/APP_ID
  • Windows: C:\Users\UserName\AppData\Roaming\APP_ID

If you don’t set Self::app_id, the title argument to crate::run_native will be used instead.

On Wayland

On Wauland this sets the Application ID for the window.

The application ID is used in several places of the compositor, e.g. for grouping windows of the same application. It is also important for connecting the configuration of a .desktop file with the window, by using the application ID as file name. This allows e.g. a proper icon handling under Wayland.

See Waylands XDG shell documentation for more information on this Wayland-specific option.

Example

fn main() -> eframe::Result<()> {

    let mut options = eframe::NativeOptions::default();
    // Set the application ID for Wayland only on Linux
    #[cfg(target_os = "linux")]
    {
        options.app_id = Some("egui-example".to_string());
    }

    eframe::run_simple_native("My egui App", options, move |ctx, _frame| {
        egui::CentralPanel::default().show(ctx, |ui| {
            ui.heading("My egui Application");
        });
    })
}

Trait Implementations§

source§

impl Clone for NativeOptions

source§

fn clone(&self) -> Self

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 Default for NativeOptions

source§

fn default() -> Self

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

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere 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.

§

impl<T> NoneValue for Twhere T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere 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 Twhere 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 Twhere 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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more