overlay

package

v0.2.3 Latest Latest Go to latest Published: Aug 17, 2026 License: MIT Imports: 2 Imported by: 0

Details

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

Repository

github.com/gechr/primer

Links

Open Source Insights

Documentation ¶

Index ¶

func Origin(foreground string, width, height int, _ Placement) (int, int)
func Place(background, foreground string, width, height int, placement Placement) string
type Placement

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Origin ¶ added in v0.2.1

func Origin(foreground string, width, height int, _ Placement) (int, int)

Origin returns the screen cell (column, row) where Place puts foreground's top-left corner on a width-by-height screen. It shares Place's placement math, so a caller translating mouse coordinates into overlay space can never drift from where the overlay was actually drawn.

func Place ¶

func Place(background, foreground string, width, height int, placement Placement) string

Place overlays foreground content on top of background content.

Types ¶

type Placement ¶

type Placement int

const (
	Center Placement = iota
)

Source Files ¶

View all Source files

overlay.go

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