Struct kludgine::text::Text

#[non_exhaustive]
pub struct Text<'a, Unit> {
    pub text: &'a str,
    pub color: Color,
    pub origin: TextOrigin<Unit>,
    pub wrap_at: Option<Unit>,
}

A text drawing command.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: &'a str

The text to be drawn.

color: Color

The color to draw the text using.

origin: TextOrigin<Unit>

The origin to draw the text around.

wrap_at: Option<Unit>

The width to wrap the text at. If None, no wrapping is performed.

Implementations

impl<'a, Unit> Text<'a, Unit>

pub const fn new(text: &'a str, color: Color) -> Self

Returns a text command that draws text with color.

pub fn origin(self, origin: TextOrigin<Unit>) -> Self

Sets the origin for the text drawing operation and returns self.

pub fn wrap_at(self, width: Unit) -> Self

Sets the width to wrap text at and returns self.

Trait Implementations

impl<'a, Unit: Clone> Clone for Text<'a, Unit>

fn clone(&self) -> Text<'a, Unit>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, Unit: Debug> Debug for Text<'a, Unit>

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

Formats the value using the given formatter.

impl<'a, Unit> From<&'a String> for Text<'a, Unit>

fn from(value: &'a String) -> Self

Converts to this type from the input type.

impl<'a, Unit> From<&'a str> for Text<'a, Unit>

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl<'a, Unit> From<Text<'a, Unit>> for Drawable<Text<'a, Unit>, Unit>

where Unit: Default,

fn from(what: Text<'a, Unit>) -> Self

Converts to this type from the input type.

impl<'a, Unit: Copy> Copy for Text<'a, Unit>

impl<'a, Unit> DrawableSource for Text<'a, Unit>