Enum bones_framework::render::color::Color

pub enum Color {
    Rgba {
        red: f32,
        green: f32,
        blue: f32,
        alpha: f32,
    },
}

Color type.

Variants

Rgba

sRGBA color

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]

Implementations

impl Color

pub const BLACK: Color = _

pub const BLUE: Color = _

pub const CYAN: Color = _

pub const GRAY: Color = _

pub const GREEN: Color = _

pub const NONE: Color = _

pub const ORANGE: Color = _

pub const RED: Color = _

pub const WHITE: Color = _

pub const YELLOW: 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 fn hex<T: AsRef<str>>(hex: T) -> Result<Color, HexColorError>

New Color from sRGB colorspace.

Examples

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

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

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_f32(self: Color) -> [f32; 4]

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

Trait Implementations

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 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 Color32

fn from(value: 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 HasSchema for Color

fn schema() -> &'static Schema

Get this type’s [Schema].

fn register_schema()

Register this schema with the global schema registry.

fn cast<T>(this: &Self) -> &T

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn cast_mut<T>(this: &mut Self) -> &mut T

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn as_schema_ref(&self) -> SchemaRef<'_>

where Self: Sized,

Converts a reference of T to a SchemaRef

fn as_schema_mut(&mut self) -> SchemaRefMut<'_>

where Self: Sized,

Converts a reference of T to a SchemaRefMut

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