Fixed-width Fonts baked into a glyph sheet, drawn as one quad per glyph. More...

#include <ObjectivelyMVC/Renderer.h>
#include <ObjectivelyMVC/Types.h>

Data Structures
struct	FontBitmap
	A fixed-width Font's glyphs, baked into one sheet, drawn as one quad per glyph. More...

Macros
#define	FONT_BITMAP_COLUMNS 32
	The number of cells per row of the glyph sheet: `FONT_BITMAP_COUNT` cells make a square grid of this many columns and rows.

#define	FONT_BITMAP_COUNT 1024
	The codepoint count Font bakes into its bitmap.

#define	FONT_BITMAP_FIRST ' '
	The first codepoint Font bakes into its bitmap.

#define	FONT_BITMAP_LAST (FONT_BITMAP_FIRST + FONT_BITMAP_COUNT)
	One past the last baked codepoint in a Font bitmap (exclusive upper bound).

#define	FONT_BITMAP_REPLACEMENT '?'
	The codepoint drawn in place of one outside the baked range.

Functions
OBJECTIVELYMVC_EXPORT void	deallocBitmap (FontBitmap *bitmap)
	Releases the resources held by `bitmap`. Safe to call on a zeroed FontBitmap.

OBJECTIVELYMVC_EXPORT bool	initBitmap (FontBitmap bitmap, Font font)
	Bakes FONT_BITMAP_COUNT codepoints of `font`, from FONT_BITMAP_FIRST, into a glyph sheet, initializing `bitmap`.

OBJECTIVELYMVC_EXPORT void	renderCharactersBitmap (Font self, const Renderer renderer, const char chars, SDL_Color color, int wrapWidth, const SDL_Point origin, const ImageAtlas *icons)
	Implements Font::renderBitmapCharacters.

OBJECTIVELYMVC_EXPORT void	renderDeviceWillResetBitmap (Font *self)
	Implements Font::renderDeviceWillReset.

OBJECTIVELYMVC_EXPORT void	sizeCharactersBitmap (const Font self, const char chars, int wrapWidth, const ImageAtlas icons, int w, int *h)
	Implements Font::sizeBitmapCharacters.

Detailed Description

Fixed-width Fonts baked into a glyph sheet, drawn as one quad per glyph.

Definition in file Font+Bitmap.h.

Macro Definition Documentation

◆ FONT_BITMAP_COLUMNS

#define FONT_BITMAP_COLUMNS 32

The number of cells per row of the glyph sheet: FONT_BITMAP_COUNT cells make a square grid of this many columns and rows.

Definition at line 50 of file Font+Bitmap.h.

◆ FONT_BITMAP_COUNT

#define FONT_BITMAP_COUNT 1024

The codepoint count Font bakes into its bitmap.

Covers Basic Latin, Latin-1 Supplement, Latin Extended-A/B, and Greek and Coptic (U+0020-U+041F) – generous enough for any Latin- or Greek-script text without configuration. Individual codepoints a Font lacks a glyph for are simply skipped, not rejected, so this is safe to bake against any fixed-width face regardless of its actual coverage.

Definition at line 40 of file Font+Bitmap.h.

◆ FONT_BITMAP_FIRST

#define FONT_BITMAP_FIRST ' '

The first codepoint Font bakes into its bitmap.

Definition at line 31 of file Font+Bitmap.h.

◆ FONT_BITMAP_LAST

#define FONT_BITMAP_LAST (FONT_BITMAP_FIRST + FONT_BITMAP_COUNT)

One past the last baked codepoint in a Font bitmap (exclusive upper bound).

Definition at line 45 of file Font+Bitmap.h.

◆ FONT_BITMAP_REPLACEMENT

#define FONT_BITMAP_REPLACEMENT '?'

The codepoint drawn in place of one outside the baked range.

Definition at line 55 of file Font+Bitmap.h.

Function Documentation

◆ deallocBitmap()

OBJECTIVELYMVC_EXPORT void deallocBitmap ( FontBitmap * bitmap )

Releases the resources held by bitmap. Safe to call on a zeroed FontBitmap.

Parameters

bitmap The FontBitmap.

Definition at line 375 of file Font+Bitmap.c.

                                       {
 
  assert(bitmap);
 
  release(bitmap->texture);
 
  if (bitmap->surface) {
    SDL_DestroySurface(bitmap->surface);
  }
}

◆ initBitmap()

OBJECTIVELYMVC_EXPORT bool initBitmap	(	FontBitmap *	bitmap,
		Font *	font
	)

Bakes FONT_BITMAP_COUNT codepoints of font, from FONT_BITMAP_FIRST, into a glyph sheet, initializing bitmap.

A codepoint outside the range draws FONT_BITMAP_REPLACEMENT instead.

Parameters

bitmap	The FontBitmap, zero-initialized.
font	The Font, which MUST be fixed-width.

Returns: True if the bitmap was baked, false if font is not fixed-width or has no glyphs in the range, in which case bitmap is left zeroed.

Definition at line 322 of file Font+Bitmap.c.

                                                {
 
  assert(bitmap);
  assert(font);
 
  if (!TTF_FontIsFixedWidth(font->font)) {
    String *name = $(font, name);
    MVC_LogWarn("%s is not fixed-width\n", name->chars);
    release(name);
    return false;
  }
 
  int minX = INT_MAX, maxX = INT_MIN, advance = 0;
 
  for (Uint32 codepoint = FONT_BITMAP_FIRST; codepoint < FONT_BITMAP_LAST; codepoint++) {
 
    if (TTF_FontHasGlyph(font->font, codepoint)) {
      int glyphMinX = 0, glyphMaxX = 0, glyphAdvance = 0;
      if (!TTF_GetGlyphMetrics(font->font, codepoint, &glyphMinX, &glyphMaxX, NULL, NULL, &glyphAdvance)) {
        continue;
      }
 
      minX = min(minX, glyphMinX);
      maxX = max(maxX, max(glyphMaxX, glyphAdvance));
      advance = max(advance, glyphAdvance);
    }
  }
 
  if (maxX <= minX || advance == 0) {
    String *name = $(font, name);
    MVC_LogWarn("%s has no glyphs in U+%04X-U+%04X\n", name->chars, FONT_BITMAP_FIRST, FONT_BITMAP_LAST - 1);
    release(name);
    return false;
  }
 
  bitmap->advance = advance;
  bitmap->bearing = minX;
  bitmap->cellSize = MakeSize(maxX - minX, TTF_GetFontHeight(font->font));
 
  const int rows = FONT_BITMAP_COUNT / FONT_BITMAP_COLUMNS;
 
  bitmap->surface = SDL_CreateSurface(FONT_BITMAP_COLUMNS * bitmap->cellSize.w, rows * bitmap->cellSize.h, SDL_PIXELFORMAT_RGBA32);
  assert(bitmap->surface);
 
  SDL_FillSurfaceRect(bitmap->surface, NULL, 0);
 
  for (Uint32 i = 0; i < FONT_BITMAP_COUNT; i++) {
    initGlyph(bitmap, font->font, FONT_BITMAP_FIRST + i, i);
  }
 
  return true;
}

◆ renderCharactersBitmap()

OBJECTIVELYMVC_EXPORT void renderCharactersBitmap	(	Font *	self,
		const Renderer *	renderer,
		const char *	chars,
		SDL_Color	color,
		int	wrapWidth,
		const SDL_Point *	origin,
		const ImageAtlas *	icons
	)

Implements Font::renderBitmapCharacters.

Definition at line 452 of file Font+Bitmap.c.

                                                                                                                                                                       {
 
  assert(self);
  assert(renderer);
  assert(origin);
 
  FontBitmap *bitmap = &self->bitmap;
  assert(bitmap->surface);
 
  if (chars == NULL) {
    return;
  }
 
  if (bitmap->texture == NULL) {
    bitmap->texture = $(renderer->device, createTextureFromSurface, bitmap->surface, SDL_GPU_TEXTUREUSAGE_SAMPLER, false);
    assert(bitmap->texture);
  }
 
  RenderContext context = {
    .renderer = renderer,
    .device = renderer->device,
    .texture = bitmap->texture,
    .origin = { roundf(origin->x * self->pixelDensity), roundf(origin->y * self->pixelDensity) },
    .scale = self->pixelDensity,
  };
 
  walk(bitmap, chars, (int) (wrapWidth * context.scale), color, icons, renderToken, &context, NULL, NULL);
}

◆ renderDeviceWillResetBitmap()

OBJECTIVELYMVC_EXPORT void renderDeviceWillResetBitmap ( Font * self )

Implements Font::renderDeviceWillReset.

Definition at line 390 of file Font+Bitmap.c.

                                             {
 
  assert(self);
 
  self->bitmap.texture = release(self->bitmap.texture);
}

◆ sizeCharactersBitmap()

OBJECTIVELYMVC_EXPORT void sizeCharactersBitmap	(	const Font *	self,
		const char *	chars,
		int	wrapWidth,
		const ImageAtlas *	icons,
		int *	w,
		int *	h
	)

Implements Font::sizeBitmapCharacters.

Definition at line 485 of file Font+Bitmap.c.

                                                                                                                       {
 
  assert(self);
 
  const FontBitmap *bitmap = &self->bitmap;
  assert(bitmap->surface);
 
  int texelsW = 0, texelsH = 0;
 
  if (chars) {
    walk(bitmap, chars, (int) (wrapWidth * self->pixelDensity), Colors.White, icons, NULL, NULL, &texelsW, &texelsH);
  }
 
  if (w) {
    *w = (int) ceilf(texelsW / self->pixelDensity);
  }
  if (h) {
    *h = (int) ceilf(texelsH / self->pixelDensity);
  }
}

Data Structures

Macros

Functions