Enum re_types::datatypes::PixelFormat

#[repr(u8)]
pub enum PixelFormat {
    Y_U_V12_LimitedRange = 20,
    NV12 = 26,
    YUY2 = 27,
    Y8_FullRange = 30,
    Y_U_V24_LimitedRange = 39,
    Y_U_V24_FullRange = 40,
    Y8_LimitedRange = 41,
    Y_U_V12_FullRange = 44,
    Y_U_V16_LimitedRange = 49,
    Y_U_V16_FullRange = 50,
}

Datatype: Specifieds a particular format of an archetypes::Image.

Most images can be described by a datatypes::ColorModel and a datatypes::ChannelDatatype, e.g. RGB and U8 respectively.

However, some image formats has chroma downsampling and/or use differing number of bits per channel, and that is what this datatypes::PixelFormat is for.

All these formats support random access.

For more compressed image formats, see archetypes::EncodedImage.

Variants

Y_U_V12_LimitedRange = 20

Y_U_V12 is a YUV 4:2:0 fully planar YUV format without chroma downsampling, also known as I420.

This uses limited range YUV, i.e. Y is expected to be within [16, 235] and U/V within [16, 240].

First comes entire image in Y in one plane, followed by the U and V planes, which each only have half the resolution of the Y plane.

NV12 = 26

NV12 (aka Y_UV12) is a YUV 4:2:0 chroma downsampled form at with 12 bits per pixel and 8 bits per channel.

This uses limited range YUV, i.e. Y is expected to be within [16, 235] and U/V within [16, 240].

First comes entire image in Y in one plane, followed by a plane with interleaved lines ordered as U0, V0, U1, V1, etc.

YUY2 = 27

YUY2 (aka YUYV, YUYV16 or NV21), is a YUV 4:2:2 chroma downsampled format with 16 bits per pixel and 8 bits per channel.

This uses limited range YUV, i.e. Y is expected to be within [16, 235] and U/V within [16, 240].

The order of the channels is Y0, U0, Y1, V0, all in the same plane.

Y8_FullRange = 30

Monochrome Y plane only, essentially a YUV 4:0:0 planar format.

Also known as just “gray”. This is virtually identical to a 8bit luminance/grayscale (see datatypes::ColorModel).

This uses entire range YUV, i.e. Y is expected to be within [0, 255]. (as opposed to “limited range” YUV as used e.g. in NV12).

Y_U_V24_LimitedRange = 39

Y_U_V24 is a YUV 4:4:4 fully planar YUV format without chroma downsampling, also known as I444.

This uses limited range YUV, i.e. Y is expected to be within [16, 235] and U/V within [16, 240].

First comes entire image in Y in one plane, followed by the U and V planes.

Y_U_V24_FullRange = 40

Y_U_V24 is a YUV 4:4:4 fully planar YUV format without chroma downsampling, also known as I444.

This uses full range YUV with all components ranging from 0 to 255 (as opposed to “limited range” YUV as used e.g. in NV12).

First comes entire image in Y in one plane, followed by the U and V planes.

Y8_LimitedRange = 41

Monochrome Y plane only, essentially a YUV 4:0:0 planar format.

Also known as just “gray”.

This uses limited range YUV, i.e. Y is expected to be within [16, 235]. If not for this range limitation/remapping, this is almost identical to 8bit luminace/grayscale (see datatypes::ColorModel).

Y_U_V12_FullRange = 44

Y_U_V12 is a YUV 4:2:0 fully planar YUV format without chroma downsampling, also known as I420.

This uses full range YUV with all components ranging from 0 to 255 (as opposed to “limited range” YUV as used e.g. in NV12).

First comes entire image in Y in one plane, followed by the U and V planes, which each only have half the resolution of the Y plane.

Y_U_V16_LimitedRange = 49

Y_U_V16 is a YUV 4:2:2 fully planar YUV format without chroma downsampling, also known as I422.

This uses limited range YUV, i.e. Y is expected to be within [16, 235] and U/V within [16, 240].

First comes entire image in Y in one plane, followed by the U and V planes, which each only have half the horizontal resolution of the Y plane.

Y_U_V16_FullRange = 50

Y_U_V16 is a YUV 4:2:2 fully planar YUV format without chroma downsampling, also known as I422.

This uses full range YUV with all components ranging from 0 to 255 (as opposed to “limited range” YUV as used e.g. in NV12).

First comes entire image in Y in one plane, followed by the U and V planes, which each only have half the horizontal resolution of the Y plane.

Implementations

impl PixelFormat

pub fn has_alpha(&self) -> bool

Do we have an alpha channel?

pub fn is_float(&self) -> bool

Is this pixel format floating point?

pub fn num_bytes(&self, [w, h]: [u32; 2]) -> usize

Number of bytes needed to represent an image of the given size.

pub fn color_model(&self) -> ColorModel

The color model derived from this pixel format.

pub fn datatype(&self) -> ChannelDatatype

The datatype that this decodes into.

pub fn decode_yuv_at( &self, buf: &[u8], [w, h]: [u32; 2], [x, y]: [u32; 2] ) -> Option<[u8; 3]>

Random-access decoding of a specific pixel of an image.

Return None if out-of-range.

pub fn is_limited_yuv_range(&self) -> bool

Returns true if the format is a YUV format using limited range YUV.

I.e. for 8bit data, Y is valid in [16, 235] and U/V [16, 240], rather than 0-255.

pub fn yuv_matrix_coefficients(&self) -> YuvMatrixCoefficients

Yuv matrix coefficients used by this format.

pub fn decode_rgb_at( &self, buf: &[u8], [w, h]: [u32; 2], [x, y]: [u32; 2] ) -> Option<[u8; 3]>

Random-access decoding of a specific pixel of an image.

Return None if out-of-range.

Trait Implementations

impl Clone for PixelFormat

fn clone(&self) -> PixelFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PixelFormat

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

Formats the value using the given formatter.

impl Default for PixelFormat

fn default() -> PixelFormat

Returns the “default value” for a type.

impl Display for PixelFormat

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

Formats the value using the given formatter.

impl Enum for PixelFormat

fn variants() -> &'static [Self]

All variants, in the order they appear in the enum.

fn docstring_md(self) -> &'static str

Markdown docstring for the given enum variant.

impl<'a> From<&'a PixelFormat> for Cow<'a, PixelFormat>

fn from(value: &'a PixelFormat) -> Self

Converts to this type from the input type.

impl<'a> From<PixelFormat> for Cow<'a, PixelFormat>

fn from(value: PixelFormat) -> Self

Converts to this type from the input type.

impl Hash for PixelFormat

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Loggable for PixelFormat

type Name = DatatypeName

fn name() -> Self::Name

The fully-qualified name of this loggable, e.g. rerun.datatypes.Vec2D.

fn arrow_datatype() -> DataType

The underlying [arrow2::datatypes::DataType], excluding datatype extensions.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, Self>>>> ) -> SerializationResult<Box<dyn Array>>

where Self: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow_opt( arrow_data: &dyn Array ) -> DeserializationResult<Vec<Option<Self>>>

where Self: Sized,

Given an Arrow array, deserializes it into a collection of optional Loggables.

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>> ) -> Result<Box<dyn Array>, SerializationError>

where Self: 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow( data: &(dyn Array + 'static) ) -> Result<Vec<Self>, DeserializationError>

Given an Arrow array, deserializes it into a collection of Loggables.

impl PartialEq for PixelFormat

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SizeBytes for PixelFormat

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

impl Copy for PixelFormat

impl Eq for PixelFormat

impl StructuralPartialEq for PixelFormat