engine

Documentation

Index

• Variables
• func NewContext(ctx context.Context, e Engine) context.Context
• func ToContext(c Setter, e Engine)
• type Engine
  • func FromContext(c context.Context) Engine
• type GoImageEngine
  • func (e *GoImageEngine) Fit(img *imagefile.ImageFile, width int, height int, options *Options) ([]byte, error)
  • func (e *GoImageEngine) Flip(img *imagefile.ImageFile, pos string, options *Options) ([]byte, error)
  • func (e *GoImageEngine) Resize(img *imagefile.ImageFile, width int, height int, options *Options) ([]byte, error)
  • func (e *GoImageEngine) Rotate(img *imagefile.ImageFile, deg int, options *Options) ([]byte, error)
  • func (e *GoImageEngine) Scale(img image.Image, dstWidth int, dstHeight int, upscale bool, ...) image.Image
  • func (e *GoImageEngine) Source(img *imagefile.ImageFile) (image.Image, error)
  • func (e *GoImageEngine) Thumbnail(img *imagefile.ImageFile, width int, height int, options *Options) ([]byte, error)
  • func (e *GoImageEngine) ToBytes(img image.Image, format imaging.Format, quality int) ([]byte, error)
  • func (e *GoImageEngine) Transform(img *imagefile.ImageFile, operation *Operation, qs map[string]string) (*imagefile.ImageFile, error)
  • func (e *GoImageEngine) TransformGIF(img *imagefile.ImageFile, width int, height int, options *Options, ...) ([]byte, error)
• type ImageTransformation
• type Operation
• type Options
• type Setter
• type Transformation

Variables

var ContentTypes = map[string]string{
	"jpeg": "image/jpeg",
	"jpg":  "image/jpeg",
	"png":  "image/png",
	"bmp":  "image/bmp",
	"gif":  "image/gif",
}

var Fit = &Operation{
	"fit",
}

var Flip = &Operation{
	"flip",
}

var FlipTransformations = map[string]ImageTransformation{
	"h": imaging.FlipH,
	"v": imaging.FlipV,
}

var Formats = map[string]imaging.Format{
	"jpeg": imaging.JPEG,
	"jpg":  imaging.JPEG,
	"png":  imaging.PNG,
	"gif":  imaging.GIF,
	"bmp":  imaging.BMP,
}

var Noop = &Operation{
	"noop",
}

var Operations = map[string]*Operation{
	Resize.Name:    Resize,
	Thumbnail.Name: Thumbnail,
	Flip.Name:      Flip,
	Rotate.Name:    Rotate,
	Fit.Name:       Fit,
	Noop.Name:      Noop,
}

var Resize = &Operation{
	"resize",
}

var Rotate = &Operation{
	"rotate",
}

var RotateTransformations = map[int]ImageTransformation{
	90:  imaging.Rotate90,
	270: imaging.Rotate270,
	180: imaging.Rotate180,
}

var Thumbnail = &Operation{
	"thumbnail",
}

Functions

func NewContext

func NewContext(ctx context.Context, e Engine) context.Context

NewContext instantiate a new context with an engine

func ToContext

func ToContext(c Setter, e Engine)

ToContext adds the Managers to this context if it supports the Setter interface.

Types

type Engine

type Engine interface {
	Resize(img *image.ImageFile, width int, height int, options *Options) ([]byte, error)
	Thumbnail(img *image.ImageFile, width int, height int, options *Options) ([]byte, error)
	Transform(img *image.ImageFile, operation *Operation, qs map[string]string) (*image.ImageFile, error)
	Flip(img *image.ImageFile, pos string, options *Options) ([]byte, error)
	Rotate(img *image.ImageFile, deg int, options *Options) ([]byte, error)
	Fit(img *image.ImageFile, width int, height int, options *Options) ([]byte, error)
}

func FromContext

func FromContext(c context.Context) Engine

FromContext returns the engine associated with this context.

type GoImageEngine

type GoImageEngine struct {
	DefaultFormat  string
	Format         string
	DefaultQuality int
}

func (*GoImageEngine) Fit

func (e *GoImageEngine) Fit(img *imagefile.ImageFile, width int, height int, options *Options) ([]byte, error)

func (*GoImageEngine) Flip

func (e *GoImageEngine) Flip(img *imagefile.ImageFile, pos string, options *Options) ([]byte, error)

func (*GoImageEngine) Resize

func (e *GoImageEngine) Resize(img *imagefile.ImageFile, width int, height int, options *Options) ([]byte, error)

func (*GoImageEngine) Rotate

func (e *GoImageEngine) Rotate(img *imagefile.ImageFile, deg int, options *Options) ([]byte, error)

func (*GoImageEngine) Scale

func (e *GoImageEngine) Scale(img image.Image, dstWidth int, dstHeight int, upscale bool, trans Transformation) image.Image

func (*GoImageEngine) Source

func (e *GoImageEngine) Source(img *imagefile.ImageFile) (image.Image, error)

func (*GoImageEngine) Thumbnail

func (e *GoImageEngine) Thumbnail(img *imagefile.ImageFile, width int, height int, options *Options) ([]byte, error)

func (*GoImageEngine) ToBytes

func (e *GoImageEngine) ToBytes(img image.Image, format imaging.Format, quality int) ([]byte, error)

func (*GoImageEngine) Transform

func (e *GoImageEngine) Transform(img *imagefile.ImageFile, operation *Operation, qs map[string]string) (*imagefile.ImageFile, error)

func (*GoImageEngine) TransformGIF

func (e *GoImageEngine) TransformGIF(img *imagefile.ImageFile, width int, height int, options *Options, trans Transformation) ([]byte, error)

type ImageTransformation

type ImageTransformation func(img image.Image) *image.NRGBA

type Operation

type Operation struct {
	Name string
}

type Options

type Options struct {
	Upscale bool
	Format  imaging.Format
	Quality int
}

type Setter

type Setter interface {
	Set(string, interface{})
}

Setter defines a context that enables setting values.

type Transformation

type Transformation func(img image.Image, width int, height int, filter imaging.ResampleFilter) *image.NRGBA