Struct epaint::shape::TextShape

pub struct TextShape {
    pub pos: Pos2,
    pub galley: Arc<Galley>,
    pub underline: Stroke,
    pub fallback_color: Color32,
    pub override_text_color: Option<Color32>,
    pub opacity_factor: f32,
    pub angle: f32,
}

How to paint some text on screen.

This needs to be recreated if pixels_per_point (dpi scale) changes.

Fields

pos: Pos2

Top left corner of the first character.

galley: Arc<Galley>

The laid out text, from Fonts::layout_job.

underline: Stroke

Add this underline to the whole text. You can also set an underline when creating the galley.

fallback_color: Color32

Any Color32::PLACEHOLDER in the galley will be replaced by the given color. Affects everything: backgrounds, glyphs, strikethrough, underline, etc.

override_text_color: Option<Color32>

If set, the text color in the galley will be ignored and replaced with the given color.

This only affects the glyphs and will NOT replace background color nor strikethrough/underline color.

opacity_factor: f32

If set, the text will be rendered with the given opacity in gamma space Affects everything: backgrounds, glyphs, strikethrough, underline, etc.

angle: f32

Rotate text by this many radians clockwise. The pivot is pos (the upper left corner of the text).

Implementations

impl TextShape

pub fn new(pos: Pos2, galley: Arc<Galley>, fallback_color: Color32) -> Self

The given fallback color will be used for any uncolored part of the galley (using Color32::PLACEHOLDER).

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

pub fn visual_bounding_rect(&self) -> Rect

The visual bounding rectangle

pub fn with_underline(self, underline: Stroke) -> Self

pub fn with_override_text_color(self, override_text_color: Color32) -> Self

Use the given color for the text, regardless of what color is already in the galley.

pub fn with_angle(self, angle: f32) -> Self

Rotate text by this many radians clockwise. The pivot is pos (the upper left corner of the text).

pub fn with_opacity_factor(self, opacity_factor: f32) -> Self

Render text with this opacity in gamma space

Trait Implementations

impl Clone for TextShape

fn clone(&self) -> TextShape

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextShape

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

Formats the value using the given formatter.

impl From<TextShape> for Shape

fn from(shape: TextShape) -> Self

Converts to this type from the input type.

impl PartialEq for TextShape

fn eq(&self, other: &TextShape) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TextShape