Struct Color 

pub struct Color {
    pub r: u8,
    pub g: u8,
    pub b: u8,
    pub a: u8,
}

An RGBA (red, green, blue, alpha) color.

All components are stored as u8 and have a color range of 0-255.

Fields

r: u8

The red component value.

g: u8

The green component value.

b: u8

The blue component value.

a: u8

The alpha component value.

Implementations

impl Color

pub const TRANSPARENT: Self

pub const BLACK: Self

pub const GRAY: Self

pub const WHITE: Self

pub const RED: Self

pub const GREEN: Self

pub const BLUE: Self

pub const YELLOW: Self

pub const CYAN: Self

pub const MAGENTA: Self

pub const fn from_rgb(rgb: u32, alpha: u8) -> Self

Creates a Color from a 32-bit rgb value and an alpha value.

The byte-ordering of the 32-bit rgb value is XXRRGGBB. The most significant byte, represented by XX, is ignored; the alpha value is provided separately. This is followed by the red (RR), green (GG), and blue (BB) components values, respectively.

Examples

use swf::Color;

let red = Color::from_rgb(0xFF0000, 255);
let green = Color::from_rgb(0x00FF00, 255);
let blue = Color::from_rgb(0x0000FF, 255);

pub const fn from_rgba(rgba: u32) -> Self

Creates a Color from a 32-bit rgba value.

The byte-ordering of the 32-bit rgba value is AARRGGBB.

Examples

use swf::Color;

let red = Color::from_rgba(0xFFFF0000);
let green = Color::from_rgba(0xFF00FF00);
let blue = Color::from_rgba(0xFF0000FF);

pub const fn to_rgb(&self) -> u32

Converts the color to a 32-bit RGB value.

The alpha value does not get stored.

Examples

Basic usage:

use swf::Color;

let color = Color::from_rgb(0xFF00FF, 255);
assert_eq!(color.to_rgb(), 0xFF00FF);

Alpha values do not get stored:

use swf::Color;

let color1 = Color::from_rgb(0xFF00FF, 255);
let color2 = Color::from_rgb(0xFF00FF, 0);
assert_eq!(color1.to_rgb(), color2.to_rgb());

pub const fn to_rgba(&self) -> u32

Converts the color to a 32-bit RGBA value.

Examples

Basic usage:

use swf::Color;

let color = Color::from_rgb(0xFF00FF, 255);
assert_eq!(color.to_rgba(), 0xFFFF00FF);

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a duplicate 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() -> Color

Returns the “default value” for a type.

impl Hash for Color

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<Color> for &ColorTransform

type Output = Color

The resulting type after applying the * operator.

fn mul(self, color: Color) -> Color

Performs the * operation.

impl PartialEq for Color

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Color

impl Eq for Color

impl StructuralPartialEq for Color