Struct rerun::external::eframe::egui::Painter

pub struct Painter {
    ctx: Context,
    pixels_per_point: f32,
    layer_id: LayerId,
    clip_rect: Rect,
    fade_to_color: Option<Color32>,
    opacity_factor: f32,
}

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

A Painter never outlive a single frame/pass.

Fields§

§ctx: Context§pixels_per_point: f32§layer_id: LayerId§clip_rect: Rect§fade_to_color: Option<Color32>§opacity_factor: f32

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.

It is undefined behavior to change the LayerId of crate::Ui::painter.

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

If set, colors will be modified to look like this

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

Set the opacity (alpha multiplier) of everything painted by this painter from this point forward.

opacity must be between 0.0 and 1.0, where 0.0 means fully transparent (i.e., invisible) and 1.0 means fully opaque.

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

Like Self::set_opacity, but multiplies the given value with the current opacity.

See also: Self::set_opacity and Self::opacity.

pub fn opacity(&self) -> f32

Read the current opacity of the underlying painter.

pub fn is_visible(&self) -> bool

If false, nothing you paint will show up.

Also checks Context::will_discard.

pub fn set_invisible(&mut self)

If false, nothing added to the painter will be visible

pub fn ctx(&self) -> &Context

Get a reference to the parent Context.

pub fn pixels_per_point(&self) -> f32

Number of physical pixels for each logical UI point.

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 shrink_clip_rect(&mut self, new_clip_rect: Rect)

Constrain the rectangle in which we can paint.

Short for painter.set_clip_rect(painter.clip_rect().intersect(new_clip_rect)).

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.

Warning: growing the clip rect might cause unexpected results! When in doubt, use Self::shrink_clip_rect instead.