options

Documentation

Index

• func DecodeURL(parts []string) (string, string, error)
• func ParsePresets(presetStrs []string) error
• func ValidatePresets() error
• type CropOptions
• type ExtendOptions
• type GravityOptions
  • func (g *GravityOptions) RotateAndFlip(angle int, flip bool)
• type GravityType
  • func (gt GravityType) MarshalJSON() ([]byte, error)
  • func (gt GravityType) String() string
• type InvalidURLError
  • func (e InvalidURLError) Error() string
• type OptionArgumentError
  • func (e OptionArgumentError) Error() string
• type PaddingOptions
• type ProcessingOptions
  • func NewProcessingOptions() *ProcessingOptions
  • func ParsePath(path string, headers http.Header) (*ProcessingOptions, string, error)
  • func (po *ProcessingOptions) Diff() structdiff.Entries
  • func (po *ProcessingOptions) GetQuality() int
  • func (po *ProcessingOptions) MarshalJSON() ([]byte, error)
  • func (po *ProcessingOptions) String() string
• type ResizeType
  • func (rt ResizeType) MarshalJSON() ([]byte, error)
  • func (rt ResizeType) String() string
• type TrimOptions
• type UnknownOptionError
  • func (e UnknownOptionError) Error() string
• type WatermarkOptions
  • func (wo WatermarkOptions) ShouldReplicate() bool

Functions

func DecodeURL

func DecodeURL(parts []string) (string, string, error)

func ParsePresets

func ParsePresets(presetStrs []string) error

func ValidatePresets

func ValidatePresets() error

Types

type CropOptions

type CropOptions struct {
	Width   float64
	Height  float64
	Gravity GravityOptions
}

type ExtendOptions

type ExtendOptions struct {
	Enabled bool
	Gravity GravityOptions
}

type GravityOptions

type GravityOptions struct {
	Type GravityType
	X, Y float64
}

func (*GravityOptions) RotateAndFlip

func (g *GravityOptions) RotateAndFlip(angle int, flip bool)

type GravityType

type GravityType int

const (
	GravityUnknown GravityType = iota
	GravityCenter
	GravityNorth
	GravityEast
	GravitySouth
	GravityWest
	GravityNorthWest
	GravityNorthEast
	GravitySouthWest
	GravitySouthEast
	GravitySmart
	GravityFocusPoint

	// Watermark gravity types
	GravityReplicate
)

func (GravityType) MarshalJSON

func (gt GravityType) MarshalJSON() ([]byte, error)

func (GravityType) String

func (gt GravityType) String() string

type InvalidURLError

type InvalidURLError string

func (InvalidURLError) Error

func (e InvalidURLError) Error() string

type OptionArgumentError

type OptionArgumentError string

func (OptionArgumentError) Error

func (e OptionArgumentError) Error() string

type PaddingOptions

type PaddingOptions struct {
	Enabled bool
	Top     int
	Right   int
	Bottom  int
	Left    int
}

type ProcessingOptions

type ProcessingOptions struct {
	ResizingType      ResizeType
	Width             int
	Height            int
	MinWidth          int
	MinHeight         int
	ZoomWidth         float64
	ZoomHeight        float64
	Dpr               float64
	Gravity           GravityOptions
	Enlarge           bool
	Extend            ExtendOptions
	ExtendAspectRatio ExtendOptions
	Crop              CropOptions
	Padding           PaddingOptions
	Trim              TrimOptions
	Rotate            int
	Format            imagetype.Type
	Quality           int
	FormatQuality     map[imagetype.Type]int
	MaxBytes          int
	Flatten           bool
	Background        vips.Color
	Blur              float32
	Sharpen           float32
	Pixelate          int
	StripMetadata     bool
	KeepCopyright     bool
	StripColorProfile bool
	AutoRotate        bool
	EnforceThumbnail  bool

	SkipProcessingFormats []imagetype.Type

	CacheBuster string

	Expires *time.Time

	Watermark WatermarkOptions

	PreferWebP  bool
	EnforceWebP bool
	PreferAvif  bool
	EnforceAvif bool
	PreferJxl   bool
	EnforceJxl  bool

	Filename         string
	ReturnAttachment bool

	Raw bool

	UsedPresets []string

	SecurityOptions security.Options
	// contains filtered or unexported fields
}

func NewProcessingOptions

func NewProcessingOptions() *ProcessingOptions

func ParsePath

func ParsePath(path string, headers http.Header) (*ProcessingOptions, string, error)

func (*ProcessingOptions) Diff

func (po *ProcessingOptions) Diff() structdiff.Entries

func (*ProcessingOptions) GetQuality

func (po *ProcessingOptions) GetQuality() int

func (*ProcessingOptions) MarshalJSON

func (po *ProcessingOptions) MarshalJSON() ([]byte, error)

func (*ProcessingOptions) String

func (po *ProcessingOptions) String() string

type ResizeType

type ResizeType int

const (
	ResizeFit ResizeType = iota
	ResizeFill
	ResizeFillDown
	ResizeForce
	ResizeAuto
)

func (ResizeType) MarshalJSON

func (rt ResizeType) MarshalJSON() ([]byte, error)

func (ResizeType) String

func (rt ResizeType) String() string

type TrimOptions

type TrimOptions struct {
	Enabled   bool
	Threshold float64
	Smart     bool
	Color     vips.Color
	EqualHor  bool
	EqualVer  bool
}

type UnknownOptionError

type UnknownOptionError string

func (UnknownOptionError) Error

func (e UnknownOptionError) Error() string

type WatermarkOptions

type WatermarkOptions struct {
	Enabled  bool
	Opacity  float64
	Position GravityOptions
	Scale    float64
}

func (WatermarkOptions) ShouldReplicate

func (wo WatermarkOptions) ShouldReplicate() bool