SkRect Reference

Rect

Overview

Overview Subtopic

namedescription
Constructorfunctions that construct SkRect
Member Functionstatic functions and member methods
Membermember values
Operatoroperator overloading methods
Related Functionsimilar methods grouped together

Struct SkRect

SkRect holds four SkScalar coordinates describing the upper and lower bounds of a rectangle. SkRect may be created from outer bounds or from position, width, and height. SkRect 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.

SkRect can be constructed from int values to avoid compiler warnings that integer input cannot convert to SkScalar without loss of precision.

Related Function

namedescription
As Pointsconversion to and from Points
From Integersset Scalar values from integer input
Inset Outset Offsetmoves sides
Intersectionset to shared bounds
Joinset to union of bounds
Propertymember values, center, validity
Roundingadjust to integer bounds
Setreplaces all values
Sortingorders sides

Member Function

namedescription
Intersectsreturns true if areas overlap
Makeconstructs from ISize returning (0, 0, width, height)
MakeEmptyconstructs from bounds of (0, 0, 0, 0)
MakeIWHconstructs from int input returning (0, 0, width, height)
MakeLTRBconstructs from SkScalar left, top, right, bottom
MakeSizeconstructs from Size returning (0, 0, width, height)
MakeWHconstructs from SkScalar input returning (0, 0, width, height)
MakeXYWHconstructs from SkScalar input returning (x, y, width, height)
asScalarsreturns pointer to members as array
bottomreturns larger bounds in y, if sorted
centerXreturns midpoint in x
centerYreturns midpoint in y
containsreturns true if points are equal or inside
dumpsends text representation to standard output using floats
dumpHexsends text representation to standard output using hexadecimal
heightreturns span in y
insetmoves the sides symmetrically about the center
intersectsets to shared area; returns true if not empty
intersectsreturns true if areas overlap
isEmptyreturns true if width or height are zero or negative
isFinitereturns true if no member is infinite or NaN
isSortedreturns true if width or height are zero or positive
isetsets to int input (left, top, right, bottom)
isetWHsets to int input (0, 0, width, height)
joinsets to union of bounds
joinNonEmptyArgsets to union of bounds, asserting that argument is not empty
joinPossiblyEmptyRectsets to union of bounds. Skips empty check for both
leftreturns smaller bounds in x, if sorted
makeInsetconstructs from sides moved symmetrically about the center
makeOffsetconstructs from translated sides
makeOutsetconstructs from sides moved symmetrically about the center
makeSortedconstructs, ordering sides from smaller to larger
offsettranslates sides without changing width and height
offsetTotranslates to (x, y) without changing width and height
outsetmoves the sides symmetrically about the center
rightreturns larger bounds in x, if sorted
roundsets members to nearest integer value
roundInsets members to nearest integer value towards opposite
roundOutsets members to nearest integer value away from opposite
setsets to SkScalar input (left, top, right, bottom) and others
setBoundssets to upper and lower limits of Point array
setBoundsChecksets to upper and lower limits of Point array
setEmptysets to (0, 0, 0, 0)
setLTRBsets to SkScalar input (left, top, right, bottom)
setWHsets to SkScalar input (0, 0, width, height)
setXYWHsets to SkScalar input (x, y, width, height)
sortorders sides from smaller to larger
toQuadreturns four corners as Point
topreturns smaller bounds in y, if sorted
widthreturns span in x
xreturns bounds left
yreturns bounds top

Member

namedescription
fBottomlarger y-axis bounds
fLeftsmaller x-axis bounds
fRightlarger x-axis bounds
fTopsmaller y-axis bounds

SkScalar fLeft

May contain any value, including infinities and NaN. The smaller of the horizontal values when sorted. When equal to or greater than fRight, Rect is empty.

SkScalar fTop

May contain any value, including infinities and NaN. The smaller of the vertical values when sorted. When equal to or greater than fBottom, Rect is empty.

SkScalar fRight

May contain any value, including infinities and NaN. The larger of the horizontal values when sorted. When equal to or less than fLeft, Rect is empty.

SkScalar fBottom

May contain any value, including infinities and NaN. The larger of the vertical values when sorted. When equal to or less than fTop, Rect is empty.

Constructor

namedescription
Makeconstructs from ISize returning (0, 0, width, height)
MakeEmptyconstructs from bounds of (0, 0, 0, 0)
MakeIWHconstructs from int input returning (0, 0, width, height)
MakeLTRBconstructs from SkScalar left, top, right, bottom
MakeSizeconstructs from Size returning (0, 0, width, height)
MakeWHconstructs from SkScalar input returning (0, 0, width, height)
MakeXYWHconstructs from SkScalar input returning (x, y, width, height)
makeInsetconstructs from sides moved symmetrically about the center
makeOffsetconstructs from translated sides
makeOutsetconstructs from sides moved symmetrically about the center
makeSortedconstructs, ordering sides from smaller to larger

MakeEmpty

Returns constructed Rect 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

isEmpty setEmpty SkIRect::MakeEmpty


MakeWH

Returns constructed Rect set to SkScalar values (0, 0, w, h). Does not validate input; w or h may be negative.

Passing integer values may generate a compiler warning since Rect cannot represent 32-bit integers exactly. Use SkIRect for an exact integer rectangle.

Parameters

Return Value

bounds (0, 0, w, h)

Example

Example Output

all equal

See Also

MakeSize MakeXYWH MakeIWH setWH SkIRect::MakeWH


MakeIWH

Returns constructed Rect set to integer values (0, 0, w, h). Does not validate input; w or h may be negative.

Use to avoid a compiler warning that input may lose precision when stored. Use SkIRect for an exact integer rectangle.

Parameters

Return Value

bounds (0, 0, w, h)

Example

Example Output

i_rect width: 25 f_rect width:25
i_rect width: 125000111 f_rect width:125000112

See Also

MakeXYWH MakeWH isetWH SkIRect::MakeWH


MakeSize

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

Parameters

Return Value

bounds (0, 0, size.width, size.height)

Example

Example Output

rect width: 25.5  height: 35.5
floor width: 25  height: 35

See Also

MakeWH MakeXYWH MakeIWH setWH SkIRect::MakeWH


MakeLTRB

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

Parameters

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 SkIRect::MakeLTRB


MakeXYWH

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

Parameters

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 SkIRect::MakeXYWH


MakeFromIRect


Make

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

Parameters

Return Value

bounds (0, 0, size.width, size.height)

Example

Example Output

rect1 == rect2

See Also

MakeWH MakeXYWH SkRect::MakeIWH SkIRect::MakeSize


Returns constructed IRect set to irect, promoting integers to Scalar. Does not validate input; fLeft may be greater than fRight, fTop may be greater than fBottom.

Parameters

Return Value

irect members converted to SkScalar

Example

See Also

MakeLTRB


Property

namedescription
asScalarsreturns pointer to members as array
bottomreturns larger bounds in y, if sorted
centerXreturns midpoint in x
centerYreturns midpoint in y
dumpsends text representation to standard output using floats
dump(bool asHex) const
dump const
dumpHexsends text representation to standard output using hexadecimal
heightreturns span in y
isEmptyreturns true if width or height are zero or negative
isFinitereturns true if no member is infinite or NaN
isSortedreturns true if width or height are zero or positive
leftreturns smaller bounds in x, if sorted
rightreturns larger bounds in x, if sorted
topreturns smaller bounds in y, if sorted
widthreturns span in x
xreturns bounds left
yreturns bounds top

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 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

MakeEmpty sort SkIRect::isEmpty


isSorted

Returns true if fLeft is equal to or less than fRight, or if fTop is equal to or less than fBottom. Call sort to reverse rectangles with negative width or height.

Return Value

true if width or height are zero or positive

Example

Example Output

rect: {20, 40, 10, 50} is not sorted
sorted: {10, 40, 20, 50} is sorted
rect: {20, 40, 20, 50} is sorted
sorted: {20, 40, 20, 50} is sorted

See Also

sort makeSorted isEmpty


isFinite

Returns true if all values in the rectangle are finite: SK ScalarMin or larger, and SK ScalarMax or smaller.

Return Value

true if no member is infinite or NaN

Example

Example Output

largest is finite: true
large width inf
widest is finite: false

See Also

SkScalarIsFinite SkScalarIsNaN


x

Returns left edge of Rect, if sorted. Call isSorted to see if Rect is valid. Call 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 SkIRect::x()


y

Returns top edge of Rect, if sorted. Call isEmpty to see if Rect 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 SkIRect::y()


left

Returns left edge of Rect, if sorted. Call isSorted to see if Rect is valid. 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 SkIRect::left()


top

Returns top edge of Rect, if sorted. Call isEmpty to see if Rect 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 SkIRect::top()


right

Returns right edge of Rect, if sorted. Call isSorted to see if Rect is valid. 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 SkIRect::right()


bottom

Returns bottom edge of Rect, if sorted. Call isEmpty to see if Rect 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 SkIRect::bottom()


width

Returns span on the x-axis. This does not check if Rect is sorted, or if result fits in 32-bit float; result may be negative or infinity.

Return Value

fRight minus fLeft

Example

Example Output

unsorted width: -5
large width: 4294967296

See Also

height SkIRect::width()


height

Returns span on the y-axis. This does not check if IRect is sorted, or if result fits in 32-bit float; result may be negative or infinity.

Return Value

fBottom minus fTop

Example

Example Output

unsorted height: -5
large height: 4294967296

See Also

width SkIRect::height()


centerX

Returns average of left edge and right edge. Result does not change if Rect is sorted. Result may overflow to infinity if Rect is far from the origin.

Return Value

midpoint in x

Example

Example Output

left:  20 right:  41 centerX: 30.5
left:  20 right:  41 centerX: 30.5
left: -20 right: -41 centerX: -30.5
left: -41 right: -20 centerX: -30.5

See Also

centerY SkIRect::centerX


centerY

Returns average of top edge and bottom edge. Result does not change if Rect is sorted. Result may overflow to infinity if Rect is far from the origin.

Return Value

midpoint in y

Example

Example Output

left: 2e+38 right: 3e+38 centerX: inf safe mid x: 2.5e+38

See Also

centerX SkIRect::centerY


Operator

namedescription
operator!=(const SkRect& a, const SkRect& b)returns true if members are unequal
operator==(const SkRect& a, const SkRect& b)returns true if members are equal

operator==

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

a and b are not equal if either contain NaN. a and b are equal if members contain zeroes width different signs.

Parameters

Return Value

true if members are equal

Example

Example Output

tests are equal
{0, 0, 2, 2} == {-0, -0, 2, 2} and are numerically equal
{0, 0, 2, 2} == {-0, -0, 2, 2} and are numerically equal
{0, 0, 2, 2} == {-0, -0, 2, 2} and are numerically equal

See Also

operator!=(const SkRect& a, const SkRect& b)


operator!=

Returns true if any in a: fLeft, fTop, fRight, and fBottom; does not equal the corresponding members in b.

a and b are not equal if either contain NaN. a and b are equal if members contain zeroes width different signs.

Parameters

Return Value

true if members are not equal

Example

Example Output

test with NaN is not equal to itself

See Also

operator==(const SkRect& a, const SkRect& b)


As Points

namedescription
setBoundssets to upper and lower limits of Point array
setBoundsChecksets to upper and lower limits of Point array
toQuadreturns four corners as Point

toQuad

Returns four points in quad that enclose Rect ordered as: top-left, top-right, bottom-right, bottom-left.

Parameters

Example

Example Output

rect: {1, 2, 3, 4}
corners: {1, 2} {3, 2} {3, 4} {1, 4}

See Also

SkPath::addRect[2][3]


setBounds

Sets to bounds of Point array with count entries. If count is zero or smaller, or if Point array contains an infinity or NaN, sets to (0, 0, 0, 0).

Result is either empty or sorted: fLeft is less than or equal to fRight, and fTop is less than or equal to fBottom.

Parameters

Example

Example Output

count: 0 rect: 0, 0, 0, 0
added:   3, 4 count: 1 rect: 3, 4, 3, 4
added:   1, 2 count: 2 rect: 1, 2, 3, 4
added:   5, 6 count: 3 rect: 1, 2, 5, 6
added: nan, 8 count: 4 rect: 0, 0, 0, 0

See Also

set[2][3][4] setBoundsCheck SkPath::addPoly


setBoundsCheck

Sets to bounds of Point array with count entries. Returns false if count is zero or smaller, or if Point array contains an infinity or NaN; in these cases sets Rect to (0, 0, 0, 0).

Result is either empty or sorted: fLeft is less than or equal to fRight, and fTop is less than or equal to fBottom.

Parameters

Return Value

true if all Point values are finite

Example

Example Output

count: 0 rect: 0, 0, 0, 0 success: true
added:   3, 4 count: 1 rect: 3, 4, 3, 4 success: true
added:   1, 2 count: 2 rect: 1, 2, 3, 4 success: true
added:   5, 6 count: 3 rect: 1, 2, 5, 6 success: true
added: nan, 8 count: 4 rect: 0, 0, 0, 0 success: false

See Also

set[2][3][4] setBounds SkPath::addPoly


Set

namedescription
setsets to SkScalar input (left, top, right, bottom) and others
set(const SkIRect& src)
setEmptysets to (0, 0, 0, 0)
setLTRBsets to SkScalar input (left, top, right, bottom)
setWHsets to SkScalar input (0, 0, width, height)
setXYWHsets to SkScalar input (x, y, width, height)

setEmpty

Sets Rect 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 SkIRect::setEmpty


set

Sets Rect to src, promoting src members from integer to Scalar. Very large values in src may lose precision.

Parameters

Example

Example Output

i_rect: {3, 4, 1, 2}
f_rect: {3, 4, 1, 2}

See Also

setLTRB SkIntToScalar


Sets Rect 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

Example

Example Output

rect1: {3, 4, 1, 2}
rect2: {3, 4, 1, 2}

See Also

setLTRB setXYWH SkIRect::set


setLTRB

Sets Rect 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

Example

Example Output

rect1: {3, 4, 1, 2}
rect2: {3, 4, 1, 2}

See Also

set[2][3][4] setXYWH SkIRect::set


Sets to bounds of Point array with count entries. If count is zero or smaller, or if Point array contains an infinity or NaN, sets Rect to (0, 0, 0, 0).

Result is either empty or sorted: fLeft is less than or equal to fRight, and fTop is less than or equal to fBottom.

Parameters

Example

Example Output

count: 0 rect: 0, 0, 0, 0
added:   3, 4 count: 1 rect: 3, 4, 3, 4
added:   1, 2 count: 2 rect: 1, 2, 3, 4
added:   5, 6 count: 3 rect: 1, 2, 5, 6
added: nan, 8 count: 4 rect: 0, 0, 0, 0

See Also

setBounds setBoundsCheck SkPath::addPoly


Sets bounds to the smallest Rect enclosing Points p0 and p1. The result is sorted and may be empty. Does not check to see if values are finite.

Parameters

Example

See Also

setBounds setBoundsCheck


setXYWH

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

Parameters

Example

Example Output

rect: 5, 35, -10, 60  isEmpty: true
rect: -10, 35, 5, 60  isEmpty: false

See Also

MakeXYWH setLTRB set[2][3][4] SkIRect::setXYWH


setWH

Sets Rect to (0, 0, width, height). Does not validate input; width or height may be negative.

Parameters

Example

Example Output

rect: 0, 0, -15, 25  isEmpty: true
rect: -15, 0, 0, 25  isEmpty: false

See Also

MakeWH setXYWH isetWH


From Integers

namedescription
isetsets to int input (left, top, right, bottom)
isetWHsets to int input (0, 0, width, height)

iset

Sets Rect to (left, top, right, bottom). All parameters are promoted from integer to Scalar. 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

Example

Example Output

rect1: {3, 4, 1, 2}
rect2: {3, 4, 1, 2}

See Also

set[2][3][4] setLTRB SkIRect::set SkIntToScalar


isetWH

Sets Rect to (0, 0, width, height). width and height may be zero or negative. width and height are promoted from integer to SkScalar, large values may lose precision.

Parameters

Example

Example Output

rect1: {0, 0, 1, 2}
rect2: {0, 0, 1, 2}

See Also

MakeWH MakeXYWH iset SkIRect:MakeWH


Inset Outset Offset

namedescription
insetmoves the sides symmetrically about the center
offsettranslates sides without changing width and height
offset(SkScalar dx, SkScalar dy)
offsetTotranslates to (x, y) without changing width and height
outsetmoves the sides symmetrically about the center

makeOffset

Returns Rect offset by (dx, dy).

If dx is negative, Rect returned is moved to the left. If dx is positive, Rect returned is moved to the right. If dy is negative, Rect returned is moved upward. If dy is positive, Rect returned is moved downward.

Parameters

Return Value

Rect offset in x or y, 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 SkIRect::makeOffset


makeInset

Returns Rect, inset by (dx, dy).

If dx is negative, Rect returned is wider. If dx is positive, Rect returned is narrower. If dy is negative, Rect returned is taller. If dy is positive, Rect returned is shorter.

Parameters

Return Value

Rect 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 SkIRect::makeInset


makeOutset

Returns Rect, outset by (dx, dy).

If dx is negative, Rect returned is narrower. If dx is positive, Rect returned is wider. If dy is negative, Rect returned is shorter. If dy is positive, Rect returned is taller.

Parameters

Return Value

Rect 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 SkIRect::makeOutset


offset

Offsets Rect by adding dx to fLeft, fRight; and by adding dy to fTop, fBottom.

If dx is negative, moves Rect to the left. If dx is positive, moves Rect to the right. If dy is negative, moves Rect upward. If dy is positive, moves Rect downward.

Parameters

Example

Example Output

rect: 15, 27, 55, 86

See Also

offsetTo makeOffset SkIRect::offset[2]


Offsets Rect by adding delta.fX to fLeft, fRight; and by adding delta.fY to fTop, fBottom.

If delta.fX is negative, moves Rect to the left. If delta.fX is positive, moves Rect to the right. If delta.fY is negative, moves Rect upward. If delta.fY is positive, moves Rect downward.

Parameters

Example

Example Output

rect: 15, 27, 55, 86

See Also

offsetTo makeOffset SkIRect::offset[2]


offsetTo

Offsets Rect so that fLeft equals newX, and fTop equals newY. width and height are unchanged.

Parameters

Example

Example Output

rect: 15, 27, 55, 86

See Also

offset[2] makeOffset setXYWH SkIRect::offsetTo


inset

Insets Rect by (dx, dy).

If dx is positive, makes Rect narrower. If dx is negative, makes Rect wider. If dy is positive, makes Rect shorter. If dy is negative, makes Rect taller.

Parameters

Example

Example Output

rect: 15, 27, 45, 60

See Also

outset makeInset SkIRect::inset


outset

Outsets Rect by (dx, dy).

If dx is positive, makes Rect wider. If dx is negative, makes Rect narrower. If dy is positive, makes Rect taller. If dy is negative, makes Rect shorter.

Parameters

Example

Example Output

rect: 5, 1, 55, 86

See Also

inset makeOutset SkIRect::outset


Intersection

Rects 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 Rect 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 Rect is not empty and describes an area: fLeft is less than fRight, and fTop is less than fBottom.

namedescription
Intersectsreturns true if areas overlap
containsreturns true if points are equal or inside
contains(SkScalar x, SkScalar y) const
intersectsets to shared area; returns true if not empty
intersect(const SkRect& r)
intersectsreturns true if areas overlap
intersects(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom) const

contains

Returns true if: fLeft <= x < fRight && fTop <= y < fBottom. Returns false if SkRect is empty.

Parameters

Return Value

true if (x, y) is inside SkRect

Example

Example Output

rect: (30, 50, 40, 60) contains (30, 50)
rect: (30, 50, 40, 60) does not contain (39, 49)
rect: (30, 50, 40, 60) does not contain (29, 59)

See Also

SkIRect::contains[2][3][4]


Returns true if Rect contains r. Returns false if Rect is empty or r is empty.

Rect contains r when Rect area completely includes r area.

Parameters

Return Value

true if all sides of Rect are outside r

Example

Example Output

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)

See Also

SkIRect::contains[2][3][4]


Returns true if Rect contains r. Returns false if Rect is empty or r is empty.

Rect contains r when Rect area completely includes r area.

Parameters

Return Value

true if all sides of Rect are outside r

Example

Example Output

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)

See Also

SkIRect::contains[2][3][4]


intersect

Returns true if Rect intersects r, and sets Rect to intersection. Returns false if Rect does not intersect r, and leaves Rect unchanged.

Returns false if either r or Rect is empty, leaving Rect unchanged.

Parameters

Return Value

true if r and Rect have area in common

Example

Example Output

intersection: 30, 60, 50, 80

See Also

intersects[2] Intersects join[2] SkIRect::intersect[2][3]


Constructs Rect to intersect from (left, top, right, bottom). Does not sort construction.

Returns true if Rect intersects construction, and sets Rect to intersection. Returns false if Rect does not intersect construction, and leaves Rect unchanged.

Returns false if either construction or Rect is empty, leaving Rect unchanged.

Parameters

Return Value

true if construction and Rect have area in common

Example

Example Output

intersection: 30, 60, 50, 80

See Also

intersects[2] Intersects join[2] SkIRect::intersect[2][3]


Returns true if a intersects b, and sets Rect to intersection. Returns false if a does not intersect b, and leaves Rect unchanged.

Returns false if either a or b is empty, leaving Rect unchanged.

Parameters

Return Value

true if a and b have area in common

Example

Example Output

intersection: 30, 60, 50, 80

See Also

intersects[2] Intersects join[2] SkIRect::intersect[2][3]


intersects

Constructs Rect to intersect from (left, top, right, bottom). Does not sort construction.

Returns true if Rect intersects construction. Returns false if either construction or Rect is empty, or do not intersect.

Parameters

Return Value

true if construction and Rect have area in common

Example

Example Output

intersection

See Also

intersect[2][3] Intersects SkIRect::Intersects


Returns true if Rect intersects r. Returns false if either r or Rect is empty, or do not intersect.

Parameters

Return Value

true if r and Rect have area in common

Example

Example Output

intersection

See Also

intersect[2][3] Intersects SkIRect::Intersects


Intersects

Returns true if a intersects b. Returns false if either a or b is empty, or do not intersect.

Parameters

Return Value

true if a and b have area in common

Example

Example Output

intersection

See Also

intersect[2][3] intersects[2] SkIRect::Intersects


Join

namedescription
joinsets to union of bounds
join(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom)
joinNonEmptyArgsets to union of bounds, asserting that argument is not empty
joinPossiblyEmptyRectsets to union of bounds. Skips empty check for both

join

Constructs Rect to intersect from (left, top, right, bottom). Does not sort construction.

Sets Rect to the union of itself and the construction.

Has no effect if construction is empty. Otherwise, if Rect is empty, sets Rect to construction.

Parameters

Example

Example Output

join: 10, 20, 55, 65

See Also

joinNonEmptyArg joinPossiblyEmptyRect SkIRect::join[2]


Sets Rect to the union of itself and r.

Has no effect if r is empty. Otherwise, if Rect is empty, sets Rect to r.

Parameters

Example

Example Output

join: 10, 20, 55, 65

See Also

joinNonEmptyArg joinPossiblyEmptyRect SkIRect::join[2]


joinNonEmptyArg

Sets Rect to the union of itself and r.

Asserts if r is empty and SK_DEBUG is defined. If Rect is empty, sets Rect to r.

May produce incorrect results if r is empty.

Parameters

Example

Example Output

rect: 50, 60, 55, 65
sorted: 10, 0, 55, 100

See Also

join[2] joinPossiblyEmptyRect SkIRect::join[2]


joinPossiblyEmptyRect

Sets Rect to the union of itself and the construction.

May produce incorrect results if Rect or r is empty.

Parameters

Example

Example Output

rect: 10, 60, 55, 65
sorted: 10, 0, 55, 100

See Also

joinNonEmptyArg join[2] SkIRect::join[2]


Rounding

namedescription
roundsets members to nearest integer value
round(SkIRect* dst) const
roundInsets members to nearest integer value towards opposite
roundOutsets members to nearest integer value away from opposite
roundOut(SkIRect* dst) const

round

Sets IRect by adding 0.5 and discarding the fractional portion of Rect members, using(.

Parameters

Example

Example Output

round: 31, 51, 41, 61

See Also

roundIn roundOut[2][3] SkScalarRoundToInt


roundOut

Sets IRect by discarding the fractional portion of fLeft and fTop; and rounding up fRight and fBottom, using(.

Parameters

Example

Example Output

round: 30, 50, 41, 61

See Also

roundIn round[2] SkScalarRoundToInt


Sets Rect by discarding the fractional portion of fLeft and fTop; and rounding up fRight and fBottom, using(.

Parameters

Example

Example Output

round: 30, 50, 41, 61

See Also

roundIn round[2] SkScalarRoundToInt


roundIn

Sets Rect by rounding up fLeft and fTop; and discarding the fractional portion of fRight and fBottom, using(.

Parameters

Example

Example Output

round: 31, 51, 40, 60

See Also

roundOut[2][3] round[2] SkScalarRoundToInt


Returns IRect by adding 0.5 and discarding the fractional portion of Rect members, using(.

Return Value

rounded IRect

Example

Example Output

round: 31, 51, 41, 61

See Also

roundOut[2][3] roundIn SkScalarRoundToInt


Sets IRect by discarding the fractional portion of fLeft and fTop; and rounding up fRight and fBottom, using(.

Return Value

rounded IRect

Example

Example Output

round: 30, 50, 41, 61

See Also

round[2] roundIn SkScalarRoundToInt


Sorting

namedescription
sortorders sides from smaller to larger

sort

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.

Example

Example Output

rect: 30.5, 50.5, 20.5, 10.5
sorted: 20.5, 10.5, 30.5, 50.5

See Also

makeSorted SkIRect::sort isSorted


makeSorted

Returns Rect 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.

Return Value

sorted Rect

Example

Example Output

rect: 30.5, 50.5, 20.5, 10.5
sorted: 20.5, 10.5, 30.5, 50.5

See Also

sort SkIRect::makeSorted isSorted


asScalars

Returns pointer to first Scalar in Rect, to treat it as an array with four entries.

Return Value

pointer to fLeft

Example

Example Output

rect.asScalars() == &rect.fLeft

See Also

toQuad


dump

Writes text representation of Rect to standard output. Set asHex to true to generate exact binary representations of floating point numbers.

Parameters

Example

Example Output

SkRect::MakeLTRB(20, 30, 40, 50);
SkRect::MakeLTRB(SkBits2Float(0x41a00000), /* 20.000000 */
SkBits2Float(0x41f00000), /* 30.000000 */
SkBits2Float(0x42200000), /* 40.000000 */
SkBits2Float(0x42480000)  /* 50.000000 */);

See Also

dumpHex


Writes text representation of Rect to standard output. The representation may be directly compiled as C++ code. Floating point values are written with limited precision; it may not be possible to reconstruct original Rect from output.

Example

Example Output

SkRect::MakeLTRB(0.857143f, 0.666667f, 2.6f, 7);
rect is not equal to copy

See Also

dumpHex


dumpHex

Writes text representation of Rect to standard output. The representation may be directly compiled as C++ code. Floating point values are written in hexadecimal to preserve their exact bit pattern. The output reconstructs the original Rect.

Use instead of dump when submitting bug reports against Skia .

Example

Example Output

SkRect::MakeLTRB(SkBits2Float(0x3f5b6db7), /* 0.857143 */
SkBits2Float(0x3f2aaaab), /* 0.666667 */
SkBits2Float(0x40266666), /* 2.600000 */
SkBits2Float(0x40e00000)  /* 7.000000 */);
rect is equal to copy

See Also

dump[2]


MakeLargest