ugfx/src/gdisp/mcufont/mf_bwfont.h

85 lines
2.6 KiB
C

/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.org/license.html
*/
/* Uncompressed font format for storing black & white fonts. Very efficient
* to decode and works well for small font sizes.
*/
#ifndef _MF_BWFONT_H_
#define _MF_BWFONT_H_
#include "mf_font.h"
/* Versions of the BW font format that are supported. */
#define MF_BWFONT_VERSION_4_SUPPORTED 1
/* Structure for a range of characters. */
struct mf_bwfont_char_range_s
{
/* The number of the first character in this range. */
uint16_t first_char;
/* The total count of characters in this range. */
uint16_t char_count;
/* The left and top skips of the characters in this range.
* This is the number of empty rows at left and at top. */
uint8_t offset_x;
uint8_t offset_y;
/* Column height for glyphs in this range, in bytes and pixels. */
uint8_t height_bytes;
uint8_t height_pixels;
/* Positive value if the width of all glyphs in this range is the
* same, or zero if it is not. */
uint8_t width;
/* Lookup table for the character widths. NULL if width is specified. */
const uint8_t *glyph_widths;
/* Lookup table for the character offsets. Multiply by height_bytes
* to get the byte offset. Also allows lookup of the number of columns.
* NULL if width is specified. */
const uint16_t *glyph_offsets;
/* Table for the glyph data.
* The data for each glyph is column-by-column, with N bytes per each
* column. The LSB of the first byte is the top left pixel.
*/
const uint8_t *glyph_data;
};
/* Structure for the font */
struct mf_bwfont_s
{
struct mf_font_s font;
/* Version of the font format. */
const uint8_t version;
/* Number of character ranges. */
const uint16_t char_range_count;
/* Array of the character ranges */
const struct mf_bwfont_char_range_s *char_ranges;
};
#ifdef MF_BWFONT_INTERNALS
/* Internal functions, don't use these directly. */
MF_EXTERN uint8_t mf_bwfont_render_character(const struct mf_font_s *font,
int16_t x0, int16_t y0,
uint16_t character,
mf_pixel_callback_t callback,
void *state);
MF_EXTERN uint8_t mf_bwfont_character_width(const struct mf_font_s *font,
uint16_t character);
#endif
#endif