Struct prisma::ycbcr::BareYCbCr

#[repr(C)]pub struct BareYCbCr<T> { /* fields omitted */ }

A YCbCr color that does not know its model.

BareYCbCr is used internally to implement YCbCr and is provided as a separate type for performance reasons; generally, the use of YCbCr is preferred. It is "bare" in the sense that it does not store the model information along with the channel information. This makes it less smart, but can save memory when used with custom models.

When using a custom model, YCbCr must store a reference to the model along with its channel values. This can increase the memory footprint significantly, but gives greater safety and convenience as well as forbidding illogical conversions and comparisons. It is therefore only advised to use this when the extra memory consumption has show to be an issue.

Implementations

impl<T> BareYCbCr<T> where
    T: NormalChannelScalar + PosNormalChannelScalar, 

pub fn new(luma: T, cb: T, cr: T) -> Self

Construct a BareYCbCr from channel values.

pub fn color_cast<TOut>(&self) -> BareYCbCr<TOut> where
    T: ChannelFormatCast<TOut>,
    TOut: PosNormalChannelScalar + NormalChannelScalar, 

Convert the internal channel scalar format

pub fn luma(&self) -> T

Get the luma (Y') channel.

pub fn cb(&self) -> T

Get the Cb channel.

pub fn cr(&self) -> T

Get the Cr channel.

pub fn luma_mut(&mut self) -> &mut T

Get a mutable reference to the luma (Y') channel.

pub fn cb_mut(&mut self) -> &mut T

Get a mutable reference to the Cb channel.

pub fn cr_mut(&mut self) -> &mut T

Get a mutable reference to the Cr channel.

pub fn set_luma(&mut self, val: T)

Set the luma (Y') channel to a value.

pub fn set_cb(&mut self, val: T)

Set the Cb channel to a value.

pub fn set_cr(&mut self, val: T)

Set the Cr channel to a value.

pub fn with_model<M>(self, model: M) -> YCbCr<T, M> where
    M: YCbCrModel<T>, 

Construct a new YCbCr object from self and a model.

Equivalent to constructing the YCbCr object directly:

let c = BareYCbCr::new(0.5, 0.3, 0.2).with_model(JpegModel);
assert_eq!(c, YCbCrJpeg::new(0.5, 0.3, 0.2));

impl<T> BareYCbCr<T> where
    T: NormalChannelScalar + PosNormalChannelScalar + NumCast, 

pub fn from_rgb_and_model<M: YCbCrModel<T>>(from: &Rgb<T>, model: &M) -> Self

Construct a BareYCbCr by converting from an Rgb value.

model is only used within the conversion, it is up to the user to remember which model any BareYCbCr is using.

pub fn to_rgb<M: YCbCrModel<T>>(
    &self,
    model: &M,
    out_of_gamut_mode: YCbCrOutOfGamutMode
) -> Rgb<T>

Convert from YCbCr to Rgb.

Params

• model - The model to use for the conversion. Note that this does not change the model of the color being converted. If you convert to YCbCr from Rgb and convert back under a different model, the resulting colors will be different.
• out_of_gamut_mode - How to handle colors that are out of gamut in Rgb. See OutOfGamutMode for a description the options.

Trait Implementations

impl<T> AbsDiffEq<BareYCbCr<T>> for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar + AbsDiffEq,
    T::Epsilon: Clone, 

type Epsilon = T::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of ApproxEq::abs_diff_eq.

impl<T> Bounded for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar, 

fn normalize(self) -> Self

Return a value clipped inside the normalized range

fn is_normalized(&self) -> bool

Return true if the value is normalized

impl<T> Broadcast for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar, 

fn broadcast(value: T) -> Self

Construct Self with each channel set to value

impl<T: Clone> Clone for BareYCbCr<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Color for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar, 

type Tag = YCbCrTag

The unique tag unit struct identifying the color type

type ChannelsTuple = (T, T, T)

A tuple of types for each channel in the color

fn num_channels() -> u32

Return how many channels the color has

fn to_tuple(self) -> Self::ChannelsTuple

Convert a color into a tuple of channels

impl<T: Copy> Copy for BareYCbCr<T>

impl<T: Debug> Debug for BareYCbCr<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T> Default for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar + Zero, 

fn default() -> Self

Returns the "default value" for a type.

impl<T> Display for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar + Display, 

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T> EncodableColor for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar, 

fn encoded_as<E>(self, encoding: E) -> EncodedColor<Self, E> where
    E: ColorEncoding, 

Specify what encoding the color has. This does not actually encode anything

fn linear(self) -> EncodedColor<Self, LinearEncoding>

Specify that the color is linear

fn srgb_encoded(self) -> EncodedColor<Self, SrgbEncoding>

Specify that the color is sRGB encoded

fn gamma_encoded<T: Float>(
    self,
    gamma: T
) -> EncodedColor<Self, GammaEncoding<T>>

Specify that the color is gamma encoded with a given gamma

impl<T: Eq> Eq for BareYCbCr<T>

impl<T> Flatten for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar, 

fn as_slice(&self) -> &[Self::ChannelFormat]

Return a slice representation of Self

fn from_slice(vals: &[T]) -> Self

Return Self constructed from values

impl<T> FromTuple for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar, 

fn from_tuple(values: Self::ChannelsTuple) -> Self

Construct Self from a tuple of channel values

impl<T: Hash> Hash for BareYCbCr<T>

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, 

Feeds a slice of this type into the given [Hasher].

impl<T> HomogeneousColor for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar, 

type ChannelFormat = T

The scalar type of each channel

fn clamp(self, min: T, max: T) -> Self

Clamp the value of each channel between min and max

impl<T> Invert for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar, 

fn invert(self) -> Self

Invert Self

impl<T> Lerp for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar + Lerp, 

type Position = <T as Lerp>::Position

The type of the pos argument

fn lerp(&self, right: &Self, pos: Self::Position) -> Self

Interpolate between self and right

impl<T: Ord> Ord for BareYCbCr<T>

fn cmp(&self, other: &BareYCbCr<T>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<BareYCbCr<T>> for BareYCbCr<T>

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BareYCbCr<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<BareYCbCr<T>> for BareYCbCr<T>

fn partial_cmp(&self, other: &BareYCbCr<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &BareYCbCr<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &BareYCbCr<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &BareYCbCr<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &BareYCbCr<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> RelativeEq<BareYCbCr<T>> for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar + RelativeEq,
    T::Epsilon: Clone, 

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

impl<T> StructuralEq for BareYCbCr<T>

impl<T> StructuralPartialEq for BareYCbCr<T>

impl<T> UlpsEq<BareYCbCr<T>> for BareYCbCr<T> where
    T: PosNormalChannelScalar + NormalChannelScalar + UlpsEq,
    T::Epsilon: Clone, 

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of ApproxEq::ulps_eq.