Struct Rgba 

pub struct Rgba { /* private fields */ }

A floating-point RGBA color value.

• Each color component must have a nonnegative, non-NaN value. Depending on the application, they may be considered to have a nominal range of 0 to 1, or unbounded. (TODO: Split these use cases into different types.)
• The alpha must have a non-NaN value.
• Color components 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 usually be treated equivalently to zero and one, respectively, but are preserved rather than clipped.

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns the alpha component.

Note that the RGB components are not premultiplied by alpha.

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 const 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) -> Rgba

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]) -> Rgba

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

pub fn clamp(self) -> Rgba

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<Rgba, 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 Rgba

fn clone(&self) -> Rgba

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

Formats the value using the given formatter.

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

fn from(value: [ZeroOne<f32>; 4]) -> Rgba

Converts to this type from the input type.

impl From<(PositiveSign<f32>, PositiveSign<f32>, PositiveSign<f32>, ZeroOne<f32>)> for Rgba

fn from( value: (PositiveSign<f32>, PositiveSign<f32>, PositiveSign<f32>, ZeroOne<f32>), ) -> Rgba

Converts to this type from the input type.

impl From<Rgba> for Atom

fn from(color: Rgba) -> Self

Construct an Atom with the given reflectance color, and default attributes.

impl From<Rgba> for Block

fn from(color: Rgba) -> Self

Construct a Block with the given reflectance color, and default attributes.

This operation allocates a new Primitive value on the heap. If the color is a constant, you may use block::from_color! instead to avoid allocation.

impl From<Rgba> for Builder<'_, Atom, ()>

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

fn from(color: Rgba) -> Self

Converts to this type from the input type.

impl Hash for Rgba

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

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