convert

README

imgutils-convert

Format conversion (PNG, JPEG, WebP, etc.)

Documentation

Overview

Package convert provides image format conversion utilities.

Index

• func Convert(r io.Reader, w io.Writer, format Format, opts Options) error
• func ConvertFile(inputPath, outputPath string, opts Options) error
• func Encode(w io.Writer, img image.Image, format Format, opts Options) error
• func ToBMP(img image.Image, w io.Writer) error
• func ToGIF(img image.Image, w io.Writer) error
• func ToJPEG(img image.Image, w io.Writer, quality int) error
• func ToPNG(img image.Image, w io.Writer) error
• func ToTIFF(img image.Image, w io.Writer) error
• type Format
  • func Decode(r io.Reader) (image.Image, Format, error)
  • func FormatFromExtension(path string) Format
• type Options
  • func DefaultOptions() Options

Functions

func Convert

func Convert(r io.Reader, w io.Writer, format Format, opts Options) error

Convert reads an image and converts it to a different format.

func ConvertFile

func ConvertFile(inputPath, outputPath string, opts Options) error

ConvertFile converts an image file to a different format.

func Encode

func Encode(w io.Writer, img image.Image, format Format, opts Options) error

Encode writes an image to the writer in the specified format.

func ToBMP

func ToBMP(img image.Image, w io.Writer) error

ToBMP converts an image to BMP format.

func ToGIF

func ToGIF(img image.Image, w io.Writer) error

ToGIF converts an image to GIF format.

func ToJPEG

func ToJPEG(img image.Image, w io.Writer, quality int) error

ToJPEG converts an image to JPEG format.

func ToPNG

func ToPNG(img image.Image, w io.Writer) error

ToPNG converts an image to PNG format.

func ToTIFF

func ToTIFF(img image.Image, w io.Writer) error

ToTIFF converts an image to TIFF format.

Types

type Format

type Format string

Format represents an image format.

const (
	JPEG Format = "jpeg"
	PNG  Format = "png"
	GIF  Format = "gif"
	BMP  Format = "bmp"
	TIFF Format = "tiff"
)

func Decode

func Decode(r io.Reader) (image.Image, Format, error)

Decode reads an image from the reader.

func FormatFromExtension

func FormatFromExtension(path string) Format

FormatFromExtension determines the format from a file extension.

type Options

type Options struct {
	Quality int // JPEG quality (1-100), default 85
}

Options configures the conversion.

func DefaultOptions

func DefaultOptions() Options

DefaultOptions returns sensible defaults.