Struct FrameOptions 

pub struct FrameOptions { /* private fields */ }

Whole-scene frame rendering controls.

The default renders frames the way the reference export does: frames are enabled, their contents are clipped, and their names and outlines are drawn. Start from FrameOptions::default and turn individual controls off with the with_* setters:

use excalidraw_render::FrameOptions;

let options = FrameOptions::default().with_show_name(false).with_outline(false);
assert!(options.enabled() && options.clip());
assert!(!options.show_name() && !options.outline());

Implementations

impl FrameOptions

pub const fn with_enabled(self, enabled: bool) -> Self

Selects whether frames are rendered at all (default true).

pub const fn with_clip(self, clip: bool) -> Self

Selects whether frame contents are clipped to the frame (default true).

pub const fn with_show_name(self, show_name: bool) -> Self

Selects whether frame names are rendered (default true).

pub const fn with_outline(self, outline: bool) -> Self

Selects whether frame outlines are rendered (default true).

pub const fn enabled(&self) -> bool

Returns whether frames are rendered.

pub const fn clip(&self) -> bool

Returns whether frame contents are clipped.

pub const fn show_name(&self) -> bool

Returns whether frame names are rendered.

pub const fn outline(&self) -> bool

Returns whether frame outlines are rendered.

Trait Implementations

impl Clone for FrameOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameOptions

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

Formats the value using the given formatter.

impl Default for FrameOptions

fn default() -> Self

Every frame control on: rendered, clipped, named and outlined.

impl Eq for FrameOptions

impl PartialEq for FrameOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FrameOptions