Struct crankstart::sprite::TextSprite

pub struct TextSprite { /* private fields */ }

This is a helper type for drawing text into a sprite. Drawing text into a sprite is the recommended way to display text when using sprites in your game; it removes timing issues and gives you the flexibility of the sprite system rather than draw_text alone.

After creation with new, you can update_text as desired, and use get_sprite or get_sprite_mut to access the Sprite for other operations like move_to and get_bounds (which can tell you the height and width of the generated bitmap).

Note: it’s assumed that you’re using the system font and haven’t changed its tracking; we have no way to retrieve the current font or tracking with C APIs.

Implementations

impl TextSprite

pub fn new<S>(text: S, background: LCDColor) -> Result<Self, Error>where S: AsRef<str>,

Creates a TextSprite, draws the given text into it over the given background color, and adds the underlying sprite to the SpriteManager.

pub fn get_sprite(&self) -> &Sprite

pub fn get_sprite_mut(&mut self) -> &mut Sprite

pub fn update_text<S>(&mut self, text: S) -> Result<(), Error>where S: AsRef<str>,

Recreates the underlying bitmap with the given text; use get_sprite().get_bounds() to see the new size.

Trait Implementations

impl Clone for TextSprite

fn clone(&self) -> TextSprite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextSprite

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

Formats the value using the given formatter.