Struct show_image::WindowOptions
source · [−]pub struct WindowOptions {
pub preserve_aspect_ratio: bool,
pub background_color: Color,
pub start_hidden: bool,
pub size: Option<[u32; 2]>,
pub resizable: bool,
pub borderless: bool,
pub overlays_visible: bool,
pub default_controls: bool,
}
Expand description
Options for creating a new window.
Fields
preserve_aspect_ratio: bool
Preserve the aspect ratio of the image when scaling.
background_color: Color
The background color for the window.
This is used to color areas without image data if preserve_aspect_ratio
is true.
Create the window hidden.
The window can manually be made visible at a later time.
size: Option<[u32; 2]>
The initial size of the window in pixel.
This may be ignored by some window managers.
resizable: bool
If true allow the window to be resized.
This may be ignored by some window managers.
borderless: bool
Make the window borderless.
overlays_visible: bool
If true, draw overlays on the image.
Defaults to true.
default_controls: bool
If true, enable default mouse based controls for panning and zooming the image.
Defaults to true.
Implementations
sourceimpl WindowOptions
impl WindowOptions
sourcepub fn set_preserve_aspect_ratio(self, preserve_aspect_ratio: bool) -> Self
pub fn set_preserve_aspect_ratio(self, preserve_aspect_ratio: bool) -> Self
Preserve the aspect ratio of displayed images, or not.
This function consumes and returns self
to allow daisy chaining.
sourcepub fn set_background_color(self, background_color: Color) -> Self
pub fn set_background_color(self, background_color: Color) -> Self
Set the background color of the window.
This function consumes and returns self
to allow daisy chaining.
Start the window hidden.
This function consumes and returns self
to allow daisy chaining.
sourcepub fn set_size(self, size: impl Into<Option<[u32; 2]>>) -> Self
pub fn set_size(self, size: impl Into<Option<[u32; 2]>>) -> Self
Set the initial size of the window.
Pass None
to clear a previously set value,
which will let the window manager choose the initial size.
This property may be ignored by some window managers.
This function consumes and returns self
to allow daisy chaining.
sourcepub fn set_resizable(self, resizable: bool) -> Self
pub fn set_resizable(self, resizable: bool) -> Self
Make the window resizable or not.
This property may be ignored by some window managers.
This function consumes and returns self
to allow daisy chaining.
sourcepub fn set_borderless(self, borderless: bool) -> Self
pub fn set_borderless(self, borderless: bool) -> Self
Make the window borderless or not.
This function consumes and returns self
to allow daisy chaining.
sourcepub fn set_show_overlays(self, overlays_visible: bool) -> Self
pub fn set_show_overlays(self, overlays_visible: bool) -> Self
Set whether or not overlays should be drawn on the window.
sourcepub fn set_default_controls(self, default_controls: bool) -> Self
pub fn set_default_controls(self, default_controls: bool) -> Self
Set whether or not default mouse controls for panning and zooming the image should be added.
Trait Implementations
sourceimpl Clone for WindowOptions
impl Clone for WindowOptions
sourcefn clone(&self) -> WindowOptions
fn clone(&self) -> WindowOptions
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for WindowOptions
impl Debug for WindowOptions
Auto Trait Implementations
impl RefUnwindSafe for WindowOptions
impl Send for WindowOptions
impl Sync for WindowOptions
impl Unpin for WindowOptions
impl UnwindSafe for WindowOptions
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more