Documentation
¶
Index ¶
- Constants
- Variables
- type ANSImage
- func (ai *ANSImage) GetAt(y, x int) (*ANSIpixel, error)
- func (ai *ANSImage) GetMaxProcs() int
- func (ai *ANSImage) Height() int
- func (ai *ANSImage) Render() string
- 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
- type ScaleMode
Constants ¶
const ( ScaleModeResize = ScaleMode(iota) ScaleModeFill ScaleModeFit )
ANSImage scale modes: resize (full scaled to area), fill (resize and crop the image with a center anchor point to fill area), fit (resize the image to fit area, preserving the aspect ratio).
const ( BlockSizeY = 8 BlockSizeX = 4 )
ANSImage block size in pixels (dithering mode)
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 NewScaledFromReader ¶
func NewScaledFromReader(reader io.Reader, y, x int, bg color.Color, sm ScaleMode) (*ANSImage, error)
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