|Jens Pitkänen f9647c314d Update default deps, remove tests, overall cleanup||1 month ago|
|examples||6 months ago|
|src||1 month ago|
|.gitignore||8 months ago|
|Cargo.lock||6 months ago|
|Cargo.toml||1 month ago|
|LICENSE.md||11 months ago|
|README.md||1 month ago|
|build.rs||9 months ago|
Fae is a simple, performant and compatible 2D rendering crate with
optional window creation functionality and text rendering. Its main
design goals are simplicity and performance while supporting
older/low-end target platforms. The base crate which implements the
rendering functions only depends on OpenGL and std. Optional features
exist for ttf rendering and window creation,
glfw respectively. The crate supports OpenGL 2.1+ and
OpenGL ES 2.0+ contexts, but will do some optimizations if a 3.3 or ES
3.0 context is available.
The crate is currently under development, and I wouldn’t recommend it for any kind of usage yet. Especially since the API is currently oriented so it fits the backend of the crate, instead of being easy to use, and that will definitely change in the future. It’s on crates.io mostly so I don’t have to come up with another name :)
windowmod, which allows for easy window creation using glutin, with all the required OpenGL context wrangling done for you. This is enabled by default.
textmod, which has functionality for drawing strings. Fonts are provided in the form of .ttf files shipped with your application. The glyph rendering is done by
rusttype, which this feature adds as a dependency, as well as
unicode-normalization. A lightweight version of this feature is planned, where you can use bitmap fonts to conserve executable size and performance. This is enabled by default.
Image::from_pngfunction, which allows you to load images from PNG data. This is a very convenient feature, but not necessarily a requirement for using the crate, so it’s optional. This is enabled by default.
flamein your own application that uses
fae, but don’t want the
faeprofiling information, use
The GLFW feature exists as an option since the examples built with it are about 0.5x the size of the executables built with glutin (on Linux, Windows has no benefit and I don’t think macOS has either), but I wouldn’t recommend it. Glutin is better in almost all ways: better HiDPI support, less CPU utilization, and it’s written in Rust.
FAE_OPENGL_LEGACYenvironment variable. This is intended for making sure that builds work in both legacy and modern modes, though of course, if there are visual differences between the modes (aside from fps), they should be considered a bug in this crate. Make an issue! Example usage:
sh FAE_OPENGL_LEGACY=1 cargo run
If you come across bugs, other issues or feature requests, feel free to open an issue on GitHub. Pull requests are welcome as well, though keep in mind that this is supposed to be a relatively minimalistic crate, so I probably won’t include any considerable new functionality. If in doubt, open an issue!
fae crate is distributed under the MIT license.