Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Pure ruby library for read/write access to PNG images.

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.rdoc

Chunky PNG

This library can read and write PNG files. It is written in pure Ruby for maximum portability. Let me rephrase: it does NOT require RMagick or any other memory leaking image library.

Source code

github.com/wvanbergen/chunky_png/tree

RDoc

rdoc.info/projects/wvanbergen/chunky_png

Wiki

wiki.github.com/wvanbergen/chunky_png

Issue tracker

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 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 amount of used colors.

  • R/W access to the image's pixels.

  • R/W access to all image metadata that is stored in chunks.

  • Memory efficient (uses a Fixnum, i.e. 4 bytes of memory, per pixel)

  • Reasonably fast for Ruby standards, by only using integer math and a highly optimized saving routine.

  • Interoperability with RMagick.

Classes

The main classes and modules used within ChunkyPNG are:

ChunkyPNG::Image

create PNG images from scratch or based on another PNG image.

ChunkyPNG::Datastream

low-level read and write access to PNG images from or to a file or stream.

ChunkyPNG::Canvas

represents an image canvas as a matrix of pixels.

ChunkyPNG::Color

to handle Fixnums as color values.

Usage

require 'chunky_png'

# Creating an image from scratch, save as an interlaced PNG
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', :interlace => true)

# 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', :fast_rgba) # Force the fast saving routine.

# Accessing metadata
image = ChunkyPNG::Image.from_file('with_metadata.png')
puts image.metadata['Title']
image.metadata['Author'] = 'Willem van Bergen'
image.save('with_metadata.png') # Overwrite file

# Low level access to PNG chunks
png_stream = ChunkyPNG::Datastream.from_file('filename.png')
png_stream.each_chunk { |chunk| p chunk.type }

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.: The name of this library is intentionally similar to Chunky Bacon and Chunky GIF. Use Google if you want to know _why. :-)

Something went wrong with that request. Please try again.