Struct SceneOptions

#[non_exhaustive]
pub struct SceneOptions {
    pub origin: Origin,
    pub max_visits: usize,
    pub max_path_bytes: usize,
}

Options for RenderScene::from_composition.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

origin: Origin

The render origin; Origin::Auto by default.

max_visits: usize

Most node visits of the walk, counting a node once per path that reaches it; DEFAULT_MAX_VISITS by default. See Limits.

max_path_bytes: usize

Most bytes of node paths the walk builds, summed over every visit; DEFAULT_MAX_PATH_BYTES by default. Bounds the memory of instance paths in deep trees with long names. See Limits.

Implementations

impl SceneOptions

pub const DEFAULT_MAX_VISITS: usize = 10_000_000usize

Default of max_visits: 10 million.

pub const DEFAULT_MAX_PATH_BYTES: usize = 1_073_741_824usize

Default of max_path_bytes: 1 GiB.

pub fn with_origin(self, origin: Origin) -> Self

Sets the render origin.

pub fn with_max_visits(self, max_visits: usize) -> Self

Sets max_visits.

pub fn with_max_path_bytes(self, max_path_bytes: usize) -> Self

Sets max_path_bytes.

Trait Implementations

impl Clone for SceneOptions

fn clone(&self) -> SceneOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SceneOptions

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

Formats the value using the given formatter.

impl Default for SceneOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for SceneOptions

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SceneOptions