Struct DrawingContext 

pub struct DrawingContext<'a> { /* private fields */ }

The surface a visual draws itself onto during rendering.

Implementations

impl<'a> DrawingContext<'a>

pub fn new(core: &'a mut dyn IDrawingContextCore) -> Self

Creates a context over a borrowed core. Dropping (or disposing) the context pops the states still pushed but leaves the core alive.

pub fn owned(core: Box<dyn IDrawingContextCore + 'a>) -> Self

Creates a context that owns its core: disposing (or dropping) the context pops the states still pushed and disposes the core.

pub fn dispose(self)

Pops every state still pushed and releases the context (and the core, if the context owns it).

pub fn draw_image(&mut self, source: &dyn IImage, rect: Rect)

Draws an image into rect.

pub fn draw_image_with_rects( &mut self, source: &dyn IImage, source_rect: Rect, dest_rect: Rect, )

Draws the part of an image inside source_rect into dest_rect.

pub fn draw_bitmap( &mut self, source: &RefCounted<SharedBitmapImpl>, opacity: f64, source_rect: Rect, dest_rect: Rect, )

Draws a platform bitmap.

pub fn draw_line(&mut self, pen: &Rc<dyn IPen>, p1: Point, p2: Point)

Draws a line.

pub fn draw_geometry( &mut self, brush: Option<&Rc<dyn IBrush>>, pen: Option<&Rc<dyn IPen>>, geometry: &Ref<Geometry>, )

Draws a geometry.

pub fn draw_geometry_impl( &mut self, brush: Option<&Rc<dyn IBrush>>, pen: Option<&Rc<dyn IPen>>, geometry: &Arc<dyn IGeometryImpl>, )

Draws a platform geometry.

pub fn draw_rectangle( &mut self, brush: Option<&Rc<dyn IBrush>>, pen: Option<&Rc<dyn IPen>>, rect: Rect, radius_x: f64, radius_y: f64, box_shadows: &BoxShadows, )

Draws a rectangle with the specified brush and pen.

The brush and the pen can both be None. If the brush is None, no fill is performed. If the pen is None, no stroke is performed. If both are None and there are no box shadows, the call is a no-op.

pub fn draw_rounded_rectangle( &mut self, brush: Option<&Rc<dyn IBrush>>, pen: Option<&Rc<dyn IPen>>, rrect: RoundedRect, box_shadows: &BoxShadows, )

Draws a rounded rectangle with the specified brush and pen.

pub fn draw_rectangle_outline( &mut self, pen: &Rc<dyn IPen>, rect: Rect, corner_radius: f32, )

Draws the outline of a rectangle.

pub fn fill_rectangle( &mut self, brush: &Rc<dyn IBrush>, rect: Rect, corner_radius: f32, )

Draws a filled rectangle.

pub fn draw_ellipse_at( &mut self, brush: Option<&Rc<dyn IBrush>>, pen: Option<&Rc<dyn IPen>>, center: Point, radius_x: f64, radius_y: f64, )

Draws an ellipse given its center and radii.

pub fn draw_ellipse( &mut self, brush: Option<&Rc<dyn IBrush>>, pen: Option<&Rc<dyn IPen>>, rect: Rect, )

Draws an ellipse inscribed in a rectangle.

pub fn custom(&mut self, custom: &Arc<dyn ICustomDrawOperation>)

Draws a custom drawing operation.

pub fn draw_text(&mut self, text: &FormattedText, origin: Point)

Draws text. origin is the upper-left corner of the text.

pub fn draw_glyph_run( &mut self, foreground: Option<&Rc<dyn IBrush>>, glyph_run: &Rc<GlyphRun>, )

Draws a glyph run.

pub fn draw_rectangle_acrylic( &mut self, material: &dyn IExperimentalAcrylicMaterial, rect: RoundedRect, )

Draws a rectangle filled with an acrylic-like material. A core without acrylic support fills the rectangle with the fallback color of the material; see IDrawingContextCore::draw_rectangle_acrylic_core.

pub fn pop(&mut self, state: PushedState)

Pops a pushed state (C# PushedState.Dispose).

Panics if the state is not the most recently pushed one. Popping PushedState::NONE, or any state after the context has been disposed, does nothing.

pub fn scope(&mut self, state: PushedState) -> PushedScope<'_, 'a>

Turns a pushed state into a guard that derefs to the context and pops the state when dropped.

pub fn push_rounded_clip(&mut self, clip: RoundedRect) -> PushedState

Pushes a rounded clip rectangle.

pub fn push_clip(&mut self, clip: Rect) -> PushedState

Pushes a clip rectangle.

pub fn push_geometry_clip(&mut self, clip: &Ref<Geometry>) -> PushedState

Pushes a clip geometry.

pub fn push_opacity(&mut self, opacity: f64) -> PushedState

Pushes an opacity value.

pub fn push_opacity_mask( &mut self, mask: &Rc<dyn IBrush>, bounds: Rect, ) -> PushedState

Pushes an opacity mask.

bounds are the bounds of the control, used to place brushes correctly.

pub fn push_transform(&mut self, matrix: Matrix) -> PushedState

Pushes a matrix transformation.

pub fn push_render_options( &mut self, render_options: RenderOptions, ) -> PushedState

Pushes render options.

pub fn push_text_options(&mut self, text_options: TextOptions) -> PushedState

Pushes text options.

pub fn push_effect( &mut self, effect: &Rc<dyn IEffect>, bounds: Rect, ) -> PushedState

Pushes an effect applied to everything drawn until the state is popped. bounds are the bounds of the affected content.

Trait Implementations

impl Drop for DrawingContext<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl ITextDrawingSink for DrawingContext<'_>

Text draws itself through the sink members, which are the corresponding drawing context members. A sink push has no state token: its pop restores the state pushed last, which is the transform the matching push pushed because text balances its pushes.

fn draw_glyph_run( &mut self, foreground: Option<&Rc<dyn IBrush>>, glyph_run: &Rc<GlyphRun>, )

Draws a glyph run (DrawingContext.DrawGlyphRun(IBrush? foreground, GlyphRun glyphRun)).

fn draw_rectangle( &mut self, brush: Option<&Rc<dyn IBrush>>, pen: Option<&Rc<dyn IPen>>, rect: Rect, )

Draws a rectangle with the specified brush and pen (DrawingContext.DrawRectangle(IBrush? brush, IPen? pen, Rect rect)).

fn draw_line(&mut self, pen: &Rc<dyn IPen>, p1: Point, p2: Point)

Draws a line (DrawingContext.DrawLine(IPen pen, Point p1, Point p2)).

fn push_transform(&mut self, matrix: Matrix)

Pushes a matrix transformation (DrawingContext.PushTransform(Matrix matrix)). Every push is balanced by one ITextDrawingSink::pop_transform.

fn pop_transform(&mut self)

Pops the transformation pushed last (disposing upstream’s PushedState).