Struct fltk::enums::Color

pub struct Color { /* fields omitted */ }

Defines colors used by FLTK Colors are stored as RGBI values, the last being the index for FLTK colors in this enum. Colors in this enum don’t have an RGB stored. However, custom colors have an RGB, and don’t have an index. The RGBI can be acquired by casting the color to u32 and formatting it to 0x{08x}. The last 2 digits are the hexadecimal representation of the color in this enum. For example, Color::White, has a hex of 0x000000ff, ff being the 255 value of this enum. A custom color like Color::from_u32(0x646464), will have an representation as 0x64646400, of which the final 00 indicates that it is not stored in this enum. For convenience, the fmt::Display trait is implemented so that the name of the Color is shown when there is one, otherwise the RGB value is given.

Implementations

impl Color

pub const ForeGround: Color

ForeGround, label colors

pub const BackGround2: Color

BackGround2, Is the color inside input, output and text display widgets

pub const Inactive: Color

Inactive

pub const Selection: Color

Selection

pub const Gray0: Color

Gray0

pub const Dark3: Color

Dark3

pub const Dark2: Color

Dark2

pub const Dark1: Color

Dark1

pub const FrameDefault: Color

FrameDefault

pub const BackGround: Color

BackGround

pub const Light1: Color

Light1

pub const Light2: Color

Light2

pub const Light3: Color

Light3

pub const Black: Color

Black

pub const Red: Color

Red

pub const Green: Color

Green

pub const Yellow: Color

Yellow

pub const Blue: Color

Blue

pub const Magenta: Color

Magenta

pub const Cyan: Color

Cyan

pub const DarkRed: Color

DarkRed

pub const DarkGreen: Color

DarkGreen

pub const DarkYellow: Color

DarkYellow

pub const DarkBlue: Color

DarkBlue

pub const DarkMagenta: Color

DarkMagenta

pub const DarkCyan: Color

DarkCyan

pub const White: Color

White

pub const fn empty() -> Color

Returns an empty set of flags

pub const fn all() -> Color

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

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) -> Color

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl Color

pub fn from_rgb(r: u8, g: u8, b: u8) -> Color

Returns a color from RGB

pub fn from_u32(val: u32) -> Color

Returns a color from hex or decimal

pub fn by_index(idx: u8) -> Color

Returns a color by index of RGBI

Trait Implementations

impl Binary for Color

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

Formats the value using the given formatter.

impl BitAnd<Color> for Color

type Output = Color

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Color> for Color

fn bitand_assign(&mut self, other: Color)

Disables all flags disabled in the set.

impl BitOr<Color> for Color

type Output = Color

The resulting type after applying the | operator.

fn bitor(self, other: Color) -> Color

Returns the union of the two sets of flags.

impl BitOrAssign<Color> for Color

fn bitor_assign(&mut self, other: Color)

Adds the set of flags.

impl BitXor<Color> for Color

type Output = Color

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<Color> for Color

fn bitxor_assign(&mut self, other: Color)

Toggles the set of flags.

impl Clone for Color

fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Color

impl Debug for Color

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

Formats the value using the given formatter.

impl Display for Color

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

Formats the value using the given formatter.

impl Eq for Color

impl Extend<Color> for Color

fn extend<T: IntoIterator<Item = Color>>(&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<Color> for Color

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

Creates a value from an iterator.

impl Hash for Color

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 Color

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

Formats the value using the given formatter.

impl Not for Color

type Output = Color

The resulting type after applying the ! operator.

fn not(self) -> Color

Returns the complement of this set of flags.

impl Octal for Color

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

Formats the value using the given formatter.

impl Ord for Color

fn cmp(&self, other: &Color) -> 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<Color> for Color

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

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

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

This method tests for !=.

impl PartialOrd<Color> for Color

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for Color

impl StructuralPartialEq for Color

impl Sub<Color> for Color

type Output = Color

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Color> for Color

fn sub_assign(&mut self, other: Color)

Disables all flags enabled in the set.

impl UpperHex for Color

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

Formats the value using the given formatter.