Struct Rgb

#[repr(transparent)]
pub struct Rgb<T>(pub [T; 3]);
Available on crate feature dep_image only.
Expand description

RGB colors.

For the purpose of color conversion, as well as blending, the implementation of Pixel assumes an sRGB color space of its data.

Tuple Fields§

§0: [T; 3]

Trait Implementations§

§

impl<T> Clone for Rgb<T>
where T: Clone,

§

fn clone(&self) -> Rgb<T>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl<T> Debug for Rgb<T>
where T: Debug,

§

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

Formats the value using the given formatter. Read more
§

impl<T> From<[T; 3]> for Rgb<T>

§

fn from(c: [T; 3]) -> Rgb<T>

Converts to this type from the input type.
§

impl<T> Hash for Rgb<T>
where T: Hash,

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl<T> Index<usize> for Rgb<T>

§

type Output = T

The returned type after indexing.
§

fn index(&self, _index: usize) -> &T

Performs the indexing (container[index]) operation. Read more
§

impl<T> IndexMut<usize> for Rgb<T>

§

fn index_mut(&mut self, _index: usize) -> &mut T

Performs the mutable indexing (container[index]) operation. Read more
§

impl<T> PartialEq for Rgb<T>
where T: PartialEq,

§

fn eq(&self, other: &Rgb<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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<T> Pixel for Rgb<T>
where T: Primitive + Enlargeable,

§

const CHANNEL_COUNT: u8 = 3u8

The number of channels of this pixel type.
§

const COLOR_MODEL: &'static str = "RGB"

A string that can help to interpret the meaning each channel See gimp babl.
§

type Subpixel = T

The scalar type that is used to store each channel in this pixel.
§

fn channels(&self) -> &[T]

Returns the components as a slice.
§

fn channels_mut(&mut self) -> &mut [T]

Returns the components as a mutable slice
§

fn channels4(&self) -> (T, T, T, T)

👎Deprecated since 0.24.0: Use channels() or channels_mut()
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
§

fn from_channels(a: T, b: T, c: T, d: T) -> Rgb<T>

👎Deprecated since 0.24.0: Use the constructor of the pixel, for example Rgba([r,g,b,a]) or Pixel::from_slice
Construct a pixel from the 4 channels a, b, c and d. If the pixel does not contain 4 channels the extra are ignored.
§

fn from_slice(slice: &[T]) -> &Rgb<T>

Returns a view into a slice. Read more
§

fn from_slice_mut(slice: &mut [T]) -> &mut Rgb<T>

Returns mutable view into a mutable slice. Read more
§

fn to_rgb(&self) -> Rgb<T>

Convert this pixel to RGB
§

fn to_rgba(&self) -> Rgba<T>

Convert this pixel to RGB with an alpha channel
§

fn to_luma(&self) -> Luma<T>

Convert this pixel to luma
§

fn to_luma_alpha(&self) -> LumaA<T>

Convert this pixel to luma with an alpha channel
§

fn map<F>(&self, f: F) -> Rgb<T>
where F: FnMut(T) -> T,

Apply the function f to each channel of this pixel.
§

fn apply<F>(&mut self, f: F)
where F: FnMut(T) -> T,

Apply the function f to each channel of this pixel.
§

fn map_with_alpha<F, G>(&self, f: F, g: G) -> Rgb<T>
where F: FnMut(T) -> T, G: FnMut(T) -> T,

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: FnMut(T) -> T, G: FnMut(T) -> T,

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: &Rgb<T>, f: F) -> Rgb<T>
where F: FnMut(T, T) -> T,

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

fn apply2<F>(&mut self, other: &Rgb<T>, f: F)
where F: FnMut(T, T) -> T,

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: &Rgb<T>)

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

fn map_without_alpha<F>(&self, f: F) -> Self
where F: FnMut(Self::Subpixel) -> Self::Subpixel,

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

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

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

impl PixelWithColorType for Rgb<f32>

§

const COLOR_TYPE: ExtendedColorType = ExtendedColorType::Rgb32F

This pixel has the format of one of the predefined ColorTypes, such as Rgb8, La16 or Rgba32F. This is needed for automatically detecting a color format when saving an image as a file.
§

impl PixelWithColorType for Rgb<u16>

§

const COLOR_TYPE: ExtendedColorType = ExtendedColorType::Rgb16

This pixel has the format of one of the predefined ColorTypes, such as Rgb8, La16 or Rgba32F. This is needed for automatically detecting a color format when saving an image as a file.
§

impl PixelWithColorType for Rgb<u8>

§

const COLOR_TYPE: ExtendedColorType = ExtendedColorType::Rgb8

This pixel has the format of one of the predefined ColorTypes, such as Rgb8, La16 or Rgba32F. This is needed for automatically detecting a color format when saving an image as a file.
§

impl<T> Copy for Rgb<T>
where T: Copy,

§

impl<T> Eq for Rgb<T>
where T: Eq,

§

impl<T> StructuralPartialEq for Rgb<T>

Auto Trait Implementations§

§

impl<T> Freeze for Rgb<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Rgb<T>
where T: RefUnwindSafe,

§

impl<T> Send for Rgb<T>
where T: Send,

§

impl<T> Sync for Rgb<T>
where T: Sync,

§

impl<T> Unpin for Rgb<T>
where T: Unpin,

§

impl<T> UnwindSafe for Rgb<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByteSized for T

Source§

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.
Source§

const BYTE_SIZE: usize = _

The size of this type in bytes.
Source§

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.
Source§

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more
Source§

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more
Source§

impl<T, R> Chain<R> for T
where T: ?Sized,

Source§

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.
Source§

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.
Source§

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> ExtAny for T
where T: Any + ?Sized,

Source§

fn type_id() -> TypeId

Returns the TypeId of Self. Read more
Source§

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more
Source§

fn type_name(&self) -> &'static str

Returns the type name of self. Read more
Source§

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more
Source§

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.
Source§

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.
Source§

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more
Source§

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more
Source§

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more
Source§

fn downcast_ref<T: 'static>(&self) -> Option<&T>

Available on crate feature unsafe_layout only.
Returns some shared reference to the inner value if it is of type T. Read more
Source§

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T>

Available on crate feature unsafe_layout only.
Returns some exclusive reference to the inner value if it is of type T. Read more
Source§

impl<T> ExtMem for T
where T: ?Sized,

Source§

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.
Source§

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more
Source§

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more
Source§

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more
Source§

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more
Source§

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more
Source§

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more
Source§

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more
Source§

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more
Source§

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more
Source§

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more
Source§

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more
Source§

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

fn mem_as_bytes(&self) -> &[u8]
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &[u8]. Read more
Source§

fn mem_as_bytes_mut(&mut self) -> &mut [u8]
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &mut [u8]. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

Source§

impl<T> Hook for T

Source§

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more
Source§

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

§

impl<T> Ungil for T
where T: Send,