Struct ThemeToken 

pub struct ThemeToken {
    pub color: Hsla,
    pub background: Background,
}

A theme token that keeps a solid representative color and its renderable background.

Fields

color: Hsla

background: Background

Implementations

impl ThemeToken

pub fn new(color: Hsla, background: Background) -> Self

Methods from Deref<Target = Hsla>

pub fn to_rgb(self) -> Rgba

Converts this HSLA color to an RGBA color.

pub fn is_transparent(&self) -> bool

Returns true if the HSLA color is fully transparent, false otherwise.

pub fn is_opaque(&self) -> bool

Returns true if the HSLA color is fully opaque, false otherwise.

pub fn blend(self, other: Hsla) -> Hsla

Blends other on top of self based on other’s alpha value. The resulting color is a combination of self’s and other’s colors.

If other’s alpha value is 1.0 or greater, other color is fully opaque, thus other is returned as the output color. If other’s alpha value is 0.0 or less, other color is fully transparent, thus self is returned as the output color. Else, the output color is calculated as a blend of self and other based on their weighted alpha values.

Assumptions:

• Alpha values are contained in the range [0, 1], with 1 as fully opaque and 0 as fully transparent.
• The relative contributions of self and other is based on self’s alpha value (self.a) and other’s alpha value (other.a), self contributing self.a * (1.0 - other.a) and other contributing its own alpha value.
• RGB color components are contained in the range [0, 1].
• If self and other colors are out of the valid range, the blend operation’s output and behavior is undefined.

pub fn grayscale(&self) -> Hsla

Returns a new HSLA color with the same hue, and lightness, but with no saturation.

pub fn opacity(&self, factor: f32) -> Hsla

Multiplies the alpha value of the color by a given factor and returns a new HSLA color.

Useful for transforming colors with dynamic opacity, like a color from an external source.

Example:

let color = gpui::red();
let faded_color = color.opacity(0.5);
assert_eq!(faded_color.a, 0.5);

This will return a red color with half the opacity.

Example:

use gpui::hsla;
let color = hsla(0.7, 1.0, 0.5, 0.7); // A saturated blue
let faded_color = color.opacity(0.16);
assert!((faded_color.a - 0.112).abs() < 1e-6);

This will return a blue color with around ~10% opacity, suitable for an element’s hover or selected state.

pub fn alpha(&self, a: f32) -> Hsla

Returns a new HSLA color with the same hue, saturation, and lightness, but with a new alpha value.

Example:

let color = gpui::red();
let red_color = color.alpha(0.25);
assert_eq!(red_color.a, 0.25);

This will return a red color with 25% opacity.

Example:

use gpui::hsla;
let color = hsla(0.7, 1.0, 0.5, 0.7); // A saturated blue
let faded_color = color.alpha(0.25);
assert_eq!(faded_color.a, 0.25);

This will return a blue color with 25% opacity.

Trait Implementations

impl Clone for ThemeToken

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ThemeToken

impl Debug for ThemeToken

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

Formats the value using the given formatter.

impl Default for ThemeToken

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ThemeToken

type Target = Hsla

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for ThemeToken

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Hsla> for ThemeToken

fn from(color: Hsla) -> Self

Converts to this type from the input type.

impl From<ThemeToken> for Hsla

fn from(token: ThemeToken) -> Self

Converts to this type from the input type.

impl From<ThemeToken> for Background

fn from(token: ThemeToken) -> Self

Converts to this type from the input type.

impl From<ThemeToken> for Fill

fn from(token: ThemeToken) -> Self

Converts to this type from the input type.

impl JsonSchema for ThemeToken

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ThemeToken

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ThemeToken

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ThemeToken