Documentation
¶
Overview ¶
Package ansimage is a simplified version of the ansimage package in https://github.com/eliukblau/pixterm focused in rendering images to a tcell-based TUI app.
___ _____ ____ / _ \/ _/ |/_/ /____ ______ _ / ___// /_> </ __/ -_) __/ ' \ /_/ /___/_/|_|\__/\__/_/ /_/_/_/
This package is licensed under the Mozilla Public License v2.0.
Index ¶
- Variables
- type ANSImage
- func New(h, w int, bg color.Color) (*ANSImage, error)
- func NewFromFile(name string, bg color.Color) (*ANSImage, error)
- func NewFromReader(reader io.Reader, bg color.Color) (*ANSImage, error)
- func NewScaledFromFile(name string, y, x int, bg color.Color) (*ANSImage, error)
- func NewScaledFromReader(reader io.Reader, y, x int, bg color.Color) (*ANSImage, error)
- func (ai *ANSImage) GetAt(y, x int) (*ANSIpixel, error)
- func (ai *ANSImage) GetMaxProcs() int
- func (ai *ANSImage) Height() int
- func (ai *ANSImage) Pixmap() [][]*ANSIpixel
- func (ai *ANSImage) Render() []tstring.TString
- func (ai *ANSImage) SetAt(y, x int, r, g, b, brightness uint8) error
- func (ai *ANSImage) SetMaxProcs(max int)
- func (ai *ANSImage) Width() int
- type ANSIpixel
Constants ¶
This section is empty.
Variables ¶
var ( // ErrHeightNonMoT happens when ANSImage height is not a Multiple of Two value. ErrHeightNonMoT = errors.New("ANSImage: height must be a Multiple of Two value") // ErrInvalidBoundsMoT happens when ANSImage height or width are invalid values (Multiple of Two). ErrInvalidBoundsMoT = errors.New("ANSImage: height or width must be >=2") // ErrOutOfBounds happens when ANSI-pixel coordinates are out of ANSImage bounds. ErrOutOfBounds = errors.New("ANSImage: out of bounds") )
Functions ¶
This section is empty.
Types ¶
type ANSImage ¶
type ANSImage struct {
// contains filtered or unexported fields
}
ANSImage represents an image encoded in ANSI escape codes.
func NewFromFile ¶
NewFromFile creates a new ANSImage from a file. Background color is used to fill when image has transparency or dithering mode is enabled Dithering mode is used to specify the way that ANSImage render ANSI-pixels (char/block elements).
func NewFromReader ¶
NewFromReader creates a new ANSImage from an io.Reader. Background color is used to fill when image has transparency or dithering mode is enabled Dithering mode is used to specify the way that ANSImage render ANSI-pixels (char/block elements).
func NewScaledFromFile ¶
NewScaledFromFile creates a new scaled ANSImage from a file. Background color is used to fill when image has transparency or dithering mode is enabled Dithering mode is used to specify the way that ANSImage render ANSI-pixels (char/block elements).
func NewScaledFromReader ¶
NewScaledFromReader creates a new scaled ANSImage from an io.Reader. Background color is used to fill when image has transparency or dithering mode is enabled Dithering mode is used to specify the way that ANSImage render ANSI-pixels (char/block elements).
func (*ANSImage) GetMaxProcs ¶
GetMaxProcs gets the maximum number of parallels goroutines to render the ANSImage.
func (*ANSImage) Render ¶
Render returns the ANSI-compatible string form of ANSImage. (Nice info for ANSI True Colour - https://gist.github.com/XVilka/8346728)
func (*ANSImage) SetMaxProcs ¶
SetMaxProcs sets the maximum number of parallel goroutines to render the ANSImage (user should manually sets `runtime.GOMAXPROCS(max)` before to this change takes effect).
Source Files