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.
Returns constructed SkIRect 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 SkIRect 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 SkIRect 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 SkRect::MakeIWH
Returns constructed SkIRect set to (l, t, r, b). Does not sort input; SkIRect 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 SkIRect 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 SkIRect, 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 SkIRect, if sorted. Call isEmpty() to see if SkIRect 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 SkIRect, 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 SkIRect, if sorted. Call isEmpty() to see if SkIRect 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 SkIRect, if sorted. Call isEmpty() to see if SkIRect 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 SkIRect, if sorted. Call isEmpty() to see if SkIRect 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 SkIRect 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 SkIRect 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 SkIRect 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 SkIRect 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 SkIRect is sorted, or if result fits in 32-bit signed integer; result may be negative.
SkISize (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() are zero or negative.
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
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 SkIRect 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 SkIRect 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
Sets SkIRect 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 SkIRect offset by (dx, dy).
If dx is negative, SkIRect returned is moved to the left. If dx is positive, SkIRect returned is moved to the right. If dy is negative, SkIRect returned is moved upward. If dy is positive, SkIRect returned is moved downward.
SkIRect 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() makeInset makeOutset SkRect::makeOffset
Returns SkIRect, inset by (dx, dy).
If dx is negative, SkIRect returned is wider. If dx is positive, SkIRect returned is narrower. If dy is negative, SkIRect returned is taller. If dy is positive, SkIRect returned is shorter.
SkIRect 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 SkIRect, outset by (dx, dy).
If dx is negative, SkIRect returned is narrower. If dx is positive, SkIRect returned is wider. If dy is negative, SkIRect returned is shorter. If dy is positive, SkIRect returned is taller.
SkIRect 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 SkIRect by adding dx to fLeft, fRight; and by adding dy to fTop, fBottom.
If dx is negative, moves SkIRect returned to the left. If dx is positive, moves SkIRect returned to the right. If dy is negative, moves SkIRect returned upward. If dy is positive, moves SkIRect returned downward.
rect: 15, 27, 55, 86
offsetTo makeOffset SkRect::offset
Offsets SkIRect by adding delta.fX to fLeft, fRight; and by adding delta.fY to fTop, fBottom.
If delta.fX is negative, moves SkIRect returned to the left. If delta.fX is positive, moves SkIRect returned to the right. If delta.fY is negative, moves SkIRect returned upward. If delta.fY is positive, moves SkIRect returned downward.
rect: 15, 27, 55, 86
offsetTo makeOffset SkRect::offset
Offsets SkIRect so that fLeft equals newX, and fTop equals newY. width and height are unchanged.
rect: 15, 27, 55, 86
offset makeOffset setXYWH SkRect::offsetTo
Insets SkIRect by (dx,dy).
If dx is positive, makes SkIRect narrower. If dx is negative, makes SkIRect wider. If dy is positive, makes SkIRect shorter. If dy is negative, makes SkIRect taller.
rect: 15, 27, 45, 60
outset makeInset SkRect::inset
Outsets SkIRect by (dx, dy).
If dx is positive, makes SkIRect wider. If dx is negative, makes SkIRect narrower. If dy is positive, makes SkIRect taller. If dy is negative, makes SkIRect 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; SkIRect::isEmpty() 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 SkIRect by adding dL to fLeft, dT to fTop, dR to fRight, and dB to fBottom.
If dL is positive, narrows SkIRect on the left. If negative, widens it on the left. If dT is positive, shrinks SkIRect on the top. If negative, lengthens it on the top. If dR is positive, narrows SkIRect on the right. If negative, widens it on the right. If dB is positive, shrinks SkIRect on the bottom. If negative, lengthens it on the bottom.
The resulting SkIRect is not checked for validity. Thus, if the resulting SkIRect left is greater than right, the SkIRect 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 SkRect::contains
Constructs SkIRect to intersect from (left, top, right, bottom). Does not sort construction.
Returns true if SkIRect contains construction. Returns false if SkIRect is empty or construction is empty.
true if all sides of SkIRect 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 SkRect::contains
Returns true if SkIRect contains r. Returns false if SkIRect is empty or r is empty.
SkIRect contains r when SkIRect area completely includes r area.
true if all sides of SkIRect 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 SkRect::contains
Returns true if SkIRect contains r. Returns false if SkIRect is empty or r is empty.
SkIRect contains r when SkIRect area completely includes r area.
true if all sides of SkIRect 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 SkRect::contains
Constructs SkIRect from (left, top, right, bottom). Does not sort construction.
Returns true if SkIRect contains construction. Asserts if SkIRect is empty or construction is empty, and if SK_DEBUG is defined.
Return is undefined if SkIRect is empty or construction is empty.
true if all sides of SkIRect 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 SkRect::contains
Returns true if SkIRect contains construction. Asserts if SkIRect is empty or construction is empty, and if SK_DEBUG is defined.
Return is undefined if SkIRect is empty or construction is empty.
true if all sides of SkIRect 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 SkRect::contains
Returns true if SkIRect intersects r, and sets SkIRect to intersection. Returns false if SkIRect does not intersect r, and leaves SkIRect unchanged.
Returns false if either r or SkIRect is empty, leaving SkIRect unchanged.
true if r and SkIRect have area in common
intersection: 30, 60, 50, 80
Intersects intersectNoEmptyCheck join SkRect::intersect
Returns true if a intersects b, and sets SkIRect to intersection. Returns false if a does not intersect b, and leaves SkIRect unchanged.
Returns false if either a or b is empty, leaving SkIRect unchanged.
true if a and b have area in common
intersection: 30, 60, 50, 80
Intersects intersectNoEmptyCheck join SkRect::intersect
Returns true if a intersects b, and sets SkIRect to intersection. Returns false if a does not intersect b, and leaves SkIRect 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 join SkRect::intersect
Constructs SkIRect to intersect from (left, top, right, bottom). Does not sort construction.
Returns true if SkIRect intersects construction, and sets SkIRect to intersection. Returns false if SkIRect does not intersect construction, and leaves SkIRect unchanged.
Returns false if either construction or SkIRect is empty, leaving SkIRect unchanged.
true if construction and SkIRect have area in common
intersection: 30, 60, 50, 80
intersectNoEmptyCheck Intersects join SkRect::intersect
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 SkRect::intersect
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 SkRect::intersect
Constructs SkIRect to intersect from (left, top, right, bottom). Does not sort construction.
Sets SkIRect to the union of itself and the construction.
Has no effect if construction is empty. Otherwise, if SkIRect is empty, sets SkIRect to construction.
join: 10, 20, 55, 65
set SkRect::join
Sets SkIRect to the union of itself and r.
Has no effect if r is empty. Otherwise, if SkIRect is empty, sets SkIRect to r.
join: 10, 20, 55, 65
set SkRect::join
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 SkIRect 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 SkIRect
rect: 30, 50, 20, 10 sorted: 20, 10, 30, 50
sort SkRect::makeSorted
Returns a reference to immutable empty SkIRect, set to (0, 0, 0, 0).
global SkIRect set to all zeroes
rect: 0, 0, 0, 0
MakeEmpty