Struct all_is_cubes::math::Rgb

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

A floating-point RGB color value.

• Each component may be considered to have a nominal range of 0 to 1, but larger values are permitted — corresponding to bright light sources and other such things which it is reasonable to “overexpose”. (No meaning is given to negative values, but they are permitted.)
• NaN is banned so that Eq may be implemented. (Infinities are permitted.)
• Color values are linear (gamma = 1), but use the same RGB primaries as sRGB (Rec. 709).

Implementations

impl Rgb

pub const ZERO: Rgb = _

Black; the constant equal to Rgb::new(0., 0., 0.).unwrap().

pub const ONE: Rgb = _

Nominal white; the constant equal to Rgb::new(1., 1., 1.).unwrap().

Note that brighter values may exist; the color system “supports HDR”.

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

Constructs a color from components. Panics if any component is NaN. No other range checks are performed.

pub const fn new_nn(r: NotNan<f32>, g: NotNan<f32>, b: NotNan<f32>) -> Self

Constructs a color from components that have already been checked for not being NaN.

Note: This exists primarily to assist the rgb_const! macro and may be renamed or replaced in future versions.

pub fn from_luminance(luminance: f32) -> Self

Constructs a shade of gray (components all equal). Panics if any component is NaN. No other range checks are performed.

pub const fn with_alpha(self, alpha: NotNan<f32>) -> Rgba

Adds an alpha component to produce an Rgba color.

pub const fn with_alpha_one(self) -> Rgba

Adds an alpha component of 1.0 (fully opaque) to produce an Rgba color.

pub const fn red(self) -> NotNan<f32>

Returns the red color component. Values are linear (gamma = 1).

pub const fn green(self) -> NotNan<f32>

Returns the green color component. Values are linear (gamma = 1).

pub const fn blue(self) -> NotNan<f32>

Returns the blue color component. Values are linear (gamma = 1).

pub fn luminance(self) -> f32

Combines the red, green, and blue components to obtain a relative luminance (“grayscale”) value. This will be equal to 1 if all components are 1.

use all_is_cubes::math::Rgb;

assert_eq!(0.0, Rgb::ZERO.luminance());
assert_eq!(0.5, (Rgb::ONE * 0.5).luminance());
assert_eq!(1.0, Rgb::ONE.luminance());
assert_eq!(2.0, (Rgb::ONE * 2.0).luminance());

assert_eq!(0.2126, Rgb::new(1., 0., 0.).luminance());
assert_eq!(0.7152, Rgb::new(0., 1., 0.).luminance());
assert_eq!(0.0722, Rgb::new(0., 0., 1.).luminance());

pub const fn from_srgb8(rgb: [u8; 3]) -> Self

Converts sRGB 8-bits-per-component color to the corresponding linear Rgba value.

pub fn clamp(self) -> Self

Clamp each component to lie within the range 0 to 1, inclusive.

Trait Implementations

impl Add for Rgb

type Output = Rgb

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl AddAssign for Rgb

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<'a> Arbitrary<'a> for Rgb

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

impl Clone for Rgb

fn clone(&self) -> Rgb

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rgb

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

Formats the value using the given formatter.

impl From<[NotNan<f32>; 3]> for Rgb

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

Converts to this type from the input type.

impl From<Rgb> for [NotNan<f32>; 3]

fn from(value: Rgb) -> Self

Converts to this type from the input type.

impl From<Rgb> for [f32; 3]

fn from(value: Rgb) -> Self

Converts to this type from the input type.

impl From<Rgb> for Atom

fn from(color: Rgb) -> Self

Convert a color to an Atom with default attributes.

impl From<Rgb> for Block

fn from(color: Rgb) -> Self

Convert a color to a block with default attributes.

impl From<Rgb> for BlockBuilder<BlockBuilderAtom, ()>

Equivalent to Block::builder().color(color.with_alpha_one()).

fn from(color: Rgb) -> Self

Converts to this type from the input type.

impl From<Rgb> for Cow<'_, Block>

fn from(color: Rgb) -> Self

Convert a color to a block with default attributes.

impl From<Rgb> for PackedLight

fn from(value: Rgb) -> Self

Converts to this type from the input type.

impl From<Rgb> for Vector3D<f32, Intensity>

fn from(value: Rgb) -> Self

Converts to this type from the input type.

impl From<Rgb888> for Rgb

Adapt embedded_graphics’s most general color type to ours.

fn from(color: Rgb888) -> Rgb

Converts to this type from the input type.

impl From<Vector3D<NotNan<f32>, Intensity>> for Rgb

fn from(value: Vector3D<NotNan<f32>, Intensity>) -> Self

Converts to this type from the input type.

impl Hash for Rgb

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<NotNan<f32>> for Rgb

Multiplies this color value by a scalar.

fn mul(self, scalar: NotNan<f32>) -> Self

Multiplies this color value by a scalar.

type Output = Rgb

The resulting type after applying the * operator.

impl Mul<f32> for Rgb

Multiplies this color value by a scalar. Panics if the scalar is NaN.

fn mul(self, scalar: f32) -> Self

Multiplies this color value by a scalar. Panics if the scalar is NaN.

type Output = Rgb

The resulting type after applying the * operator.

impl Mul for Rgb

Multiplies two color values componentwise.

fn mul(self, other: Rgb) -> Self

Multiplies two color values componentwise.

type Output = Rgb

The resulting type after applying the * operator.

impl PartialEq for Rgb

fn eq(&self, other: &Rgb) -> 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 PixelColor for Rgb

type Raw = ()

Raw data type.

impl Sub for Rgb

type Output = Rgb

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl Sum for Rgb

There is no corresponding impl Sum for Rgba because the alpha would not have a universally reasonable interpretation.

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<Vector3D<f32, Intensity>> for Rgb

type Error = FloatIsNan

The type returned in the event of a conversion error.

fn try_from(value: Vector3D<f32, Intensity>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> VoxelColor<'a> for Rgb

fn into_blocks(self) -> VoxelBrush<'a>

Returns a corresponding VoxelBrush, the most general form of blocky drawing.

impl Copy for Rgb

impl Eq for Rgb

impl StructuralEq for Rgb

impl StructuralPartialEq for Rgb