Struct ggez::graphics::Text

source ·
pub struct Text { /* private fields */ }
Expand description

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§

source§

impl Text

source

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

Creates a Text from a TextFragment.

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

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

Appends a TextFragment to the Text.

source

pub fn clear(&mut self)

Clear all TextFragment from the Text

source

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

Returns an immutable slice of all TextFragments.

source

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

Returns a mutable slice of all TextFragments.

source

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

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

source

pub fn set_layout(&mut self, layout: TextLayout) -> &mut Self

Specifies how the text will be layed out.

source

pub fn set_wrap(&mut self, wrap: bool) -> &mut Self

Specifies whether or not the text will be wrapped within the bounds bounds specified by Text::set_bounds.

source

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.

source

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

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

source

pub fn contents(&self) -> String

Returns the string that the text represents.

source

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

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

source

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

Measures the glyph boundaries for the text.

Trait Implementations§

source§

impl Clone for Text

source§

fn clone(&self) -> Text

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 Text

source§

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

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

impl Default for Text

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Drawable for Text

source§

fn draw(&self, canvas: &mut Canvas, param: impl Into<DrawParam>)

Draws the drawable onto the canvas.
source§

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

Returns a bounding box in the form of a Rect. Read more

Auto Trait Implementations§

§

impl RefUnwindSafe for Text

§

impl Send for Text

§

impl Sync for Text

§

impl Unpin for Text

§

impl UnwindSafe for Text

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

source§

impl<T> Has<T> for T

source§

fn retrieve(&self) -> &T

Method to retrieve the context type.
source§

impl<T> HasMut<T> for T

source§

fn retrieve_mut(&mut self) -> &mut T

Method to retrieve the context type as mutable.
source§

impl<T, U> Into<U> for Twhere 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.

§

impl<F, T> IntoSample<T> for Fwhere T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere 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
§

impl<T, U> ToSample<U> for Twhere U: FromSample<T>,

§

fn to_sample_(self) -> U

source§

impl<T, U> TryFrom<U> for Twhere 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 Twhere 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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<S, T> Duplex<S> for Twhere T: FromSample<S> + ToSample<S>,