Enum ChromaLocation

#[non_exhaustive]
#[repr(u32)]
pub enum ChromaLocation {
    Type0 = 1,
    Type1 = 2,
    Type2 = 3,
    Type3 = 4,
    Type4 = 5,
    Type5 = 6,
}

Available on crate feature wayland and Linux only.

Chroma sample location for 4:2:0 YCbCr

Chroma sample location as defined by H.273 Chroma420SampleLocType.

A value of 0 is invalid and will never be present in the list of enums.

The descriptions list the matching Vulkan VkChromaLocation combinations for convenience.

Variants (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.

Type0 = 1

Horizontal offset of 0, vertical offset of 0.5

Corresponding to VkChromaLocations:

• xChromaOffset: VK_CHROMA_LOCATION_COSITED_EVEN
• yChromaOffset: VK_CHROMA_LOCATION_MIDPOINT

Equivalent to H.273 Chroma420SampleLocType 0.

Type1 = 2

Horizontal offset of 0.5, vertical offset of 0.5

Corresponding to VkChromaLocations:

• xChromaOffset: VK_CHROMA_LOCATION_MIDPOINT
• yChromaOffset: VK_CHROMA_LOCATION_MIDPOINT

Equivalent to H.273 Chroma420SampleLocType 1.

Type2 = 3

Horizontal offset of 0, vertical offset of 0

Corresponding to VkChromaLocations:

• xChromaOffset: VK_CHROMA_LOCATION_COSITED_EVEN
• yChromaOffset: VK_CHROMA_LOCATION_COSITED_EVEN

Equivalent to H.273 Chroma420SampleLocType 2.

Type3 = 4

Horizontal offset of 0.5, vertical offset of 0

Corresponding to VkChromaLocations:

• xChromaOffset: VK_CHROMA_LOCATION_MIDPOINT
• yChromaOffset: VK_CHROMA_LOCATION_COSITED_EVEN

Equivalent to H.273 Chroma420SampleLocType 3.

Type4 = 5

Horizontal offset of 0, vertical offset of 1

Equivalent to H.273 Chroma420SampleLocType 4.

Type5 = 6

Horizontal offset of 0.5, vertical offset of 1

Equivalent to H.273 Chroma420SampleLocType 5.

Trait Implementations

impl Clone for ChromaLocation

fn clone(&self) -> ChromaLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChromaLocation

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

Formats the value using the given formatter.

impl Hash for ChromaLocation

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 Ord for ChromaLocation

fn cmp(&self, other: &ChromaLocation) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ChromaLocation

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

Tests for self and other values to be equal, and is used by ==.

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 PartialOrd for ChromaLocation

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl TryFrom<u32> for ChromaLocation

type Error = ()

The type returned in the event of a conversion error.

fn try_from(val: u32) -> Result<ChromaLocation, ()>

Performs the conversion.

impl Copy for ChromaLocation

impl Eq for ChromaLocation

impl StructuralPartialEq for ChromaLocation