Skip to main content

ColorRange

Enum ColorRange 

Source
#[non_exhaustive]
pub enum ColorRange { Limited, Full, Unknown, }
Expand description

Color range defining the valid range of color values.

Video typically uses “limited” range where black is at level 16 and white at level 235 (for 8-bit). Computer graphics typically use “full” range where black is 0 and white is 255.

§Common Usage

  • Limited: Broadcast video, Blu-ray, streaming services
  • Full: Computer graphics, screenshots, game capture

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Limited

Limited/TV range (16-235 for Y, 16-240 for UV in 8-bit)

§

Full

Full/PC range (0-255 for all components in 8-bit)

§

Unknown

Color range is not specified or unknown

Implementations§

Source§

impl ColorRange

Source

pub const fn name(&self) -> &'static str

Returns the name of the color range as a human-readable string.

§Examples
use ff_format::color::ColorRange;

assert_eq!(ColorRange::Limited.name(), "limited");
assert_eq!(ColorRange::Full.name(), "full");
Source

pub const fn is_full(&self) -> bool

Returns true if this is full (PC) range.

§Examples
use ff_format::color::ColorRange;

assert!(ColorRange::Full.is_full());
assert!(!ColorRange::Limited.is_full());
Source

pub const fn is_limited(&self) -> bool

Returns true if this is limited (TV) range.

§Examples
use ff_format::color::ColorRange;

assert!(ColorRange::Limited.is_limited());
assert!(!ColorRange::Full.is_limited());
Source

pub const fn is_unknown(&self) -> bool

Returns true if the color range is unknown.

§Examples
use ff_format::color::ColorRange;

assert!(ColorRange::Unknown.is_unknown());
assert!(!ColorRange::Limited.is_unknown());
Source

pub const fn luma_min_8bit(&self) -> u8

Returns the minimum value for luma (Y) in 8-bit.

§Examples
use ff_format::color::ColorRange;

assert_eq!(ColorRange::Limited.luma_min_8bit(), 16);
assert_eq!(ColorRange::Full.luma_min_8bit(), 0);
Source

pub const fn luma_max_8bit(&self) -> u8

Returns the maximum value for luma (Y) in 8-bit.

§Examples
use ff_format::color::ColorRange;

assert_eq!(ColorRange::Limited.luma_max_8bit(), 235);
assert_eq!(ColorRange::Full.luma_max_8bit(), 255);

Trait Implementations§

Source§

impl Clone for ColorRange

Source§

fn clone(&self) -> ColorRange

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ColorRange

Source§

impl Debug for ColorRange

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ColorRange

Source§

fn default() -> ColorRange

Returns the “default value” for a type. Read more
Source§

impl Display for ColorRange

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ColorRange

Source§

impl Hash for ColorRange

Source§

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

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
Source§

impl PartialEq for ColorRange

Source§

fn eq(&self, other: &ColorRange) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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.
Source§

impl StructuralPartialEq for ColorRange

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

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

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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.