MSDF Toolkit
Higher-level toolkit for MSDF text rendering
About
MSDF - an abbreviation of Multi-channel Signed Distance Field.
In short, an efficient way for rendering text on screen, based on deserializing
data map which contains various informations for mapping glyphs in produced texture atlas.
If you want to read more about MSDF, read Valve's paper or msdfgen author's thesis.
Features
msdf-toolkit
provides an interface for users to let them
easly serialize TrueType fonts into .*msdf
(RON) & generate texture atlas (*.png
)
Not yet implemented
- Serializer:
- serialize
.tff
from path - save serialized data as
*.msdf
in RON format
- serialize
- Deserializer:
- deserialize
*.msdf
from path - expose deserialized data to the user
- deserialize
- Renderer:
- pack glyphs into font-atlas in
*.png
format
- pack glyphs into font-atlas in
Contributing
Pre-commit
Before you commit changes, it's good practice to run formatter & linter locally:
$ cargo fmt --all
$ cargo clippy -- -D warnings
Commits
Note that msdf-toolkit
uses Conventional Commits for clean history & future changelog generation.
License
msdf-toolkit
is licensed under Apache License 2.0, see LICENSE for more info.