Skip to main content

Text

Struct Text 

Source
pub struct Text<'a, C> { /* private fields */ }
Expand description

A drawable text string with configurable positioning and styling.

Implements the Drawable trait from embedded-graphics, allowing it to be rendered on any DrawTarget.

§Fields (Internal)

  • text: String to render
  • position: Position for the anchor point
  • font: Font to use for rendering
  • color: Pixel color for the text
  • anchor: Which point of the text bounds the position refers to
  • tracking: Extra pixel spacing between characters

§Examples

use embedded_graphics::geometry::Point;
use embedded_graphics_profont::{Text, Anchor, WithAnchor};

// Simple left-aligned text
let text = Text::new("Hello", Point::new(0, 0), &font, Rgb565::WHITE);
target.draw(&text)?;

// Centered text with letter spacing
let text = Text::new("Spaced", Point::new(64, 32), &font, color)
    .with_anchor(Anchor::MiddleCenter)
    .with_tracking(2);
target.draw(&text)?;

Implementations§

Source§

impl<'a, C> Text<'a, C>
where C: PixelColor,

Source

pub fn new(text: &'a str, position: Point, font: &'a Font, color: C) -> Self

Create a new text drawable.

The text will be positioned at the given point using the default TopLeft anchor. Use with_anchor() to change the anchor point.

§Arguments
  • text - String to render
  • position - Position of the anchor point
  • font - Font to use
  • color - Pixel color for the text
Source

pub fn with_tracking(self, tracking: i32) -> Self

Set the spacing between characters in pixels.

§Arguments
  • tracking - Extra pixels to add between characters (can be negative)
§Examples
let text = Text::new("Hello", Point::new(0, 0), &font, color)
    .with_tracking(2);  // 2 pixels between each character

Trait Implementations§

Source§

impl<'a, C> Drawable for Text<'a, C>
where C: PixelColor,

Source§

type Color = C

The pixel color type.
Source§

type Output = ()

The return type of the draw method. Read more
Source§

fn draw<D>(&self, target: &mut D) -> Result<Self::Output, D::Error>
where D: DrawTarget<Color = Self::Color>,

Draw the graphics object using the supplied DrawTarget.
Source§

impl<'a, C: PixelColor> WithAnchor for Text<'a, C>

Source§

fn with_anchor(self, anchor: Anchor) -> Self

Set the anchor point for positioning this object.

Auto Trait Implementations§

§

impl<'a, C> Freeze for Text<'a, C>
where C: Freeze,

§

impl<'a, C> RefUnwindSafe for Text<'a, C>
where C: RefUnwindSafe,

§

impl<'a, C> Send for Text<'a, C>
where C: Send,

§

impl<'a, C> Sync for Text<'a, C>
where C: Sync,

§

impl<'a, C> Unpin for Text<'a, C>
where C: Unpin,

§

impl<'a, C> UnsafeUnpin for Text<'a, C>
where C: UnsafeUnpin,

§

impl<'a, C> UnwindSafe for Text<'a, C>
where C: UnwindSafe,

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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

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

Source§

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>,

Source§

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> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.