Struct ggez::graphics::Text

pub struct Text { /* private fields */ }

Drawable text object. Essentially a list of TextFragment. and some cached size information.

It implements Drawable so it can be drawn immediately with Canvas::draw().

Implementations

impl Text

pub fn new(fragment: impl Into<TextFragment>) -> Self

Creates a Text from a TextFragment.

let text = Text::new("foo");

pub fn add(&mut self, fragment: impl Into<TextFragment>) -> &mut Self

Appends a TextFragment to the Text.

pub fn fragments(&self) -> &[TextFragment]

Returns an immutable slice of all TextFragments.

pub fn fragments_mut(&mut self) -> &mut [TextFragment]

Returns a mutable slice of all TextFragments.

pub fn set_bounds(
    &mut self,
    bounds: impl Into<Vector2<f32>>,
    layout: TextLayout
) -> &mut Text

Specifies rectangular dimensions to fit text inside of, wrapping where necessary. Within these bounds is also where text alignment occurs.

Wrapping can be disabled by setting layout to TextLayout::SingleLine.

pub fn set_font(&mut self, font: impl Into<String>) -> &mut Self

Specifies the text’s font for fragments that don’t specify their own font.

pub fn set_scale(&mut self, scale: impl Into<PxScale>) -> &mut Self

Specifies the text’s font scael for fragments that don’t specify their own scale.

pub fn contents(&self) -> String

Returns the string that the text represents.

pub fn glyph_positions(
    &self,
    gfx: &mut impl HasMut<GraphicsContext>
) -> GameResult<Vec<Point2<f32>>>

Returns a Vec containing the coordinates of the formatted and wrapped text.

pub fn measure(
    &self,
    gfx: &mut impl HasMut<GraphicsContext>
) -> GameResult<Vector2<f32>>

Measures the glyph boundaries for the text.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.

impl Drawable for Text

fn draw(&self, canvas: &mut Canvas, param: DrawParam)

Draws the drawable onto the canvas.

fn dimensions(&self, gfx: &mut impl HasMut<GraphicsContext>) -> Option<Rect>

Returns a bounding box in the form of a Rect.