No description
Find a file
Lukas Kalbertodt 87e742047d Add debug impls (#56)
* Add missing `Debug` impls to public types

In one case, a missing Clone and Copy impl was added, too.

* Remove several `doc(hidden)` & make some modules private

I'm not quite sure why it was done the way it was. This change makes
items that were used in the public API visible in the documentation. It
also makes modules not used in the public API private.

* Add `#![deny(missing_debug_implementations)]` to crate root
2018-08-10 09:14:14 +02:00
examples Implemented bounds checking for update_with_buffer 2017-08-11 12:41:24 +02:00
src Add debug impls (#56) 2018-08-10 09:14:14 +02:00
.gitignore Initial version 2015-11-22 18:55:38 +01:00
.travis.yml Fix Travis-CI build (#43) 2017-10-04 06:45:19 +02:00
appveyor.yml Merge from mouse-support 2016-01-29 20:16:00 +01:00
appveyor_rust_install.ps1 Merge from mouse-support 2016-01-29 20:16:00 +01:00
build.rs Updated gcc -> cc 1.0 2018-05-18 21:58:55 +02:00
Cargo.toml Bump to 0.10.6 2018-05-18 22:14:53 +02:00
CHANGELOG.md Bump to 0.10.6 2018-05-18 22:14:53 +02:00
LICENSE Initial version 2015-11-22 18:55:38 +01:00
LICENSE-APACHE Re-licence under MIT/Apache-2.0 2016-01-10 18:36:57 +01:00
LICENSE-MIT Re-licence under MIT/Apache-2.0 2016-01-10 18:36:57 +01:00
README.md Bump to 0.10.6 2018-05-18 22:14:53 +02:00

Crates.io Build Status Build Status Documentation

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. An example is the best way to show how it works:

Changelog

Usage

# Cargo.toml
[dependencies]
minifb = "0.10.6"

Example

extern crate minifb;

use minifb::{Key, WindowOptions, Window};

const WIDTH: usize = 640;
const HEIGHT: usize = 360;

fn main() {
    let mut buffer: Vec<u32> = vec![0; WIDTH * HEIGHT];

    let mut window = Window::new("Test - ESC to exit",
                                 WIDTH,
                                 HEIGHT,
                                 WindowOptions::default()).unwrap_or_else(|e| {
        panic!("{}", e);
    });

    while window.is_open() && !window.is_key_down(Key::Escape) {
        for i in buffer.iter_mut() {
            *i = 0; // write something more funny here!
        }

        // We unwrap here as we want this code to exit if it fails. Real applications may want to handle this in a different way
        window.update_with_buffer(&buffer).unwrap();
    }
}

Status

Currently Mac, Redox, Linux and Windows (64-bit and 32-bit) are the current supported platforms. X11 (Linux/FreeBSD/etc) support has been tested on Ubuntu (x64). Bug report(s) for other OSes/CPUs are welcome!

Build instructions

cargo build
cargo run --example noise

This will run the noise example which should look something like this (Mac screenshot)

mac_screenshot

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.