engrave

package

v1.3.8 Latest Latest Go to latest Published: Aug 19, 2025 License: Unlicense Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/seedhammer/seedhammer

Links

Open Source Insights

Documentation ¶

Overview ¶

package engrave transforms shapes such as text and QR codes into line and move commands for use with an engraver.

Index ¶

func ManhattanDist(p1, p2 image.Point) int
func Measure(plan Plan) image.Rectangle
func NewBitmap(w, h int) bitmap
func Rasterize(img draw.Image, p Plan)
type Command
- func Line(p image.Point) Command
- func Move(p image.Point) Command
type ConstantStringer
- func NewConstantStringer(face *vector.Face, em int, shortest, longest int) *ConstantStringer
- func (c *ConstantStringer) String(txt string) Plan
type Params
- func (p Params) F(v float32) int
- func (p Params) I(v int) int
type Plan
type Rect
- func (r Rect) Engrave(yield func(Command) bool)
type StringCmd
- func String(face *vector.Face, em int, txt string) *StringCmd
- func (s *StringCmd) Engrave() Plan
- func (s *StringCmd) Measure() image.Point

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ManhattanDist ¶ added in v1.3.0

func ManhattanDist(p1, p2 image.Point) int

func Measure ¶ added in v0.10.0

func Measure(plan Plan) image.Rectangle

func NewBitmap ¶ added in v0.10.0

func NewBitmap(w, h int) bitmap

func Rasterize ¶ added in v1.3.2

func Rasterize(img draw.Image, p Plan)

Types ¶

type Command ¶

type Command struct {
	Line  bool
	Coord image.Point
}

func Line ¶ added in v1.3.0

func Line(p image.Point) Command

func Move ¶ added in v1.3.0

func Move(p image.Point) Command

type ConstantStringer ¶ added in v0.10.0

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

ConstantStringer can engrave text in a timing insensitive way.

func NewConstantStringer ¶ added in v0.10.0

func NewConstantStringer(face *vector.Face, em int, shortest, longest int) *ConstantStringer

func (*ConstantStringer) String ¶ added in v0.10.0

func (c *ConstantStringer) String(txt string) Plan

type Params ¶ added in v1.3.0

type Params struct {
	// The StrokeWidth measured in machine units.
	StrokeWidth int
	// A Millimeter measured in machine units.
	Millimeter int
}

Params decribe the physical characteristics of an engraver.

func (Params) F ¶ added in v1.3.0

func (p Params) F(v float32) int

func (Params) I ¶ added in v1.3.0

func (p Params) I(v int) int

type Plan ¶ added in v1.3.0

type Plan iter.Seq[Command]

Plan is an iterator over the commands of an engraving.

func Commands ¶

func Commands(plans ...Plan) Plan

func ConstantQR ¶ added in v0.10.0

func ConstantQR(strokeWidth, scale int, qrc *qr.Code) (Plan, error)

ConstantQR is like QR that engraves the QR code in a pattern independent of content, except for the QR code version (size).

func DryRun ¶ added in v1.3.0

func DryRun(p Plan) Plan

func Offset ¶

func Offset(x, y int, cmd Plan) Plan

func QR ¶

func QR(strokeWidth int, scale int, qr *qr.Code) Plan

func Rotate ¶

func Rotate(radians float64, cmd Plan) Plan

func Scale ¶

func Scale(sx, sy int, cmd Plan) Plan

type Rect ¶ added in v0.10.0

type Rect image.Rectangle

func (Rect) Engrave ¶ added in v0.10.0

func (r Rect) Engrave(yield func(Command) bool)

type StringCmd ¶

type StringCmd struct {
	LineHeight int
	// contains filtered or unexported fields
}

func String ¶

func String(face *vector.Face, em int, txt string) *StringCmd

func (*StringCmd) Engrave ¶

func (s *StringCmd) Engrave() Plan

func (*StringCmd) Measure ¶ added in v0.10.0

func (s *StringCmd) Measure() image.Point

Source Files ¶

View all Source files

engrave.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL