Struct all_is_cubes::math::Rgba

pub struct Rgba { /* private fields */ }

A floating-point RGBA color value.

• Each color 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).
• The alpha is not premultiplied.
• Alpha values less than zero and greater than one will be treated equivalently to zero and one, respectively, but are preserved rather than clipped.

Implementations

impl Rgba

pub const TRANSPARENT: Rgba = _

Transparent black (all components zero); identical to Rgba::new(0.0, 0.0, 0.0, 0.0) except for being a constant.

pub const BLACK: Rgba = _

Black; identical to Rgba::new(0.0, 0.0, 0.0, 1.0) except for being a constant.

pub const WHITE: Rgba = _

White; identical to Rgba::new(1.0, 1.0, 1.0, 1.0) except for being a constant.

pub fn new(r: f32, g: f32, b: f32, a: 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>, a: 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 red(self) -> NotNan<f32>

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

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

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

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

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

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

Returns the alpha component.

Alpha is not premultiplied. Alpha values less than zero and greater than one are allowed and may be returned by this method, but alpha test methods will treat

pub fn fully_transparent(self) -> bool

Returns whether this color is fully transparent, or has an alpha component of zero or less.

pub fn fully_opaque(self) -> bool

Returns whether this color is fully opaque, or has an alpha component of one or greater.

pub fn opacity_category(self) -> OpacityCategory

Returns the OpacityCategory which this color’s alpha fits into. This returns the same information as Rgba::fully_transparent combined with Rgba::fully_opaque.

pub fn to_rgb(self) -> Rgb

Discards the alpha component to produce an RGB color.

Note that if alpha is 0 then the components could be any value and yet be “hidden” by the transparency.

pub fn map_rgb(self, f: impl FnOnce(Rgb) -> Rgb) -> Self

Applies a function to the RGB portion of this color.

pub fn luminance(self) -> f32

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

This is identical to Rgb::luminance, ignoring the alpha component.

pub fn to_srgb8(self) -> [u8; 4]

Converts this color lossily to sRGB 8-bits-per-component color.

pub const fn from_srgb8(rgba: [u8; 4]) -> 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<'a> Arbitrary<'a> for Rgba

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 Rgba

fn clone(&self) -> Rgba

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rgba

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

Formats the value using the given formatter.

impl From<[NotNan<f32>; 4]> for Rgba

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

Converts to this type from the input type.

impl From<ColorBuf> for Rgba

fn from(buf: ColorBuf) -> Rgba

Returns the color (image pixel) accumulated in this buffer.

Not tone mapped; consider using Camera::post_process_color() for that.

impl From<Rgba> for [NotNan<f32>; 4]

fn from(value: Rgba) -> Self

Converts to this type from the input type.

impl From<Rgba> for [f32; 4]

fn from(value: Rgba) -> Self

Converts to this type from the input type.

impl From<Rgba> for Atom

fn from(color: Rgba) -> Self

Convert a color to an Atom with default attributes.

impl From<Rgba> for Block

fn from(color: Rgba) -> Self

Convert a color to a block with default attributes.

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

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

fn from(color: Rgba) -> Self

Converts to this type from the input type.

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

fn from(color: Rgba) -> Self

Convert a color to a block with default attributes.

impl Hash for Rgba

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 PartialEq for Rgba

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

type Raw = ()

Raw data type.

impl<'a> VoxelColor<'a> for Rgba

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

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

impl Copy for Rgba

impl Eq for Rgba

impl StructuralEq for Rgba

impl StructuralPartialEq for Rgba