Struct pix_engine::gui::theme::Colors

#[non_exhaustive]
pub struct Colors {
    pub background: Color,
    pub surface: Color,
    pub primary: Color,
    pub primary_variant: Color,
    pub secondary: Color,
    pub secondary_variant: Color,
    pub error: Color,
    pub on_background: Color,
    pub on_surface: Color,
    pub on_primary: Color,
    pub on_secondary: Color,
    pub on_error: Color,
}

A set of Colors for theming UI elements.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

background: Color

Background color, used to clear the screen each frame and appears behind scrollable content.

surface: Color

Surface color, used to render surfaces of widgets, cards, sheets, and menus.

primary: Color

Primary color displayed most often across widgets.

primary_variant: Color

Primary variant color.

secondary: Color

Secondary color for accents and distinguishing content, optional.

secondary_variant: Color

Secondary variant color, optional.

error: Color

Error highlighting of text and outlines.

on_background: Color

Text and icon color when rendered over the background color.

on_surface: Color

Text and icon color when rendered over the surface color.

on_primary: Color

Text and icon color when rendered over a primary color.

on_secondary: Color

Text and icon color when rendered over a secondary color.

on_error: Color

Text and icon color when rendered over the error color.

Implementations

impl Colors

pub const fn dark() -> Self

A dark color theme.

pub const fn light() -> Self

A light color theme.

pub fn on_background(&self) -> Color

Return the on background overlay color.

pub fn on_surface(&self) -> Color

Return the on surface overlay color.

pub fn disabled(&self) -> Color

Return the disabled color.

Trait Implementations

impl Clone for Colors

fn clone(&self) -> Colors

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Colors

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

Formats the value using the given formatter.

impl Default for Colors

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Colors

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Colors

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 PartialEq<Colors> for Colors

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Colors

impl Eq for Colors

impl StructuralEq for Colors

impl StructuralPartialEq for Colors