# Figures

![figures is considered alpha and unsupported](https://img.shields.io/badge/status-alpha-orange)
[![crate version](https://img.shields.io/crates/v/figures.svg)](https://crates.io/crates/figures)
[![Documentation for `main` branch](https://img.shields.io/badge/docs-main-informational)](https://khonsulabs.github.io/figures/main/figures)

A primarily integer-based 2d graphics math library.

## Inspiration

Sharp graphics are achieved by ensuring that drawing is aligned to pixel
boundaries. If a 1px-square dot is drawn at 0.99 pixels offset, the dot may look
fuzzy because its color will be shared across multiple pixels. While this can
give the illusion of subpixel imaging, it can also be undesired on high-dpi
displays.

This library embraces integer types for its data representation to allow for
predictable math to be performed without loss of precision. It supports
subdividing physical pixels into 4 subpixels, allowing for subpixel layout while
providing consistent results.

## Pixels (`Px`) and Device-Independent Pixels (`Lp`)

In this crate, a pixel (`Px`) is a single colorable location on a screen. A
display's resolution, such as 1920x1080, is its measurement in pixels. A pixel
can vary in size greatly -- a modern smartphone's display is often over 300
pixels per inch while a 23-inch 1080p monitor contains roughly 96
pixels-per-inch (ppi).

As an alternative to pixels, this crate also provides its own measurement unit:
device-independent pixels (`Lp`). This type offers many constructors using
real-world measurements that developers and designers are familiar with, and
handles converting to the display's scale for the developer.

## Project Status

This project is early in development as part of [Kludgine][kludgine] and
[Gooey][gooey]. It is considered alpha and unsupported at this time, and the
primary focus for [@ecton][ecton] is to use this for his own projects. Feature
requests and bug fixes will be prioritized based on @ecton's own needs.

If you would like to contribute, bug fixes are always appreciated. Before
working on a new feature, please [open an issue][issues] proposing the feature
and problem it aims to solve. Doing so will help prevent friction in merging
pull requests, as it ensures changes fit the vision the maintainers have for
Gooey.

[gooey]: https://github.com/khonsulabs/gooey
[kludgine]: https://github.com/khonsulabs/kludgine
[ecton]: https://github.com/khonsulabs/ecton
[issues]: https://github.com/khonsulabs/gooey/issues