area

package

v0.1.0 Latest Latest Go to latest Published: Jun 13, 2018 License: Apache-2.0 Imports: 2 Imported by: 0

Details

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

Repository

github.com/mum4k/termdash

Links

Open Source Insights

Documentation ¶

Overview ¶

Package area provides functions working with image areas.

Index ¶

func ExcludeBorder(area image.Rectangle) image.Rectangle
func FromSize(size image.Point) (image.Rectangle, error)
func HSplit(area image.Rectangle) (image.Rectangle, image.Rectangle)
func Size(area image.Rectangle) image.Point
func VSplit(area image.Rectangle) (image.Rectangle, image.Rectangle)
func WithRatio(area image.Rectangle, ratio image.Point) image.Rectangle

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ExcludeBorder ¶

func ExcludeBorder(area image.Rectangle) image.Rectangle

ExcludeBorder returns a new area created by subtracting a border around the provided area. Return the zero area if there isn't enough space to exclude the border.

func FromSize ¶

func FromSize(size image.Point) (image.Rectangle, error)

FromSize returns the corresponding area for the provided size.

func HSplit ¶

func HSplit(area image.Rectangle) (image.Rectangle, image.Rectangle)

HSplit returns two new areas created by splitting the provided area in the middle along the horizontal axis. Can return zero size areas.

func Size ¶

func Size(area image.Rectangle) image.Point

Size returns the size of the provided area.

func VSplit ¶

func VSplit(area image.Rectangle) (image.Rectangle, image.Rectangle)

VSplit returns two new areas created by splitting the provided area in the middle along the vertical axis. Can return zero size areas.

func WithRatio ¶

func WithRatio(area image.Rectangle, ratio image.Point) image.Rectangle

WithRatio returns the largest area that has the requested ratio but is either equal or smaller than the provided area. Returns zero area if the area or the ratio are zero, or if there is no such area.

Types ¶

This section is empty.

Source Files ¶

View all Source files

area.go

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