Struct ggez::graphics::Text

pub struct Text { /* fields omitted */ }

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

It implements Drawable so it can be drawn immediately with graphics::draw(), or many of them can be queued with graphics::queue_text() and then all drawn at once with graphics::draw_queued_text().

Implementations

impl Text

pub fn new<F>(fragment: F) -> Text where
    F: Into<TextFragment>, 

Creates a Text from a TextFragment.

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

pub fn add<F>(&mut self, fragment: F) -> &mut Text where
    F: Into<TextFragment>, 

Appends a TextFragment to the Text.

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

Returns a read-only slice of all TextFragment's.

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

Returns a mutable slice with all fragments.

pub fn set_bounds<P>(&mut self, bounds: P, alignment: Align) -> &mut Text where
    P: Into<Point2<f32>>, 

Specifies rectangular dimensions to try and fit contents inside of, by wrapping, and alignment within the bounds. To disable wrapping, give it a layout with f32::INF for the x value.

pub fn set_font(&mut self, font: Font, font_scale: PxScale) -> &mut Text

Specifies text's font and font scale; used for fragments that don't have their own.

pub fn contents(&self) -> String

Returns the string that the text represents.

pub fn dimensions(&self, context: &Context) -> Rect

Returns a Rect containing the width and height of the formatted and wrapped text.

pub fn width(&self, context: &Context) -> f32

Returns the width of formatted and wrapped text, in screen coordinates.

pub fn height(&self, context: &Context) -> f32

Returns the height of formatted and wrapped text, in screen coordinates.

Trait Implementations

impl Clone for Text

pub fn clone(&self) -> Text

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

pub fn default() -> Self

Returns the "default value" for a type.

impl Drawable for Text

pub fn draw(&self, ctx: &mut Context, param: DrawParam) -> GameResult

Draws the drawable onto the rendering target.

pub fn dimensions(&self, ctx: &mut Context) -> Option<Rect>

Returns a bounding box in the form of a Rect.

pub fn set_blend_mode(&mut self, mode: Option<BlendMode>)

Sets the blend mode to be used when drawing this drawable. This overrides the general graphics::set_blend_mode(). If None is set, defers to the blend mode set by graphics::set_blend_mode().

pub fn blend_mode(&self) -> Option<BlendMode>

Gets the blend mode to be used when drawing this drawable.