Struct egui::painter::Painter

source ·
pub struct Painter {
    ctx: Context,
    layer_id: LayerId,
    clip_rect: Rect,
    fade_to_color: Option<Color32>,
}
Expand description

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).

Fields§

§ctx: Context

Source of fonts and destination of shapes

§layer_id: LayerId

Where we paint

§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.

§fade_to_color: Option<Color32>

If set, all shapes will have their colors modified to be closer to this. This is used to implement grayed out interfaces.

Implementations§

source§

impl Painter

source

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

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

source

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

Redirect where you are painting.

source

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

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.

source

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

Redirect where you are painting.

source

pub(crate) fn set_fade_to_color(&mut self, fade_to_color: Option<Color32>)

If set, colors will be modified to look like this

source

pub(crate) fn is_visible(&self) -> bool

source

pub(crate) fn set_invisible(&mut self)

If false, nothing added to the painter will be visible

source§

impl Painter

§Accessors etc
source

pub fn ctx(&self) -> &Context

Get a reference to the parent Context.

source

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.

source

pub fn layer_id(&self) -> LayerId

Where we paint

source

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.

source

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.

source

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

Useful for pixel-perfect rendering.

source

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

Useful for pixel-perfect rendering.

source

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

Useful for pixel-perfect rendering.

source§

impl Painter

§Low level
source

fn paint_list<R>(&self, writer: impl FnOnce(&mut PaintList) -> R) -> R

source

fn transform_shape(&self, shape: &mut Shape)

source

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!

source

pub fn extend<I: IntoIterator<Item = Shape>>(&self, shapes: I)

Add many shapes at once.

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

source

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

Modify an existing Shape.

source

pub fn for_each_shape(&self, reader: impl FnMut(&ClippedShape))

Access all shapes added this frame.

source§

impl Painter

§Debug painting
source

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

source

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

source

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

Text with a background.

See also Context::debug_text.

source§

impl Painter

§Paint different primitives

source

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

Paints a line from the first point to the second.

source

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

Paints a horizontal line.

source

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

Paints a vertical line.

source

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

source

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

source

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

source

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

source

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

source

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

source

pub fn arrow(&self, origin: Pos2, vec: Vec2, stroke: impl Into<Stroke>)

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

source

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

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);
source§

impl Painter

§Text
source

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.

source

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.

source

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.

source

pub fn layout_job(&self, layout_job: LayoutJob) -> Arc<Galley>

Lay out this text layut job in a galley.

Paint the results with Self::galley.

source

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

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

You can create the Galley with Self::layout or Self::layout_job.

Any uncolored parts of the Galley (using Color32::PLACEHOLDER) will be replaced with the given color.

Any non-placeholder color in the galley takes precedence over this fallback color.

source

pub fn galley_with_override_text_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.

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

source

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

👎Deprecated: Use Painter::galley or Painter::galley_with_override_text_color instead

Trait Implementations§

source§

impl Clone for Painter

source§

fn clone(&self) -> Painter

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,