Struct pix_engine::gui::theme::Theme

#[non_exhaustive]
pub struct Theme {
    pub name: String,
    pub fonts: Fonts,
    pub font_size: u32,
    pub styles: FontStyles,
    pub colors: Colors,
    pub spacing: Spacing,
}

A UI Theme containing font families, sizes, styles, and colors.

See the [Builder] examples for building a custom theme.

Example

fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
    s.fill(Color::CADET_BLUE); // Change font color
    s.font_size(16)?;
    s.font_style(FontStyle::UNDERLINE);
    s.font_family(Font::from_file("Some font", "./some_font.ttf"))?;
    s.text("Blue, underlined, size 16 text in Some Font")?;
    Ok(())
}

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.

name: String

The name of this theme.

fonts: Fonts

The font families used in this theme.

font_size: u32

The body font size used in this theme.

styles: FontStyles

The font styles used in this theme.

colors: Colors

The colors used in this theme.

spacing: Spacing

The padding, offsets, and other styles used in this theme.

Implementations

impl Theme

pub fn builder() -> ThemeBuilder

Constructs a default [Builder] which can build a Theme instance.

See [Builder] for examples.

pub fn dark() -> Self

Constructs a default dark Theme.

pub fn light() -> Self

Constructs a default light Theme.

Trait Implementations

impl Clone for Theme

fn clone(&self) -> Theme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Theme

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

Formats the value using the given formatter.

impl Default for Theme

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Theme

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Theme

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Theme

impl StructuralEq for Theme

impl StructuralPartialEq for Theme