README.rdoc in chunky_png-0.0.5 vs README.rdoc in chunky_png-0.5.0
- old
+ new
@@ -9,12 +9,12 @@
Wiki:: http://wiki.github.com/wvanbergen/chunky_png
Issue tracker:: http://github.com/wvanbergen/chunky_png/issues
== Features
-* Decodes almost any image that the PNG standard allows, except for images
- that use a different color depth than 8 bits. This includes all standard
+* Decodes almost any image that the PNG standard allows, except for images
+ that use a different color depth than 8 bits. This includes all standard
color modes and all transparency, interlacing and filtering options.
* Encodes images supports all color modes (true color, grayscale and indexed)
and transparency for all these color modes. The best color mode will be
chosen automatically, based on the image's colors.
* R/W access to the image's pixels.
@@ -24,30 +24,40 @@
The main classes used within ChunkyPNG are:
<tt>ChunkyPNG::Image</tt> :: create PNG images from scratch or based on another PNG image.
<tt>ChunkyPNG::Datastream</tt> :: low-level read and write access to PNG images from or to a file or stream.
-<tt>ChunkyPNG::PixelMatrix</tt> :: represents an images as a matrix of pixels.
-<tt>ChunkyPNG::Pixel</tt> :: represents a single pixel or color value.
+<tt>ChunkyPNG::Canvas</tt> :: represents an image canvas as a matrix of pixels.
+<tt>ChunkyPNG::Color</tt> :: represents a, RGBA color
== Usage
require 'chunky_png'
-
+
# Creating an image from scratch
- png = ChunkyPNG::Image.new(16, 16, ChunkyPNG::Pixel::TRANSPARENT)
- png[1,1] = ChunkyPNG::Pixel.rgba(255, 255, 255, 128)
- png[2,1] = ChunkyPNG::Pixel.rgba(255, 255, 255, 128)
+ png = ChunkyPNG::Image.new(16, 16, ChunkyPNG::Color::TRANSPARENT)
+ png[1,1] = ChunkyPNG::Color.rgba(10, 20, 30, 128)
+ png[2,1] = ChunkyPNG::Color.rgba(0, 0, 0, 128)
png.save('filename.png')
- # Modify an image - TODO
+ # Compose images using alpha blending
+ avatar = ChunkyPNG::Image.from_file('avatar.png')
+ badge = ChunkyPNG::Image.from_file('no_ie_badge.png')
+ avatar.compose(badge, 10, 10)
+ avatar.save('composited.png', :color_mode => ChunkyPNG::COLOR_GRAYSCALE, :interlace => true)
+
# Inspecting metadata - TODO
+
+ # Low level access to PNG chunks
+ png_stream = ChunkyPNG::Datastream.from_file('filename.png')
+ png_stream.each_chunk { |chunk| p chunk.type }
(Note: this is subject to change while work is in progress)
== About
The library is written by Willem van Bergen for Floorplanner.com, and released
under the MIT license (see LICENSE). Please contact me for questions or
remarks. Patches are greatly appreciated! :-)
-P.S.: _why is why this library is so chunky.
+P.S.: The name of this library is intentionally similar to Chunky Bacon and
+Chunky GIF. Use Google if you want to know _why.