crop

Documentation

Index

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

Types

type Crop

type Crop struct {
	Width  string `json:"width,omitempty"`
	Height string `json:"height,omitempty"`
	Anchor string `json:"anchor,omitempty"`
}

Crop produces a cropped image as rectangular region of a specific size.

func (*Crop) Apply

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

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

func (Crop) CaddyModule

func (Crop) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Crop) UnmarshalCaddyfile

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

UnmarshalCaddyfile configures Crop instance.

Syntax:

crop <width> <height> [<anchor>]

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.

anchor determines the anchor point of the rectangular region that is cut out. Possible values are: center, topleft, top, topright, left, right, bottomleft, bottom, bottomright. Default is center.