text.h

#ifndef TEXT_INCLUDED
#define TEXT_INCLUDED

#include "core.h"
#include <libdragon.h>

typedef enum {
    TextEmpty,
    TextNoTpak,
    TextNoCartridge,
    TextLoadCartridge,
    TextLoadingCartridge,
    TextExpansionPakRequired,
    TextRetryCartridgePrompt,
    TextChecksumFailed,
    TextUnsupportedCartridge,
    TextMenuResume,
    TextMenuReset,
    TextMenuChangeCart,
    TextMenuOptions,
    TextMenuAddPlayer,
    TextMenuAddGame,
    TextSplash,
    TextAudioOn,
    TextAudioOff,
    TextEnd
} TextId;

/**
 * Gets the text string with the given id code, and loads it into output.
 * @param textId The text id code.
 * @out output the destination string.
 */
void getText(TextId textId, string output);

/**
 * Initialises text subsystem by loading sprites etc.
 */
sByte initText();

/**
 * Frees resources used by the text subsystem when done.
 */
void freeText();

/**
 * Draws a horizontal string of text starting at the given location.
 * @param frame The id of the frame to draw on.
 * @param x The x co-ordinate to start the string at.
 * @param y The y co-ordinate to start the string at.
 * @param scale size of the text sprites.
 */
void drawText(const display_context_t frame, const string text, const natural x, const natural y, const float scale);

/**
 * Draws a horizontal string of text starting at the given location.
 * @param frame The id of the frame to draw on.
 * @param x The x co-ordinate to start the string at.
 * @param y The y co-ordinate to start the string at.
 * @param scale size of the text sprites.
 * @param width width of the area available for text.
 */
void drawTextParagraph(
    const display_context_t frame,
    const string text,
    const natural x,
    const natural y,
    const float scale,
    const natural width
);

/**
 * Calculates the length in pixels of a given string, including any sprites.
 * @param text the string.
 * @return the length in pixels.
 */
natural getStringWidth(const string text);

#endif