Expand description
Fae is a small 2D graphics rendering crate, with the main intended use-case being 2D games. Its main goals are simplicity, performance, and compatiblity.
Modules§
- errors
- The errors that fae can return.
- gl
- OpenGL functions and constants.
- profiler
- Module for reading the profiling data that
fae
collects. If theprofiler
feature is disabled, all the functions are no-ops, and there will be no profiling overhead. Probably not very useful outside of this crate’s development.
Structs§
- Alpha
Blending - Describes how a spritesheet should be blended with the background.
- Context
- The overarching state of the crate. Intended to live outside of the main game loop.
- Font
- Holds a font for rendering. See also:
Font::draw
. - Graphics
Context - Draw stuff on the screen with this.
- Image
- Contains the raw pixel color data of an image.
- Rect
- Represents a rectangle.
- Shader
Pair - Contains the code for a vertex shader and a fragment shader.
- Shaders
- Contains the shader code for a spritesheet.
- Sprite
- Sprite builder struct. Call
finish
to draw the sprite. - Spritesheet
- Holds a texture for rendering.
- Spritesheet
Builder - A builder for
Spritesheet
. - Text
- Text builder struct. Call
finish
to draw the text.
Enums§
- Alignment
- Defines the alignment of text.
- Error
- A generic error type that wraps fae’s other error types in the
fae::errors
module. - Open
GlApi - Represents the two different variants of OpenGL.
- Open
GlVersion - Represents the parsed version of the OpenGL version string.
- Texture
Wrapping - Describes how textures are wrapped.