emoon / rust_minifb

Cross platfrom window and framebuffer crate for Rust
MIT License
1k stars 95 forks source link

Document features #303

Open griffi-gh opened 1 year ago

griffi-gh commented 1 year ago

currently all crate features are undocumented.

emoon commented 1 year ago

The readme states:

minifb is a cross platform library written in Rust and that makes it easy to setup a window and to (optional) display a 32-bit pixel buffer. It also makes it easy to get input from keyboard and mouse.

And the public API is documented here https://docs.rs/minifb/latest/minifb/struct.Window.html So I'm sure I understand when you state that all features are undocumented? The API doc shows what you can do.

griffi-gh commented 1 year ago

crate feature flags, for example what is dlopen for and what does it change in the context of this crate