convert

Documentation

Overview

Package convert provides the core ASCII art conversion function.

Index

• Constants
• type ASCIIArt
  • func FromImage(img image.Image, width uint) ASCIIArt
  • func (img ASCIIArt) String() string

Constants

const CharacterAspectRatio = 1.0 / 2.0

CharacterAspectRatio gives the percentage by which input images' heights will be scaled relative to their native aspect ratio. Characters in most fonts are taller than they are wide, and are even taller when the space between lines is taken into account, resulting in output ASCII "pixels" that are not square.

Types

type ASCIIArt

type ASCIIArt [][]byte

ASCIIArt is the output of asciist's image conversion. The top-level slice contains the lines of the ASCII art (y axis), and each inner slice contains the bytes of each line (x axis).

func FromImage

func FromImage(img image.Image, width uint) ASCIIArt

FromImage converts the given image to ASCII art, where each line is `width` characters wide, and the height of the output is chosen to preserve the input aspect ratio (taking into account that ASCII "pixels" are not square; see CharacterAspectRatio).

func (ASCIIArt) String

func (img ASCIIArt) String() string

String builds a string of the art by converting each line to a string and joining them with newline characters.