Enum bevy::prelude::Color

pub enum Color {
    Rgba {
        red: f32,
        green: f32,
        blue: f32,
        alpha: f32,
    },
    RgbaLinear {
        red: f32,
        green: f32,
        blue: f32,
        alpha: f32,
    },
    Hsla {
        hue: f32,
        saturation: f32,
        lightness: f32,
        alpha: f32,
    },
    Lcha {
        lightness: f32,
        chroma: f32,
        hue: f32,
        alpha: f32,
    },
}

Variants

Rgba

Fields

red: f32

Red channel. [0.0, 1.0]

green: f32

Green channel. [0.0, 1.0]

blue: f32

Blue channel. [0.0, 1.0]

alpha: f32

Alpha channel. [0.0, 1.0]

sRGBA color

RgbaLinear

Fields

red: f32

Red channel. [0.0, 1.0]

green: f32

Green channel. [0.0, 1.0]

blue: f32

Blue channel. [0.0, 1.0]

alpha: f32

Alpha channel. [0.0, 1.0]

RGBA color in the Linear sRGB colorspace (often colloquially referred to as “linear”, “RGB”, or “linear RGB”).

Hsla

Fields

hue: f32

Hue channel. [0.0, 360.0]

saturation: f32

Saturation channel. [0.0, 1.0]

lightness: f32

Lightness channel. [0.0, 1.0]

alpha: f32

Alpha channel. [0.0, 1.0]

HSL (hue, saturation, lightness) color with an alpha channel

Lcha

Fields

lightness: f32

Lightness channel. [0.0, 1.5]

chroma: f32

Chroma channel. [0.0, 1.5]

hue: f32

Hue channel. [0.0, 360.0]

alpha: f32

Alpha channel. [0.0, 1.0]

LCH(ab) (lightness, chroma, hue) color with an alpha channel

Implementations

impl Color

pub const ALICE_BLUE: Color = _

pub const ANTIQUE_WHITE: Color = _

pub const AQUAMARINE: Color = _

pub const AZURE: Color = _

pub const BEIGE: Color = _

pub const BISQUE: Color = _

pub const BLACK: Color = _

pub const BLUE: Color = _

pub const CRIMSON: Color = _

pub const CYAN: Color = _

pub const DARK_GRAY: Color = _

pub const DARK_GREEN: Color = _

pub const FUCHSIA: Color = _

pub const GOLD: Color = _

pub const GRAY: Color = _

pub const GREEN: Color = _

pub const INDIGO: Color = _

pub const LIME_GREEN: Color = _

pub const MAROON: Color = _

pub const MIDNIGHT_BLUE: Color = _

pub const NAVY: Color = _

pub const NONE: Color = _

pub const OLIVE: Color = _

pub const ORANGE: Color = _

pub const ORANGE_RED: Color = _

pub const PINK: Color = _

pub const PURPLE: Color = _

pub const RED: Color = _

pub const SALMON: Color = _

pub const SEA_GREEN: Color = _

pub const SILVER: Color = _

pub const TEAL: Color = _

pub const TOMATO: Color = _

pub const TURQUOISE: Color = _

pub const VIOLET: Color = _

pub const WHITE: Color = _

pub const YELLOW: Color = _

pub const YELLOW_GREEN: Color = _

pub const fn rgb(r: f32, g: f32, b: f32) -> Color

New Color from sRGB colorspace.

Arguments

• r - Red channel. [0.0, 1.0]
• g - Green channel. [0.0, 1.0]
• b - Blue channel. [0.0, 1.0]

See also Color::rgba, Color::rgb_u8, Color::hex.

pub const fn rgba(r: f32, g: f32, b: f32, a: f32) -> Color

New Color from sRGB colorspace.

Arguments

• r - Red channel. [0.0, 1.0]
• g - Green channel. [0.0, 1.0]
• b - Blue channel. [0.0, 1.0]
• a - Alpha channel. [0.0, 1.0]

See also Color::rgb, Color::rgba_u8, Color::hex.

pub const fn rgb_linear(r: f32, g: f32, b: f32) -> Color

New Color from linear RGB colorspace.

Arguments

• r - Red channel. [0.0, 1.0]
• g - Green channel. [0.0, 1.0]
• b - Blue channel. [0.0, 1.0]

See also Color::rgb, Color::rgba_linear.

pub const fn rgba_linear(r: f32, g: f32, b: f32, a: f32) -> Color

New Color from linear RGB colorspace.

Arguments

• r - Red channel. [0.0, 1.0]
• g - Green channel. [0.0, 1.0]
• b - Blue channel. [0.0, 1.0]
• a - Alpha channel. [0.0, 1.0]

See also Color::rgba, Color::rgb_linear.

pub const fn hsl(hue: f32, saturation: f32, lightness: f32) -> Color

New Color with HSL representation in sRGB colorspace.

Arguments

• hue - Hue channel. [0.0, 360.0]
• saturation - Saturation channel. [0.0, 1.0]
• lightness - Lightness channel. [0.0, 1.0]

See also Color::hsla.

pub const fn hsla( hue: f32, saturation: f32, lightness: f32, alpha: f32 ) -> Color

New Color with HSL representation in sRGB colorspace.

Arguments

• hue - Hue channel. [0.0, 360.0]
• saturation - Saturation channel. [0.0, 1.0]
• lightness - Lightness channel. [0.0, 1.0]
• alpha - Alpha channel. [0.0, 1.0]

See also Color::hsl.

pub const fn lch(lightness: f32, chroma: f32, hue: f32) -> Color

New Color with LCH representation in sRGB colorspace.

Arguments

• lightness - Lightness channel. [0.0, 1.5]
• chroma - Chroma channel. [0.0, 1.5]
• hue - Hue channel. [0.0, 360.0]

See also Color::lcha.

pub const fn lcha(lightness: f32, chroma: f32, hue: f32, alpha: f32) -> Color

New Color with LCH representation in sRGB colorspace.

Arguments

• lightness - Lightness channel. [0.0, 1.5]
• chroma - Chroma channel. [0.0, 1.5]
• hue - Hue channel. [0.0, 360.0]
• alpha - Alpha channel. [0.0, 1.0]

See also Color::lch.

pub fn hex<T>(hex: T) -> Result<Color, HexColorError>

where T: AsRef<str>,

New Color from sRGB colorspace.

Examples

let color = Color::hex("FF00FF").unwrap(); // fuchsia
let color = Color::hex("FF00FF7F").unwrap(); // partially transparent fuchsia

// A standard hex color notation is also available
assert_eq!(Color::hex("#FFFFFF").unwrap(), Color::rgb(1.0, 1.0, 1.0));

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

New Color from sRGB colorspace.

Arguments

• r - Red channel. [0, 255]
• g - Green channel. [0, 255]
• b - Blue channel. [0, 255]

See also Color::rgb, Color::rgba_u8, Color::hex.

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

New Color from sRGB colorspace.

Arguments

• r - Red channel. [0, 255]
• g - Green channel. [0, 255]
• b - Blue channel. [0, 255]
• a - Alpha channel. [0, 255]

See also Color::rgba, Color::rgb_u8, Color::hex.

pub fn r(&self) -> f32

Converts a Color to variant Color::Rgba and return red in sRGB colorspace

pub fn g(&self) -> f32

Converts a Color to variant Color::Rgba and return green in sRGB colorspace

pub fn b(&self) -> f32

Converts a Color to variant Color::Rgba and return blue in sRGB colorspace

pub fn set_r(&mut self, r: f32) -> &mut Color

Converts a Color to variant Color::Rgba and set red

pub fn with_r(self, r: f32) -> Color

Converts a Color to variant Color::Rgba and return this color with red set to a new value

pub fn set_g(&mut self, g: f32) -> &mut Color

Converts a Color to variant Color::Rgba and set green

pub fn with_g(self, g: f32) -> Color

Converts a Color to variant Color::Rgba and return this color with green set to a new value

pub fn set_b(&mut self, b: f32) -> &mut Color

Converts a Color to variant Color::Rgba and set blue

pub fn with_b(self, b: f32) -> Color

Converts a Color to variant Color::Rgba and return this color with blue set to a new value

pub fn h(&self) -> f32

Converts a Color to variant Color::Hsla and return hue

pub fn s(&self) -> f32

Converts a Color to variant Color::Hsla and return saturation

pub fn l(&self) -> f32

Converts a Color to variant Color::Hsla and return lightness

pub fn set_h(&mut self, h: f32) -> &mut Color

Converts a Color to variant Color::Hsla and set hue

pub fn with_h(self, h: f32) -> Color

Converts a Color to variant Color::Hsla and return this color with hue set to a new value

pub fn set_s(&mut self, s: f32) -> &mut Color

Converts a Color to variant Color::Hsla and set saturation

pub fn with_s(self, s: f32) -> Color

Converts a Color to variant Color::Hsla and return this color with saturation set to a new value

pub fn set_l(&mut self, l: f32) -> &mut Color

Converts a Color to variant Color::Hsla and set lightness

pub fn with_l(self, l: f32) -> Color

Converts a Color to variant Color::Hsla and return this color with lightness set to a new value

pub fn a(&self) -> f32

Get alpha.

pub fn set_a(&mut self, a: f32) -> &mut Color

Set alpha.

pub fn with_a(self, a: f32) -> Color

Returns this color with a new alpha value.

pub fn is_fully_transparent(&self) -> bool

Determine if the color is fully transparent, i.e. if the alpha is 0.

Examples

// Fully transparent colors
assert!(Color::NONE.is_fully_transparent());
assert!(Color::rgba(1.0, 0.5, 0.5, 0.0).is_fully_transparent());

// (Partially) opaque colors
assert!(!Color::BLACK.is_fully_transparent());
assert!(!Color::rgba(1.0, 0.5, 0.5, 0.2).is_fully_transparent());

pub fn as_rgba(&self) -> Color

Converts a Color to variant Color::Rgba

pub fn as_rgba_linear(&self) -> Color

Converts a Color to variant Color::RgbaLinear

pub fn as_hsla(&self) -> Color

Converts a Color to variant Color::Hsla

pub fn as_lcha(&self) -> Color

Converts a Color to variant Color::Lcha

pub fn as_rgba_u8(&self) -> [u8; 4]

Converts a Color to a [u8; 4] from sRGB colorspace

pub fn as_rgba_f32(self) -> [f32; 4]

Converts a Color to a [f32; 4] from sRGB colorspace

pub fn as_linear_rgba_f32(self) -> [f32; 4]

Converts a Color to a [f32; 4] from linear RGB colorspace

pub fn as_hsla_f32(self) -> [f32; 4]

Converts a Color to a [f32; 4] from HSL colorspace

pub fn as_lcha_f32(self) -> [f32; 4]

Converts a Color to a [f32; 4] from LCH colorspace

pub fn as_rgba_u32(self) -> u32

Converts Color to a u32 from sRGB colorspace.

Maps the RGBA channels in RGBA order to a little-endian byte array (GPUs are little-endian). A will be the most significant byte and R the least significant.

pub fn as_linear_rgba_u32(self) -> u32

Converts Color to a u32 from linear RGB colorspace.

Maps the RGBA channels in RGBA order to a little-endian byte array (GPUs are little-endian). A will be the most significant byte and R the least significant.

pub fn rgba_from_array(arr: impl Into<[f32; 4]>) -> Color

New Color from [f32; 4] (or a type that can be converted into them) with RGB representation in sRGB colorspace.

pub fn rgb_from_array(arr: impl Into<[f32; 3]>) -> Color

New Color from [f32; 3] (or a type that can be converted into them) with RGB representation in sRGB colorspace.

pub fn rgba_linear_from_array(arr: impl Into<[f32; 4]>) -> Color

New Color from [f32; 4] (or a type that can be converted into them) with RGB representation in linear RGB colorspace.

pub fn rgb_linear_from_array(arr: impl Into<[f32; 3]>) -> Color

New Color from [f32; 3] (or a type that can be converted into them) with RGB representation in linear RGB colorspace.

pub fn hsla_from_array(arr: impl Into<[f32; 4]>) -> Color

New Color from [f32; 4] (or a type that can be converted into them) with HSL representation in sRGB colorspace.

pub fn hsl_from_array(arr: impl Into<[f32; 3]>) -> Color

New Color from [f32; 3] (or a type that can be converted into them) with HSL representation in sRGB colorspace.

pub fn lcha_from_array(arr: impl Into<[f32; 4]>) -> Color

New Color from [f32; 4] (or a type that can be converted into them) with LCH representation in sRGB colorspace.

pub fn lch_from_array(arr: impl Into<[f32; 3]>) -> Color

New Color from [f32; 3] (or a type that can be converted into them) with LCH representation in sRGB colorspace.

pub fn rgba_to_vec4(&self) -> Vec4

Convert Color to RGBA and return as Vec4.

pub fn rgb_to_vec3(&self) -> Vec3

Convert Color to RGBA and return as Vec3.

pub fn rgba_linear_to_vec4(&self) -> Vec4

Convert Color to linear RGBA and return as Vec4.

pub fn rgb_linear_to_vec3(&self) -> Vec3

Convert Color to linear RGBA and return as Vec3.

pub fn hsla_to_vec4(&self) -> Vec4

Convert Color to HSLA and return as Vec4.

pub fn hsl_to_vec3(&self) -> Vec3

Convert Color to HSLA and return as Vec3.

pub fn lcha_to_vec4(&self) -> Vec4

Convert Color to LCHA and return as Vec4.

pub fn lch_to_vec3(&self) -> Vec3

Convert Color to LCHA and return as Vec3.

Trait Implementations

impl Add for Color

type Output = Color

The resulting type after applying the + operator.

fn add(self, rhs: Color) -> <Color as Add>::Output

Performs the + operation.

impl Clone for Color

fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CreateFrom for Color

fn create_from<B>(reader: &mut Reader<B>) -> Color

where B: BufferRef,

impl Debug for Color

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

Formats the value using the given formatter.

impl Default for Color

fn default() -> Color

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Color

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Enum for Color

where Color: Any + Send + Sync, f32: FromReflect + TypePath,

fn field(&self, __name_param: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut( &mut self, __name_param: &str ) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut( &mut self, __index_param: usize ) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

fn iter_fields(&self) -> VariantFieldIter<'_>

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl From<Color> for BackgroundColor

fn from(color: Color) -> BackgroundColor

Converts to this type from the input type.

impl From<Color> for BorderColor

fn from(color: Color) -> BorderColor

Converts to this type from the input type.

impl From<Color> for ClearColorConfig

fn from(color: Color) -> ClearColorConfig

Converts to this type from the input type.

impl From<Color> for Color

fn from(color: Color) -> Color

Converts to this type from the input type.

impl From<Color> for ColorMaterial

fn from(color: Color) -> ColorMaterial

Converts to this type from the input type.

impl From<Color> for StandardMaterial

fn from(color: Color) -> StandardMaterial

Converts to this type from the input type.

impl FromReflect for Color

where Color: Any + Send + Sync, f32: FromReflect + TypePath,

fn from_reflect(__param0: &(dyn Reflect + 'static)) -> Option<Color>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Color

where Color: Any + Send + Sync, f32: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Mul<[f32; 3]> for Color

type Output = Color

The resulting type after applying the * operator.

fn mul(self, rhs: [f32; 3]) -> <Color as Mul<[f32; 3]>>::Output

Performs the * operation.

impl Mul<[f32; 4]> for Color

type Output = Color

The resulting type after applying the * operator.

fn mul(self, rhs: [f32; 4]) -> <Color as Mul<[f32; 4]>>::Output

Performs the * operation.

impl Mul<Vec3> for Color

type Output = Color

The resulting type after applying the * operator.

fn mul(self, rhs: Vec3) -> <Color as Mul<Vec3>>::Output

Performs the * operation.

impl Mul<Vec4> for Color

type Output = Color

The resulting type after applying the * operator.

fn mul(self, rhs: Vec4) -> <Color as Mul<Vec4>>::Output

Performs the * operation.

impl Mul<f32> for Color

type Output = Color

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> <Color as Mul<f32>>::Output

Performs the * operation.

impl MulAssign<[f32; 3]> for Color

fn mul_assign(&mut self, rhs: [f32; 3])

Performs the *= operation.

impl MulAssign<[f32; 4]> for Color

fn mul_assign(&mut self, rhs: [f32; 4])

Performs the *= operation.

impl MulAssign<Vec3> for Color

fn mul_assign(&mut self, rhs: Vec3)

Performs the *= operation.

impl MulAssign<Vec4> for Color

fn mul_assign(&mut self, rhs: Vec4)

Performs the *= operation.

impl MulAssign<f32> for Color

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ReadFrom for Color

fn read_from<B>(&mut self, reader: &mut Reader<B>)

where B: BufferRef,

impl Reflect for Color

where Color: Any + Send + Sync, f32: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Color>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Color>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set( &mut self, __value_param: Box<dyn Reflect> ) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, __value_param: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Color>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Serialize for Color

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ShaderSize for Color

const SHADER_SIZE: NonZeroU64 = _

Represents WGSL Size (equivalent to ShaderType::min_size)

impl ShaderType for Color

fn min_size() -> NonZeroU64

Represents the minimum size of Self (equivalent to GPUBufferBindingLayout.minBindingSize)

fn size(&self) -> NonZeroU64

Returns the size of Self at runtime

fn assert_uniform_compat()

Asserts that Self meets the requirements of the uniform address space restrictions on stored values and the uniform address space layout constraints

impl TypePath for Color

where Color: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Color

where Color: Any + Send + Sync, f32: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl WriteInto for Color

fn write_into<B>(&self, writer: &mut Writer<B>)

where B: BufferMut,

impl Copy for Color

impl StructuralPartialEq for Color