WindowParam

Struct WindowParam 

Source
pub struct WindowParam {
    pub title: String,
    pub size: Point2,
    pub high_dpi: bool,
    pub fullscreen: bool,
    pub sample_count: u32,
    pub resizable: bool,
    pub icon: Option<Icon>,
    pub platform: Platform,
}

Fields§

§title: String

Title of the window, defaults to an empty string.

§size: Point2

The preferred width / height of the window

Default: [960, 540]

§high_dpi: bool

Whether the rendering canvas is full-resolution on HighDPI displays.

Default: false

§fullscreen: bool

Whether the window should be created in fullscreen mode, ignored on wasm/android.

Default: false

§sample_count: u32

MSAA sample count

Default: 1

§resizable: bool

Determines if the application user can resize the window

§icon: Option<Icon>

The icon will be used as

  • taskbar and titlebar icons on Windows.
  • dock and titlebar icon on MacOs.
  • TODO: favicon on HTML5
  • TODO: taskbar and titlebar(highly dependent on the WM) icons on Linux
§platform: Platform

Platform specific settings. Hints to OS for context creation, driver-specific settings etc.

Implementations§

Source§

impl WindowParam

Source

pub fn new() -> Self

Source

pub fn title(self, title: impl Into<String>) -> Self

Source

pub fn high_dpi(self, high_dpi: bool) -> Self

Whether the rendering canvas is full-resolution on HighDPI displays.

Default: false

Source

pub fn fullscreen(self, fullscreen: bool) -> Self

Whether the window should be created in fullscreen mode, ignored on wasm/android.

Default: false

Source

pub fn sample_count(self, sample_count: u32) -> Self

MSAA sample count

Default: 1

Source

pub fn resizeable(self, window_resizable: bool) -> Self

Determines if the application user can resize the window

Source

pub fn icon(self, icon: Option<Icon>) -> Self

The icon will be used as

  • taskbar and titlebar icons on Windows.
  • dock and titlebar icon on MacOs.
  • TODO: favicon on HTML5
  • TODO: taskbar and titlebar(highly dependent on the WM) icons on Linux
Source

pub fn platform(self, platform: Platform) -> Self

Platform specific settings. Hints to OS for context creation, driver-specific settings etc.

Trait Implementations§

Source§

impl Clone for WindowParam

Source§

fn clone(&self) -> WindowParam

Returns a duplicate 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 Debug for WindowParam

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WindowParam

Source§

fn default() -> Self

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

impl Hash for WindowParam

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for WindowParam

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for WindowParam

Source§

impl StructuralPartialEq for WindowParam

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dest> CastFrom<Dest> for Src
where Dest: CastInto<Src>,

Source§

fn cast_from(value: Dest) -> Src

Source§

impl<Src, Dest> CastRangeFrom<Dest> for Src
where Dest: CastRangeInto<Src>,

Source§

fn cast_range_from(value: Dest) -> Src

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DefaultExtension for T
where T: Default + PartialEq,

Source§

impl<T> DefaultIsTripleUnderscore for T
where T: Default,

Source§

fn ___() -> T

The Self::default() method. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToDebug for T
where T: Debug,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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.