Struct Options

pub struct Options {
    pub ups: usize,
    pub scaling: WindowScaling,
    pub vsync: bool,
    pub hide_cursor: bool,
    pub confine_cursor: bool,
    pub style: UiStyle,
}

Options for program windows

Fields

ups: usize

Target and max number of times [Scene::update] can be called per second Default is 240

scaling: WindowScaling

How the window should be scaled Default is [Auto][WindowScaling::Auto]

vsync: bool

If vsync should be enabled Default is true

hide_cursor: bool

If OS mouse cursor should be hidden (you’ll have to draw your own if this is true, this is often called software cursor in games) Default is false

confine_cursor: bool

If the mouse cursor should be locked to within this window while it’s in the foreground Default is false

style: UiStyle

Style data for [UiElement]

Implementations

impl Options

pub fn new( ups: usize, scaling: WindowScaling, vsync: bool, hide_cursor: bool, confine_cursor: bool, style: UiStyle, ) -> Self

Trait Implementations

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Options

fn eq(&self, other: &Options) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Options