Struct Background 

pub struct Background { /* private fields */ }

A fill for a shape: a solid color, a linear gradient, or a pattern.

Build a background with solid_background, linear_gradient, pattern_slash or checkerboard, or convert a color with .into(). Elements take a background through Styled::bg. Use Background::kind to inspect one.

Examples

use gpui::{Background, blue, linear_color_stop, linear_gradient, red};

let solid: Background = red().into();
assert!(solid.as_solid().is_some());

let gradient = linear_gradient(
    90.,
    linear_color_stop(red(), 0.),
    linear_color_stop(blue(), 1.),
);
assert!(gradient.as_solid().is_none());

Implementations

impl Background

pub fn as_solid(&self) -> Option<Hsla>

Returns the color if this is a solid background, and None otherwise.

pub fn kind(&self) -> BackgroundKind

Returns the decoded form of this background.

pub fn color_space(self, color_space: ColorSpace) -> Self

Sets the color space that a gradient’s colors are interpolated in.

The default for linear_gradient is ColorSpace::Oklab. Solid colors and patterns don’t interpolate, so this has no effect on them.

https://developer.mozilla.org/en-US/docs/Web/CSS/color-interpolation-method

pub fn interpolation_space(&self) -> ColorSpace

The color space used to interpolate this background, set by Background::color_space.

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

Returns a copy of this background with the alpha of every color multiplied by factor.

The factor is clamped to 0.0..=1.0. Gradient stops are scaled too.

pub fn is_transparent(&self) -> bool

Returns whether this background paints nothing.

A solid, pattern or checkerboard background is transparent when its color has zero alpha. A gradient is transparent only when both of its stops have zero alpha.

Trait Implementations

impl Clone for Background

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 Background

impl Debug for Background

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

Formats the value using the given formatter.

impl Default for Background

fn default() -> Self

Returns a solid background with zero alpha, which paints nothing.

impl<'de> Deserialize<'de> for Background

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Background

impl<T: IntoColor<Hsla>> From<T> for Background

fn from(value: T) -> Self

Converts a color into a solid Background.

impl JsonSchema for Background

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 Lerp for Background

fn lerp(&self, to: &Self, delta: f32) -> Self

Returns the value delta of the way from self to to.

impl PartialEq for Background

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Background

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 Background