Struct show_image::WindowOptions

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 show_overlays: bool,
}

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.

start_hidden: bool

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 a window manager.

resizable: bool

If true allow the window to be resized.

This may be ignored by a window manager.

borderless: bool

Make the window borderless.

show_overlays: bool

If true, draw overlays on the image.

Defaults to true.

Implementations

impl WindowOptions

pub fn set_preserve_aspect_ratio(
    mut self: 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.

pub fn set_background_color(mut self: Self, background_color: Color) -> Self

Set the background color of the window.

This function consumes and returns self to allow daisy chaining.

pub fn set_start_hidden(mut self: Self, start_hidden: bool) -> Self

Start the window hidden.

This function consumes and returns self to allow daisy chaining.

pub fn set_size(mut self: Self, size: [u32; 2]) -> Self

Set the initial size of the window.

This property may be ignored by a window manager.

This function consumes and returns self to allow daisy chaining.

pub fn set_resizable(mut self: Self, resizable: bool) -> Self

Make the window resizable or not.

This property may be ignored by a window manager.

This function consumes and returns self to allow daisy chaining.

pub fn set_borderless(mut self: Self, borderless: bool) -> Self

Make the window borderless or not.

This function consumes and returns self to allow daisy chaining.

pub fn set_show_overlays(mut self: Self, show_overlays: bool) -> Self

Set wether or not overlays should be drawn on the window.

Trait Implementations

impl Clone for WindowOptions

fn clone(&self) -> WindowOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowOptions

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

Formats the value using the given formatter.

impl Default for WindowOptions

fn default() -> Self

Returns the "default value" for a type.