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.
SkIRect global, struct, and class related member functions share a topic.
SkIRect member functions read and modify the structure properties.
SkIRect members may be read and written directly without using a member function.
SkIRect can be constructed or initialized by these functions, including C++ class constructors.
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.
bounds (0, 0, 0, 0)
MakeEmpty isEmpty: true offset rect isEmpty: true inset rect isEmpty: true outset rect isEmpty: false
EmptyIRect isEmpty setEmpty SkRect::MakeEmpty
Returns constructed IRect set to (0, 0, w, h). Does not validate input; w or h may be negative.
bounds (0, 0, w, h)
all equal
MakeSize MakeXYWH SkRect::MakeWH SkRect::MakeIWH
Returns constructed IRect set to (0, 0, size.width, size.height). Does not validate input; size.width or size.height may be negative.
bounds (0, 0, size.width, size.height)
round width: 26 height: 36 floor width: 25 height: 35
MakeWH MakeXYWH SkRect::Make[2] SkRect::MakeIWH
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.
bounds (l, t, r, b)
rect: 5, 35, 15, 25 isEmpty: true rect: 5, 25, 15, 35 isEmpty: false
MakeXYWH SkRect::MakeLTRB
Returns constructed IRect set to: (x, y, x + w, y + h). Does not validate input; w or h may be negative.
bounds at (x, y) with width w and height h
rect: 5, 35, -10, 60 isEmpty: true rect: -10, 35, 5, 60 isEmpty: false
MakeLTRB SkRect::MakeXYWH
Returns left edge of IRect, if sorted. Call sort to reverse fLeft and fRight if needed.
fLeft
unsorted.fLeft: 15 unsorted.left(): 15 sorted.fLeft: 10 sorted.left(): 10
fLeft x SkRect::left()
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.
fTop
unsorted.fTop: 25 unsorted.top(): 25 sorted.fTop: 5 sorted.top(): 5
fTop y SkRect::top()
Returns right edge of IRect, if sorted. Call sort to reverse fLeft and fRight if needed.
fRight
unsorted.fRight: 10 unsorted.right(): 10 sorted.fRight: 15 sorted.right(): 15
fRight SkRect::right()
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.
fBottom
unsorted.fBottom: 5 unsorted.bottom(): 5 sorted.fBottom: 25 sorted.bottom(): 25
fBottom SkRect::bottom()
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.
fLeft
unsorted.fLeft: 15 unsorted.x(): 15 sorted.fLeft: 10 sorted.x(): 10
fLeft left y SkRect::x()
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.
fTop
unsorted.fTop: 25 unsorted.y(): 25 sorted.fTop: 5 sorted.y(): 5
fTop top x SkRect::y()
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.
fRight minus fLeft
unsorted width: -5 large width: -5
height width64 height64 SkRect::width()
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.
fRight minus fLeft cast to int64_t
width: -5 width64: 4294967291
width height height64 SkRect::width()
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.
fBottom minus fTop
unsorted height: -5 large height: -5
width SkRect::height()
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.
fBottom minus fTop cast to int64_t
height: -5 height64: 4294967291
width height width64 SkRect::height()
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.
ISize (width, height)
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
height width MakeSize
Returns true if width or height .
true if width or height are zero or negative
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
EmptyIRect MakeEmpty sort SkRect::isEmpty
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.
true if width64 or height64 are zero or negative
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
EmptyIRect MakeEmpty sort SkRect::isEmpty
SkIRect operators inline class member functions with arithmetic equivalents.
Returns true if all members in a: fLeft, fTop, fRight, and fBottom; are identical to corresponding members in b.
true if members are equal
test == sorted
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.
true if members are not equal
test != sorted
operator==(const SkIRect& a, const SkIRect& b)
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.
rect: {3, 4, 1, 2} is empty
rect: {0, 0, 0, 0} is empty
MakeEmpty SkRect::setEmpty
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.
rect1: {3, 4, 1, 2}
rect2: {3, 4, 1, 2}
setLTRB setXYWH SkRect::set[2][3][4]
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.
rect1: {3, 4, 1, 2}
rect2: {3, 4, 1, 2}
set setXYWH SkRect::setLTRB
Sets IRect to: (x, y, x + width, y + height). Does not validate input; width or height may be negative.
rect: 5, 35, -10, 60 isEmpty: true rect: -10, 35, 5, 60 isEmpty: false
MakeXYWH setLTRB set SkRect::setXYWH
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.
IRect offset by dx and dy, with original width and height
rect: 10, 50, 20, 60 isEmpty: false rect: 25, 82, 35, 92 isEmpty: false
offset[2] makeInset makeOutset SkRect::makeOffset
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.
IRect inset symmetrically left and right, top and bottom
rect: 10, 50, 20, 60 isEmpty: false rect: 25, 82, 5, 28 isEmpty: true
inset makeOffset makeOutset SkRect::makeInset
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.
IRect outset symmetrically left and right, top and bottom
rect: 10, 50, 20, 60 isEmpty: false rect: -5, 18, 35, 92 isEmpty: false
outset makeOffset makeInset SkRect::makeOutset
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.
rect: 15, 27, 55, 86
offsetTo makeOffset SkRect::offset[2]
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.
rect: 15, 27, 55, 86
offsetTo makeOffset SkRect::offset[2]
Offsets IRect so that fLeft equals newX, and fTop equals newY. width and height are unchanged.
rect: 15, 27, 55, 86
offset[2] makeOffset setXYWH SkRect::offsetTo
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.
rect: 15, 27, 45, 60
outset makeInset SkRect::inset
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.
rect: 5, 1, 55, 86
inset makeOutset SkRect::outset
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.
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.
rect: 10, 10, 20, 20
inset outset
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.
true if (x, y) is inside IRect
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)
containsNoEmptyCheck[2] SkRect::contains[2][3]
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.
true if all sides of IRect are outside construction
rect: (30, 50, 40, 60) contains (30, 50, 31, 51) rect: (30, 50, 40, 60) does not contain (39, 49, 40, 50) rect: (30, 50, 40, 60) does not contain (29, 59, 30, 60)
containsNoEmptyCheck[2] SkRect::contains[2][3]
Returns true if IRect contains r. Returns false if IRect is empty or r is empty.
IRect contains r when IRect area completely includes r area.
true if all sides of IRect are outside r
rect: (30, 50, 40, 60) contains (30, 50, 31, 51) rect: (30, 50, 40, 60) does not contain (39, 49, 40, 50) rect: (30, 50, 40, 60) does not contain (29, 59, 30, 60)
containsNoEmptyCheck[2] SkRect::contains[2][3]
Returns true if IRect contains r. Returns false if IRect is empty or r is empty.
IRect contains r when IRect area completely includes r area.
true if all sides of IRect are outside r
rect: (30, 50, 40, 60) contains (30, 50, 31, 51) rect: (30, 50, 40, 60) does not contain (39, 49, 40, 50) rect: (30, 50, 40, 60) does not contain (29, 59, 30, 60)
containsNoEmptyCheck[2] SkRect::contains[2][3]
Constructs IRect from (left, top, right, bottom). Does not sort construction.
Returns true if IRect contains construction. Asserts if IRect is empty or construction is empty, and if SK_DEBUG is defined.
Return is undefined if IRect is empty or construction is empty.
true if all sides of IRect are outside construction
rect: (30, 50, 40, 60) contains (30, 50, 31, 51) rect: (30, 50, 40, 60) does not contain (39, 49, 40, 50) rect: (30, 50, 40, 60) does not contain (29, 59, 30, 60)
contains[2][3][4] SkRect::contains[2][3]
Returns true if IRect contains construction. Asserts if IRect is empty or construction is empty, and if SK_DEBUG is defined.
Return is undefined if IRect is empty or construction is empty.
true if all sides of IRect are outside r
rect: (30, 50, 40, 60) contains (30, 50, 31, 51) rect: (30, 50, 40, 60) does not contain (39, 49, 40, 50) rect: (30, 50, 40, 60) does not contain (29, 59, 30, 60)
contains[2][3][4] SkRect::contains[2][3]
Returns true if IRect intersects r, and sets IRect to intersection. Returns false if IRect does not intersect r, and leaves IRect unchanged.
Returns false if either r or IRect is empty, leaving IRect unchanged.
true if r and IRect have area in common
intersection: 30, 60, 50, 80
Intersects intersectNoEmptyCheck join[2] SkRect::intersect[2][3]
Returns true if a intersects b, and sets IRect to intersection. Returns false if a does not intersect b, and leaves IRect unchanged.
Returns false if either a or b is empty, leaving IRect unchanged.
true if a and b have area in common
intersection: 30, 60, 50, 80
Intersects intersectNoEmptyCheck join[2] SkRect::intersect[2][3]
Returns true if a intersects b, and sets IRect to intersection. Returns false if a does not intersect b, and leaves IRect unchanged.
Asserts if either a or b is empty, and if SK_DEBUG is defined.
true if a and b have area in common
intersection: 30, 60, 50, 80
Intersects intersect[2][3] join[2] SkRect::intersect[2][3]
Constructs IRect to intersect from (left, top, right, bottom). Does not sort construction.
Returns true if IRect intersects construction, and sets IRect to intersection. Returns false if IRect does not intersect construction, and leaves IRect unchanged.
Returns false if either construction or IRect is empty, leaving IRect unchanged.
true if construction and IRect have area in common
intersection: 30, 60, 50, 80
intersectNoEmptyCheck Intersects join[2] SkRect::intersect[2][3]
Returns true if a intersects b. Returns false if either a or b is empty, or do not intersect.
true if a and b have area in common
intersection
IntersectsNoEmptyCheck intersect[2][3] SkRect::intersect[2][3]
Returns true if a intersects b. Asserts if either a or b is empty, and if SK_DEBUG is defined.
true if a and b have area in common
intersection
Intersects intersect[2][3] SkRect::intersect[2][3]
Constructs IRect to intersect from (left, top, right, bottom). Does not sort construction.
Sets IRect to the union of itself and the construction.
Has no effect if construction is empty. Otherwise, if IRect is empty, sets IRect to construction.
join: 10, 20, 55, 65
set SkRect::join[2]
Sets IRect to the union of itself and r.
Has no effect if r is empty. Otherwise, if IRect is empty, sets IRect to r.
join: 10, 20, 55, 65
set SkRect::join[2]
Swaps fLeft and fRight if fLeft is greater than fRight; and swaps fTop and fBottom if fTop is greater than fBottom. Result may be empty, and width and height will be zero or positive.
rect: 30, 50, 20, 10 sorted: 20, 10, 30, 50
makeSorted SkRect::sort
Returns IRect with fLeft and fRight swapped if fLeft is greater than fRight; and with fTop and fBottom swapped if fTop is greater than fBottom. Result may be empty; and width and height will be zero or positive.
sorted IRect
rect: 30, 50, 20, 10 sorted: 20, 10, 30, 50
sort SkRect::makeSorted
Returns a reference to immutable empty IRect, set to (0, 0, 0, 0).
global IRect set to all zeroes
rect: 0, 0, 0, 0
MakeEmpty
Deprecated.