# verdant
[](https://crates.io/crates/verdant)
[](https://docs.rs/verdant)
<img width="800" height="462" alt="boids" src="https://github.com/user-attachments/assets/50e31e90-9e4b-4cf3-8702-e27c5dd8bfd2" />
*See [boids.rs](examples/boids.rs)*
<img width="800" height="820" alt="clock" src="https://github.com/user-attachments/assets/1841ac1d-d3e1-4efc-b5d9-b8186a67dc53" />
*See [clock.rs](examples/clock.rs)*
<img width="800" height="467" alt="verdant paint" src="https://github.com/user-attachments/assets/2a791f8a-c498-4676-bb05-6e68d398debd" />
*See [paint.rs](examples/paint.rs)*
> Verdant is a work-in-progress. The API may change at any time.
---
## What is Verdant?
Verdant is a rendering and windowing library for Rust.
Built on top of `wgpu` and `winit`, Verdant focuses on a clean, expressive, and easy-to-use API that makes common rendering tasks easy and difficult mistakes hard to make.
```rust
use verdant::{Renderer, RendererResult, WindowEvent, canvas::RenderSurface, rgb, shapes::{Drawable, Rect}};
fn main() -> RendererResult<()> {
// initialize the renderer and create a window
let mut renderer = Renderer::new()?;
let window = renderer.create_window("verdant hello world", 800, 600);
// main drawing loop
// `is_running` returns true while there is at least one window open
while renderer.is_running() {
// poll for events...
for (id, event) in renderer.poll() {
// ...handling window closing
if event == WindowEvent::CloseRequested {
renderer.close_window(id);
}
}
// start drawing by getting a window
if let Some(window) = renderer.get_window(window) {
// clearing the background to a neutral color
window.background(rgb(0.15, 0.15, 0.15));
// and drawing a circle
window.fill(rgb(0.8, 0.3, 0.3));
window.ellipse(400., 300., 100., 100.);
}
// and finishing off the frame by flushing all draw commands to the GPU
renderer.flush()?;
}
Ok(())
}
```
Verdant aims to be performant and powerful, while still remaining lightweight and nice to use.
---
## Why Verdant?
### SDF-based rendering
Almost all Verdant primitives are rendered using SDFs (signed-distance-fields).
This allows for your graphics to have perfect anti-aliasing and rounding, at any scale, while remaining efficient.
### Multiple windows are first-class
Most graphics libraries start with a single window and treat additional windows as an advanced feature.
Verdant easily and cleanly supports multiple windows, built into the API since day one.
*See [multi_window.rs](examples/multi_window.rs)*
### Scoped state
Most graphics libraries have functions like `push_state` and `pop_state`.
This is powerful, but it can lead to mistakes where state is leaked out of the context where you need it.
Verdant prevents this by providing scoped state through closures.
*See [scoped_state.rs](examples/scoped_state.rs)*
### Pick your API
Verdant doesn't force you to stick to a state machine API or a more "retained" builder pattern API, instead allowing you to choose between either one.
*See [drawing.rs](examples/drawing.rs)*
### Rich text
Verdant provides both a basic text API and a rich text API, allowing you to mix fonts, colors, sizes, and styles, all in a single function call.
*See [rich_text.rs](examples/rich_text.rs)*
<img width="753" height="255" alt="image" src="https://github.com/user-attachments/assets/859c9eff-11d6-4048-8791-f4cc7e25a23a" />
### Canvases are first-class
Verdant allows you to render to off-screen surfaces just as easily as rendering to a window.
*See [canvas.rs](examples/canvas.rs) and [paint.rs](examples/paint.rs)*
### Views and coordinate systems
Verdant allows you to define a logical rendering space, independent of the physical window size.
This allows you to create scalable applications without having to manually handle aspect-ratio math.
*See [views.rs](examples/views.rs)*
<img width="1299" height="891" alt="image" src="https://github.com/user-attachments/assets/a28250a2-8b80-4e34-84d1-e130cae74957" />
---
## Installation
Add this to your `Cargo.toml`:
```toml
[dependencies]
verdant = "0.4"
```
Currently, Verdant only supports desktop, though web/mobile support is planned soon.
(Windows and Linux have been tested, and macOS is currently untested)
### Cargo Features
By default, Verdant includes `image` and `text` features. If you don't need asset loading and/or text and want a lighter dependency tree, you can disable them:
```toml
[dependencies]
verdant = { version = "0.4", default-features = false }
```
### Running the Examples
To try out the examples locally, clone the repository and run them using Cargo:
```sh
git clone https://github.com/grimtin10/verdant.git
cd verdant
cargo run --example boids --release
cargo run --example clock --release
```
## Feedback
For any feedback on the API or for feature requests, please go to the [issues page](https://github.com/grimtin10/verdant/issues).
## License
Verdant is licensed under MPL-2.0.
Applications built with Verdant may be distributed under any license.
Only modifications to Verdant itself are required to remain MPL-licensed.