Struct rerun::EncodedImage

pub struct EncodedImage {
    pub blob: Option<SerializedComponentBatch>,
    pub media_type: Option<SerializedComponentBatch>,
    pub opacity: Option<SerializedComponentBatch>,
    pub draw_order: Option<SerializedComponentBatch>,
}

Archetype: An image encoded as e.g. a JPEG or PNG.

Rerun also supports uncompressed images with the archetypes::Image. For images that refer to video frames see archetypes::VideoFrameReference.

Example

encoded_image:

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rec = rerun::RecordingStreamBuilder::new("rerun_example_encoded_image").spawn()?;

    let image = include_bytes!("ferris.png");

    rec.log(
        "image",
        &rerun::EncodedImage::from_file_contents(image.to_vec()),
    )?;

    Ok(())
}

Fields

blob: Option<SerializedComponentBatch>

The encoded content of some image file, e.g. a PNG or JPEG.

media_type: Option<SerializedComponentBatch>

The Media Type of the asset.

Supported values:

• image/jpeg
• image/png

If omitted, the viewer will try to guess from the data blob. If it cannot guess, it won’t be able to render the asset.

opacity: Option<SerializedComponentBatch>

Opacity of the image, useful for layering several images.

Defaults to 1.0 (fully opaque).

draw_order: Option<SerializedComponentBatch>

An optional floating point value that specifies the 2D drawing order.

Objects with higher values are drawn on top of those with lower values.

Implementations

impl EncodedImage

pub fn descriptor_blob() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::blob.

pub fn descriptor_media_type() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::media_type.

pub fn descriptor_opacity() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::opacity.

pub fn descriptor_draw_order() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::draw_order.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl EncodedImage

pub const NUM_COMPONENTS: usize = 5usize

The total number of components in the archetype: 1 required, 2 recommended, 2 optional

impl EncodedImage

pub fn new(blob: impl Into<Blob>) -> EncodedImage

Create a new EncodedImage.

pub fn update_fields() -> EncodedImage

Update only some specific fields of a EncodedImage.

pub fn clear_fields() -> EncodedImage

Clear all the fields of a EncodedImage.

pub fn columns<I>( self, _lengths: I, ) -> Result<impl Iterator<Item = SerializedComponentColumn>, SerializationError>

where I: IntoIterator<Item = usize> + Clone,

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing SerializedComponentBatches data into SerializedComponentColumns instead, via SerializedComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

pub fn columns_of_unit_batches( self, ) -> Result<impl Iterator<Item = SerializedComponentColumn>, SerializationError>

Helper to partition the component data into unit-length sub-batches.

This is semantically similar to calling Self::columns with std::iter::take(1).repeat(n), where n is automatically guessed.

pub fn with_blob(self, blob: impl Into<Blob>) -> EncodedImage

The encoded content of some image file, e.g. a PNG or JPEG.

pub fn with_many_blob( self, blob: impl IntoIterator<Item = impl Into<Blob>>, ) -> EncodedImage

This method makes it possible to pack multiple crate::components::Blob in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_blob should be used when logging a single row’s worth of data.

pub fn with_media_type(self, media_type: impl Into<MediaType>) -> EncodedImage

The Media Type of the asset.

Supported values:

• image/jpeg
• image/png

If omitted, the viewer will try to guess from the data blob. If it cannot guess, it won’t be able to render the asset.

pub fn with_many_media_type( self, media_type: impl IntoIterator<Item = impl Into<MediaType>>, ) -> EncodedImage

This method makes it possible to pack multiple crate::components::MediaType in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_media_type should be used when logging a single row’s worth of data.

pub fn with_opacity(self, opacity: impl Into<Opacity>) -> EncodedImage

Opacity of the image, useful for layering several images.

Defaults to 1.0 (fully opaque).

pub fn with_many_opacity( self, opacity: impl IntoIterator<Item = impl Into<Opacity>>, ) -> EncodedImage

This method makes it possible to pack multiple crate::components::Opacity in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_opacity should be used when logging a single row’s worth of data.

pub fn with_draw_order(self, draw_order: impl Into<DrawOrder>) -> EncodedImage

An optional floating point value that specifies the 2D drawing order.

Objects with higher values are drawn on top of those with lower values.

pub fn with_many_draw_order( self, draw_order: impl IntoIterator<Item = impl Into<DrawOrder>>, ) -> EncodedImage

This method makes it possible to pack multiple crate::components::DrawOrder in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_draw_order should be used when logging a single row’s worth of data.

impl EncodedImage

pub fn from_file(filepath: impl AsRef<Path>) -> Result<EncodedImage, Error>

Creates a new image from the file contents at path.

The MediaType will first be guessed from the file contents.

Returns an error if the file cannot be read.

pub fn from_file_contents(bytes: Vec<u8>) -> EncodedImage

Construct an image given the encoded content of some image file, e.g. a PNG or JPEG.

Self::media_type will be guessed from the bytes.

Trait Implementations

impl Archetype for EncodedImage

type Indicator = GenericIndicatorComponent<EncodedImage>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn display_name() -> &'static str

Readable name for displaying in UI.

fn indicator() -> SerializedComponentBatch

Creates a ComponentBatch out of the associated Self::Indicator component.

fn required_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, Arc<dyn Array>)>, ) -> Result<EncodedImage, DeserializationError>

Given an iterator of Arrow arrays and their respective ComponentNames, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>, ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for EncodedImage

fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>

Exposes the object’s contents as a set of SerializedComponentBatches.

fn to_arrow(&self) -> Result<Vec<(Field, Arc<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays.

impl Clone for EncodedImage

fn clone(&self) -> EncodedImage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncodedImage

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

Formats the value using the given formatter.

impl Default for EncodedImage

fn default() -> EncodedImage

Returns the “default value” for a type.

impl PartialEq for EncodedImage

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

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

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.

fn is_pod() -> bool

Is Self just plain old data?

impl ArchetypeReflectionMarker for EncodedImage

impl StructuralPartialEq for EncodedImage