Struct bevy_color::Srgba

source ·
pub struct Srgba {
    pub red: f32,
    pub green: f32,
    pub blue: f32,
    pub alpha: f32,
}
Expand description

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.

GPU

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§

source§

impl Srgba

source

pub const BLACK: Srgba = _

source

pub const NONE: Srgba = _

source

pub const WHITE: Srgba = _

source

pub const RED: Self = _

A fully red color with full alpha.

source

pub const GREEN: Self = _

A fully green color with full alpha.

source

pub const BLUE: Self = _

A fully blue color with full alpha.

source

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]
source

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]
source

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

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

source

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

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

source

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

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

source

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));
source

pub fn to_hex(&self) -> String

Convert this color to CSS-style hexadecimal notation.

source

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.

source

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.

source

pub fn gamma_function(value: f32) -> f32

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

source

pub fn gamma_function_inverse(value: f32) -> f32

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

Trait Implementations§

source§

impl Add for Srgba

§

type Output = Srgba

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl AddAssign for Srgba

source§

fn add_assign(&mut self, rhs: Self)

Performs the += operation. Read more
source§

impl Alpha for Srgba

source§

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

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

fn alpha(&self) -> f32

Return a the alpha component of this color.
source§

fn set_alpha(&mut self, alpha: f32)

Sets the alpha component of this color.
source§

fn is_fully_transparent(&self) -> bool

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

fn is_fully_opaque(&self) -> bool

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

impl Clone for Srgba

source§

fn clone(&self) -> Srgba

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl ColorToComponents for Srgba

source§

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

Convert to an f32 array
source§

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

Convert to an f32 array without the alpha value
source§

fn to_vec4(self) -> Vec4

Convert to a Vec4
source§

fn to_vec3(self) -> Vec3

Convert to a Vec3
source§

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

Convert from an f32 array
source§

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

Convert from an f32 array without the alpha value
source§

fn from_vec4(color: Vec4) -> Self

Convert from a Vec4
source§

fn from_vec3(color: Vec3) -> Self

Convert from a Vec3
source§

impl ColorToPacked for Srgba

source§

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

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

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

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

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

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

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

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

impl Debug for Srgba

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Srgba

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Div<f32> for Srgba

§

type Output = Srgba

The resulting type after applying the / operator.
source§

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

Performs the / operation. Read more
source§

impl DivAssign<f32> for Srgba

source§

fn div_assign(&mut self, rhs: f32)

Performs the /= operation. Read more
source§

impl EuclideanDistance for Srgba

source§

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

Distance squared from self to other.
source§

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

Distance from self to other.
source§

impl From<Color> for Srgba

source§

fn from(value: Color) -> Self

Converts to this type from the input type.
source§

impl From<Hsla> for Srgba

source§

fn from(value: Hsla) -> Self

Converts to this type from the input type.
source§

impl From<Hsva> for Srgba

source§

fn from(value: Hsva) -> Self

Converts to this type from the input type.
source§

impl From<Hwba> for Srgba

source§

fn from(_: Hwba) -> Self

Converts to this type from the input type.
source§

impl From<Laba> for Srgba

source§

fn from(value: Laba) -> Self

Converts to this type from the input type.
source§

impl From<Lcha> for Srgba

source§

fn from(value: Lcha) -> Self

Converts to this type from the input type.
source§

impl From<LinearRgba> for Srgba

source§

fn from(value: LinearRgba) -> Self

Converts to this type from the input type.
source§

impl From<Oklaba> for Srgba

source§

fn from(value: Oklaba) -> Self

Converts to this type from the input type.
source§

impl From<Oklcha> for Srgba

source§

fn from(value: Oklcha) -> Self

Converts to this type from the input type.
source§

impl From<Srgba> for Color

source§

fn from(value: Srgba) -> Self

Converts to this type from the input type.
source§

impl From<Srgba> for Hsla

source§

fn from(value: Srgba) -> Self

Converts to this type from the input type.
source§

impl From<Srgba> for Hsva

source§

fn from(value: Srgba) -> Self

Converts to this type from the input type.
source§

impl From<Srgba> for Hwba

source§

fn from(_: Srgba) -> Self

Converts to this type from the input type.
source§

impl From<Srgba> for Laba

source§

fn from(value: Srgba) -> Self

Converts to this type from the input type.
source§

impl From<Srgba> for Lcha

source§

fn from(value: Srgba) -> Self

Converts to this type from the input type.
source§

impl From<Srgba> for LinearRgba

source§

fn from(value: Srgba) -> Self

Converts to this type from the input type.
source§

impl From<Srgba> for Oklaba

source§

fn from(value: Srgba) -> Self

Converts to this type from the input type.
source§

impl From<Srgba> for Oklcha

source§

fn from(value: Srgba) -> Self

Converts to this type from the input type.
source§

impl From<Srgba> for Xyza

source§

fn from(value: Srgba) -> Self

Converts to this type from the input type.
source§

impl From<Xyza> for Srgba

source§

fn from(value: Xyza) -> Self

Converts to this type from the input type.
source§

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

source§

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

Constructs a concrete instance of Self from a reflected value.
source§

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. Read more
source§

impl GetTypeRegistration for Srgba
where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

source§

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.
source§

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type. Read more
source§

impl Gray for Srgba

source§

const BLACK: Self = Self::BLACK

A pure black color.
source§

const WHITE: Self = Self::WHITE

A pure white color.
source§

fn gray(lightness: f32) -> Self

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

impl Luminance for Srgba

source§

fn luminance(&self) -> f32

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

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.
source§

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. Read more
source§

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. Read more
source§

impl Mix for Srgba

source§

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.
source§

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.
source§

impl Mul<Srgba> for f32

§

type Output = Srgba

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl Mul<f32> for Srgba

§

type Output = Srgba

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl MulAssign<f32> for Srgba

source§

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation. Read more
source§

impl Neg for Srgba

§

type Output = Srgba

The resulting type after applying the - operator.
source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
source§

impl PartialEq for Srgba

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl Reflect for Srgba
where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

source§

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

Returns the TypeInfo of the type represented by this value. Read more
source§

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

Returns the value as a Box<dyn Any>.
source§

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.
source§

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

Returns the value as a &mut dyn Any.
source§

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

Casts this type to a boxed reflected value.
source§

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.
source§

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

Casts this type to a mutable reflected value.
source§

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

Clones the value as a Reflect trait object. Read more
source§

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

Performs a type-checked assignment of a reflected value to this value. Read more
source§

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

Tries to apply a reflected value to this value. Read more
source§

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type. Read more
source§

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

Returns an immutable enumeration of “kinds” of type. Read more
source§

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

Returns a mutable enumeration of “kinds” of type. Read more
source§

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

Returns an owned enumeration of “kinds” of type. Read more
source§

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

Returns a “partial equality” comparison result. Read more
source§

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

Applies a reflected value to this value. Read more
source§

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

Returns a hash of the value (which includes the type). Read more
source§

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

Debug formatter for the value. Read more
source§

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

Returns a serializable version of the value. Read more
source§

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type. Read more
source§

impl Serialize for Srgba

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Struct for Srgba
where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

source§

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

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

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.
source§

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.
source§

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.
source§

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

Returns the name of the field with index index.
source§

fn field_len(&self) -> usize

Returns the number of fields in the struct.
source§

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

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

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.
source§

impl Sub for Srgba

§

type Output = Srgba

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl SubAssign for Srgba

source§

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation. Read more
source§

impl TypePath for Srgba
where Self: Any + Send + Sync,

source§

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type. Read more
source§

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type. Read more
source§

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

Returns the name of the type, or None if it is anonymous. Read more
source§

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

Returns the name of the crate the type is in, or None if it is anonymous. Read more
source§

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

Returns the path to the module the type is in, or None if it is anonymous. Read more
source§

impl Typed for Srgba
where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

source§

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.
source§

impl VectorSpace for Srgba

source§

const ZERO: Self = _

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

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. Read more
source§

impl Copy for Srgba

source§

impl StructuralPartialEq for Srgba

Auto Trait Implementations§

§

impl Freeze for Srgba

§

impl RefUnwindSafe for Srgba

§

impl Send for Srgba

§

impl Sync for Srgba

§

impl Unpin for Srgba

§

impl UnwindSafe for Srgba

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast for T
where T: Any,

source§

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

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> DynamicTypePath for T
where T: TypePath,

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<S> GetField for S
where S: Struct,

source§

fn get_field<T>(&self, name: &str) -> Option<&T>
where T: Reflect,

Returns a reference to the value of the field named name, downcast to T.
source§

fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>
where T: Reflect,

Returns a mutable reference to the value of the field named name, downcast to T.
source§

impl<T> GetPath for T
where T: Reflect + ?Sized,

source§

fn reflect_path<'p>( &self, path: impl ReflectPath<'p> ) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>

Returns a reference to the value specified by path. Read more
source§

fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p> ) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>

Returns a mutable reference to the value specified by path. Read more
source§

fn path<'p, T>( &self, path: impl ReflectPath<'p> ) -> Result<&T, ReflectPathError<'p>>
where T: Reflect,

Returns a statically typed reference to the value specified by path. Read more
source§

fn path_mut<'p, T>( &mut self, path: impl ReflectPath<'p> ) -> Result<&mut T, ReflectPathError<'p>>
where T: Reflect,

Returns a statically typed mutable reference to the value specified by path. Read more
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer ) -> Result<(), ErrorImpl>

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> ConditionalSend for T
where T: Send,

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,