Enum ambient_color::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,
    },
}

Variants

Rgba

Fields

red: f32

Red component. [0.0, 1.0]

green: f32

Green component. [0.0, 1.0]

blue: f32

Blue component. [0.0, 1.0]

alpha: f32

Alpha component. [0.0, 1.0]

sRGBA color

RgbaLinear

Fields

red: f32

Red component. [0.0, 1.0]

green: f32

Green component. [0.0, 1.0]

blue: f32

Blue component. [0.0, 1.0]

alpha: f32

Alpha component. [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 component. [0.0, 360.0]

saturation: f32

Saturation component. [0.0, 1.0]

lightness: f32

Lightness component. [0.0, 1.0]

alpha: f32

Alpha component. [0.0, 1.0]

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

Implementations

impl Color

pub const WHITE: Color = _

pub const BLACK: Color = _

pub const TRANSPARENT: Color = _

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

New Color from sRGB colorspace.

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

New Color from sRGB colorspace.

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

New Color from linear RGB colorspace.

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

New Color from linear RGB colorspace.

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

New Color with HSL representation in sRGB colorspace.

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

New Color with HSL representation in sRGB colorspace.

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

New Color from sRGB colorspace.

pub fn u8_debug(v: u8) -> Self

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

New Color from sRGB colorspace.

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

New Color from sRGB colorspace.

pub fn r(&self) -> f32

Get red in sRGB colorspace.

pub fn g(&self) -> f32

Get green in sRGB colorspace.

pub fn b(&self) -> f32

Get blue in sRGB colorspace.

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

Set red in sRGB colorspace.

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

Set green in sRGB colorspace.

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

Set blue in sRGB colorspace.

pub fn a(&self) -> f32

Get alpha.

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

Set alpha.

pub fn as_rgba(self: &Color) -> Color

Converts a Color to variant Color::Rgba

pub fn as_rgba_linear(self: &Color) -> Color

Converts a Color to variant Color::RgbaLinear

pub fn as_hsla(self: &Color) -> Color

Converts a Color to variant Color::Hsla

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

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

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

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

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

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

pub fn as_rgba_u32(self: Color) -> 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: Color) -> 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 saturate(self, amount: f32) -> Self

pub fn desaturate(self, amount: f32) -> Self

pub fn lighten(self, amount: f32) -> Self

pub fn darken(self, amount: f32) -> Self

Trait Implementations

impl Add<Vec4> for Color

type Output = Color

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Color

type Output = Color

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Vec4> for Color

fn add_assign(&mut self, rhs: Vec4)

Performs the += operation.

impl AddAssign for Color

fn add_assign(&mut self, rhs: Color)

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 Debug for Color

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

Formats the value using the given formatter.

impl Default for Color

fn default() -> Self

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<[f32; 3]> for Color

fn from([r, g, b]: [f32; 3]) -> Self

Converts to this type from the input type.

impl From<[f32; 4]> for Color

fn from([r, g, b, a]: [f32; 4]) -> Self

Converts to this type from the input type.

impl From<Color> for [f32; 4]

fn from(color: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Vec3

fn from(color: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Vec4

fn from(color: Color) -> Self

Converts to this type from the input type.

impl From<Vec4> for Color

fn from(vec4: Vec4) -> Self

Converts to this type from the input type.

impl Mul<[f32; 3]> for Color

type Output = Color

The resulting type after applying the * operator.

fn mul(self, rhs: [f32; 3]) -> Self::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]) -> Self::Output

Performs the * operation.

impl Mul<Vec3> for Color

type Output = Color

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec4> for Color

type Output = Color

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Color

type Output = Color

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self::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 Serialize for Color

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Color

impl StructuralPartialEq for Color