This project is part of the @thi.ng/umbrella monorepo.
Multi-channel SDF font rendering & basic text layout for WebGL. This is a support package for @thi.ng/webgl.
This package provides multi-channel SDF font rendering capabilities for @thi.ng/webgl, incl. optional support for basic text alignment, vertex colors (e.g. for multi-color text), and shader options to draw outlines for each character. Furthermore, the key GLSL functions are provided as shader snippets to embed this functionality in custom shaders without having to resort to copy & paste.
There're different versions of MSDF font generators. The format supported by this module is based on Don McCurdy's.
STABLE - used in production
yarn add @thi.ng/webgl-msdf
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/webgl-msdf?module" crossorigin></script>
// UMD
<script src="https://unpkg.com/@thi.ng/webgl-msdf/lib/index.umd.js" crossorigin></script>
Package sizes (gzipped, pre-treeshake): ESM: 1.48 KB / CJS: 1.52 KB / UMD: 1.59 KB
- @thi.ng/api
- @thi.ng/shader-ast
- @thi.ng/transducers
- @thi.ng/vector-pools
- @thi.ng/vectors
- @thi.ng/webgl
Several demos in this repo's /examples directory are using this package.
A selection:
Screenshot | Description | Live demo | Source |
---|---|---|---|
WebGL MSDF text rendering & particle system | Demo | Source |
TODO
Karsten Schmidt
© 2019 - 2020 Karsten Schmidt // Apache Software License 2.0