Struct Rgb 

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

A floating-point RGB color value, unbounded.

• Represents a light intensity in unspecified units.
• Each color component must have a nonnegative, non-NaN f32 value.
• Color components are linear (gamma = 1), but use the same RGB primaries as sRGB (Rec. 709).

For colors whose components do not exceed 1, use Rgb01 instead.

Suitability

The primary purpose of this color type and its relatives, and the reason for its enforced value restrictions, is to be able to be stored in game state data structures, with reliable comparison and serialization. It is not necessarily appropriate for storing the intermediate results of computations (though the operations do take care to avoid unnecessary re-validation).

Future versions of All is Cubes may choose to reduce the precision of this type to f16 when Rust has built-in support for that data type.

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 const fn new(r: f32, g: f32, b: f32) -> Rgb

Constructs a color from components.

Panics if any component is NaN. Clamps any component that is negative.

pub const fn new_ps( r: PositiveSign<f32>, g: PositiveSign<f32>, b: PositiveSign<f32>, ) -> Rgb

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

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

pub const fn from_luminance(luminance: f32) -> Rgb

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: ZeroOne<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) -> PositiveSign<f32>

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

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

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

pub const fn blue(self) -> PositiveSign<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]) -> Rgb

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

pub fn clamp(self, maximum: PositiveSign<f32>) -> Rgb

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

pub fn clamp_01(self) -> Rgb01

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

pub fn saturating_sub(self, other: Rgb) -> Rgb

Subtract other from self; if any component would be negative, it is zero instead.

Trait Implementations

impl Add for Rgb

type Output = Rgb

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Rgb

fn add_assign(&mut self, other: Rgb)

Performs the += operation.

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

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Rgb, Error>

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.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

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

impl Clone for Rgb

fn clone(&self) -> Rgb

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

Formats the value using the given formatter.

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

fn from(value: [PositiveSign<f32>; 3]) -> Rgb

Converts to this type from the input type.

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

fn from(value: [ZeroOne<f32>; 3]) -> Rgb

Converts to this type from the input type.

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) -> Vector3D<f32, Intensity>

Converts to this type from the input type.

impl From<Rgb01> for Rgb

fn from(value: Rgb01) -> Rgb

Converts to this type from the input type.

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

fn from(value: Vector3D<PositiveSign<f32>, Intensity>) -> Rgb

Converts to this type from the input type.

impl Hash for Rgb

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

where __H: Hasher,

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

Multiplies this color value by a scalar.

fn mul(self, scalar: PositiveSign<f32>) -> Rgb

Multiplies this color value by a scalar.

type Output = Rgb

The resulting type after applying the * operator.

impl Mul<ZeroOne<f32>> for Rgb

fn mul(self, scalar: ZeroOne<f32>) -> Rgb

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. Returns zero if the scalar is negative.

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

Multiplies this color value by a scalar.

Panics if the scalar is NaN. Returns zero if the scalar is negative.

type Output = Rgb

The resulting type after applying the * operator.

impl Mul for Rgb

Multiplies two color values componentwise.

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

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

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 Sum for Rgb

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

fn sum<I>(iter: I) -> Rgb

where I: Iterator<Item = Rgb>,

Takes an iterator and generates Self from the elements by “summing up” the items.

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

type Error = NotPositiveSign<f32>

The type returned in the event of a conversion error.

fn try_from( value: Vector3D<f32, Intensity>, ) -> Result<Rgb, <Rgb as TryFrom<Vector3D<f32, Intensity>>>::Error>

Performs the conversion.

impl Copy for Rgb

impl Eq for Rgb

impl StructuralPartialEq for Rgb