Struct Scene

Source

pub struct Scene { /* private fields */ }

Expand description

A render context for GPU rendering.

This context maintains the state for path rendering and manages the rendering pipeline from paths to strips that can be rendered by the GPU.

Implementations§

Source §

impl Scene

Source

pub fn new(width: u16, height: u16) -> Self

Create a new render context with the given width and height in pixels.

Source

pub fn new_with(width: u16, height: u16, level: Level) -> Self

Create a new render context with a specific SIMD level.

Source

pub fn fill_path(&mut self, path: &BezPath)

Fill a path with the current paint and fill rule.

Source

pub fn push_clip_path(&mut self, path: &BezPath)

Push a new clip path to the clip stack.

See the explanation in the clipping example for how this method differs from push_clip_layer.

Source

pub fn push_clip_rect(&mut self, rect: &Rect)

Push a rectangular clip path.

Source

pub fn pop_clip(&mut self)

Pop the most recently pushed clip path or clip rectangle from the clip stack.

Note that unlike push_clip_layer, it is permissible to have pending pushed clips before finishing the rendering operation.

Source

pub fn stroke_path(&mut self, path: &BezPath)

Stroke a path with the current paint and stroke settings.

Source

pub fn set_aliasing_threshold(&mut self, aliasing_threshold: Option<u8>)

Set the aliasing threshold.

If set to None (which is the recommended option in nearly all cases), anti-aliasing will be applied.

If instead set to some value, then a pixel will be fully painted if the coverage is bigger than the threshold (between 0 and 255), otherwise it will not be painted at all.

Note that there is no performance benefit to disabling anti-aliasing and this functionality is simply provided for compatibility.

Source

pub fn fill_rect(&mut self, rect: &Rect)

Fill a rectangle with the current paint and fill rule.

Source

pub fn stroke_rect(&mut self, rect: &Rect)

Stroke a rectangle with the current paint and stroke settings.

Source

pub fn fill_blurred_rounded_rect( &mut self, rect: &Rect, radius: f32, std_dev: f32, invert: bool, )

Fill a blurred rectangle with the given corner radius and standard deviation.

When invert is true, the inverse (1 - alpha) of the blur coverage is painted: the paint is fully opaque outside the blurred rectangle and fades to transparent inside it. This can be used to implement inset box shadows.

This operation uses the current transform and paint transform. Like Vello CPU, it only uses solid paints; non-solid paints fall back to black.

Source

pub fn glyph_run<'a>( &'a mut self, resources: &'a mut Resources, font: &FontData, ) -> GlyphRunBuilder<'a>

Creates a builder for drawing a run of glyphs that have the same attributes.

Source

pub fn push_layer( &mut self, clip_path: Option<&BezPath>, blend_mode: Option<BlendMode>, opacity: Option<f32>, mask: Option<Mask>, filter: Option<Filter>, )

Push a new layer with the given properties.

§Panics

Panics if mask is provided because mask layers are not yet supported.

Source

pub fn push_clip_layer(&mut self, path: &BezPath)

Push a new clip layer.

See the explanation in the clipping example for how this method differs from push_clip_path.

Source

pub fn push_blend_layer(&mut self, blend_mode: BlendMode)

Push a new blend layer.

Source

pub fn push_opacity_layer(&mut self, opacity: f32)

Push a new opacity layer.

Source

pub fn push_mask_layer(&mut self, mask: Mask)

Push a new mask layer.

§Panics

This method currently always panics since masks are not supported yet.

Source

pub fn push_filter_layer(&mut self, filter: Filter)

Push a new filter layer.

Source

pub fn pop_layer(&mut self)

Pop the last pushed layer.

Source

pub fn set_blend_mode(&mut self, blend_mode: BlendMode)

Set the blend mode for subsequent rendering operations.

§Panics

Panics if blend_mode is destructive, which is currently not supported for non-isolated blends. You need to use clip layers instead if you need that behavior.

Source

pub fn set_stroke(&mut self, stroke: Stroke)

Set the stroke settings for subsequent stroke operations.

Source

pub fn stroke(&self) -> &Stroke

Get the current stroke.

Source

pub fn set_paint(&mut self, paint: impl Into<PaintType>)

Set the paint for subsequent rendering operations.

Source

pub fn set_tint(&mut self, tint: Option<Tint>)

Set the tint for subsequent image paint operations.

Source

pub fn reset_tint(&mut self)

Clear the tint, so subsequent image paints are drawn without tinting.

Source

pub fn paint(&self) -> &PaintType

Get the current paint.

Source

pub fn set_paint_transform(&mut self, paint_transform: Affine)

Set the current paint transform.

The paint transform is applied to the paint after the transform of the geometry the paint is drawn in, i.e., the paint transform is applied after the global transform. This allows transforming the paint independently from the drawn geometry.

Source