paper

README

Paper

Paper is a Go library to simulate monochromic old print papers, as shown in the following sample picture.

Getting Started

The Paper struct defined in this library implements the draw.Image interface; i.e. it can be used as a drawing canvas to overlay images and to draw shapes and texts.

Note: The Paper needs to be Mask-ed and Unmask-ed before and after the drawing is done for paper theme to be applied correctly.

import "github.com/aslrousta/paper"

p := paper.New(paper.Nostalgia, 800, 300)

p.Mask()
draw.Draw(p, p.Bounds(), im, image.Point{0, 0}, draw.Src)
p.Unmask()

Documentation

Index

• Variables
• type Paper
  • func New(th Theme, w, h int) *Paper
  • func (p *Paper) At(x, y int) color.Color
  • func (p *Paper) Bounds() image.Rectangle
  • func (p *Paper) ColorModel() color.Model
  • func (p *Paper) ExtendHeight(extra int)
  • func (p *Paper) ExtendWidth(extra int)
  • func (p *Paper) Mask()
  • func (p *Paper) Set(x, y int, c color.Color)
  • func (p *Paper) Unmask()
• type Theme

Variables

var (
	Modern = Theme{
		Primary:    color.RGBA{21, 21, 21, 255},
		Background: color.RGBA{221, 221, 221, 255},
	}
	Nostalgia = Theme{
		Primary:    color.RGBA{45, 40, 14, 255},
		Background: color.RGBA{227, 218, 189, 255},
	}
	Sepia = Theme{
		Primary:    color.RGBA{52, 36, 36, 255},
		Background: color.RGBA{190, 155, 118, 255},
	}
	Night = Theme{
		Primary:    color.RGBA{221, 221, 221, 255},
		Background: color.RGBA{21, 21, 21, 255},
	}
)

Types

type Paper

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

func New

func New(th Theme, w, h int) *Paper

func (*Paper) At

func (p *Paper) At(x, y int) color.Color

func (*Paper) Bounds

func (p *Paper) Bounds() image.Rectangle

func (*Paper) ColorModel

func (p *Paper) ColorModel() color.Model

func (*Paper) ExtendHeight

func (p *Paper) ExtendHeight(extra int)

func (*Paper) ExtendWidth

func (p *Paper) ExtendWidth(extra int)

func (*Paper) Mask

func (p *Paper) Mask()

func (*Paper) Set

func (p *Paper) Set(x, y int, c color.Color)

func (*Paper) Unmask

func (p *Paper) Unmask()

type Theme

type Theme struct {
	Primary    color.RGBA
	Background color.RGBA
}