Struct carnelian::scene::scene::SceneOptions

pub struct SceneOptions {
    pub background_color: Color,
    pub round_scene_corners: bool,
    pub enable_mouse_cursor: bool,
    pub root_arranger: Option<ArrangerPtr>,
    pub mutable: bool,
    pub animated: bool,
}

Options for creating a scene.

Fields

background_color: Color

Background color.

round_scene_corners: bool

True if, when running without Scenic, if the scene should round the corners of the screen to match the presentation that sometimes occurs with Scenic.

enable_mouse_cursor: bool

True if, when running without Scenic, the mouse cursor should be drawn.

root_arranger: Option<ArrangerPtr>

Option arranger for the root group.

mutable: bool

True if the scene should be mutable. If the scene is not going to change, setting this to false can provide some important performance benefits.

animated: bool

True if the scene is animated in a way that requires a render on every frame, for example, Spinning Square.

Implementations

impl SceneOptions

pub fn with_background_color(background_color: Color) -> Self

Create the default scene options with a specified background color.

Trait Implementations

impl Default for SceneOptions

fn default() -> Self

Returns the “default value” for a type.