Struct bevy_color::Srgba

pub struct Srgba {
    pub red: f32,
    pub green: f32,
    pub blue: f32,
    pub alpha: f32,
}

Non-linear standard RGB with alpha.

Conversion

Conversion between the various color spaces is achieved using Rust’s native From trait. Because certain color spaces are defined by their transformation to and from another space, these From implementations reflect that set of definitions.

let color = Srgba::rgb(0.5, 0.5, 0.5);

// Using From explicitly
let linear_color = LinearRgba::from(color);

// Using Into
let linear_color: LinearRgba = color.into();

For example, the sRGB space is defined by its relationship with Linear RGB, and HWB by its with sRGB. As such, it is the responsibility of sRGB to provide From implementations for Linear RGB, and HWB for sRGB. To then provide conversion between Linear RGB and HWB directly, HWB is responsible for implementing these conversions, delegating to sRGB as an intermediatory. This ensures that all conversions take the shortest path between any two spaces, and limit the proliferation of domain specific knowledge for each color space to their respective definitions.

Fields

red: f32

The red channel. [0.0, 1.0]

green: f32

The green channel. [0.0, 1.0]

blue: f32

The blue channel. [0.0, 1.0]

alpha: f32

The alpha channel. [0.0, 1.0]

Implementations

impl Srgba

pub const BLACK: Srgba = _

pub const NONE: Srgba = _

pub const WHITE: Srgba = _

pub const RED: Self = _

A fully red color with full alpha.

pub const GREEN: Self = _

A fully green color with full alpha.

pub const BLUE: Self = _

A fully blue color with full alpha.

pub const fn new(red: f32, green: f32, blue: f32, alpha: f32) -> Self

Construct a new Srgba color from components.

Arguments

• red - Red channel. [0.0, 1.0]
• green - Green channel. [0.0, 1.0]
• blue - Blue channel. [0.0, 1.0]
• alpha - Alpha channel. [0.0, 1.0]

pub const fn rgb(red: f32, green: f32, blue: f32) -> Self

Construct a new Srgba color from (r, g, b) components, with the default alpha (1.0).

Arguments

• red - Red channel. [0.0, 1.0]
• green - Green channel. [0.0, 1.0]
• blue - Blue channel. [0.0, 1.0]

pub const fn with_red(self, red: f32) -> Self

Return a copy of this color with the red channel set to the given value.

pub const fn with_green(self, green: f32) -> Self

Return a copy of this color with the green channel set to the given value.

pub const fn with_blue(self, blue: f32) -> Self

Return a copy of this color with the blue channel set to the given value.

pub fn hex<T: AsRef<str>>(hex: T) -> Result<Self, HexColorError>

New Srgba from a CSS-style hexadecimal string.

Examples

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

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

pub fn to_hex(&self) -> String

Convert this color to CSS-style hexadecimal notation.

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

New Srgba from sRGB colorspace.

Arguments

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

See also Srgba::new, Srgba::rgba_u8, Srgba::hex.

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

New Srgba 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 Srgba::new, Srgba::rgb_u8, Srgba::hex.

pub fn gamma_function(value: f32) -> f32

Converts a non-linear sRGB value to a linear one via gamma correction.

pub fn gamma_function_inverse(value: f32) -> f32

Converts a linear sRGB value to a non-linear one via gamma correction.

Trait Implementations

impl Add for Srgba

type Output = Srgba

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Srgba

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Alpha for Srgba

fn with_alpha(&self, alpha: f32) -> Self

Return a new version of this color with the given alpha value.

fn alpha(&self) -> f32

Return a the alpha component of this color.

fn set_alpha(&mut self, alpha: f32)

Sets the alpha component of this color.

fn is_fully_transparent(&self) -> bool

Is the alpha component of this color less than or equal to 0.0?

fn is_fully_opaque(&self) -> bool

Is the alpha component of this color greater than or equal to 1.0?

impl Clone for Srgba

fn clone(&self) -> Srgba

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ColorToComponents for Srgba

fn to_f32_array(self) -> [f32; 4]

Convert to an f32 array

fn to_f32_array_no_alpha(self) -> [f32; 3]

Convert to an f32 array without the alpha value

fn to_vec4(self) -> Vec4

Convert to a Vec4

fn to_vec3(self) -> Vec3

Convert to a Vec3

fn from_f32_array(color: [f32; 4]) -> Self

Convert from an f32 array

fn from_f32_array_no_alpha(color: [f32; 3]) -> Self

Convert from an f32 array without the alpha value

fn from_vec4(color: Vec4) -> Self

Convert from a Vec4

fn from_vec3(color: Vec3) -> Self

Convert from a Vec3

impl ColorToPacked for Srgba

fn to_u8_array(self) -> [u8; 4]

Convert to [u8; 4] where that makes sense (Srgba is most relevant)

fn to_u8_array_no_alpha(self) -> [u8; 3]

Convert to [u8; 3] where that makes sense (Srgba is most relevant)

fn from_u8_array(color: [u8; 4]) -> Self

Convert from [u8; 4] where that makes sense (Srgba is most relevant)

fn from_u8_array_no_alpha(color: [u8; 3]) -> Self

Convert to [u8; 3] where that makes sense (Srgba is most relevant)

impl Debug for Srgba

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

Formats the value using the given formatter.

impl Default for Srgba

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Srgba

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<f32> for Srgba

type Output = Srgba

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self::Output

Performs the / operation.

impl DivAssign<f32> for Srgba

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl EuclideanDistance for Srgba

fn distance_squared(&self, other: &Self) -> f32

Distance squared from self to other.

fn distance(&self, other: &Self) -> f32

Distance from self to other.

impl From<Color> for Srgba

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Hsla> for Srgba

fn from(value: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsva> for Srgba

fn from(value: Hsva) -> Self

Converts to this type from the input type.

impl From<Hwba> for Srgba

fn from(_: Hwba) -> Self

Converts to this type from the input type.

impl From<Laba> for Srgba

fn from(value: Laba) -> Self

Converts to this type from the input type.

impl From<Lcha> for Srgba

fn from(value: Lcha) -> Self

Converts to this type from the input type.

impl From<LinearRgba> for Srgba

fn from(value: LinearRgba) -> Self

Converts to this type from the input type.

impl From<Oklaba> for Srgba

fn from(value: Oklaba) -> Self

Converts to this type from the input type.

impl From<Oklcha> for Srgba

fn from(value: Oklcha) -> Self

Converts to this type from the input type.

impl From<Srgba> for Color

fn from(value: Srgba) -> Self

Converts to this type from the input type.

impl From<Srgba> for Hsla

fn from(value: Srgba) -> Self

Converts to this type from the input type.

impl From<Srgba> for Hsva

fn from(value: Srgba) -> Self

Converts to this type from the input type.

impl From<Srgba> for Hwba

fn from(_: Srgba) -> Self

Converts to this type from the input type.

impl From<Srgba> for Laba

fn from(value: Srgba) -> Self

Converts to this type from the input type.

impl From<Srgba> for Lcha

fn from(value: Srgba) -> Self

Converts to this type from the input type.

impl From<Srgba> for LinearRgba

fn from(value: Srgba) -> Self

Converts to this type from the input type.

impl From<Srgba> for Oklaba

fn from(value: Srgba) -> Self

Converts to this type from the input type.

impl From<Srgba> for Oklcha

fn from(value: Srgba) -> Self

Converts to this type from the input type.

impl From<Srgba> for Xyza

fn from(value: Srgba) -> Self

Converts to this type from the input type.

impl From<Xyza> for Srgba

fn from(value: Xyza) -> Self

Converts to this type from the input type.

impl FromReflect for Srgba

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

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 Srgba

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Gray for Srgba

const BLACK: Self = Self::BLACK

A pure black color.

const WHITE: Self = Self::WHITE

A pure white color.

fn gray(lightness: f32) -> Self

Returns a grey color with the provided lightness from (0.0 - 1.0). 0 is black, 1 is white.

impl Luminance for Srgba

fn luminance(&self) -> f32

Return the luminance of this color (0.0 - 1.0).

fn with_luminance(&self, luminance: f32) -> Self

Return a new version of this color with the given luminance. The resulting color will be clamped to the valid range for the color space; for some color spaces, clamping may cause the hue or chroma to change.

fn darker(&self, amount: f32) -> Self

Return a darker version of this color. The amount should be between 0.0 and 1.0. The amount represents an absolute decrease in luminance, and is distributive: color.darker(a).darker(b) == color.darker(a + b). Colors are clamped to black if the amount would cause them to go below black.

fn lighter(&self, amount: f32) -> Self

Return a lighter version of this color. The amount should be between 0.0 and 1.0. The amount represents an absolute increase in luminance, and is distributive: color.lighter(a).lighter(b) == color.lighter(a + b). Colors are clamped to white if the amount would cause them to go above white.

impl Mix for Srgba

fn mix(&self, other: &Self, factor: f32) -> Self

Linearly interpolate between this and another color, by factor. Factor should be between 0.0 and 1.0.

fn mix_assign(&mut self, other: Self, factor: f32)

Linearly interpolate between this and another color, by factor, storing the result in this color. Factor should be between 0.0 and 1.0.

impl Mul<Srgba> for f32

type Output = Srgba

The resulting type after applying the * operator.

fn mul(self, rhs: Srgba) -> Self::Output

Performs the * operation.

impl Mul<f32> for Srgba

type Output = Srgba

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self::Output

Performs the * operation.

impl MulAssign<f32> for Srgba

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Srgba

type Output = Srgba

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Srgba

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

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

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

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

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: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

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

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply 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<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

Returns a “partial equality” comparison result.

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

Applies a reflected value to this value.

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

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

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 Srgba

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for Srgba

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

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

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

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

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl Sub for Srgba

type Output = Srgba

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for Srgba

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TypePath for Srgba

where Self: 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 Srgba

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl VectorSpace for Srgba

const ZERO: Self = _

The zero vector, which is the identity of addition for the vector space type.

fn lerp(&self, rhs: Self, t: f32) -> Self

Perform vector space linear interpolation between this element and another, based on the parameter t. When t is 0, self is recovered. When t is 1, rhs is recovered.

impl Copy for Srgba

impl StructuralPartialEq for Srgba