Struct re_types::blueprint::archetypes::Background

pub struct Background {
    pub kind: BackgroundKind,
    pub color: Option<Color>,
}

Archetype: Configuration for the background of a view.

Fields

kind: BackgroundKind

The type of the background. Defaults to BackgroundKind.GradientDark.

color: Option<Color>

Color used for BackgroundKind.SolidColor.

Defaults to White.

Implementations

impl Background

pub const NUM_COMPONENTS: usize = 3usize

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

impl Background

pub fn new(kind: impl Into<BackgroundKind>) -> Self

Create a new Background.

pub fn with_color(self, color: impl Into<Color>) -> Self

Color used for BackgroundKind.SolidColor.

Defaults to White.

impl Background

pub const DEFAULT_2D: Self = _

Default background of 2D space views.

pub const DEFAULT_3D: Self = _

Default background of 3D space views.

pub const DEFAULT_COLOR_2D: Color = Color::BLACK

Default background color of 2D space views.

pub const DEFAULT_COLOR_3D: Color = Color::WHITE

Default background color of 3D space views.

Trait Implementations

impl Archetype for Background

type Indicator = GenericIndicatorComponent<Background>

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 indicator() -> MaybeOwnedComponentBatch<'static>

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

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

Returns the names of all components that must be provided by the user when constructing this archetype.

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

Returns the names of all components that should be provided by the user when constructing this archetype.

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

Returns the names of all components that may be provided by the user when constructing this archetype.

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

Returns the names of all components that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)> ) -> DeserializationResult<Self>

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

fn from_arrow( data: impl IntoIterator<Item = (Field, Box<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 Background

fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>

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

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

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

impl Clone for Background

fn clone(&self) -> Background

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Background

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

Formats the value using the given formatter.

impl SizeBytes for Background

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 Background