Struct sixtyfps::Color

#[repr(C)]pub struct Color { /* fields omitted */ }

Color represents a color in the SixtyFPS run-time, represented using 8-bit channels for red, green, blue and the alpha (opacity). It can be conveniently constructed and destructured using the to_ and from_ (a)rgb helper functions:

let col = some_color.to_argb_f32();
do_something_with_red_and_green(col.red, col.green);

let RgbaColor { red, blue, green, .. } = some_color.to_argb_u8();
do_something_with_red(red);

let new_col = Color::from(RgbaColor{ red: 0.5, green: 0.65, blue: 0.32, alpha: 1.});

Implementations

impl Color

pub const fn from_argb_encoded(encoded: u32) -> Color

Construct a color from an integer encoded as 0xAARRGGBB

pub fn as_argb_encoded(&self) -> u32

Returns (alpha, red, green, blue) encoded as u32

pub fn from_argb_u8(alpha: u8, red: u8, green: u8, blue: u8) -> Color

Construct a color from the alpha, red, green and blue color channel parameters.

pub fn from_rgb_u8(red: u8, green: u8, blue: u8) -> Color

Construct a color from the red, green and blue color channel parameters. The alpha channel will have the value 255.

pub fn from_argb_f32(alpha: f32, red: f32, green: f32, blue: f32) -> Color

Construct a color from the alpha, red, green and blue color channel parameters.

pub fn from_rgb_f32(red: f32, green: f32, blue: f32) -> Color

Construct a color from the red, green and blue color channel parameters. The alpha channel will have the value 255.

pub fn to_argb_u8(&self) -> RgbaColor<u8>

Converts this color to an RgbaColor struct for easy destructuring.

pub fn to_argb_f32(&self) -> RgbaColor<f32>

Converts this color to an RgbaColor struct for easy destructuring.

pub fn red(self) -> u8

Returns the red channel of the color as u8 in the range 0..255.

pub fn green(self) -> u8

Returns the green channel of the color as u8 in the range 0..255.

pub fn blue(self) -> u8

Returns the blue channel of the color as u8 in the range 0..255.

pub fn alpha(self) -> u8

Returns the alpha channel of the color as u8 in the range 0..255.

Trait Implementations

impl Clone for Color

pub fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Color

impl Debug for Color

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

Formats the value using the given formatter.

impl Default for Color

pub fn default() -> Color

Returns the "default value" for a type.

impl Display for Color

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

Formats the value using the given formatter.

impl From<Color> for RgbaColor<f32>

pub fn from(col: Color) -> RgbaColor<f32>

Performs the conversion.

impl From<Color> for RgbaColor<u8>

pub fn from(col: Color) -> RgbaColor<u8>

Performs the conversion.

impl From<RgbaColor<f32>> for Color

pub fn from(col: RgbaColor<f32>) -> Color

Performs the conversion.

impl From<RgbaColor<u8>> for Color

pub fn from(col: RgbaColor<u8>) -> Color

Performs the conversion.

impl InterpolatedPropertyValue for Color

pub fn interpolate(self, target_value: Color, t: f32) -> Color

Returns the interpolated value between self and target_value according to the progress parameter t that's usually between 0 and 1. With certain animation easing curves it may over- or undershoot though.

impl PartialEq<Color> for Color

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

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

pub fn ne(&self, other: &Color) -> bool

This method tests for !=.

impl StructuralPartialEq for Color