area

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, heightPerc int) (top image.Rectangle, bottom image.Rectangle, err error)
• func HSplitCells(area image.Rectangle, cells int) (top image.Rectangle, bottom image.Rectangle, err error)
• func MoveDown(area image.Rectangle, cells int) (image.Rectangle, error)
• func MoveUp(area image.Rectangle, cells int) (image.Rectangle, error)
• func Shrink(area image.Rectangle, topCells, rightCells, bottomCells, leftCells int) (image.Rectangle, error)
• func ShrinkPercent(area image.Rectangle, topPerc, rightPerc, bottomPerc, leftPerc int) (image.Rectangle, error)
• func Size(area image.Rectangle) image.Point
• func VSplit(area image.Rectangle, widthPerc int) (left image.Rectangle, right image.Rectangle, err error)
• func VSplitCells(area image.Rectangle, cells int) (left image.Rectangle, right image.Rectangle, err error)
• func WithRatio(area image.Rectangle, ratio image.Point) image.Rectangle

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, heightPerc int) (top image.Rectangle, bottom image.Rectangle, err error)

HSplit returns two new areas created by splitting the provided area at the specified percentage of its width. The percentage must be in the range 0 <= heightPerc <= 100. Can return zero size areas.

func HSplitCells

func HSplitCells(area image.Rectangle, cells int) (top image.Rectangle, bottom image.Rectangle, err error)

HSplitCells returns two new areas created by splitting the provided area after the specified amount of cells of its height. The number of cells must be a zero or a positive integer. Providing a zero returns top=image.ZR, bottom=area. Providing a number equal or larger to area's height returns top=area, bottom=image.ZR.

func MoveDown

func MoveDown(area image.Rectangle, cells int) (image.Rectangle, error)

MoveDown returns a new area that is moved down by the specified amount of cells. The values must be zero or positive integers.

func MoveUp

func MoveUp(area image.Rectangle, cells int) (image.Rectangle, error)

MoveUp returns a new area that is moved up by the specified amount of cells. Returns an error if the move would result in negative Y coordinates. The values must be zero or positive integers.

func Shrink

func Shrink(area image.Rectangle, topCells, rightCells, bottomCells, leftCells int) (image.Rectangle, error)

Shrink returns a new area whose size is reduced by the specified amount of cells. Can return a zero area if there is no space left in the area. The values must be zero or positive integers.

func ShrinkPercent

func ShrinkPercent(area image.Rectangle, topPerc, rightPerc, bottomPerc, leftPerc int) (image.Rectangle, error)

ShrinkPercent returns a new area whose size is reduced by percentage of its width or height. Can return a zero area if there is no space left in the area. The topPerc and bottomPerc indicate the percentage of area's height. The rightPerc and leftPerc indicate the percentage of area's width. The percentages must be in range 0 <= v <= 100.

func Size

func Size(area image.Rectangle) image.Point

Size returns the size of the provided area.

func VSplit

func VSplit(area image.Rectangle, widthPerc int) (left image.Rectangle, right image.Rectangle, err error)

VSplit returns two new areas created by splitting the provided area at the specified percentage of its width. The percentage must be in the range 0 <= widthPerc <= 100. Can return zero size areas.

func VSplitCells

func VSplitCells(area image.Rectangle, cells int) (left image.Rectangle, right image.Rectangle, err error)

VSplitCells returns two new areas created by splitting the provided area after the specified amount of cells of its width. The number of cells must be a zero or a positive integer. Providing a zero returns left=image.ZR, right=area. Providing a number equal or larger to area's width returns left=area, right=image.ZR.

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.