cjslep / gorph

Package gorph manipulates graphic images in order to procedurally modify or create derived images.

Table of Contents

1. About
2. Dependencies
3. License
4. Installation
5. Usage/API
6. Contributing
7. Authors

About ---

Gorph is a library that manipulates graphic images in order to procedurally modify or create derived images.

It is currently under development with the goal of enabling server-side clients to pre-render or procedurally generate images.

The name is an homage to the library itself. It is derived from using the "morph" of two images to create a keyframe-based animation system. It also comes from "gopher" or "golang". Morphing the two different words gives the perhaps-not-quite-as-humorous result.

This library is still unstable, please do not hesitate to contact me with questions. Comments in the source are nonexistant, and is the first item to be remedied.

License ---

Gorph is released under the MIT Expat License, a permissive free software license. Contributing back to the source is appreciated greatly, but not demanded by the license. A copy of the license is distributed with the source code.

Dependencies ---

At this time, no additional dependencies are required beyond the golang standard library.

Installation ---

If Go is not installed, please do so first.

To download the source, use the command:

go get github.com/cjslep/gorph

Then, to build the source:

go build github.com/cjslep/gorph

To ensure all tests pass, run:

go test github.com/cjslep/gorph

Note that the dev-unstable branch may not pass all tests.

Usage / API ---

This section will be more detailed once development stabilizes. The following functions are targeted:

• Resize - Adjusts an image to new bounds. The aspect ratio may change. Anti-aliasing needed except in cases where pixels line up nicely.
• Scale - Adjusts an image by a percent, preserving aspect ratio. Anti-aliasing needed except in cases where pixels line up nicely.
• CrossDissolve - Applies a weight on a pixel-by-pixel basis between images to produce a faded new image.
• Morph - Keyframe image interpolation based on a grid.
• MorphFeature - Keyframe image interpolation based on a feature line.

Additionally, internally there are helpful functions that are currently buried that need to be extracted, or need to be written:

• bicubicInterpolation - Interpolates a pixel color from an image using bicubic interpolation.
• bilinearInterpolation - Interpolates a pixel color from an image using bilinear interpolation, where color changes may not be continuous over square boundaries.
• nearestNeighborInterpolation - Interpolates a pixel color from an image using the closest neighboring pixel.
• mergePixelsInLine - Already written, could be broken out into simpler pieces.

Contributing ---

The license governing this source code does not require users to contribute back to this source code, nor does it prevent users from creating proprietary derivative works. However, contributions back to the source are greatly appreciated.

Comments in the source are nonexistant, and is the first item to be remedied.

Authors ---

In no particular order:

• cjslep