Struct imgui::ConfigFlags

#[repr(transparent)]pub struct ConfigFlags { /* fields omitted */ }

Configuration flags

Implementations

impl ConfigFlags

pub const NAV_ENABLE_KEYBOARD: ConfigFlags

Master keyboard navigation enable flag.

frame() will automatically fill io.nav_inputs based on io.keys_down.

pub const NAV_ENABLE_GAMEPAD: ConfigFlags

Master gamepad navigation enable flag.

This is mostly to instruct the backend to fill io.nav_inputs. The backend also needs to set BackendFlags::HasGamepad.

pub const NAV_ENABLE_SET_MOUSE_POS: ConfigFlags

Instruction navigation to move the mouse cursor.

May be useful on TV/console systems where moving a virtual mouse is awkward. Will update io.mouse_pos and set io.want_set_mouse_pos = true. If enabled, you must honor io.want_set_mouse_pos, or imgui-rs will react as if the mouse is jumping around back and forth.

pub const NAV_NO_CAPTURE_KEYBOARD: ConfigFlags

Instruction navigation to not set the io.want_capture_keyboard flag when io.nav_active is set.

pub const NO_MOUSE: ConfigFlags

Instruction imgui-rs to clear mouse position/buttons in frame().

This allows ignoring the mouse information set by the backend.

pub const NO_MOUSE_CURSOR_CHANGE: ConfigFlags

Instruction backend to not alter mouse cursor shape and visibility.

Use if the backend cursor changes are interfering with yours and you don't want to use set_mouse_cursor to change the mouse cursor. You may want to honor requests from imgui-rs by reading get_mouse_cursor yourself instead.

pub const IS_SRGB: ConfigFlags

Application is SRGB-aware.

Not used by core imgui-rs.

pub const IS_TOUCH_SCREEN: ConfigFlags

Application is using a touch screen instead of a mouse.

Not used by core imgui-rs.

pub const fn empty() -> ConfigFlags

Returns an empty set of flags

pub const fn all() -> ConfigFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

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

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

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

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

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for ConfigFlags

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

Formats the value using the given formatter.

impl BitAnd<ConfigFlags> for ConfigFlags

type Output = ConfigFlags

The resulting type after applying the & operator.

pub fn bitand(self, other: ConfigFlags) -> ConfigFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<ConfigFlags> for ConfigFlags

pub fn bitand_assign(&mut self, other: ConfigFlags)

Disables all flags disabled in the set.

impl BitOr<ConfigFlags> for ConfigFlags

type Output = ConfigFlags

The resulting type after applying the | operator.

pub fn bitor(self, other: ConfigFlags) -> ConfigFlags

Returns the union of the two sets of flags.

impl BitOrAssign<ConfigFlags> for ConfigFlags

pub fn bitor_assign(&mut self, other: ConfigFlags)

Adds the set of flags.

impl BitXor<ConfigFlags> for ConfigFlags

type Output = ConfigFlags

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: ConfigFlags) -> ConfigFlags

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

impl BitXorAssign<ConfigFlags> for ConfigFlags

pub fn bitxor_assign(&mut self, other: ConfigFlags)

Toggles the set of flags.

impl Clone for ConfigFlags

pub fn clone(&self) -> ConfigFlags

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ConfigFlags

impl Debug for ConfigFlags

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

Formats the value using the given formatter.

impl Eq for ConfigFlags

impl Extend<ConfigFlags> for ConfigFlags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

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

impl FromIterator<ConfigFlags> for ConfigFlags

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

Creates a value from an iterator.

impl Hash for ConfigFlags

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for ConfigFlags

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

Formats the value using the given formatter.

impl Not for ConfigFlags

type Output = ConfigFlags

The resulting type after applying the ! operator.

pub fn not(self) -> ConfigFlags

Returns the complement of this set of flags.

impl Octal for ConfigFlags

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

Formats the value using the given formatter.

impl Ord for ConfigFlags

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ConfigFlags> for ConfigFlags

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

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

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

This method tests for !=.

impl PartialOrd<ConfigFlags> for ConfigFlags

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for ConfigFlags

impl StructuralPartialEq for ConfigFlags

impl Sub<ConfigFlags> for ConfigFlags

type Output = ConfigFlags

The resulting type after applying the - operator.

pub fn sub(self, other: ConfigFlags) -> ConfigFlags

Returns the set difference of the two sets of flags.

impl SubAssign<ConfigFlags> for ConfigFlags

pub fn sub_assign(&mut self, other: ConfigFlags)

Disables all flags enabled in the set.

impl UpperHex for ConfigFlags

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

Formats the value using the given formatter.