mosaic

README

Mosaic

Generates images from many small tiles.

This is still in an early stage of development, but it is currently functional. Here's an example, click to enlarge:

This was generated with:

./mosaic -image gopher.png -tiles gophers/ -tile-width 50 -tile-height 70 -blend

Usage

• Ensure a recent version of Go is installed.
• Clone this repo
• Inside this project's directory run: go build ./cmd/mosaic

./mosaic -image source.jpg -out output.jpg -tiles path/to/tile/images

Credit

For the example image:

• The Go Gopher was designed by Renee French
• Base image by Takuya Ueda
• Tile images were gathered from around the internet, but mainly the Go blog

Documentation

Index

• Variables
• func Generate(ctx context.Context, src image.Image, tileImages *Index, config Config) image.Image
• type Config
• type Index
  • func NewIndex(config Config) *Index
  • func (idx *Index) AddPath(ctx context.Context, path string) error
  • func (idx *Index) FindNearest(color uint32) (uint32, []string)
  • func (idx *Index) Len() int

Variables

var ErrNoImagesFound = errors.New("no images found")

ErrNoImagesFound is returned when no images are found in the given path.

Functions

func Generate

func Generate(ctx context.Context, src image.Image, tileImages *Index, config Config) image.Image

Generate generates a mosaic image from the source image and the tile images.

Types

type Config

type Config struct {
	Workers int
	Blend   bool

	Scale float64

	TileWidth  int
	TileHeight int

	// ResizeTiles indicates whether the tile images should be resized before
	// determining their primary color.
	ResizeTiles bool
}

Config contains options for mosaic generation.

type Index

type Index struct {
	// contains filtered or unexported fields
}

Index is a list of images that can be accessed by color.

func NewIndex

func NewIndex(config Config) *Index

NewIndex creates a new, empty, image index.

func (*Index) AddPath

func (idx *Index) AddPath(ctx context.Context, path string) error

AddPath finds and indexes images from the given path.

func (*Index) FindNearest

func (idx *Index) FindNearest(color uint32) (uint32, []string)

FindNearest returns the nearest color and the images associated with it.

func (*Index) Len

func (idx *Index) Len() int

Len returns the number of items in the list.