core

Documentation

Index

• Constants
• func FromMock(t testing.TB) bool
• func GetWallpaper() (string, error)
• func MockServers(t testing.TB)
• func SetWallpaper(path string, mode Mode) error
• func WithFuriganaApiAppId(appId string) configOption
• func WithGoogleAppCredentials(credentials string) configOption
• type Image
  • func DownloadAndDecode(day types.Day, region types.Region, resolution types.Resolution, ...) (*Image, error)
  • func SetupTestImage(t testing.TB) *Image
  • func (img *Image) DrawDescription(position types.Position, fontName string) error
  • func (img *Image) DrawQRCode(resolution types.Resolution, position types.Position) error
  • func (img *Image) DrawWatermark(watermarkFile string, rotateCounterClockwise bool) error
  • func (img *Image) EncodeAndDump(targetDir string) (string, error)
  • func (i *Image) Equals(other *Image) bool
• type Mode

Constants

const (
	ModeCenter  = wallpaper.Center
	ModeCrop    = wallpaper.Crop
	ModeFit     = wallpaper.Fit
	ModeSpan    = wallpaper.Span
	ModeStretch = wallpaper.Stretch
	ModeTile    = wallpaper.Tile
)

Functions

func FromMock

func FromMock(t testing.TB) bool

FromMock returns true if the test is running in mock mode.

func GetWallpaper

func GetWallpaper() (string, error)

GetWallpaper returns the path to the current wallpaper.

func MockServers

func MockServers(t testing.TB)

MockServers sets up mock servers for the Bing and Hiragana API.

func SetWallpaper

func SetWallpaper(path string, mode Mode) error

SetWallpaper sets the wallpaper from the given path.

func WithFuriganaApiAppId

func WithFuriganaApiAppId(appId string) configOption

func WithGoogleAppCredentials

func WithGoogleAppCredentials(credentials string) configOption

Types

type Image

type Image struct {
	image.Image
	Description string
	SearchURL   string
	DownloadURL string
}

Image is a wrapper around the image.Image interface.

func DownloadAndDecode

func DownloadAndDecode(day types.Day, region types.Region, resolution types.Resolution, opts ...configOption) (*Image, error)

DownloadAndDecode fetches the Bing wallpaper and decodes it.

func SetupTestImage

func SetupTestImage(t testing.TB) *Image

SetupTestImage returns a test image

func (*Image) DrawDescription

func (img *Image) DrawDescription(position types.Position, fontName string) error

DrawDescription draws a title onto the given image.

func (*Image) DrawQRCode

func (img *Image) DrawQRCode(resolution types.Resolution, position types.Position) error

DrawQRCode draws a QR code onto the given image.

func (*Image) DrawWatermark

func (img *Image) DrawWatermark(watermarkFile string, rotateCounterClockwise bool) error

DrawWatermark draws a watermark onto the given image.

func (*Image) EncodeAndDump

func (img *Image) EncodeAndDump(targetDir string) (string, error)

EncodeAndDump encodes the image and dumps it to the target directory.

func (*Image) Equals

func (i *Image) Equals(other *Image) bool

Equals returns true if the given image is equal to the receiver.

type Mode

type Mode = wallpaper.Mode

Mode represents the wallpaper setting mode.