ueberzug

README

ueberzug-go

A simple half-assed "port" (but not really) of ueberzug to Golang, aimed to replace w3m.

Instructions

Refer to ueberzug_test.go

Todo

• Handle soft translations
• Alpha channels, maybe
• tview primitive
• Add more New* functions

Documentation

Index

• func Close()
• func GetParentSize() (int, int, error)
• func Initialize() error
• type Image
  • func NewImage(img image.Image, X, Y int) (*Image, error)
  • func (i *Image) Clear()
  • func (i *Image) Destroy()
  • func (i *Image) Show()

Functions

func Close

func Close()

Close frees things

func GetParentSize

func GetParentSize() (int, int, error)

GetParentSize returns the size of the parent window, which is the terminal.

func Initialize

func Initialize() error

Initialize initalizes an X connection

Types

type Image

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

Image is the structure for the image

func NewImage

func NewImage(img image.Image, X, Y int) (*Image, error)

NewImage makes a new image. This also initializes X if it's not initialized.

func (*Image) Clear

func (i *Image) Clear()

Clear clears the image

func (*Image) Destroy

func (i *Image) Destroy()

Destroy destroys the image and window, freeing up resources

func (*Image) Show

func (i *Image) Show()

Show shows the image