imagecat

README

imagecat

Concatenate images into a single image on x or y axis with optional alignment centering

Installation

go get github.com/dillonstreator/imagecat/v2

Usage

import (
    "image"

    "github.com/dillonstreator/imagecat/v2"
)

func main () {

    images := []image.Image{
        // ... images
    }

    // concat on x-axis with no alignment
    img, err := imagecat.Concat(images)
    if err != nil { /* handle error */ }

    // concat on y-axis with center alignment
    img, err = imagecat.Concat(images, imagecat.WithAxis(imagecat.AxisY), imagecat.WithAlignment(imagecat.AlignmentCenter))
    if err != nil { /* handle error */ }

}

Examples

Input images

concat on x-axis with no alignment

concat on x-axis with center alignment

concat on y-axis with no alignment

concat on y-axis with center alignment

Documentation

Index

• Constants
• func Concat(images []image.Image, options ...OptionFn) (*image.RGBA, error)
• type Alignment
• type Axis
• type OptionFn
  • func WithAlignment(alignment Alignment) OptionFn
  • func WithAxis(axis Axis) OptionFn
  • func WithDrawOp(op draw.Op) OptionFn

Constants

const (
	// Specifies the axis with which the images will be concatenated on
	AxisX Axis = iota
	AxisY

	// Specifies the alignment that will be applied to the images
	AlignmentNone Alignment = iota
	AlignmentCenter
)

Functions

func Concat

func Concat(images []image.Image, options ...OptionFn) (*image.RGBA, error)

Types

type Alignment

type Alignment int

type Axis

type Axis int

type OptionFn

type OptionFn func(*config)

func WithAlignment

func WithAlignment(alignment Alignment) OptionFn

func WithAxis

func WithAxis(axis Axis) OptionFn

func WithDrawOp

func WithDrawOp(op draw.Op) OptionFn