Skip to main content

CandlOptions

Struct CandlOptions 

Source
pub struct CandlOptions { /* private fields */ }
Expand description

Window options

This type is an extract from luminance-windowing

Implementations§

Source§

impl CandlOptions

Source

pub fn cursor_mode(&self) -> CursorMode

get the cursor current visiblity

Source

pub fn set_cursor_mode(self, cursor_mode: CursorMode) -> Self

choose the cursor visibility

Source

pub fn decorations(&self) -> bool

get the window current decoration status (default true)

Source

pub fn set_decorations(self, decorations: bool) -> Self

set if the window use decoration

Source

pub fn max_size(&self) -> Option<(u32, u32)>

get the maximal size, if set, or none otherwise

Source

pub fn set_maw_size(self, max_size: Option<(u32, u32)>) -> Self

set the maximal size of the window

Source

pub fn min_size(&self) -> Option<(u32, u32)>

get the minimal size, if set, or none otherwise

Source

pub fn set_min_size(self, min_size: Option<(u32, u32)>) -> Self

set the minimal size of the window

Source

pub fn on_top(&self) -> bool

get if the window must be always on top, or not

Source

pub fn set_on_top(self, on_top: bool) -> Self

set if the window is always on top or not

Source

pub fn samples(&self) -> Option<u32>

get the number of samples for multisampling

Source

pub fn set_samples<S: Into<Option<u32>>>(self, samples: S) -> Self

choose the number of samples for multisampling

Source

pub fn transparent(&self) -> bool

get if the window can be transparent (default false)

Source

pub fn set_transparent(self, transparent: bool) -> Self

set the window transparency

Source

pub fn vsync(&self) -> bool

get actual vsync configuration

Source

pub fn set_vsync(self, vsync: bool) -> Self

set the vsync (false by default)

Trait Implementations§

Source§

impl Clone for CandlOptions

Source§

fn clone(&self) -> CandlOptions

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 CandlOptions

Source§

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

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

impl Default for CandlOptions

Source§

fn default() -> Self

Default:

Default options for a window, with cursor visible

Source§

impl PartialEq for CandlOptions

Source§

fn eq(&self, other: &CandlOptions) -> 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 Copy for CandlOptions

Source§

impl Eq for CandlOptions

Source§

impl StructuralPartialEq for CandlOptions

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<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> 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> 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.