image

Documentation

Index

• Constants
• func AutoLoad(r io.Reader, ext string) (image.Image, error)
• func AutoLoadFile(file string) (image.Image, error)
• type LoadOptions
• type Loader
  • func NewLoader(cachedSize int) *Loader
  • func (l *Loader) Get(file string) (image.Image, error)
  • func (l *Loader) GetWithOptions(file string, opt LoadOptions) (image.Image, error)

Constants

const DefaultCacheSize = 10

Functions

func AutoLoad

func AutoLoad(r io.Reader, ext string) (image.Image, error)

load image data from io.Reader r with its image type, png, jpeg, and jpg, and return loaded image with error. error contains unsupported extension.

func AutoLoadFile

func AutoLoadFile(file string) (image.Image, error)

auto detect file extension, png, jpeg, and jpg, and return loaded image data with error. error contains file not found, unsupported extension, ... etc.

Types

type LoadOptions

type LoadOptions struct {
	// Size of resized image. Empty this means no resized.
	// If either X or Y of size is zero, auto filled it by calculating
	// from the other with keep aspect ratio.
	// For example, Let source image size (W, H) = (1920, 1080) and resized size
	// (RW, RH) = (960, 0) then auto-filled resized size (RW', RH') = (960, 540)
	// since 1920:1080 = 960:540.
	ResizedSize image.Point
}

LoadOptions is options for image loading.

type Loader

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

Loader holds image caches. concurrent use is OK.

func NewLoader

func NewLoader(cachedSize int) *Loader

Loader has cachedSize cache entries. the oldest image is removed from cache using LRU. use DefaultCacheSize if cachedSize <= 0.

func (*Loader) Get

func (l *Loader) Get(file string) (image.Image, error)

get cached image by using image's file name. if not found, load image data from file and return loaded image with loading error. error nil means loaded image found.

func (*Loader) GetWithOptions

func (l *Loader) GetWithOptions(file string, opt LoadOptions) (image.Image, error)

It is almost same as Get(), except that it accepts options for loaded image property.