Struct imgui::ColorEditFlags

pub struct ColorEditFlags { /* private fields */ }

Color edit flags

Implementations

impl ColorEditFlags

pub const NO_ALPHA: Self = _

ColorEdit, ColorPicker, ColorButton: ignore Alpha component (read only 3 components of the value).

pub const NO_PICKER: Self = _

ColorEdit: disable picker when clicking on colored square.

pub const NO_OPTIONS: Self = _

ColorEdit: disable toggling options menu when right-clicking on inputs/small preview.

pub const NO_SMALL_PREVIEW: Self = _

ColorEdit, ColorPicker: disable colored square preview next to the inputs. (e.g. to show only the inputs)

pub const NO_INPUTS: Self = _

ColorEdit, ColorPicker: disable inputs sliders/text widgets (e.g. to show only the small preview colored square).

pub const NO_TOOLTIP: Self = _

ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview.

pub const NO_LABEL: Self = _

ColorEdit, ColorPicker: disable display of inline text label (the label is still forwarded to the tooltip and picker).

pub const NO_SIDE_PREVIEW: Self = _

ColorPicker: disable bigger color preview on right side of the picker, use small colored square preview instead.

pub const NO_DRAG_DROP: Self = _

ColorEdit: disable drag and drop target. ColorButton: disable drag and drop source.

pub const NO_BORDER: Self = _

ColorButton: disable border (which is enforced by default).

pub const ALPHA_BAR: Self = _

ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker.

pub const ALPHA_PREVIEW: Self = _

ColorEdit, ColorPicker, ColorButton: display preview as a transparent color over a checkerboard, instead of opaque.

pub const ALPHA_PREVIEW_HALF: Self = _

ColorEdit, ColorPicker, ColorButton: display half opaque / half checkerboard, instead of opaque.

pub const HDR: Self = _

(WIP) ColorEdit: Currently onlys disable 0.0f..1.0f limits in RGBA editing (note: you probably want to use ColorEditFlags::FLOAT as well).

pub const DISPLAY_RGB: Self = _

ColorEdit: display only as RGB. ColorPicker: Enable RGB display.

pub const DISPLAY_HSV: Self = _

ColorEdit: display only as HSV. ColorPicker: Enable HSV display.

pub const DISPLAY_HEX: Self = _

ColorEdit: display only as HEX. ColorPicker: Enable Hex display.

pub const UINT8: Self = _

ColorEdit, ColorPicker, ColorButton: display values formatted as 0..255.

pub const FLOAT: Self = _

ColorEdit, ColorPicker, ColorButton: display values formatted as 0.0f..1.0f floats instead of 0..255 integers. No round-trip of value via integers.

pub const PICKER_HUE_BAR: Self = _

ColorPicker: bar for Hue, rectangle for Sat/Value.

pub const PICKER_HUE_WHEEL: Self = _

ColorPicker: wheel for Hue, triangle for Sat/Value.

pub const INPUT_RGB: Self = _

ColorEdit, ColorPicker: input and output data in RGB format.

pub const INPUT_HSV: Self = _

ColorEdit, ColorPicker: input and output data in HSV format.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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.

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

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

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.

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: Self) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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.

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.

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.

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.

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

impl Binary for ColorEditFlags

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

Formats the value using the given formatter.

impl BitAnd for ColorEditFlags

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

Returns the intersection between the two sets of flags.

type Output = ColorEditFlags

The resulting type after applying the & operator.

impl BitAndAssign for ColorEditFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for ColorEditFlags

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

Returns the union of the two sets of flags.

type Output = ColorEditFlags

The resulting type after applying the | operator.

impl BitOrAssign for ColorEditFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for ColorEditFlags

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

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

type Output = ColorEditFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for ColorEditFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for ColorEditFlags

fn clone(&self) -> ColorEditFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorEditFlags

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

Formats the value using the given formatter.

impl Extend<ColorEditFlags> for ColorEditFlags

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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<ColorEditFlags> for ColorEditFlags

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

Creates a value from an iterator.

impl Hash for ColorEditFlags

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for ColorEditFlags

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

Formats the value using the given formatter.

impl Not for ColorEditFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = ColorEditFlags

The resulting type after applying the ! operator.

impl Octal for ColorEditFlags

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

Formats the value using the given formatter.

impl Ord for ColorEditFlags

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ColorEditFlags

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

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

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.

impl PartialOrd for ColorEditFlags

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

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

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

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

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

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

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

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

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

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

impl Sub for ColorEditFlags

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

Returns the set difference of the two sets of flags.

type Output = ColorEditFlags

The resulting type after applying the - operator.

impl SubAssign for ColorEditFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for ColorEditFlags

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

Formats the value using the given formatter.

impl Copy for ColorEditFlags

impl Eq for ColorEditFlags

impl StructuralPartialEq for ColorEditFlags