Struct ConfigFlag

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

System/Window config flags

NOTE: Every bit registers one state (use it with bit masks)

By default all flags are set to 0

Implementations§

Source§

impl ConfigFlag

Source

pub const VsyncHint: ConfigFlag

Set to try enabling V-Sync on GPU

Source

pub const FullscreenMode: ConfigFlag

Set to run program in fullscreen

Source

pub const WindowResizable: ConfigFlag

Set to allow resizable window

Source

pub const WindowUndecorated: ConfigFlag

Set to disable window decoration (frame and buttons)

Source

pub const WindowHidden: ConfigFlag

Set to hide window

Source

pub const WindowMinimized: ConfigFlag

Set to minimize window (iconify)

Source

pub const WindowMaximized: ConfigFlag

Set to maximize window (expanded to monitor)

Source

pub const WindowUnfocused: ConfigFlag

Set to window non focused

Source

pub const WindowTopmost: ConfigFlag

Set to window always on top

Source

pub const WindowAlwaysRun: ConfigFlag

Set to allow windows running while

Source

pub const WindowTransparent: ConfigFlag

Set to allow transparent framebuffer

Source

pub const WindowHighdpi: ConfigFlag

Set to support HighDPI

Source

pub const WindowMousePassthrough: ConfigFlag

Set to support mouse passthrough, only supported when ConfigFlag::WindowUndecorated

Source

pub const BorderlessWindowedMode: ConfigFlag

Set to run program in borderless windowed mode

Source

pub const Msaa4xHint: ConfigFlag

Set to try enabling MSAA 4X

Source

pub const InterlacedHint: ConfigFlag

Set to try enabling interlaced video format (for V3D)

Source

pub const fn bits(&self) -> u32

Returns the underlying bits of the bitmask.

Source

pub const fn all_bits() -> Self

Returns a bitmask that contains all values.

This will include bits that do not have any flags. Use ::all_flags() if you only want to use flags.

Source

pub const fn all_flags() -> Self

Returns a bitmask that contains all flags.

Source

pub const fn is_all_bits(&self) -> bool

Returns true if the bitmask contains all values.

This will check for bits == !0, use .is_all_flags() if you only want to check for all flags

Source

pub const fn is_all_flags(&self) -> bool

Returns true if the bitmask contains all flags.

This will fail if any unused bit is set, consider using .truncate() first.

Source

pub const fn all() -> Self

👎Deprecated: Please use the ::all_bits() constructor

Returns a bitmask that contains all values.

This will include bits that do not have any flags. Use ::all_flags() if you only want to use flags.

Source

pub const fn is_all(&self) -> bool

👎Deprecated: Please use the .is_all_bits() method

Returns true if the bitmask contains all values.

This will check for bits == !0, use .is_all_flags() if you only want to check for all flags

Source

pub const fn full() -> Self

👎Deprecated: Please use the ::all_flags() constructor

Returns a bitmask that contains all flags.

Source

pub const fn is_full(&self) -> bool

👎Deprecated: Please use the .is_all_flags() method

Returns true if the bitmask contains all flags.

This will fail if any unused bit is set, consider using .truncate() first.

Source

pub const fn none() -> Self

Returns a bitmask that does not contain any values.

Source

pub const fn is_none(&self) -> bool

Returns true if the bitmask does not contain any values.

Source

pub const fn truncate(&self) -> Self

Returns a bitmask that only has bits corresponding to flags

Source

pub const fn intersects(&self, other: Self) -> bool

Returns true if self intersects with any value in other, or if other does not contain any values.

This is equivalent to (self & other) != 0 || other == 0.

Source

pub const fn contains(&self, other: Self) -> bool

Returns true if self contains all values of other.

This is equivalent to (self & other) == other.

Source

pub const fn not(self) -> Self

Returns the bitwise NOT of the bitmask.

Source

pub const fn and(self, other: Self) -> Self

Returns the bitwise AND of the bitmask.

Source

pub const fn or(self, other: Self) -> Self

Returns the bitwise OR of the bitmask.

Source

pub const fn xor(self, other: Self) -> Self

Returns the bitwise XOR of the bitmask.

Trait Implementations§

Source§

impl Binary for ConfigFlag

Source§

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

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

impl BitAnd for ConfigFlag

Source§

type Output = ConfigFlag

The resulting type after applying the & operator.
Source§

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation. Read more
Source§

impl BitAndAssign for ConfigFlag

Source§

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation. Read more
Source§

impl BitOr for ConfigFlag

Source§

type Output = ConfigFlag

The resulting type after applying the | operator.
Source§

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation. Read more
Source§

impl BitOrAssign for ConfigFlag

Source§

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation. Read more
Source§

impl BitXor for ConfigFlag

Source§

type Output = ConfigFlag

The resulting type after applying the ^ operator.
Source§

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation. Read more
Source§

impl BitXorAssign for ConfigFlag

Source§

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation. Read more
Source§

impl Clone for ConfigFlag

Source§

fn clone(&self) -> ConfigFlag

Returns a copy 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 ConfigFlag

Source§

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

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

impl From<ConfigFlag> for u32

Source§

fn from(val: ConfigFlag) -> u32

Converts to this type from the input type.
Source§

impl From<u32> for ConfigFlag

Source§

fn from(val: u32) -> Self

Converts to this type from the input type.
Source§

impl Hash for ConfigFlag

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 LowerHex for ConfigFlag

Source§

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

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

impl Not for ConfigFlag

Source§

type Output = ConfigFlag

The resulting type after applying the ! operator.
Source§

fn not(self) -> Self::Output

Performs the unary ! operation. Read more
Source§

impl Octal for ConfigFlag

Source§

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

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

impl Ord for ConfigFlag

Source§

fn cmp(&self, other: &ConfigFlag) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq<u32> for ConfigFlag

Source§

fn eq(&self, other: &u32) -> 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 PartialEq for ConfigFlag

Source§

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

Source§

fn partial_cmp(&self, other: &ConfigFlag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl UpperHex for ConfigFlag

Source§

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

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

impl Copy for ConfigFlag

Source§

impl Eq for ConfigFlag

Source§

impl StructuralPartialEq for ConfigFlag

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.