fit

Documentation

Index

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

Types

type Fit

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

Fit scales a image to fit to the specified maximum width and height using a linear filter, the image aspect ratio is preserved. If the image already fits inside the bounds, nothing will be done.

func (*Fit) Apply

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

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

func (Fit) CaddyModule

func (Fit) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Fit) UnmarshalCaddyfile

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

UnmarshalCaddyfile configures the Fit instance.

Syntax:

fit <width> <height>

Parameters:

width must be a positive integer and determines the maximum width.

height must be a positive integer and determines the maximum height.