From 6a1100b611a24eea78d1f7bd83cedcf3fd47b8c9 Mon Sep 17 00:00:00 2001 From: Daniel Collin Date: Fri, 6 Jun 2014 18:16:01 +0200 Subject: [PATCH] Updated README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6599184..759a7c3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -minifb +MinFB ====== MiniFB is a small cross platform library that makes it easy to render (32-bit) pixels in a window. An example is the best way to show how it works: @@ -21,7 +21,7 @@ MiniFB is a small cross platform library that makes it easy to render (32-bit) p mfb_close(); -First the code creates window with the mfb_open call that is used to display the data, next it's the applications resposiblity to allocate a buffer (which has to be at least the size of the window and in 32-bit) Next when calling mfb_update function the buffer will be copied over to the window and displayed. Currently the mfb_update will return -1 if ESC key is pressed but later on it will support to return a key code for a pressed button. +First the code creates window with the mfb_open call that is used to display the data, next it's the applications resposiblity to allocate a buffer (which has to be at least the size of the window and in 32-bit) Next when calling mfb_update function the buffer will be copied over to the window and displayed. Currently the mfb_update will return -1 if ESC key is pressed but later on it will support to return a key code for a pressed button. See https://github.com/emoon/minifb/blob/master/tests/noise.c for a complete example MiniFB has been tested on Windows, Mac OS X and Linux but may of course have trouble depending on your setup. Currently the code will not do any converting of data if not a proper 32-bit display can be created.