pokeemerald/gflib/text.h

175 lines
4.6 KiB
C
Raw Normal View History

2017-01-14 20:53:20 +01:00
#ifndef GUARD_TEXT_H
#define GUARD_TEXT_H
2021-10-30 22:19:10 +02:00
#include "characters.h"
2021-09-24 20:30:15 +02:00
2017-03-07 14:44:41 +01:00
#define NUM_TEXT_PRINTERS 32
// Given as a text speed when all the text should be
// loaded at once but not copied to vram yet.
#define TEXT_SKIP_DRAW 0xFF
2017-11-19 22:48:46 +01:00
2021-10-30 22:47:37 +02:00
enum {
FONT_SMALL,
FONT_NORMAL,
FONT_SHORT,
FONT_SHORT_COPY_1,
FONT_SHORT_COPY_2,
FONT_SHORT_COPY_3,
FONT_BRAILLE,
FONT_NARROW,
FONT_SMALL_NARROW, // Very similar to FONT_SMALL, some glyphs are narrower
FONT_BOLD, // JP glyph set only
};
// Return values for font functions
enum {
RENDER_PRINT,
RENDER_FINISH,
RENDER_REPEAT, // Run render function again, if e.g. a control code is encountered.
RENDER_UPDATE,
};
// Text printer states read by RenderText / FontFunc_Braille
enum {
RENDER_STATE_HANDLE_CHAR,
RENDER_STATE_WAIT,
RENDER_STATE_CLEAR,
RENDER_STATE_SCROLL_START,
RENDER_STATE_SCROLL,
RENDER_STATE_WAIT_SE,
RENDER_STATE_PAUSE,
};
2021-10-30 22:47:37 +02:00
enum {
2018-07-15 13:23:38 +02:00
FONTATTR_MAX_LETTER_WIDTH,
FONTATTR_MAX_LETTER_HEIGHT,
FONTATTR_LETTER_SPACING,
FONTATTR_LINE_SPACING,
FONTATTR_UNKNOWN, // dunno what this is yet
2018-07-15 13:23:38 +02:00
FONTATTR_COLOR_FOREGROUND,
FONTATTR_COLOR_BACKGROUND,
FONTATTR_COLOR_SHADOW
};
2018-11-05 21:42:12 +01:00
struct TextPrinterSubStruct
2017-09-22 05:43:13 +02:00
{
2021-10-30 22:47:37 +02:00
u8 fontId:4; // 0x14
2018-11-06 17:44:48 +01:00
bool8 hasPrintBeenSpedUp:1;
2018-11-06 18:30:21 +01:00
u8 unk:3;
2018-11-06 17:44:48 +01:00
u8 downArrowDelay:5;
u8 downArrowYPosIdx:2;
2021-10-30 22:47:37 +02:00
bool8 hasFontIdBeenSet:1;
2018-11-06 18:30:21 +01:00
u8 autoScrollDelay;
2017-09-22 05:43:13 +02:00
};
2018-11-06 17:44:48 +01:00
struct TextPrinterTemplate
2017-09-26 22:39:59 +02:00
{
const u8 *currentChar;
2017-09-23 03:26:37 +02:00
u8 windowId;
u8 fontId;
u8 x;
u8 y;
u8 currentX; // 0x8
u8 currentY;
u8 letterSpacing;
u8 lineSpacing;
u8 unk:4; // 0xC
2018-01-25 22:25:35 +01:00
u8 fgColor:4;
2017-09-23 03:26:37 +02:00
u8 bgColor:4;
u8 shadowColor:4;
};
2017-03-07 14:44:41 +01:00
struct TextPrinter
{
2018-11-06 17:44:48 +01:00
struct TextPrinterTemplate printerTemplate;
2017-09-06 17:19:08 +02:00
2018-11-06 17:44:48 +01:00
void (*callback)(struct TextPrinterTemplate *, u16); // 0x10
2017-09-06 17:19:08 +02:00
2020-05-21 04:07:49 +02:00
u8 subStructFields[7]; // always cast to struct TextPrinterSubStruct... so why bother
2018-11-05 21:42:12 +01:00
u8 active;
2017-03-07 14:44:41 +01:00
u8 state; // 0x1C
2018-11-05 21:42:12 +01:00
u8 textSpeed;
2017-03-07 14:44:41 +01:00
u8 delayCounter;
u8 scrollDistance;
u8 minLetterSpacing; // 0x20
u8 japanese;
2017-03-07 14:44:41 +01:00
};
struct FontInfo
{
u16 (*fontFunction)(struct TextPrinter *x);
u8 maxLetterWidth;
u8 maxLetterHeight;
u8 letterSpacing;
u8 lineSpacing;
u8 unk:4;
2018-01-25 22:25:35 +01:00
u8 fgColor:4;
2017-03-07 14:44:41 +01:00
u8 bgColor:4;
u8 shadowColor:4;
};
2017-09-22 05:43:13 +02:00
extern const struct FontInfo *gFonts;
2017-09-18 23:48:47 +02:00
struct GlyphWidthFunc
{
2018-11-06 18:30:21 +01:00
u32 fontId;
2017-03-28 02:30:49 +02:00
u32 (*func)(u16 glyphId, bool32 isJapanese);
};
2017-09-22 05:43:13 +02:00
typedef struct {
2018-11-06 18:30:21 +01:00
bool8 canABSpeedUpPrint:1;
bool8 useAlternateDownArrow:1;
bool8 autoScroll:1;
bool8 forceMidTextSpeed:1;
2017-09-22 05:43:13 +02:00
} TextFlags;
2021-03-29 18:20:00 +02:00
struct TextGlyph
2018-11-05 21:42:12 +01:00
{
2021-03-29 18:20:00 +02:00
u32 gfxBufferTop[16];
u32 gfxBufferBottom[16];
2020-10-21 10:26:45 +02:00
u8 width;
u8 height;
2018-11-05 21:42:12 +01:00
};
2017-09-22 05:43:13 +02:00
extern TextFlags gTextFlags;
2021-03-29 18:20:00 +02:00
extern u8 gDisableTextPrinters;
extern struct TextGlyph gCurGlyph;
2017-09-22 05:43:13 +02:00
void DeactivateAllTextPrinters(void);
2018-11-06 17:44:48 +01:00
u16 AddTextPrinterParameterized(u8 windowId, u8 fontId, const u8 *str, u8 x, u8 y, u8 speed, void (*callback)(struct TextPrinterTemplate *, u16));
bool16 AddTextPrinter(struct TextPrinterTemplate *template, u8 speed, void (*callback)(struct TextPrinterTemplate *, u16));
2017-03-28 06:20:55 +02:00
void RunTextPrinters(void);
2017-09-18 23:48:47 +02:00
bool16 IsTextPrinterActive(u8 id);
2017-03-28 06:20:55 +02:00
void GenerateFontHalfRowLookupTable(u8 fgColor, u8 bgColor, u8 shadowColor);
void SaveTextColors(u8 *fgColor, u8 *bgColor, u8 *shadowColor);
void RestoreTextColors(u8 *fgColor, u8 *bgColor, u8 *shadowColor);
2018-11-21 23:30:04 +01:00
void DecompressGlyphTile(const void *src_, void *dest_);
2017-03-28 06:20:55 +02:00
void CopyGlyphToWindow(struct TextPrinter *x);
void ClearTextSpan(struct TextPrinter *textPrinter, u32 width);
2018-02-09 03:00:28 +01:00
u8 GetMenuCursorDimensionByFont(u8, u8);
2017-03-28 06:20:55 +02:00
void TextPrinterInitDownArrowCounters(struct TextPrinter *textPrinter);
void TextPrinterDrawDownArrow(struct TextPrinter *textPrinter);
void TextPrinterClearDownArrow(struct TextPrinter *textPrinter);
bool8 TextPrinterWaitAutoMode(struct TextPrinter *textPrinter);
2017-09-22 05:43:13 +02:00
bool16 TextPrinterWaitWithDownArrow(struct TextPrinter *textPrinter);
bool16 TextPrinterWait(struct TextPrinter *textPrinter);
2017-03-28 06:20:55 +02:00
void DrawDownArrow(u8 windowId, u16 x, u16 y, u8 bgColor, bool8 drawArrow, u8 *counter, u8 *yCoordIndex);
2018-12-15 23:58:47 +01:00
s32 GetStringWidth(u8 fontId, const u8 *str, s16 letterSpacing);
2021-10-31 06:44:18 +01:00
u8 RenderTextHandleBold(u8 *pixels, u8 fontId, u8 *str);
2017-03-28 06:20:55 +02:00
u8 DrawKeypadIcon(u8 windowId, u8 keypadIconId, u16 x, u16 y);
u8 GetKeypadIconTileOffset(u8 keypadIconId);
u8 GetKeypadIconWidth(u8 keypadIconId);
u8 GetKeypadIconHeight(u8 keypadIconId);
void SetDefaultFontsPointer(void);
u8 GetFontAttribute(u8 fontId, u8 attributeId);
u8 GetMenuCursorDimensionByFont(u8 fontId, u8 whichDimension);
2021-10-30 22:47:37 +02:00
// braille.c
u16 FontFunc_Braille(struct TextPrinter *textPrinter);
u32 GetGlyphWidth_Braille(u16 glyphId, bool32 isJapanese);
2019-03-02 09:18:08 +01:00
2017-01-14 20:53:20 +01:00
#endif // GUARD_TEXT_H