sixel

package

v1.0.0 Latest Latest Go to latest Published: Jan 1, 2026 License: MIT Imports: 4 Imported by: 0

Details

View Source

const MaxColors = 256

MaxColors is the maximum number of colors in a Sixel palette.

This section is empty.

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

Encode writes an image to w using Sixel graphics protocol.

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

Encoder encodes images using the Sixel graphics protocol.

func NewEncoder(opts ...Option) *Encoder

NewEncoder creates a new Encoder with the given options.

func (e *Encoder) Encode(w io.Writer, img image.Image) error

Encode writes an image to w using Sixel graphics protocol.

type Option func(*Encoder)

Option configures an Encoder.

func WithOnAfterEncode(fn func()) Option

WithOnAfterEncode sets the callback called after encoding completes.

func WithOnAfterEncodeChunk(fn func(chunkIndex int, isLast bool)) Option

WithOnAfterEncodeChunk sets the callback called after each band is encoded.

func WithOnBeforeEncode(fn func()) Option

WithOnBeforeEncode sets the callback called before encoding starts.

func WithOnBeforeEncodeChunk(fn func(chunkIndex int, isLast bool)) Option

WithOnBeforeEncodeChunk sets the callback called before each band is encoded.