Struct epaint::TextShape

source ·
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,
}
Expand description

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, strikethough, 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, strikethough, underline, etc.

§angle: f32

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

Implementations§

source§

impl TextShape

source

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.

source

pub fn visual_bounding_rect(&self) -> Rect

The visual bounding rectangle

source

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

source

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.

source

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

source

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

Render text with this opacity in gamma space

Trait Implementations§

source§

impl Clone for TextShape

source§

fn clone(&self) -> TextShape

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

impl Debug for TextShape

source§

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

Formats the value using the given formatter. Read more
source§

impl From<TextShape> for Shape

source§

fn from(shape: TextShape) -> Self

Converts to this type from the input type.
source§

impl PartialEq for TextShape

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for TextShape

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.