Struct Painter

pub struct Painter { /* private fields */ }

Helper to paint shapes and text to a specific region on a specific layer.

All coordinates are screen coordinates in the unit points (one point can consist of many physical pixels).

Implementations

impl Painter

pub fn new(ctx: Context, layer_id: LayerId, clip_rect: Rect) -> Painter

Create a painter to a specific layer within a certain clip rectangle.

pub fn with_layer_id(self, layer_id: LayerId) -> Painter

Redirect where you are painting.

pub fn with_clip_rect(&self, rect: Rect) -> Painter

Create a painter for a sub-region of this Painter.

The clip-rect of the returned Painter will be the intersection of the given rectangle and the clip_rect() of the parent Painter.

pub fn set_layer_id(&mut self, layer_id: LayerId)

Redirect where you are painting.

pub fn sub_region(&self, rect: Rect) -> Painter

👎Deprecated: Use Painter::with_clip_rect

impl Painter

Accessors etc

pub fn ctx(&self) -> &Context

Get a reference to the parent Context.

pub fn fonts<R>(&self, reader: impl FnOnce(&Fonts) -> R) -> R

Read-only access to the shared Fonts.

See Context documentation for how locks work.

pub fn layer_id(&self) -> LayerId

Where we paint

pub fn clip_rect(&self) -> Rect

Everything painted in this Painter will be clipped against this. This means nothing outside of this rectangle will be visible on screen.

pub fn set_clip_rect(&mut self, clip_rect: Rect)

Everything painted in this Painter will be clipped against this. This means nothing outside of this rectangle will be visible on screen.

pub fn round_to_pixel(&self, point: f32) -> f32

Useful for pixel-perfect rendering.

pub fn round_vec_to_pixels(&self, vec: Vec2) -> Vec2

Useful for pixel-perfect rendering.

pub fn round_pos_to_pixels(&self, pos: Pos2) -> Pos2

Useful for pixel-perfect rendering.

impl Painter

Low level

pub fn add(&self, shape: impl Into<Shape>) -> ShapeIdx

It is up to the caller to make sure there is room for this. Can be used for free painting. NOTE: all coordinates are screen coordinates!

pub fn extend<I>(&self, shapes: I)

where I: IntoIterator<Item = Shape>,

Add many shapes at once.

Calling this once is generally faster than calling Self::add multiple times.

pub fn set(&self, idx: ShapeIdx, shape: impl Into<Shape>)

Modify an existing Shape.

impl Painter

Debug painting

pub fn debug_rect(&self, rect: Rect, color: Color32, text: impl ToString)

pub fn error(&self, pos: Pos2, text: impl Display) -> Rect

pub fn debug_text( &self, pos: Pos2, anchor: Align2, color: Color32, text: impl ToString, ) -> Rect

text with a background

impl Painter

Paint different primitives

pub fn line_segment(&self, points: [Pos2; 2], stroke: impl Into<Stroke>)

Paints a line from the first point to the second.

pub fn hline(&self, x: impl Into<Rangef>, y: f32, stroke: impl Into<Stroke>)

Paints a horizontal line.

pub fn vline(&self, x: f32, y: impl Into<Rangef>, stroke: impl Into<Stroke>)

Paints a vertical line.

pub fn circle( &self, center: Pos2, radius: f32, fill_color: impl Into<Color32>, stroke: impl Into<Stroke>, )

pub fn circle_filled( &self, center: Pos2, radius: f32, fill_color: impl Into<Color32>, )

pub fn circle_stroke( &self, center: Pos2, radius: f32, stroke: impl Into<Stroke>, )

pub fn rect( &self, rect: Rect, rounding: impl Into<Rounding>, fill_color: impl Into<Color32>, stroke: impl Into<Stroke>, )

pub fn rect_filled( &self, rect: Rect, rounding: impl Into<Rounding>, fill_color: impl Into<Color32>, )

pub fn rect_stroke( &self, rect: Rect, rounding: impl Into<Rounding>, stroke: impl Into<Stroke>, )

pub fn arrow(&self, origin: Pos2, vec: Vec2, stroke: Stroke)

Show an arrow starting at origin and going in the direction of vec, with the length vec.length().

pub fn image(&self, texture_id: TextureId, rect: Rect, uv: Rect, tint: Color32)

An image at the given position.

uv should normally be Rect::from_min_max(pos2(0.0, 0.0), pos2(1.0, 1.0)) unless you want to crop or flip the image.

tint is a color multiplier. Use Color32::WHITE if you don’t want to tint the image.

Usually it is easier to use crate::Image::paint_at instead:

egui::Image::new(egui::include_image!("../assets/ferris.png"))
    .rounding(5.0)
    .tint(egui::Color32::LIGHT_BLUE)
    .paint_at(ui, rect);

impl Painter

Text

pub fn text( &self, pos: Pos2, anchor: Align2, text: impl ToString, font_id: FontId, text_color: Color32, ) -> Rect

Lay out and paint some text.

To center the text at the given position, use Align2::CENTER_CENTER.

To find out the size of text before painting it, use Self::layout or Self::layout_no_wrap.

Returns where the text ended up.

pub fn layout( &self, text: String, font_id: FontId, color: Color32, wrap_width: f32, ) -> Arc<Galley>

Will wrap text at the given width and line break at \n.

Paint the results with Self::galley.

pub fn layout_no_wrap( &self, text: String, font_id: FontId, color: Color32, ) -> Arc<Galley>

Will line break at \n.

Paint the results with Self::galley.

pub fn galley(&self, pos: Pos2, galley: Arc<Galley>)

Paint text that has already been laid out in a Galley.

You can create the Galley with Self::layout.

If you want to change the color of the text, use Self::galley_with_color.

pub fn galley_with_color( &self, pos: Pos2, galley: Arc<Galley>, text_color: Color32, )

Paint text that has already been laid out in a Galley.

You can create the Galley with Self::layout.

The text color in the Galley will be replaced with the given color.

Trait Implementations

impl Clone for Painter

fn clone(&self) -> Painter

Returns a duplicate of the value.

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

Performs copy-assignment from source.