Struct cat_engine::WindowSettings

pub struct WindowSettings {
    pub initial_colour: Option<Colour>,
    pub mouse_cursor_icon_path: PathBuf,
    pub mouse_cursor_icon_range: Range<usize>,
    pub inner_size: Option<Size>,
    pub min_inner_size: Option<Size>,
    pub max_inner_size: Option<Size>,
    pub resizable: bool,
    pub fullscreen: Option<Fullscreen>,
    pub title: String,
    pub maximized: bool,
    pub visible: bool,
    pub transparent: bool,
    pub decorations: bool,
    pub always_on_top: bool,
    pub window_icon: Option<Icon>,
    pub debug: bool,
    pub vsync: bool,
    pub hardware_accelerated: Option<bool>,
    pub color_bits: Option<u8>,
    pub float_color_buffer: bool,
    pub alpha_bits: Option<u8>,
    pub depth_bits: Option<u8>,
    pub stencil_bits: Option<u8>,
    pub double_buffer: Option<bool>,
    pub multisampling: Option<u16>,
    pub stereoscopy: bool,
    pub srgb: bool,
    pub release_behavior: ReleaseBehavior,
    pub texture_vertex_buffer_size: usize,
    pub simple_vertex_buffer_size: usize,
    pub text_vertex_buffer_size: usize,
}

Fields

initial_colour: Option<Colour>

Whether the window should be filled with given colour upon creation.

The default is None.

mouse_cursor_icon_path: PathBuf

The path for the mouse cursor icon.

The default is ./mouse_cursor_icon.png.

feature = "mouse_cursor_icon"

mouse_cursor_icon_range: Range<usize>

The range of the texture vertex buffer to save the mouse cursor vertexes.

The default is 4..8.

feature = "mouse_cursor_icon"

inner_size: Option<Size>

The dimensions of the window. If this is None, some platform-specific dimensions will be used.

The default is None.

min_inner_size: Option<Size>

The minimum dimensions a window can be. If this is None, the window will have no minimum dimensions (aside from reserved).

The default is None.

max_inner_size: Option<Size>

The maximum dimensions a window can be. If this is None, the maximum will have no maximum or will be set to the primary monitor's dimensions by the platform.

The default is None.

resizable: bool

Whether the window is resizable or not.

The default is true.

fullscreen: Option<Fullscreen>

Whether the window should be set as fullscreen upon creation.

The default is None.

title: String

The title of the window in the title bar.

The default is "Window".

maximized: bool

Whether the window should be maximized upon creation.

The default is false.

visible: bool

Whether the window should be immediately visible upon creation.

The default is true.

transparent: bool

Whether the the window should be transparent. If this is true, writing colors with alpha values different than 1.0 will produce a transparent window.

The default is false.

decorations: bool

Whether the window should have borders and bars.

The default is true.

always_on_top: bool

Whether the window should always be on top of other windows.

The default is false.

window_icon: Option<Icon>

The window icon.

The default is None.

debug: bool

Whether to enable the debug flag of the context.

Debug contexts are usually slower but give better error reporting.

The default is false.

vsync: bool

Whether to use vsync. If vsync is enabled, calling swap_buffers will block until the screen refreshes. This is typically used to prevent screen tearing.

The default is false.

hardware_accelerated: Option<bool>

If true, only hardware-accelerated formats will be considered. If false, only software renderers. None means "don't care".

Default is Some(true).

color_bits: Option<u8>

Minimum number of bits for the color buffer, excluding alpha. None means "don't care".

The default is Some(24).

float_color_buffer: bool

If true, the color buffer must be in a floating point format. Using floating points allows you to write values outside of the [0.0, 1.0] range.

Default is false.

alpha_bits: Option<u8>

Minimum number of bits for the alpha in the color buffer. None means "don't care".

The default is Some(8).

depth_bits: Option<u8>

Minimum number of bits for the depth buffer. None means "don't care".

The default value is Some(24).

stencil_bits: Option<u8>

Minimum number of stencil bits. None means "don't care".

The default value is Some(8).

double_buffer: Option<bool>

If true, only double-buffered formats will be considered. If false, only single-buffer formats. None means "don't care".

The default is Some(true).

multisampling: Option<u16>

Contains the minimum number of samples per pixel in the color, depth and stencil buffers. None means "don't care". A value of Some(0) indicates that multisampling must not be enabled.

Default is None.

stereoscopy: bool

If true, only stereoscopic formats will be considered. If false, only non-stereoscopic formats.

The default is false.

srgb: bool

If true, only sRGB-capable formats will be considered. If false, don't care.

The default is true.

release_behavior: ReleaseBehavior

The behavior when changing the current context.

Default is Flush.

texture_vertex_buffer_size: usize

The default is 8.

feature = "texture_graphics"

simple_vertex_buffer_size: usize

The default is 100.

feature = "simple_graphics"

text_vertex_buffer_size: usize

The default is 2000.

feature = "text_graphics"

Implementations

impl WindowSettings

pub fn new() -> WindowSettings

Default settings.

Trait Implementations

impl Clone for WindowSettings

fn clone(&self) -> WindowSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowSettings

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

Formats the value using the given formatter.