SkIRect Reference === # IRect # Struct SkIRect SkIRect holds four 32-bit integer coordinates describing the upper and lower bounds of a rectangle. SkIRect may be created from outer bounds or from position, width, and height. SkIRect describes an area; if its right is less than or equal to its left, or if its bottom is less than or equal to its top, it is considered empty. ## Overview

Topic	Description
Constructors	functions that construct SkIRect
Functions	global and class member functions
Members	member values
Operators	operator overloading methods
Related Functions	similar member functions grouped together

## Related Function SkIRect global, struct, and class related member functions share a topic.

Topic	Description
Inset Outset Offset	moves sides
Intersection	sets to shared bounds
Join	sets to union of bounds
Property	member values, center, validity
Set	replaces all values
Sorting	orders sides

## Member Function SkIRect member functions read and modify the structure properties.

Topic	Description
EmptyIRect	returns immutable bounds of (0, 0, 0, 0)
Intersects	returns true if areas overlap
IntersectsNoEmptyCheck	returns true if areas overlap skips empty check
MakeEmpty	returns bounds of (0, 0, 0, 0)
MakeLTRB	constructs from int left, top, right, bottom
MakeSize	constructs from ISize returning (0, 0, width, height)
MakeWH	constructs from int input returning (0, 0, width, height)
MakeXYWH	constructs from int input returning (x, y, width, height)
adjust	moves the sides independently relative to their original locations
bottom	returns larger bounds in y, if sorted
contains	returns true if IPoint (x, y) is equal or inside
containsNoEmptyCheck	returns true if contains unsorted IRect
height	returns span in y
height64	returns span in y as int64_t
inset	moves the sides symmetrically about the center
intersect	sets to shared area; returns true if not empty
intersectNoEmptyCheck	sets to shared area; returns true if not empty skips empty check
isEmpty	returns true if width or height are zero or negative or they exceed int32_t
isEmpty64	returns true if width or height are zero or negative
join	sets to union of bounds
left	returns smaller bounds in x, if sorted
makeInset	constructs from sides moved symmetrically about the center
makeOffset	constructs from translated sides
makeOutset	constructs from sides moved symmetrically about the center
makeSorted	constructs IRect, ordering sides from smaller to larger
offset	translates sides without changing width and height
offsetTo	translates to (x, y) without changing width and height
outset	moves the sides symmetrically about the center
right	returns larger bounds in x, if sorted
set	sets to (left, top, right, bottom)
setEmpty	sets to (0, 0, 0, 0)
setLTRB	sets to SkScalar input (left, top, right, bottom)
setXYWH	sets to (x, y, width, height)
size	returns ISize (width, height)
sort	orders sides from smaller to larger
top	returns smaller bounds in y, if sorted
width	returns span in x
width64	returns span in y as int64_t
x	returns bounds left
y	returns bounds top

## Member ### Members

Type	Name	Description
int32_t	`fLeft`	smaller x-axis bounds
int32_t	`fTop`	smaller y-axis bounds
int32_t	`fRight`	larger x-axis bounds
int32_t	`fBottom`	larger y-axis bounds

SkIRect members may be read and written directly without using a member function.

Topic	Description
fBottom	larger y-axis bounds
fLeft	smaller x-axis bounds
fRight	larger x-axis bounds
fTop	smaller y-axis bounds

### Members ## Constructor SkIRect can be constructed or initialized by these functions, including C++ class constructors.

Type	Name	Description
int32_t	`fLeft`	May contain any value. The smaller of the horizontal values when sorted. When equal to or greater than fRight, IRect is empty.
int32_t	`fTop`	May contain any value. The smaller of the horizontal values when sorted. When equal to or greater than fBottom, IRect is empty.
int32_t	`fRight`	May contain any value. The larger of the vertical values when sorted. When equal to or less than fLeft, IRect is empty.
int32_t	`fBottom`	May contain any value. The larger of the vertical values when sorted. When equal to or less than fTop, IRect is empty.

Topic	Description
EmptyIRect	returns immutable bounds of (0, 0, 0, 0)
MakeEmpty	returns bounds of (0, 0, 0, 0)
MakeLTRB	constructs from int left, top, right, bottom
MakeSize	constructs from ISize returning (0, 0, width, height)
MakeWH	constructs from int input returning (0, 0, width, height)
MakeXYWH	constructs from int input returning (x, y, width, height)
makeInset	constructs from sides moved symmetrically about the center
makeOffset	constructs from translated sides
makeOutset	constructs from sides moved symmetrically about the center
makeSorted	constructs IRect, ordering sides from smaller to larger

## MakeEmpty

static constexpr SkIRect SK_WARN_UNUSED_RESULT MakeEmpty()

Returns constructed IRect set to (0, 0, 0, 0). Many other rectangles are empty; if left is equal to or greater than right, or if top is equal to or greater than bottom. Setting all members to zero is a convenience, but does not designate a special empty rectangle. ### Return Value bounds (0, 0, 0, 0) ### Example

#### Example Output ~~~~ MakeEmpty isEmpty: true offset rect isEmpty: true inset rect isEmpty: true outset rect isEmpty: false ~~~~

### See Also EmptyIRect isEmpty setEmpty SkRect::MakeEmpty --- ## MakeWH

static constexpr SkIRect SK_WARN_UNUSED_RESULT MakeWH(int32_t w, int32_t h)

Returns constructed IRect set to (0, 0, w, h). Does not validate input; w or h may be negative. ### Parameters

`w`	width of constructed IRect
`h`	height of constructed IRect

### Return Value bounds (0, 0, w, h) ### Example

#### Example Output ~~~~ all equal ~~~~

### See Also MakeSize MakeXYWH SkRect::MakeWH SkRect::MakeIWH --- ## MakeSize

static constexpr SkIRect SK_WARN_UNUSED_RESULT MakeSize(const SkISize& size)

Returns constructed IRect set to (0, 0, size.width, size.height). Does not validate input; size.width or size.height may be negative. ### Parameters

size values for IRect width and height

### Return Value bounds (0, 0, size.width, size.height) ### Example

#### Example Output ~~~~ round width: 26 height: 36 floor width: 25 height: 35 ~~~~

### See Also MakeWH MakeXYWH SkRect::Make^[2] SkRect::MakeIWH --- ## MakeLTRB

static constexpr SkIRect SK_WARN_UNUSED_RESULT MakeLTRB(int32_t l, int32_t t, int32_t r, int32_t b)

Returns constructed IRect set to (l, t, r, b). Does not sort input; IRect may result in fLeft greater than fRight, or fTop greater than fBottom. ### Parameters

`l`	integer stored in fLeft
`t`	integer stored in fTop
`r`	integer stored in fRight
`b`	integer stored in fBottom

### Return Value bounds (l, t, r, b) ### Example

#### Example Output ~~~~ rect: 5, 35, 15, 25 isEmpty: true rect: 5, 25, 15, 35 isEmpty: false ~~~~

### See Also MakeXYWH SkRect::MakeLTRB --- ## MakeXYWH

static constexpr SkIRect SK_WARN_UNUSED_RESULT MakeXYWH(int32_t x, int32_t y, int32_t w, int32_t h)

Returns constructed IRect set to: (x, y, x + w, y + h) . Does not validate input; w or h may be negative. ### Parameters

`x`	stored in fLeft
`y`	stored in fTop
`w`	added to x and stored in fRight
`h`	added to y and stored in fBottom

### Return Value bounds at (x, y) with width w and height h ### Example

#### Example Output ~~~~ rect: 5, 35, -10, 60 isEmpty: true rect: -10, 35, 5, 60 isEmpty: false ~~~~

### See Also MakeLTRB SkRect::MakeXYWH --- ## Property

Topic	Description
bottom	returns larger bounds in y, if sorted
height	returns span in y
height64	returns span in y as int64_t
isEmpty	returns true if width or height are zero or negative or they exceed int32_t
isEmpty64	returns true if width or height are zero or negative
left	returns smaller bounds in x, if sorted
right	returns larger bounds in x, if sorted
size	returns ISize (width, height)
top	returns smaller bounds in y, if sorted
width	returns span in x
width64	returns span in y as int64_t
x	returns bounds left
y	returns bounds top

## left

int32_t left() const

Returns left edge of IRect, if sorted. Call sort to reverse fLeft and fRight if needed. ### Return Value fLeft ### Example

#### Example Output ~~~~ unsorted.fLeft: 15 unsorted.left(): 15 sorted.fLeft: 10 sorted.left(): 10 ~~~~

### See Also fLeft x SkRect::left() --- ## top

int32_t top() const

Returns top edge of IRect, if sorted. Call isEmpty to see if IRect may be invalid, and sort to reverse fTop and fBottom if needed. ### Return Value fTop ### Example

#### Example Output ~~~~ unsorted.fTop: 25 unsorted.top(): 25 sorted.fTop: 5 sorted.top(): 5 ~~~~

### See Also fTop y SkRect::top() --- ## right

int32_t right() const

Returns right edge of IRect, if sorted. Call sort to reverse fLeft and fRight if needed. ### Return Value fRight ### Example

#### Example Output ~~~~ unsorted.fRight: 10 unsorted.right(): 10 sorted.fRight: 15 sorted.right(): 15 ~~~~

### See Also fRight SkRect::right() --- ## bottom

int32_t bottom() const

Returns bottom edge of IRect, if sorted. Call isEmpty to see if IRect may be invalid, and sort to reverse fTop and fBottom if needed. ### Return Value fBottom ### Example

#### Example Output ~~~~ unsorted.fBottom: 5 unsorted.bottom(): 5 sorted.fBottom: 25 sorted.bottom(): 25 ~~~~

### See Also fBottom SkRect::bottom() --- ## x

int32_t x() const

Returns left edge of IRect, if sorted. Call isEmpty to see if IRect may be invalid, and sort to reverse fLeft and fRight if needed. ### Return Value fLeft ### Example

#### Example Output ~~~~ unsorted.fLeft: 15 unsorted.x(): 15 sorted.fLeft: 10 sorted.x(): 10 ~~~~

### See Also fLeft left y SkRect::x() --- ## y

int32_t y() const

Returns top edge of IRect, if sorted. Call isEmpty to see if IRect may be invalid, and sort to reverse fTop and fBottom if needed. ### Return Value fTop ### Example

#### Example Output ~~~~ unsorted.fTop: 25 unsorted.y(): 25 sorted.fTop: 5 sorted.y(): 5 ~~~~

### See Also fTop top x SkRect::y() --- ## width

int32_t width() const

Returns span on the x-axis. This does not check if IRect is sorted, or if result fits in 32-bit signed integer; result may be negative. ### Return Value fRight minus fLeft ### Example

#### Example Output ~~~~ unsorted width: -5 large width: -5 ~~~~

### See Also height width64 height64 SkRect::width() --- ## width64

int64_t width64() const

Returns span on the x-axis. This does not check if IRect is sorted, so the result may be negative. This is safer than calling width since width might overflow in its calculation. ### Return Value fRight minus fLeft cast to int64_t ### Example

#### Example Output ~~~~ width: -5 width64: 4294967291 ~~~~

### See Also width height height64 SkRect::width() --- ## height

int32_t height() const

Returns span on the y-axis. This does not check if IRect is sorted, or if result fits in 32-bit signed integer; result may be negative. ### Return Value fBottom minus fTop ### Example

#### Example Output ~~~~ unsorted height: -5 large height: -5 ~~~~

### See Also width SkRect::height() --- ## height64

int64_t height64() const

Returns span on the y-axis. This does not check if IRect is sorted, so the result may be negative. This is safer than calling height since height might overflow in its calculation. ### Return Value fBottom minus fTop cast to int64_t ### Example

#### Example Output ~~~~ height: -5 height64: 4294967291 ~~~~

### See Also width height width64 SkRect::height() --- ## size

SkISize size() const

Returns spans on the x-axis and y-axis. This does not check if IRect is sorted, or if result fits in 32-bit signed integer; result may be negative. ### Return Value ISize (width, height) ### Example

#### Example Output ~~~~ original rect: 20, 30, 40, 50 size: 20, 20 offset rect: 40, 50, 60, 70 size: 20, 20 outset rect: 20, 30, 80, 90 size: 60, 60 ~~~~

### See Also height width MakeSize --- ## isEmpty

bool isEmpty() const

Returns true if width or height . ### Return Value true if width or height are zero or negative ### Example

#### Example Output ~~~~ rect: {20, 40, 10, 50} is empty sorted: {10, 40, 20, 50} is not empty rect: {20, 40, 20, 50} is empty sorted: {20, 40, 20, 50} is empty ~~~~

### See Also EmptyIRect MakeEmpty sort SkRect::isEmpty --- ## isEmpty64

bool isEmpty64() const

Returns true if fLeft is equal to or greater than fRight, or if fTop is equal to or greater than fBottom. Call sort to reverse rectangles with negative width64 or height64. ### Return Value true if width64 or height64 are zero or negative ### Example

#### Example Output ~~~~ rect: {20, 40, 10, 50} is empty sorted: {10, 40, 20, 50} is not empty rect: {20, 40, 20, 50} is empty sorted: {20, 40, 20, 50} is empty ~~~~

### See Also EmptyIRect MakeEmpty sort SkRect::isEmpty --- ## Operator SkIRect operators inline class member functions with arithmetic equivalents.

Topic	Description
operator!=(const SkIRect& a, const SkIRect& b)	returns true if members are unequal
operator==(const SkIRect& a, const SkIRect& b)	returns true if members are equal

## operator==

bool operator==(const SkIRect& a, const SkIRect& b)

Returns true if all members in a: fLeft, fTop, fRight, and fBottom; are identical to corresponding members in b. ### Parameters

`a`	IRect to compare
`b`	IRect to compare

### Return Value true if members are equal ### Example

#### Example Output ~~~~ test == sorted ~~~~

### See Also operator!=(const SkIRect& a, const SkIRect& b) --- ## operator!=

bool operator!=(const SkIRect& a, const SkIRect& b)

Returns true if any member in a: fLeft, fTop, fRight, and fBottom; is not identical to the corresponding member in b. ### Parameters

`a`	IRect to compare
`b`	IRect to compare

### Return Value true if members are not equal ### Example

#### Example Output ~~~~ test != sorted ~~~~

### See Also operator==(const SkIRect& a, const SkIRect& b) --- ## Set

Topic	Description
set	sets to (left, top, right, bottom)
setEmpty	sets to (0, 0, 0, 0)
setLTRB	sets to SkScalar input (left, top, right, bottom)
setXYWH	sets to (x, y, width, height)

## setEmpty

void setEmpty()

Sets IRect to (0, 0, 0, 0). Many other rectangles are empty; if left is equal to or greater than right, or if top is equal to or greater than bottom. Setting all members to zero is a convenience, but does not designate a special empty rectangle. ### Example

#### Example Output ~~~~ rect: {3, 4, 1, 2} is empty rect: {0, 0, 0, 0} is empty ~~~~

### See Also MakeEmpty SkRect::setEmpty --- ## set

void set(int32_t left, int32_t top, int32_t right, int32_t bottom)

Sets IRect to (left, top, right, bottom). left and right are not sorted; left is not necessarily less than right. top and bottom are not sorted; top is not necessarily less than bottom. ### Parameters

`left`	assigned to fLeft
`top`	assigned to fTop
`right`	assigned to fRight
`bottom`	assigned to fBottom

### Example

#### Example Output ~~~~ rect1: {3, 4, 1, 2} rect2: {3, 4, 1, 2} ~~~~

### See Also setLTRB setXYWH SkRect::set^[2]^[3]^[4] --- ## setLTRB

void setLTRB(int32_t left, int32_t top, int32_t right, int32_t bottom)

`left`	stored in fLeft
`top`	stored in fTop
`right`	stored in fRight
`bottom`	stored in fBottom

### Example

#### Example Output ~~~~ rect1: {3, 4, 1, 2} rect2: {3, 4, 1, 2} ~~~~

### See Also set setXYWH SkRect::setLTRB --- ## setXYWH

void setXYWH(int32_t x, int32_t y, int32_t width, int32_t height)

Sets IRect to: (x, y, x + width, y + height) . Does not validate input; width or height may be negative. ### Parameters

`x`	stored in fLeft
`y`	stored in fTop
`width`	added to x and stored in fRight
`height`	added to y and stored in fBottom

### Example

#### Example Output ~~~~ rect: 5, 35, -10, 60 isEmpty: true rect: -10, 35, 5, 60 isEmpty: false ~~~~

### See Also MakeXYWH setLTRB set SkRect::setXYWH --- ## Inset Outset Offset

Topic	Description
adjust	moves the sides independently relative to their original locations
inset	moves the sides symmetrically about the center
offset	translates sides without changing width and height
	offset(int32 t dx, int32 t dy)
offsetTo	translates to (x, y) without changing width and height
outset	moves the sides symmetrically about the center

## makeOffset

SkIRect makeOffset(int32_t dx, int32_t dy) const

Returns IRect offset by (dx, dy). If dx is negative, IRect returned is moved to the left. If dx is positive, IRect returned is moved to the right. If dy is negative, IRect returned is moved upward. If dy is positive, IRect returned is moved downward. ### Parameters

`dx`	offset added to fLeft and fRight
`dy`	offset added to fTop and fBottom

### Return Value IRect offset by dx and dy, with original width and height ### Example

#### Example Output ~~~~ rect: 10, 50, 20, 60 isEmpty: false rect: 25, 82, 35, 92 isEmpty: false ~~~~

### See Also offset^[2] makeInset makeOutset SkRect::makeOffset --- ## makeInset

SkIRect makeInset(int32_t dx, int32_t dy) const

Returns IRect, inset by (dx, dy). If dx is negative, IRect returned is wider. If dx is positive, IRect returned is narrower. If dy is negative, IRect returned is taller. If dy is positive, IRect returned is shorter. ### Parameters

`dx`	offset added to fLeft and subtracted from fRight
`dy`	offset added to fTop and subtracted from fBottom

### Return Value IRect inset symmetrically left and right, top and bottom ### Example

#### Example Output ~~~~ rect: 10, 50, 20, 60 isEmpty: false rect: 25, 82, 5, 28 isEmpty: true ~~~~

### See Also inset makeOffset makeOutset SkRect::makeInset --- ## makeOutset

SkIRect makeOutset(int32_t dx, int32_t dy) const

Returns IRect, outset by (dx, dy). If dx is negative, IRect returned is narrower. If dx is positive, IRect returned is wider. If dy is negative, IRect returned is shorter. If dy is positive, IRect returned is taller. ### Parameters

`dx`	offset subtracted to fLeft and added from fRight
`dy`	offset subtracted to fTop and added from fBottom

### Return Value IRect outset symmetrically left and right, top and bottom ### Example

#### Example Output ~~~~ rect: 10, 50, 20, 60 isEmpty: false rect: -5, 18, 35, 92 isEmpty: false ~~~~

### See Also outset makeOffset makeInset SkRect::makeOutset --- ## offset

void offset(int32_t dx, int32_t dy)

Offsets IRect by adding dx to fLeft, fRight; and by adding dy to fTop, fBottom. If dx is negative, moves IRect returned to the left. If dx is positive, moves IRect returned to the right. If dy is negative, moves IRect returned upward. If dy is positive, moves IRect returned downward. ### Parameters

`dx`	offset added to fLeft and fRight
`dy`	offset added to fTop and fBottom

### Example

#### Example Output ~~~~ rect: 15, 27, 55, 86 ~~~~

### See Also offsetTo makeOffset SkRect::offset^[2] ---

void offset(const SkIPoint& delta)

Offsets IRect by adding delta.fX to fLeft, fRight; and by adding delta.fY to fTop, fBottom. If delta.fX is negative, moves IRect returned to the left. If delta.fX is positive, moves IRect returned to the right. If delta.fY is negative, moves IRect returned upward. If delta.fY is positive, moves IRect returned downward. ### Parameters

delta offset added to IRect

### Example

#### Example Output ~~~~ rect: 15, 27, 55, 86 ~~~~

### See Also offsetTo makeOffset SkRect::offset^[2] --- ## offsetTo

void offsetTo(int32_t newX, int32_t newY)

Offsets IRect so that fLeft equals newX, and fTop equals newY. width and height are unchanged. ### Parameters

`newX`	stored in fLeft, preserving width
`newY`	stored in fTop, preserving height

### Example

#### Example Output ~~~~ rect: 15, 27, 55, 86 ~~~~

### See Also offset^[2] makeOffset setXYWH SkRect::offsetTo --- ## inset

void inset(int32_t dx, int32_t dy)

Insets IRect by (dx,dy). If dx is positive, makes IRect narrower. If dx is negative, makes IRect wider. If dy is positive, makes IRect shorter. If dy is negative, makes IRect taller. ### Parameters

`dx`	offset added to fLeft and subtracted from fRight
`dy`	offset added to fTop and subtracted from fBottom

### Example

#### Example Output ~~~~ rect: 15, 27, 45, 60 ~~~~

### See Also outset makeInset SkRect::inset --- ## outset

void outset(int32_t dx, int32_t dy)

Outsets IRect by (dx, dy). If dx is positive, makes IRect wider. If dx is negative, makes IRect narrower. If dy is positive, makes IRect taller. If dy is negative, makes IRect shorter. ### Parameters

`dx`	subtracted to fLeft and added from fRight
`dy`	subtracted to fTop and added from fBottom

### Example

#### Example Output ~~~~ rect: 5, 1, 55, 86 ~~~~

### See Also inset makeOutset SkRect::outset --- ## Intersection IRects intersect when they enclose a common area. To intersect, each of the pair must describe area; fLeft is less than fRight, and fTop is less than fBottom; empty() returns false. The intersection of IRect pair can be described by: (max(a.fLeft, b.fLeft), max(a.fTop, b.fTop), min(a.fRight, b.fRight), min(a.fBottom, b.fBottom)) . The intersection is only meaningful if the resulting IRect is not empty and describes an area: fLeft is less than fRight, and fTop is less than fBottom.

Topic	Description
Intersects	returns true if areas overlap
IntersectsNoEmptyCheck	returns true if areas overlap skips empty check
contains	returns true if IPoint (x, y) is equal or inside
	contains(int32 t x, int32 t y) const
containsNoEmptyCheck	returns true if contains unsorted IRect
	containsNoEmptyCheck(int32 t left, int32 t top, int32 t right, int32 t bottom) const
intersect	sets to shared area; returns true if not empty
	intersect(const SkIRect& r)
intersectNoEmptyCheck	sets to shared area; returns true if not empty skips empty check

## adjust

void adjust(int32_t dL, int32_t dT, int32_t dR, int32_t dB)

Adjusts IRect by adding dL to fLeft, dT to fTop, dR to fRight, and dB to fBottom. If dL is positive, narrows IRect on the left. If negative, widens it on the left. If dT is positive, shrinks IRect on the top. If negative, lengthens it on the top. If dR is positive, narrows IRect on the right. If negative, widens it on the right. If dB is positive, shrinks IRect on the bottom. If negative, lengthens it on the bottom. The resulting IRect is not checked for validity. Thus, if the resulting IRect left is greater than right, the IRect will be considered empty. Call sort after this call if that is not the desired behavior. ### Parameters

`dL`	offset added to fLeft
`dT`	offset added to fTop
`dR`	offset added to fRight
`dB`	offset added to fBottom

### Example

#### Example Output ~~~~ rect: 10, 10, 20, 20 ~~~~

### See Also inset outset --- ## contains

bool contains(int32_t x, int32_t y) const

Returns true if: fLeft <= x < fRight && fTop <= y < fBottom. Returns false if IRect is empty. Considers input to describe constructed IRect: (x, y, x + 1, y + 1) and returns true if constructed area is completely enclosed by IRect area. ### Parameters

`x`	test IPoint x-coordinate
`y`	test IPoint y-coordinate

### Return Value true if (x, y) is inside IRect ### Example

#### Example Output ~~~~ rect: (30, 50, 40, 60) contains (30, 50) rect: (30, 50, 40, 60) does not contain (40, 50) rect: (30, 50, 40, 60) does not contain (30, 60) ~~~~

### See Also containsNoEmptyCheck^[2] SkRect::contains^[2]^[3] ---

bool contains(int32_t left, int32_t top, int32_t right, int32_t bottom) const

Constructs IRect to intersect from (left, top, right, bottom). Does not sort construction. Returns true if IRect contains construction. Returns false if IRect is empty or construction is empty. ### Parameters

`left`	x-axis minimum of constructed IRect
`top`	y-axis minimum of constructed IRect
`right`	x-axis maximum of constructed IRect
`bottom`	y-axis maximum of constructed IRect

### Return Value true if all sides of IRect are outside construction ### Example