Struct RenderContext

pub struct RenderContext<'dsp, 'surf> { /* private fields */ }

The context used to draw to a Surface.

This is the whole point of this crate, and is the aperture used to actually draw with vector graphics. It’s created from a Display and a Surface, and can be used to draw to the surface.

See the RenderContext documentation for more information.

Implementations

impl<'dsp, 'surf> RenderContext<'dsp, 'surf>

pub fn new( display: &'dsp mut Display, surface: &'surf mut Surface, width: u32, height: u32, ) -> Result<Self, Error>

Create a new RenderContext from a Surface and a Display.

This creates a new RenderContext from a Surface and a Display. This is the only way to create a RenderContext.

pub unsafe fn new_unchecked( display: &'dsp mut Display, surface: &'surf mut Surface, width: u32, height: u32, ) -> Result<Self, Error>

Create a new RenderContext without checking for exclusive access.

Safety

The same as new, but you need to make sure that there are no other OpenGL contexts active on the current thread.

Trait Implementations

impl Debug for RenderContext<'_, '_>

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

Formats the value using the given formatter.

impl Drop for RenderContext<'_, '_>

fn drop(&mut self)

Executes the destructor for this type.

impl RenderContext for RenderContext<'_, '_>

type Brush = Brush

The type of a “brush”.

type Image = Image

The associated type of an image.

type Text = Text

An associated factory for creating text layouts and related resources.

type TextLayout = TextLayout

The type use to represent text layout objects.

fn status(&mut self) -> Result<(), Error>

Report an internal error.

fn solid_brush(&mut self, color: Color) -> Self::Brush

Create a new brush resource.

fn gradient( &mut self, gradient: impl Into<FixedGradient>, ) -> Result<Self::Brush, Error>

Create a new gradient brush.

fn clear(&mut self, region: impl Into<Option<Rect>>, color: Color)

Replace a region of the canvas with the provided Color.

fn stroke( &mut self, shape: impl Shape, brush: &impl IntoBrush<Self>, width: f64, )

Stroke a Shape, using the default StrokeStyle.

fn stroke_styled( &mut self, shape: impl Shape, brush: &impl IntoBrush<Self>, width: f64, style: &StrokeStyle, )

Stroke a Shape, providing a custom StrokeStyle.

fn fill(&mut self, shape: impl Shape, brush: &impl IntoBrush<Self>)

Fill a Shape, using the non-zero fill rule.

fn fill_even_odd(&mut self, shape: impl Shape, brush: &impl IntoBrush<Self>)

Fill a shape, using the even-odd fill rule.

fn clip(&mut self, shape: impl Shape)

Clip to a Shape.

fn text(&mut self) -> &mut Self::Text

Returns a reference to a shared Text object.

fn draw_text(&mut self, layout: &Self::TextLayout, pos: impl Into<Point>)

Draw a TextLayout.

fn save(&mut self) -> Result<(), Error>

Save the context state.

fn restore(&mut self) -> Result<(), Error>

Restore the context state.

fn finish(&mut self) -> Result<(), Error>

Finish any pending operations.

fn transform(&mut self, transform: Affine)

Apply a transform.

fn make_image( &mut self, width: usize, height: usize, buf: &[u8], format: ImageFormat, ) -> Result<Self::Image, Error>

Create a new Image from a pixel buffer.

fn draw_image( &mut self, image: &Self::Image, dst_rect: impl Into<Rect>, interp: InterpolationMode, )

Draw an Image into the provided Rect.

fn draw_image_area( &mut self, image: &Self::Image, src_rect: impl Into<Rect>, dst_rect: impl Into<Rect>, interp: InterpolationMode, )

Draw a specified area of an Image.

fn capture_image_area( &mut self, src_rect: impl Into<Rect>, ) -> Result<Self::Image, Error>

Create an Image of the specified region of the context.

fn blurred_rect( &mut self, rect: Rect, blur_radius: f64, brush: &impl IntoBrush<Self>, )

Draw a rectangle with Gaussian blur.

fn current_transform(&self) -> Affine

Returns the transformations currently applied to the context.

fn with_save( &mut self, f: impl FnOnce(&mut Self) -> Result<(), Error>, ) -> Result<(), Error>

Do graphics operations with the context state saved and then restored.

impl IntoBrush<RenderContext<'_, '_>> for Brush