Trait image::Pixel

pub trait Pixel: Copy + Clone {
    type Subpixel: Primitive;
    fn channel_count() -> u8;
    fn channels(&self) -> &[Self::Subpixel];
    fn channels_mut(&mut self) -> &mut [Self::Subpixel];
    fn color_model() -> &'static str;
    fn color_type() -> ColorType;
    fn channels4(
        &self
    ) -> (Self::Subpixel, Self::Subpixel, Self::Subpixel, Self::Subpixel);
    fn from_channels(
        a: Self::Subpixel, 
        b: Self::Subpixel, 
        c: Self::Subpixel, 
        d: Self::Subpixel
    ) -> Self;
    fn from_slice<'a>(slice: &'a [Self::Subpixel]) -> &'a Self;
    fn from_slice_mut<'a>(slice: &'a mut [Self::Subpixel]) -> &'a mut Self;
    fn to_rgb(&self) -> Rgb<Self::Subpixel>;
    fn to_rgba(&self) -> Rgba<Self::Subpixel>;
    fn to_luma(&self) -> Luma<Self::Subpixel>;
    fn to_luma_alpha(&self) -> LumaA<Self::Subpixel>;
    fn map<F>(&self, f: F) -> Self
    where
        F: Fn(Self::Subpixel) -> Self::Subpixel;
    fn apply<F>(&mut self, f: F)
    where
        F: Fn(Self::Subpixel) -> Self::Subpixel;
    fn map_with_alpha<F, G>(&self, f: F, g: G) -> Self
    where
        F: Fn(Self::Subpixel) -> Self::Subpixel,
        G: Fn(Self::Subpixel) -> Self::Subpixel;
    fn apply_with_alpha<F, G>(&mut self, f: F, g: G)
    where
        F: Fn(Self::Subpixel) -> Self::Subpixel,
        G: Fn(Self::Subpixel) -> Self::Subpixel;
    fn map2<F>(&self, other: &Self, f: F) -> Self
    where
        F: Fn(Self::Subpixel, Self::Subpixel) -> Self::Subpixel;
    fn apply2<F>(&mut self, other: &Self, f: F)
    where
        F: Fn(Self::Subpixel, Self::Subpixel) -> Self::Subpixel;
    fn invert(&mut self);
    fn blend(&mut self, other: &Self);
}

A generalized pixel.

A pixel object is usually not used standalone but as a view into an image buffer.

Associated Types

type Subpixel: Primitive

The underlying subpixel type.

Required Methods

fn channel_count() -> u8

Returns the number of channels of this pixel type.

fn channels(&self) -> &[Self::Subpixel]

Returns the components as a slice.

fn channels_mut(&mut self) -> &mut [Self::Subpixel]

Returns the components as a mutable slice

fn color_model() -> &'static str

Returns a string that can help to interprete the meaning each channel See gimp babl.

fn color_type() -> ColorType

Returns the ColorType for this pixel format

fn channels4(
    &self
) -> (Self::Subpixel, Self::Subpixel, Self::Subpixel, Self::Subpixel)

Returns the channels of this pixel as a 4 tuple. If the pixel has less than 4 channels the remainder is filled with the maximum value

TODO deprecate

fn from_channels(
    a: Self::Subpixel,
    b: Self::Subpixel,
    c: Self::Subpixel,
    d: Self::Subpixel
) -> Self

Construct a pixel from the 4 channels a, b, c and d. If the pixel does not contain 4 channels the extra are ignored.

TODO deprecate

fn from_slice<'a>(slice: &'a [Self::Subpixel]) -> &'a Self

Returns a view into a slice.

Note: The slice length is not checked on creation. Thus the caller has to ensure that the slice is long enough to precent panics if the pixel is used later on.

fn from_slice_mut<'a>(slice: &'a mut [Self::Subpixel]) -> &'a mut Self

Returns mutable view into a mutable slice.

Note: The slice length is not checked on creation. Thus the caller has to ensure that the slice is long enough to precent panics if the pixel is used later on.

fn to_rgb(&self) -> Rgb<Self::Subpixel>

Convert this pixel to RGB

fn to_rgba(&self) -> Rgba<Self::Subpixel>

Convert this pixel to RGB with an alpha channel

fn to_luma(&self) -> Luma<Self::Subpixel>

Convert this pixel to luma

fn to_luma_alpha(&self) -> LumaA<Self::Subpixel>

Convert this pixel to luma with an alpha channel

fn map<F>(&self, f: F) -> Self where
    F: Fn(Self::Subpixel) -> Self::Subpixel, 

Apply the function f to each channel of this pixel.

fn apply<F>(&mut self, f: F) where
    F: Fn(Self::Subpixel) -> Self::Subpixel, 

Apply the function f to each channel of this pixel.

fn map_with_alpha<F, G>(&self, f: F, g: G) -> Self where
    F: Fn(Self::Subpixel) -> Self::Subpixel,
    G: Fn(Self::Subpixel) -> Self::Subpixel, 

Apply the function f to each channel except the alpha channel. Apply the function g to the alpha channel.

fn apply_with_alpha<F, G>(&mut self, f: F, g: G) where
    F: Fn(Self::Subpixel) -> Self::Subpixel,
    G: Fn(Self::Subpixel) -> Self::Subpixel, 

Apply the function f to each channel except the alpha channel. Apply the function g to the alpha channel. Works in-place.

fn map2<F>(&self, other: &Self, f: F) -> Self where
    F: Fn(Self::Subpixel, Self::Subpixel) -> Self::Subpixel, 

Apply the function f to each channel of this pixel and other pairwise.

fn apply2<F>(&mut self, other: &Self, f: F) where
    F: Fn(Self::Subpixel, Self::Subpixel) -> Self::Subpixel, 

Apply the function f to each channel of this pixel and other pairwise. Works in-place.

fn invert(&mut self)

Invert this pixel

fn blend(&mut self, other: &Self)

Blend the color of a given pixel into ourself, taking into account alpha channels

Implementors

• impl<T: Primitive + 'static> Pixel for Rgb<T>
• impl<T: Primitive + 'static> Pixel for Luma<T>
• impl<T: Primitive + 'static> Pixel for Rgba<T>
• impl<T: Primitive + 'static> Pixel for LumaA<T>