Struct keyset_color::Color

pub struct Color(/* private fields */);

sRGB Color type.

Internally stores red, green, and blue components as f32.

Implementations

impl Color

pub const fn new(r: f32, g: f32, b: f32) -> Self

Creates a new Color value with the given red, green, and blue component values.

The components should be in the range 0.0..1.0 for a semantically valid colour, although this function does not perform any range checks.

pub const fn r(&self) -> f32

Returns the red component.

pub const fn g(&self) -> f32

Returns the green component.

pub const fn b(&self) -> f32

Returns the blue component.

pub fn iter(&self) -> impl Iterator<Item = &f32>

Returns an iterator over the colour’s components.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut f32>

Returns an iterator that allows modifying the colour’s components.

Modified components should be in the range 0.0..1.0 for a semantically valid colour, although this function does not perform any range checks.

pub fn map(self, f: impl FnMut(f32) -> f32) -> Self

Applies the function f to each of the colour’s components.

The resulting components should be in the range 0.0..1.0 for a semantically valid colour, although this function does not perform any range checks.

pub fn as_rgb8(&self) -> (u8, u8, u8)

Returns a tuple containing the red, green, and blue components as u8.

pub fn as_rgb16(&self) -> (u16, u16, u16)

Returns a tuple containing the red, green, and blue components as u16.

pub fn from_rgb8((r, g, b): (u8, u8, u8)) -> Self

Creates a new Color from a tuple containing the red, green, and blue components as u8.

pub fn from_rgb16((r, g, b): (u16, u16, u16)) -> Self

Creates a new Color from a tuple containing the red, green, and blue components as u16.

pub const fn as_slice(&self) -> &[f32]

Returns a slice containing the red, green, and blue components of the colour.

pub fn as_mut_slice(&mut self) -> &mut [f32]

Returns a mutable slice containing the red, green, and blue components of the colour.

impl Color

pub fn lighter(self, val: f32) -> Self

Lightens the colour by a given amount.

val should be in the range 0.0..1.0 for a semantically valid factor, although this function does not perform any range checks.

pub fn darker(self, val: f32) -> Self

Darkens the colour by a given amount.

val should be in the range 0.0..1.0 for a semantically valid factor, although this function does not perform any range checks.

pub fn highlight(self, val: f32) -> Self

Either calls lighter or darker on the colour depending on its luminance.

val should be in the range 0.0..1.0 for a semantically valid factor, although this function does not perform any range checks.

Trait Implementations

impl AsMut<[f32]> for Color

fn as_mut(&mut self) -> &mut [f32]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<[f32; 3]> for Color

fn as_mut(&mut self) -> &mut [f32; 3]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[f32]> for Color

fn as_ref(&self) -> &[f32]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<[f32; 3]> for Color

fn as_ref(&self) -> &[f32; 3]

Converts this type into a shared reference of the (usually inferred) input type.

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() -> Color

Returns the “default value” for a type.

impl Display for Color

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

Formats the value using the given formatter.

impl From<[f32; 3]> for Color

fn from(value: [f32; 3]) -> Self

Converts to this type from the input type.

impl From<(f32, f32, f32)> for Color

fn from((r, g, b): (f32, f32, f32)) -> Self

Converts to this type from the input type.

impl From<Color> for [f32; 3]

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for (f32, f32, f32)

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color

fn from(value: SkiaColor) -> Self

Converts to this type from the input type.

impl From<Color> for Color

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for RGB<f32>

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for RGB16

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for RGB8

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<RGB<f32>> for Color

fn from(value: RGB<f32>) -> Self

Converts to this type from the input type.

impl From<RGB<u16>> for Color

fn from(value: RGB16) -> Self

Converts to this type from the input type.

impl From<RGB<u8>> for Color

fn from(value: RGB8) -> Self

Converts to this type from the input type.

impl IntoIterator for Color

type Item = f32

The type of the elements being iterated over.

type IntoIter = IntoIter<f32, 3>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Color

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl Copy for Color

impl StructuralPartialEq for Color