smartcrop

Documentation

Index

• type Smartcrop
  • func (f *Smartcrop) Apply(repl *caddy.Replacer, img image.Image) (image.Image, error)
  • func (Smartcrop) CaddyModule() caddy.ModuleInfo
  • func (f *Smartcrop) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

Types

type Smartcrop

type Smartcrop struct {
	Width  string `json:"width,omitempty"`
	Height string `json:"height,omitempty"`
}

Smartcrop finds good rectangular image crops of a specific size. It uses https://github.com/muesli/smartcrop

func (*Smartcrop) Apply

func (f *Smartcrop) Apply(repl *caddy.Replacer, img image.Image) (image.Image, error)

Apply applies the image filter to an image and returns the new image.

func (Smartcrop) CaddyModule

func (Smartcrop) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Smartcrop) UnmarshalCaddyfile

func (f *Smartcrop) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile configures the Smartcrop instance.

Syntax:

smartcrop <width> <height>

Parameters:

width must be a positive integer and determines the width of the cropped image.

height must be a positive integer and determines the height of the cropped image.