# bgfx-rs

![Maintenance status](https://img.shields.io/badge/maintenance-looking--for--maintainer-yellow.svg)

Notice that this project is looking for a maintainer. If you are interested in maintaining this project, please open an issue.

## Bindings for BGFX

Rust bindings to [bgfx](https://github.com/bkaradzic/bgfx), a cross-platform, graphics API agnostic, "Bring Your Own Engine/Framework" style rendering library.

## Why another wrapper?

While this [wrapper](https://github.com/rhoot/bgfx-rs) for Rust exists, the code here takes a different approach and generate high-level bindings from the BGFX API [def](https://github.com/bkaradzic/bgfx/blob/master/scripts/bgfx.idl) instead which will allow easier updating of the bindings once the API changes with much reduced work.
In some cases there will be manual implementation where it makes sense to provide more ergonomic Rust code where auto-generation is difficult.

## Status

The crate is not being developed actively. 

Usage
-----

```toml
# Cargo.toml
[dependencies]
bgfx-rs = "0.20"
```

The library doesn't include any window handling and that has to be provided by the user. See [examples](https://github.com/emoon/bgfx-rs/tree/main/examples) an how to use [GLFW](https://crates.io/crates/glfw)

## License

Licensed under [BSD 2-Clause](https://bkaradzic.github.io/bgfx/license.html) to keep the license the same the BGFX code.