package gobmp

import "github.com/jsummers/gobmp"

Package gobmp implements a BMP image decoder and encoder.

Index ¶

• func Decode(r io.Reader) (image.Image, error)
• func DecodeConfig(r io.Reader) (image.Config, error)
• func Encode(w io.Writer, m image.Image) error
• func EncodeWithOptions(w io.Writer, m image.Image, opts *EncoderOptions) error
• type EncoderOptions
• func (opts *EncoderOptions) SetDensity(xDens, yDens int)
• func (opts *EncoderOptions) SupportTransparency(t bool)
• type FormatError
• func (e FormatError) Error() string
• type UnsupportedError
• func (e UnsupportedError) Error() string

Functions ¶

func Decode ¶

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

Decode reads a BMP image from r and returns it as an image.Image.

func DecodeConfig ¶

func DecodeConfig(r io.Reader) (image.Config, error)

DecodeConfig returns the color model and dimensions of the BMP image without decoding the entire image.

func Encode ¶

func Encode(w io.Writer, m image.Image) error

Encode writes the Image m to w in BMP format.

func EncodeWithOptions ¶

func EncodeWithOptions(w io.Writer, m image.Image, opts *EncoderOptions) error

EncodeWithOptions writes the Image m to w in BMP format, using the options recorded in opts. opts may be nil, in which case it behaves the same as Encode.

Types ¶

type EncoderOptions ¶

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

EncoderOptions stores options that can be passed to EncodeWithOptions(). Create an EncoderOptions object with new().

func (*EncoderOptions) SetDensity ¶

func (opts *EncoderOptions) SetDensity(xDens, yDens int)

SetDensity sets the density to write to the output image's metadata, in pixels per meter.

func (*EncoderOptions) SupportTransparency ¶

func (opts *EncoderOptions) SupportTransparency(t bool)

SupportTransparency indicates whether to retain transparency information when writing the BMP file. Transparency requires the use of a not-so-portable version of BMP.

type FormatError ¶

type FormatError string

A FormatError reports that the input is not a valid BMP file.

func (FormatError) Error ¶

func (e FormatError) Error() string

type UnsupportedError ¶

type UnsupportedError string

An UnsupportedError reports that the input uses a valid but unimplemented BMP feature.

func (UnsupportedError) Error ¶

func (e UnsupportedError) Error() string

Source Files ¶

reader.go rle.go writer.go