lqip

Documentation

Index

• Variables
• type Color
• type Image
  • func (i *Image) AspectRatio() float64
  • func (i *Image) ColorPalette() (map[string]Color, error)
  • func (i *Image) Dimensions() (int, int)
  • func (i *Image) PreviewEnhancedSrc() (string, error)
  • func (i *Image) PreviewSrc() (string, error)
• type ImageOps
  • func NewImage(imagePath string) (ImageOps, error)

Variables

var (
	ErrImageConfig  = "Cannot obtain image config from the file"
	ErrColorPalette = "Cannot obtain color palette from the image"
	ErrImageBase64  = "Cannot convert resized image to base64 string"
)

Meaningful error messages

Types

type Color

type Color vibrant.Color

Color - Web basded color format

type Image

type Image struct {
	// contains filtered or unexported fields
}

Image has basic file properties of the image

func (*Image) AspectRatio

func (i *Image) AspectRatio() float64

AspectRatio returns the aspect ratio of the image

func (*Image) ColorPalette

func (i *Image) ColorPalette() (map[string]Color, error)

ColorPalette returns the extracted colors from the image

func (*Image) Dimensions

func (i *Image) Dimensions() (int, int)

Dimensions returns the height/width of the image

func (*Image) PreviewEnhancedSrc

func (i *Image) PreviewEnhancedSrc() (string, error)

PreviewEnhancedSrc returns base64-encoded image which can be used as placeholder for large dimension preview

func (*Image) PreviewSrc

func (i *Image) PreviewSrc() (string, error)

PreviewSrc returns base64-encoded image which can be used as placeholder for small dimension preview

type ImageOps

type ImageOps interface {
	// Returns the height/width of the image
	Dimensions() (int, int)
	// Returns the aspect ratio of the image
	AspectRatio() float64
	// Returns a low quality placeholder base64 string
	PreviewSrc() (string, error)
	// Returns a low quality placeholder base64 string
	PreviewEnhancedSrc() (string, error)
	// Returns the color palette of the image
	ColorPalette() (map[string]Color, error)
}

ImageOps - List of public image functions form Image struct

func NewImage

func NewImage(imagePath string) (ImageOps, error)

NewImage implements the ImageOps interface