1.1.0 • Published 8 years ago

@smallstoneapps/font-loader v1.1.0

Weekly downloads
1
License
MIT
Repository
github
Last release
8 years ago

Font Loader Build Status npm (scoped) MIT License

Pebble library to do lazy loading of fonts from resources.

Installation

You must be using Pebble SDK 3.12 or newer to use this library.

To install the package to your app, use the pebble tool:

pebble package install @smallstoneapps/font-loader

What does it do?

Font Loader will automatically load fonts when they are needed, rather than having to handle the loading of them yourself.

It also allows you to create string aliases for the fonts, so you don't have to refer to them by their resource ID which will change if you alter the font size.

Usage

// This is not a complete example, but should demonstrate the basic usage of Font Loader.

static void init(void) {
  fonts_init();
  fonts_assign("example_font", RESOURCE_ID_FONT_EXAMPLE_24);
}

static void deiinit(void) {
  fonts_cleanup();
}

static void window_load(Window* window) {
  text_layer_set_font(text_layer, fonts_get_font(RESOURCE_ID_FONT_EXAMPLE_32));
  GFont font = fonts_get_font_by_name("example font");
}

You can also look at the demo app to see the library in action.

Tests

Font Loader has very minimal (and currently broken) tests, that you can run using ./run-tests.sh.

Function Documentation

Initialise the Font Loader library.

void fonts_init(void);

Assign a string name to a font resource ID.

bool fonts_assign(char* name, uint32_t res_id);

Returns the font as specified by a resource ID. If the font has not been requested before, it will be loaded.

GFont fonts_get_font(uint32_t res_id);

Returns the font as specified by the name you assigned. If the font has not been requested before, it will be loaded.

GFont fonts_get_font_by_name(char* name);

Unload all the fonts from memory.

void fonts_cleanup(void);
1.1.0

8 years ago

1.0.1

8 years ago

1.0.0

8 years ago