rerun::encodings::ImageFormat Struct Reference

Encoding: The metadata describing the contents of a components::ImageBuffer. More...

#include <rerun/encodings/image_format.hpp>

Public Member Functions
	ImageFormat (rerun::WidthHeight resolution, encodings::PixelFormat pixel_format_)
	From a specific pixel format.
	ImageFormat (rerun::WidthHeight resolution, encodings::ChannelDatatype datatype_)
	Create a new image format for depth or segmentation images with the given resolution and datatype.
	ImageFormat (rerun::WidthHeight resolution, encodings::ColorModel color_model_, encodings::ChannelDatatype datatype_)
RR_DISABLE_MAYBE_UNINITIALIZED_PUSH size_t	num_bytes () const
	How many bytes will this image occupy?

Public Attributes
uint32_t	width
	The width of the image in pixels.
uint32_t	height
	The height of the image in pixels.
std::optional< rerun::encodings::PixelFormat >	pixel_format
	Used mainly for chroma downsampled formats and differing number of bits per channel.
std::optional< rerun::encodings::ColorModel >	color_model
	L, RGB, RGBA, …
std::optional< rerun::encodings::ChannelDatatype >	channel_datatype
	The data type of each channel (e.g.

Detailed Description

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

Member Data Documentation

pixel_format

std::optional<rerun::encodings::PixelFormat> rerun::encodings::ImageFormat::pixel_format

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

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

color_model

std::optional<rerun::encodings::ColorModel> rerun::encodings::ImageFormat::color_model

L, RGB, RGBA, …

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

channel_datatype

std::optional<rerun::encodings::ChannelDatatype> rerun::encodings::ImageFormat::channel_datatype

The data type of each channel (e.g.

the red channel) of the image data (U8, F16, …).

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

---

The documentation for this struct was generated from the following file:

• rerun/encodings/image_format.hpp