Font Struct Reference

TrueType fonts. More...

#include <Font.h>

Inheritance diagram for Font:

Public Member Functions
Class *	_Font (void)
	The Font archetype. More...
Font *	cachedFont (const char *family, int size, int style)
	Resolves the cached Font with the given attributes. More...
void	cacheFont (Data *data, const char *family)
void	clearCache (void)
	Clears the Font cache. More...
Font *	defaultFont (void)
Font *	initWithData (Font *self, Data *data, const char *family, int size, int style)
	Initializes this Font with the given TTF Data and attributes. More...
Font *	initWithData (Font *self, Data *data, int size, int index)
void	renderCharacters (const Font *self, const char *chars, SDL_Color color, int wrapWidth)
	Renders the given characters in this Font. More...
void	renderDeviceDidReset (Font *self)
	This method should be invoked when the render context is invalidated. More...
void	sizeCharacters (const Font *self, const char *chars, int *w, int *h)

Data Fields
Data *	data
	The raw font data. More...
char *	family
	The family name. More...
ident	font
	The backing font. More...
Object	object
	The superclass. More...
int	renderSize
	The render size, adjusted for display density. More...
int	size
	The point size. More...
int	style
	The style. More...

Static Public Attributes
void(*	cacheFont )(Data *data, const char *family)
	Caches the specified font Data. More...

Protected Attributes
FontInterface *	interface
	The interface. More...

Detailed Description

TrueType fonts.

Definition at line 63 of file Font.h.

Member Function Documentation

_Font()

Class * _Font

(

void

)

The Font archetype.

Returns

The Font Class.

Definition at line 353 of file Font.c.

                   {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "Font",
            .superclass = _Object(),
            .instanceSize = sizeof(Font),
            .interfaceOffset = offsetof(Font, interface),
            .interfaceSize = sizeof(FontInterface),
            .initialize = initialize,
            .destroy = destroy,
        });
    });
 
    return clazz;
}

cachedFont()

Font * cachedFont	(	const char *	family,
		int	size,
		int	style
	)

Resolves the cached Font with the given attributes.

Parameters

family	The family.
size	The size.
style	The style.

Returns

The cached Font, or the default Font if not found.

Definition at line 124 of file Font.c.

                                                                 {
 
    if (family == NULL) {
        family = DEFAULT_FONT_FAMILY;
    }
    if (size < 1) {
        size = DEFAULT_FONT_SIZE;
    }
    if (style < FontStyleRegular || style > FontStyleStrikeThrough) {
        style = DEFAULT_FONT_STYLE;
    }
 
    const int renderSize = size * MVC_WindowScale(NULL, NULL, NULL);
 
    const Array *fonts = (Array *) _fonts;
    for (size_t i = 0; i < fonts->count; i++) {
 
        Font *font = $(fonts, objectAtIndex, i);
 
        if (!strcmp(font->family, family) &&
                font->size == size &&
                font->style == style &&
                font->renderSize == renderSize) {
            return font;
        }
    }
 
    Data *data = $((Dictionary *) _cache, objectForKeyPath, family);
    if (data) {
        Font *font = $(alloc(Font), initWithData, data, family, size, style);
        assert(font);
 
        $(_fonts, addObject, font);
        release(font);
 
        return font;
    }
 
    MVC_LogWarn("%s-%d-%d not found\n", family, size, style);
    return $$(Font, defaultFont);
}

cacheFont()

void cacheFont	(	Data *	data,
		const char *	family
	)

Definition at line 116 of file Font.c.

                                                      {
    $(_cache, setObjectForKeyPath, data, family);
}

clearCache()

void clearCache

(

void

)

Clears the Font cache.

Definition at line 170 of file Font.c.

                             {
    $(_cache, removeAllObjects);
}

defaultFont()

Font * defaultFont

(

void

)

omg *

Returns

The default Font.

Definition at line 178 of file Font.c.

                               {
    static Once once;
 
    do_once(&once, {
        Data *data = $(alloc(Data), initWithConstMemory, coda_ttf, coda_ttf_len);
        assert(data);
 
        $$(Font, cacheFont, data, DEFAULT_FONT_FAMILY);
 
        release(data);
    });
 
    return $$(Font, cachedFont, DEFAULT_FONT_FAMILY, DEFAULT_FONT_SIZE, DEFAULT_FONT_STYLE);
}

initWithData() [1/2]

Font * initWithData	(	Font *	self,
		Data *	data,
		const char *	family,
		int	size,
		int	style
	)

Initializes this Font with the given TTF Data and attributes.

Parameters

self	The Font.
data	The Data.
family	The family.
size	The size.
style	The style.

Returns

The initialized Font, or NULL on error.

Definition at line 197 of file Font.c.

                                                                                           {
 
    self = (Font *) super(Object, self, init);
    if (self) {
 
        self->data = retain(data);
        assert(self->data);
 
        self->family = strdup(family);
        assert(self->family);
 
        self->size = size;
        assert(self->size);
 
        self->style = style;
 
        $(self, renderDeviceDidReset);
    }
 
    return self;
}

initWithData() [2/2]

Font * initWithData	(	Font *	self,
		Data *	data,
		int	size,
		int	index
	)

renderCharacters()

void renderCharacters	(	const Font *	self,
		const char *	chars,
		SDL_Color	color,
		int	wrapWidth
	)

Renders the given characters in this Font.

Parameters

self	The Font.
chars	The null-terminated UTF-8 encoded C string to render.
color	The color.
wrapWidth	The maximum line width, in pixels, where wrapping should occur.

Returns

The rendered surface, or NULL on error.

Definition at line 223 of file Font.c.

                                                                                                          {
 
    SDL_Surface *surface;
    if (wrapWidth) {
        surface = TTF_RenderUTF8_Blended_Wrapped(self->font, chars, color, wrapWidth * MVC_WindowScale(NULL, NULL, NULL));
    } else {
        surface = TTF_RenderUTF8_Blended(self->font, chars, color);
    }
 
    SDL_Surface *converted = NULL;
    if (surface) {
        converted = SDL_ConvertSurfaceFormat(surface, SDL_PIXELFORMAT_RGBA32, 0);
        SDL_FreeSurface(surface);
    } else {
        MVC_LogError("%s\n", TTF_GetError());
    }
 
    return converted;
}

renderDeviceDidReset()

void renderDeviceDidReset

(

Font *

self

)

This method should be invoked when the render context is invalidated.

Parameters

self

The Font.

Definition at line 247 of file Font.c.

                                             {
 
    const int renderSize = self->size * MVC_WindowScale(NULL, NULL, NULL);
    if (renderSize != self->renderSize) {
 
        self->renderSize = renderSize;
 
        if (self->font) {
            TTF_CloseFont(self->font);
        }
 
        SDL_RWops *buffer = SDL_RWFromConstMem(self->data->bytes, (int) self->data->length);
        assert(buffer);
 
        self->font = TTF_OpenFontRW(buffer, 1, self->renderSize);
        assert(self->font);
 
        TTF_SetFontStyle(self->font, self->style);
    }
}

sizeCharacters()

void sizeCharacters	(	const Font *	self,
		const char *	chars,
		int *	w,
		int *	h
	)

Parameters

self	The Font.
chars	The null-terminated UTF-8 encoded C string to size.
w	The width to return.
h	The height to return.

Returns

The size of the rendered characters in pixels.

Definition at line 272 of file Font.c.

                                                                                {
 
    if (w) {
        *w = 0;
    }
    if (h) {
        *h = 0;
    }
 
    if (chars) {
        char *lines = strdup(chars);
 
        for (char *line = strtok(lines, "\n\r"); line; line = strtok(NULL, "\n\r")) {
 
            int line_w, line_h;
            TTF_SizeUTF8(self->font, line, &line_w, &line_h);
 
            if (w) {
                *w = max(*w, line_w);
            }
            if (h) {
                *h += line_h;
            }
        }
        free(lines);
 
        const float scale = MVC_WindowScale(NULL, NULL, NULL);
        if (w) {
            *w = ceil(*w / scale);
        }
        if (h) {
            *h = ceil(*h / scale);
        }
    }
}

Field Documentation

cacheFont

void(* cacheFont) (Data *data, const char *family)

static

Caches the specified font Data.

Parameters

data	The TTF Data.
family	The family.

Definition at line 136 of file Font.h.

data

Data* Font::data

The raw font data.

Definition at line 79 of file Font.h.

family

char* Font::family

The family name.

Definition at line 84 of file Font.h.

font

ident Font::font

The backing font.

Definition at line 89 of file Font.h.

interface

FontInterface* Font::interface

protected

The interface.

Definition at line 74 of file Font.h.

object

Object Font::object

The superclass.

Definition at line 68 of file Font.h.

renderSize

int Font::renderSize

The render size, adjusted for display density.

Definition at line 94 of file Font.h.

size

int Font::size

The point size.

Definition at line 99 of file Font.h.

style

int Font::style

The style.

Definition at line 104 of file Font.h.

---

The documentation for this struct was generated from the following files:

• Sources/ObjectivelyMVC/Font.h
• Sources/ObjectivelyMVC/Font.c