spf 0.6.0

.spf (Simple Pixel Font) file parsing, and useful api's to go alongside.
Documentation

SimplePixelFont - spf.rs stars - spf.rs forks - spf.rs Rust GitHub tag License issues - spf.rs Codecov Documentationcov

A very simple and concrete parser library for the SimplePixelFont file specifications, written in Rust. spf.rs is both a native crate and also an FFI library which can be used in a variety of other programming languages which support library loading. spf.rs is additionally shipped with features/modules to help integration be faster and easier for you next pixelated project.

Installation

  • To install spf.rs as a rust crate run the following command in your cargo project or read more:
cargo add spf
  • To use spf.rs as an FFI library in your language of choice you must first download a pre-built library artifact of spf.rs from the releases section which includes the dynamic library along with a header file. Pre-built artifacts are available for many architectures, however if there is no build for your architecture-including embedded devices-you can compile spf.rs from source.

Usage

Usage varies depending on the programming language you choose. For a guide using the native Rust interface check out the Getting Started in Rust article. You can also check out the Using the FFI in C article for usage with the spf.rs library.

Supported SPF Header Properties

Flag Type Stability Notes
Constant Cluster Codepoints Configuration Added in v0.5
Constant Width Configuration Added in v0.5
Constant Height Configuration Added in v0.5
Custom Bits Per Pixel Configuration Added in v0.6
Compact Modifier Added in v0.4

Key:

  • ⚠️ = Work in progress
  • = Not implemented
  • = Stable