Skip to content
Converts raster images to SVG, using color-run optimization.
Branch: master
Clone or download
Latest commit 72a2f4e Jul 2, 2016

README.md

px2svg

Turning raster images into SVG files, one pixel at a time. Yes, really.

What?

The PHP accepts a raster image (GIF, PNG, JPEG, that sort of thing) and creates an SVG image that recreates the raster image. It does this by drawing filled rectangles to recreate the pixels in the image. In many cases, this is literally a 1-by-1 rectangle, but it will check for runs of similar color (similar to GIF compression) and create one rectangle per run. It checks both horizontal and vertical runs to see which approach is more efficient, and returns the better option.

The script requires GD.

Why?

There are situations where people want to take small bitmaps—think primary-color buttons or badges—and make them scalable while still preserving their 8-bit appearance. See, for example, Joe Crawford’s post about upscaling a minitag. For those cases, this script will enable a quick conversion to SVG with at least some minimal attempts at optimization.

This all originally started as a one-off experiment and a bit of a jape. You can see the original at flaming-shame, if you fancy a laugh.

Who?

Eric Meyer, sometime CSS guy.

Amelia Bellamy-Royds, sometime SVG gal, added the check for runs of constant color and alpha transparency support.

Robin Cafolla made the script command-line usable and encapsulated for use in other code bases, and added posterization.

Neal Brooks thoroughly refactored the code and removed curl dependency.

ignace nyamagana butera ported the code to Composer, and refactored some more.

Documentation

Installation

Using any PSR-4 compatible autoloader.

Using the library

NOTE: the following examples currently contain commented-out lines referring to setThreshold(). This portion of the code has been disabled until we can figure out why it’s completely mangling the output in some situations, but not others. See https://github.com/meyerweb/px2svg/issues/9 for a few more details. Contributions and questions welcome!

Converting a Image into a SVG and directly output the corresponding SVG


use Px2svg\Converter;

$converter = new Converter();
$converter->loadImage('/path/to/my/image.gif');
//$converter->setThreshold(80);
header('Content-Type: text/xml');
$res = $converter->generateSVG();

Converting a Image into a SVG and saving the SVG to a file


use Px2svg\Converter;

$converter = new Converter();
$converter->loadImage('/path/to/my/image.gif');
//$converter->setThreshold(80);
$res = $converter->saveSVG('/path/to/the/save.svg');

If you need to further manipulate the SVG then you better use Converter::toXML() . This method will return a PHP DOMDocument object.


use Px2svg\Converter;

$converter = new Converter();
$converter->loadImage('/path/to/my/image.gif');
//$converter->setThreshold(80);
$res = $converter->toXML();
//$res is a DOMDocument object
You can’t perform that action at this time.