Struct Scene

pub struct Scene { /* private fields */ }

The main datatype for rendering graphics.

A Scene stores a sequence of drawing commands, their context, and the associated resources, which can later be rendered.

Most users will render this using Renderer::render_to_texture.

Rendering from a Scene will not clear it, which should be done in a separate step, by calling Scene::reset.

If this is not done for a scene which is retained (to avoid allocations) between frames, this will likely quickly increase the complexity of the render result, leading to crashes or potential host system instability.

Implementations

impl Scene

pub fn new() -> Self

Creates a new scene.

pub fn reset(&mut self)

Removes all content from the scene.

pub fn bump_estimate(&self, transform: Option<Affine>) -> BumpAllocatorMemory

Available on crate feature bump_estimate only.

Tally up the bump allocator estimate for the current state of the encoding, taking into account an optional transform applied to the entire scene.

pub fn encoding(&self) -> &Encoding

Returns the underlying raw encoding.

pub fn encoding_mut(&mut self) -> &mut Encoding

Returns a mutable reference to the underlying raw encoding.

This can be used to more easily create invalid scenes, and so should be used with care.

pub fn push_layer( &mut self, blend: impl Into<BlendMode>, alpha: f32, transform: Affine, clip: &impl Shape, )

Pushes a new layer clipped by the specified shape and composed with previous layers using the specified blend mode.

Every drawing command after this call will be clipped by the shape until the layer is popped.

However, the transforms are not saved or modified by the layer stack.

Clip layers (blend = Mix::Clip) should have an alpha value of 1.0. For an opacity group with non-unity alpha, specify Mix::Normal.

pub fn pop_layer(&mut self)

Pops the current layer.

pub fn draw_blurred_rounded_rect( &mut self, transform: Affine, rect: Rect, brush: Color, radius: f64, std_dev: f64, )

Draw a rounded rectangle blurred with a gaussian filter.

pub fn draw_blurred_rounded_rect_in( &mut self, shape: &impl Shape, transform: Affine, rect: Rect, brush: Color, radius: f64, std_dev: f64, )

Draw a rounded rectangle blurred with a gaussian filter in shape.

For performance reasons, shape should not extend more than approximately 2.5 times std_dev away from the edges of rect (as any such points will not be perceptably painted to, but calculations will still be performed for them).

This method effectively draws the blurred rounded rectangle clipped to the given shape. If just the blurred rounded rectangle is desired without clipping, use the simpler Self::draw_blurred_rounded_rect. For many users, that method will be easier to use.

pub fn fill<'b>( &mut self, style: Fill, transform: Affine, brush: impl Into<BrushRef<'b>>, brush_transform: Option<Affine>, shape: &impl Shape, )

Fills a shape using the specified style and brush.

pub fn stroke<'b>( &mut self, style: &Stroke, transform: Affine, brush: impl Into<BrushRef<'b>>, brush_transform: Option<Affine>, shape: &impl Shape, )

Strokes a shape using the specified style and brush.

pub fn draw_image(&mut self, image: &Image, transform: Affine)

Draws an image at its natural size with the given transform.

pub fn draw_glyphs(&mut self, font: &Font) -> DrawGlyphs<'_>

Returns a builder for encoding a glyph run.

pub fn append(&mut self, other: &Self, transform: Option<Affine>)

Appends a child scene.

The given transform is applied to every transform in the child. This is an O(N) operation.

Trait Implementations

impl Clone for Scene

fn clone(&self) -> Scene

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Scene

fn default() -> Scene

Returns the “default value” for a type.

impl From<Encoding> for Scene

fn from(encoding: Encoding) -> Self

Converts to this type from the input type.