pub struct WindowFlags { /* private fields */ }
Expand description

Configuration flags for windows

Implementations§

source§

impl WindowFlags

source

pub const NO_TITLE_BAR: Self = _

Disable the title bar

source

pub const NO_RESIZE: Self = _

Disable resizing with the lower-right grip

source

pub const NO_MOVE: Self = _

Disable moving the window

source

pub const NO_SCROLLBAR: Self = _

Disable scrollbars (scrolling is still possible with the mouse or programmatically)

source

pub const NO_SCROLL_WITH_MOUSE: Self = _

Disable vertical scrolling with the mouse wheel.

On child window, the mouse wheel will be forwarded to the parent unless NO_SCROLLBAR is also set.

source

pub const NO_COLLAPSE: Self = _

Disable collapsing the window by double-clicking it

source

pub const ALWAYS_AUTO_RESIZE: Self = _

Resize the window to its content on every frame

source

pub const NO_BACKGROUND: Self = _

Disable drawing of background color and outside border

source

pub const NO_SAVED_SETTINGS: Self = _

Never load/save settings

source

pub const NO_MOUSE_INPUTS: Self = _

Disable catching mouse input. Hovering test will pass through

source

pub const MENU_BAR: Self = _

Show a menu bar

source

pub const HORIZONTAL_SCROLLBAR: Self = _

Allow horizontal scrollbar to appear

source

pub const NO_FOCUS_ON_APPEARING: Self = _

Disable taking focus when transitioning from hidden to visible state

source

pub const NO_BRING_TO_FRONT_ON_FOCUS: Self = _

Disable bringing window to front when taking focus (e.g. clicking it or programmatically giving it focus)

source

pub const ALWAYS_VERTICAL_SCROLLBAR: Self = _

Always show vertical scrollbar

source

pub const ALWAYS_HORIZONTAL_SCROLLBAR: Self = _

Always show horizontal scrollbar

source

pub const ALWAYS_USE_WINDOW_PADDING: Self = _

Ensure child windows without border use style.window_padding

source

pub const NO_NAV_INPUTS: Self = _

Disable gamepad/keyboard navigation within the window

source

pub const NO_NAV_FOCUS: Self = _

No focusing toward this window with gamepad/keyboard navigation (e.g. skipped by CTRL+TAB)

source

pub const UNSAVED_DOCUMENT: Self = _

Append ‘*’ to title without affecting the ID, as a convenience

source

pub const NO_NAV: Self = _

Disable gamepad/keyboard navigation and focusing.

Shorthand for WindowFlags::NO_NAV_INPUTS | WindowFlags::NO_NAV_FOCUS.

source

pub const NO_DECORATION: Self = _

Disable all window decorations.

Shorthand for WindowFlags::NO_TITLE_BAR | WindowFlags::NO_RESIZE | WindowFlags::NO_SCROLLBAR | WindowFlags::NO_COLLAPSE.

source

pub const NO_INPUTS: Self = _

Don’t handle input.

Shorthand for WindowFlags::NO_MOUSE_INPUTS | WindowFlags::NO_NAV_INPUTS | WindowFlags::NO_NAV_FOCUS.

source

pub const fn empty() -> Self

Returns an empty set of flags.

source

pub const fn all() -> Self

Returns the set containing all flags.

source

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

source

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

source

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

source

pub const unsafe fn from_bits_unchecked(bits: u32) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

§Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

source

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

Returns true if there are flags common to both self and other.

source

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

Returns true if all of the flags in other are contained within self.

source

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

source

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

source

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

source

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

source

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

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

source

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

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

source

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

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

source

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

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

source

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations§

source§

impl Binary for WindowFlags

source§

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

Formats the value using the given formatter.
source§

impl BitAnd for WindowFlags

source§

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

§

type Output = WindowFlags

The resulting type after applying the & operator.
source§

impl BitAndAssign for WindowFlags

source§

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

source§

impl BitOr for WindowFlags

source§

fn bitor(self, other: WindowFlags) -> Self

Returns the union of the two sets of flags.

§

type Output = WindowFlags

The resulting type after applying the | operator.
source§

impl BitOrAssign for WindowFlags

source§

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

source§

impl BitXor for WindowFlags

source§

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

§

type Output = WindowFlags

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for WindowFlags

source§

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

source§

impl Clone for WindowFlags

source§

fn clone(&self) -> WindowFlags

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 WindowFlags

source§

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

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

impl Extend<WindowFlags> for WindowFlags

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl FromIterator<WindowFlags> for WindowFlags

source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator. Read more
source§

impl Hash for WindowFlags

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 WindowFlags

source§

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

Formats the value using the given formatter.
source§

impl Not for WindowFlags

source§

fn not(self) -> Self

Returns the complement of this set of flags.

§

type Output = WindowFlags

The resulting type after applying the ! operator.
source§

impl Octal for WindowFlags

source§

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

Formats the value using the given formatter.
source§

impl Ord for WindowFlags

source§

fn cmp(&self, other: &WindowFlags) -> 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 + PartialOrd,

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

impl PartialEq for WindowFlags

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for WindowFlags

source§

fn partial_cmp(&self, other: &WindowFlags) -> 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

This method 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

This method 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

This method 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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Sub for WindowFlags

source§

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

§

type Output = WindowFlags

The resulting type after applying the - operator.
source§

impl SubAssign for WindowFlags

source§

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

source§

impl UpperHex for WindowFlags

source§

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

Formats the value using the given formatter.
source§

impl Copy for WindowFlags

source§

impl Eq for WindowFlags

source§

impl StructuralPartialEq for WindowFlags

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

§

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

§

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

§

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.