Struct rerun::sdk::datatypes::ImageFormat

pub struct ImageFormat {
    pub width: u32,
    pub height: u32,
    pub pixel_format: Option<PixelFormat>,
    pub color_model: Option<ColorModel>,
    pub channel_datatype: Option<ChannelDatatype>,
}

Datatype: The metadata describing the contents of a components::ImageBuffer.

Fields

width: u32

The width of the image in pixels.

height: u32

The height of the image in pixels.

pixel_format: Option<PixelFormat>

Used mainly for chroma downsampled formats and differing number of bits per channel.

If specified, this takes precedence over both datatypes::ColorModel and datatypes::ChannelDatatype (which are ignored).

color_model: Option<ColorModel>

L, RGB, RGBA, …

Also requires a datatypes::ChannelDatatype to fully specify the pixel format.

channel_datatype: Option<ChannelDatatype>

The data type of each channel (e.g. the red channel) of the image data (U8, F16, …).

Also requires a datatypes::ColorModel to fully specify the pixel format.

Implementations

impl ImageFormat

pub fn depth(_: [u32; 2], datatype: ChannelDatatype) -> ImageFormat

Create a new depth image format with the given resolution and datatype.

pub fn segmentation(_: [u32; 2], datatype: ChannelDatatype) -> ImageFormat

Create a new segmentation image format with the given resolution and datatype.

pub fn rgb8(_: [u32; 2]) -> ImageFormat

Create a new rgb image format with 8 bit per channel with the given resolution.

pub fn rgba8(_: [u32; 2]) -> ImageFormat

Create a new rgba image format with 8 bit per channel with the given resolution.

pub fn from_pixel_format(_: [u32; 2], pixel_format: PixelFormat) -> ImageFormat

From a speicifc pixel format.

pub fn has_alpha(&self) -> bool

Determine if the image format has an alpha channel.

pub fn is_float(&self) -> bool

Determine if the image format represents floating point data.

pub fn num_bytes(&self) -> usize

Number of bytes for the whole image.

pub fn color_model(&self) -> ColorModel

The color model represented by this image format.

pub fn datatype(&self) -> ChannelDatatype

The datatype represented by this image format.

Trait Implementations

impl Borrow<ImageFormat> for ImageFormat

fn borrow(&self) -> &ImageFormat

Immutably borrows from an owned value.

impl Clone for ImageFormat

fn clone(&self) -> ImageFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageFormat

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

Formats the value using the given formatter.

impl Default for ImageFormat

fn default() -> ImageFormat

Returns the “default value” for a type.

impl Hash for ImageFormat

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 Loggable for ImageFormat

type Name = DatatypeName

fn name() -> <ImageFormat as Loggable>::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, ImageFormat>>>> ) -> Result<Box<dyn Array>, SerializationError>

where ImageFormat: 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 + 'static) ) -> Result<Vec<Option<ImageFormat>>, DeserializationError>

where ImageFormat: 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 ImageFormat

fn eq(&self, other: &ImageFormat) -> 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 ImageFormat

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 ImageFormat

impl Eq for ImageFormat

impl StructuralPartialEq for ImageFormat