Struct rdenticon::Rgb

pub struct Rgb {
    pub r: u8,
    pub g: u8,
    pub b: u8,
}

Represents an RGB pixel.

Fields

r: u8

The red component of the pixel.

g: u8

The green component of the pixel.

b: u8

The blue component of the pixel.

Implementations

impl Rgb

pub const fn new(r: u8, g: u8, b: u8) -> Rgb

Creates a new RGB pixel.

pub fn from_hex(hex: impl AsRef<str>) -> Result<Rgb, Error>

Parses an RGB pixel from a hex value.

The hex value can be in one of the following formats:

• RRGGBB
• RGB

These can be optionally padded with #, for example “#FF0000” is the same as as “FF0000”.

Errors

• Received a malformed hex code.

pub const fn black() -> Rgb

Creates a completely black pixel.

pub const fn white() -> Rgb

Creates a completely white pixel.

Trait Implementations

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, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Rgb

fn default() -> Rgb

Returns the “default value” for a type.

impl From<BitPixel> for Rgb

fn from(pixel: BitPixel) -> Rgb

Converts to this type from the input type.

impl From<Dynamic> for Rgb

fn from(pixel: Dynamic) -> Rgb

Converts to this type from the input type.

impl From<L> for Rgb

fn from(_: L) -> Rgb

Converts to this type from the input type.

impl From<PalettedRgb<'_>> for Rgb

fn from(pixel: PalettedRgb<'_>) -> Rgb

Converts to this type from the input type.

impl From<PalettedRgba<'_>> for Rgb

fn from(pixel: PalettedRgba<'_>) -> Rgb

Converts to this type from the input type.

impl From<Rgb> for Rgba

fn from(_: Rgb) -> Rgba

Converts to this type from the input type.

impl From<Rgba> for Rgb

fn from(_: Rgba) -> 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 PartialEq<Rgb> 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 Pixel for Rgb

const COLOR_TYPE: ColorType = ColorType::Rgb

The color type of the pixel.

const BIT_DEPTH: u8 = 8u8

The bit depth of the pixel.

type Subpixel = u8

The type of a single component in the pixel.

type Color = Rgb

The resolved color type of the palette. This is Self for non-paletted pixels.

type Data = [u8; 3]

The iterator type this pixel uses.

fn inverted(&self) -> Rgb

Returns the inverted value of this pixel.

fn map_subpixels<F, A>(self, f: F, _: A) -> Rgbwhere
    F: Fn(<Rgb as Pixel>::Subpixel) -> <Rgb as Pixel>::Subpixel,
    A: Fn(<Rgb as Pixel>::Subpixel) -> <Rgb as Pixel>::Subpixel,

Maps the pixel’s components and returns a new pixel with the mapped components.

fn from_raw_parts_paletted<P>(
    color_type: ColorType,
    bit_depth: u8,
    data: &[u8],
    palette: Option<&[P]>
) -> Result<Rgb, Error>where
    P: Pixel,

Creates this pixel from the given color type, bit depth, data, and possibly a color palette. This may require a lossy xonversion.

fn from_bytes(bytes: &[u8]) -> Rgb

Creates this pixel from a raw bytes. This is used internally and is unchecked - it panics if the data is not of the correct length.

fn as_bytes(&self) -> <Rgb as Pixel>::Data

Turns this pixel into bytes.

fn merge_with_alpha(self, other: Rgb, alpha: u8) -> Rgb

Merges this pixel with the given overlay pixel, where the alpha of the overlay pixel is known. This is used in anti-aliasing.

fn from_dynamic(dynamic: Dynamic) -> Rgb

Creates this pixel from any dynamic pixel, dynamically at runtime. Different from the From/Into traits.

fn as_rgb(&self) -> Rgb

Returns this pixel as RGB despite its type. This can panic on some pixel types, you must be sure this pixel is able to be converted into RGB before using this.

fn as_rgba(&self) -> Rgba

Returns this pixel as RGBA despite its type. This can panic on some pixel types, you must be sure this pixel is able to be converted into RGBA before using this.

fn color_type(&self) -> ColorType

Resolves the color type of this pixel at runtime. This is used for dynamic color types. If you are certain the pixel is not dynamic, you can use the Self::COLOR_TYPE constant instead.

fn luminance(&self) -> u8where
    Self: Into<L>,

The luminance of the pixel.

fn from_raw_parts(
    color_type: ColorType,
    bit_depth: u8,
    data: &[u8]
) -> Result<Self, Error>

Creates this pixel from the given color type, bit depth, and data. This may require a lossy conversion.

fn from_arbitrary_palette<P>(palette: &[P], index: usize) -> Result<Self, Error>where
    P: Pixel,

Creates this pixel from the given palette and index, but the conversion is done at runtime.

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

Merges this pixel with the given overlay pixel, taking into account alpha.

fn overlay(self, other: Self, mode: OverlayMode) -> Self

Overlays this pixel with the given overlay pixel, abiding by the given overlay mode.

fn overlay_with_alpha(self, other: Self, mode: OverlayMode, alpha: u8) -> Self

Overlays this pixel with the given overlay pixel, abiding by the given overlay mode with the given alpha.

impl Copy for Rgb

impl Eq for Rgb

impl StructuralEq for Rgb

impl StructuralPartialEq for Rgb