Skip to content

FrankenApps/meshtext

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Meshtext

Crates.io docs.rs

Meshtext is a font triangulation tool for 3D scenes.

⚠️ Versions <= 0.3 of this crate focus on correctness and less on speed. ⚠️

The idea is to have a feature complete Proof-of-Concept first and then start optimizing.

Features

  • Generates indexed or non-indexed meshes
  • Automatically caches glyphs (also supports preloading)
  • Flat 2D text (in 3D space) or 3D text
  • Supports custom transformation of text sections

Limitations

  • Linebreaks and wrapping must be handled manually
  • Does not support bevels, because there is only one depth segment
  • There is no support for subscripts and superscripts

TODO

  • Add a 2D mesh generator where each vertex is composed of two coordinates
  • Implement an optimizer that removes redundant vertices and triangles
  • Add proper benchmarks
  • Optimize for speed
  • Evaluate no-std support

Caveats

It is not recommended to use the font included in the crate. It is only included for the purpose of testing and the character set has been limited, in order to keep the size of the crate small.

Cargo Features

Name Description
owned Uses owned_ttf_parser instead of ttf-parser so that the font resources do not need to have a static lifetime.

Attribution

  • Depends heavily on cdt for triangulation.
  • Uses ttf-parser for font loading.
  • Uses glam for performing basic linear algebra.

License

All code in this repository is dual-licensed under either:

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Screenshot

Meshtext Logo