From cd1fbab4e99969a2328063eb2ec1ff1238ebe39e Mon Sep 17 00:00:00 2001 From: Joshua Moerman Date: Sat, 15 Sep 2012 17:12:45 +0200 Subject: [PATCH] updated readme --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ecfa652..1d8c41c 100644 --- a/README.md +++ b/README.md @@ -7,21 +7,33 @@ Some time ago I had a project where I rendered something to a high quality buffe Features -------- -* Output streams for bmp and png image files +* Output streams for bmp, png and jpg image files * Grayscale and color * Low memory usage (because it streams) * Easy to use -Uasge +Usage ----- ```C++ png::gray_ostream image(1024, 768, "test.png"); for(int y = 0; y < 768; ++y){ for(int x = 0; x < 1024; ++x){ - image << png::gray_ostream::pixel(some_generation(x,y)); + image << png::gray_ostream::pixel(some_generator(x,y)); } } -// done, image is automatically saved (wtih RAII) +// done, image is automatically saved (with RAII) ``` -There are more examples in the main.cpp file. \ No newline at end of file +There are more examples in the main.cpp file. + +Dependencies +------------ +For the png format libpng is required. For the jpg format libjpeg or libjpeg-turbo is required. The bmp format does not depend on anything, so you can output images without other libraries :D. + +TODO +---- +* Make output iterators +* Add alpha support (where possible) +* Some interface for parameters (eg. jpg quality) +* Add appropriate license +* Really make it a library (ie. restructure directories)