SkRRect Reference
RRect
Class SkRRect
Constant
SkRRect related constants are defined by enum
, enum class
, #define
, const
, and constexpr
.
Topic | Description |
---|---|
Corner | corner radii order |
Type | specialization of Round Rect geometry |
kComplex Type | non-zero width and height with arbitrary radii |
kEmpty Type | zero width or height |
kLastType | largest Type value |
kLowerLeft Corner | index of bottom-left corner radii |
kLowerRight Corner | index of bottom-right corner radii |
kNinePatch Type | non-zero width and height with axis-aligned radii |
kOval Type | non-zero width and height filled with radii |
kRect Type | non-zero width and height, and zeroed radii |
kSimple Type | non-zero width and height with equal radii |
kSizeInMemory | storage space for Round Rect |
kUpperLeft Corner | index of top-left corner radii |
kUpperRight Corner | index of top-right corner radii |
Related_Function
SkRRect global, struct
, and class
related member functions share a topic.
Topic | Description |
---|---|
Type | specialization of Round Rect geometry |
SkRRect describes a rounded rectangle with a bounds and a pair of radii for each corner. The bounds and radii can be set so that SkRRect describes: a rectangle with sharp corners; a Circle; an Oval; or a rectangle with one or more rounded corners.
SkRRect allows implementing CSS properties that describe rounded corners. SkRRect may have up to eight different radii, one for each axis on each of its four corners.
SkRRect may modify the provided parameters when initializing bounds and radii. If either axis radii is zero or less: radii are stored as zero; corner is square. If corner curves overlap, radii are proportionally reduced to fit within bounds.
Overview
Topic | Description |
---|---|
Constants | enum and enum class, and their const values |
Constructors | functions that construct SkRRect |
Functions | global and class member functions |
Operators | operator overloading methods |
Related Functions | similar member functions grouped together |
Constructor
SkRRect can be constructed or initialized by these functions, including C++ class constructors.
Topic | Description |
---|---|
MakeEmpty | creates with zeroed bounds and corner radii |
MakeOval | creates Oval to fit bounds |
MakeRect | copies bounds and zeroes corner radii |
MakeRectXY | creates rounded rectangle |
SkRRect() | creates with zeroed bounds and corner radii |
SkRRect(const SkRRect& rrect) | copies bounds and corner radii |
makeOffset | offsets bounds and radii |
Operator
SkRRect operators inline class member functions with arithmetic equivalents.
Topic | Description |
---|---|
operator!=(const SkRRect& a, const SkRRect& b) | returns true if members are unequal |
operator=(const SkRRect& rrect) | copies bounds and corner radii |
operator==(const SkRRect& a, const SkRRect& b) | returns true if members are equal |
Member Function
SkRRect member functions read and modify the structure properties.
Topic | Description |
---|---|
MakeEmpty | creates with zeroed bounds and corner radii |
MakeOval | creates Oval to fit bounds |
MakeRect | copies bounds and zeroes corner radii |
MakeRectXY | creates rounded rectangle |
contains | returns true if Rect is inside |
dump | sends text representation to standard output |
dumpHex | sends text representation using hexadecimal to standard output |
getBounds | returns bounds |
getSimpleRadii | returns corner radii for simple types |
getType | returns Type |
height | returns span in y-axis |
inset | insets bounds and radii |
isComplex | returns true if not empty, Rect, Oval, simple, or nine-patch |
isEmpty | returns true if width or height are zero |
isNinePatch | returns true if not empty, Rect, Oval or simple; and radii are axis-aligned |
isOval | returns true if not empty, axes radii are equal, radii fill bounds |
isRect | returns true if not empty, and one radius at each corner is zero |
isSimple | returns true if not empty, Rect or Oval; and axes radii are equal |
isValid | returns if type matches bounds and radii |
makeOffset | offsets bounds and radii |
offset | offsets bounds and radii |
outset | outsets bounds and radii |
radii | returns x-axis and y-axis radii for one corner |
readFromMemory | reads Round Rect from buffer |
rect | returns bounds |
setEmpty | zeroes width, height, and corner radii |
setNinePatch | replaces with rounded rectangle |
setOval | replaces with Oval to fit bounds |
setRect | sets Round Rect bounds with zeroed corners |
setRectRadii | replaces with rounded rectangle |
setRectXY | replaces with rounded rectangle |
transform | scales and offsets into copy |
type | returns Type |
width | returns span in x-axis |
writeToMemory | writes Round Rect to buffer |
SkRRect
SkRRect()
Initializes bounds at (0, 0), the origin, with zero width and height. Initializes corner radii to (0, 0), and sets type of kEmpty Type.
Return Value
empty Round Rect
Example
See Also
SkRRect
SkRRect(const SkRRect& rrect)
Initializes to copy of rrect bounds and corner radii.
Parameters
rrect |
bounds and corner to copy |
Return Value
copy of rrect
Example
See Also
operator=(const SkRRect& rrect) MakeRect
operator=
SkRRect& operator=(const SkRRect& rrect)
Copies rrect bounds and corner radii.
Parameters
rrect |
bounds and corner to copy |
Return Value
copy of rrect
Example
See Also
SkRRect(const SkRRect& rrect) MakeRect
Type
Enum SkRRect::Type
enum Type { kEmpty Type, kRect Type, kOval Type, kSimple Type, kNinePatch Type, kComplex Type, kLastType = kComplex Type, };
Type describes possible specializations of Round Rect. Each Type is exclusive; a Round Rect may only have one type.
Type members become progressively less restrictive; larger values of Type have more degrees of freedom than smaller values.
Constants
Const | Value | Description |
---|---|---|
SkRRect::kEmpty_Type |
0 | Round Rect has zero width or height. All radii are zero. |
SkRRect::kRect_Type |
1 | Round Rect has width and height. All radii are zero. |
SkRRect::kOval_Type |
2 | Round Rect has width and height. All four x-radii are equal, and at least half the width. All four y-radii are equal, and at least half the height. |
SkRRect::kSimple_Type |
3 | Round Rect has width and height. All four x-radii are equal and greater than zero, and all four y-radii are equal and greater than zero. Either x-radii are less than half the width, or y-radii is less than half the height, or both. |
SkRRect::kNinePatch_Type |
4 | Round Rect has width and height. Left x-radii are equal, top y-radii are equal, right x-radii are equal, and bottom y-radii are equal. The radii do not describe Rect, Oval, or simple type. The centers of the corner ellipses form an axis-aligned rectangle that divides the Round Rect into nine rectangular patches; an interior rectangle, four edges, and four corners. |
SkRRect::kComplex_Type |
5 | both radii are non-zero. |
SkRRect::kLastType |
5 | largest Type value |
Example
See Also
getType
Type getType() const
Returns Type, one of: kEmpty Type, kRect Type, kOval Type, kSimple Type, kNinePatch Type, kComplex Type.
Return Value
Example
See Also
type
Type type() const
Returns Type, one of: kEmpty Type, kRect Type, kOval Type, kSimple Type, kNinePatch Type, kComplex Type.
Return Value
Example
See Also
isEmpty
inline bool isEmpty() const
Returns true if rect.fLeft is equal to rect.fRight, or if rect.fTop is equal to rect.fBottom.
Return Value
true if width or height are zero
Example
See Also
isRect
inline bool isRect() const
Returns true if not empty, and if either x-axis or y-axis radius at each corner is zero.
Return Value
true if not empty, and one radius at each corner is zero
Example
See Also
isOval
inline bool isOval() const
Returns true if not empty, if all x-axis radii are equal, if all y-axis radii are equal, x-axis radii are at least half the width, and y-axis radii are at least half the height.
Return Value
true if has identical geometry to Oval
Example
See Also
isEmpty isSimple SkCanvas::drawOval
isSimple
inline bool isSimple() const
Returns true if not empty, if all x-axis radii are equal but not zero, if all y-axis radii are equal but not zero; and x-axis radius is less than half width, or y-axis radius is less than half height.
Return Value
true if not empty, Rect or Oval; and axes radii are equal
Example
See Also
isEmpty isRect isOval isNinePatch
isNinePatch
inline bool isNinePatch() const
Returns true if isEmpty, isRect, isOval, and isSimple return false; and if left x-axis radii are equal, right x-axis radii are equal, top y-axis radii are equal, and bottom y-axis radii are equal.
Return Value
true if not empty, Rect, Oval or simple; and radii are axis-aligned
Example
See Also
isEmpty isRect isOval isSimple isComplex
isComplex
inline bool isComplex() const
Returns true if isEmpty, isRect, isOval, isSimple, and isNinePatch return false. If true: width and height are greater than zero, at least one corner radii are both greater than zero; left x-axis radii are not equal, or right x-axis radii are not equal, or top y-axis radii are not equal, or bottom y-axis radii are not equal.
Return Value
true if not empty, Rect, Oval, simple, or nine-patch
Example
See Also
isEmpty isRect isOval isSimple isNinePatch
width
SkScalar width() const
Returns span on the x-axis. This does not check if result fits in 32-bit float; result may be infinity.
Return Value
bounds().fRight minus bounds().fLeft
Example
Example Output
unsorted width: 5
large width: inf
See Also
SkRect::width height getBounds
height
SkScalar height() const
Returns span on the y-axis. This does not check if result fits in 32-bit float; result may be infinity.
Return Value
bounds().fBottom minus bounds().fTop
Example
Example Output
unsorted height: 5
large height: inf
See Also
getSimpleRadii
SkVector getSimpleRadii() const
Returns top-left corner radii. If type returns kEmpty Type, kRect Type, kOval Type, or kSimple Type, returns a value representative of all corner radii. If type returns kNinePatch Type or kComplex Type, at least one of the remaining three corners has a different value.
Return Value
corner radii for simple types
Example
See Also
radii getBounds getType isSimple
setEmpty
void setEmpty()
Sets bounds to zero width and height at (0, 0), the origin. Sets corner radii to zero and sets type to kEmpty Type.
Example
See Also
setRect
void setRect(const SkRect& rect)
Sets bounds to sorted rect, and sets corner radii to zero. If set bounds has width and height, and sets type to kRect Type; otherwise, sets type to kEmpty Type.
Parameters
rect |
bounds to set |
Example
See Also
MakeEmpty
static SkRRect MakeEmpty()
Initializes bounds at (0, 0), the origin, with zero width and height. Initializes corner radii to (0, 0), and sets type of kEmpty Type.
Return Value
empty Round Rect
Example
See Also
MakeRect
static SkRRect MakeRect(const SkRect& r)
Initializes to copy of r bounds and zeroes corner radii.
Parameters
r |
bounds to copy |
Return Value
copy of r
Example
See Also
MakeOval
static SkRRect MakeOval(const SkRect& oval)
Sets bounds to oval, x-axis radii to half oval.width, and all y-axis radii to half oval.height. If oval bounds is empty, sets to kEmpty Type. Otherwise, sets to kOval Type.
Parameters
oval |
bounds of Oval |
Return Value
Example
See Also
MakeRectXY
static SkRRect MakeRectXY(const SkRect& rect, SkScalar xRad, SkScalar yRad)
Sets to rounded rectangle with the same radii for all four corners. If rect is empty, sets to kEmpty Type. Otherwise, if xRad and yRad are zero, sets to kRect Type. Otherwise, if xRad is at least half rect.width and yRad is at least half rect.height, sets to kOval Type. Otherwise, sets to kSimple Type.
Parameters
rect |
bounds of rounded rectangle |
xRad |
x-axis radius of corners |
yRad |
y-axis radius of corners |
Return Value
rounded rectangle
Example
See Also
setOval
void setOval(const SkRect& oval)
Sets bounds to oval, x-axis radii to half oval.width, and all y-axis radii to half oval.height. If oval bounds is empty, sets to kEmpty Type. Otherwise, sets to kOval Type.
Parameters
oval |
bounds of Oval |
Example
See Also
setRectXY
void setRectXY(const SkRect& rect, SkScalar xRad, SkScalar yRad)
Sets to rounded rectangle with the same radii for all four corners. If rect is empty, sets to kEmpty Type. Otherwise, if xRad or yRad is zero, sets to kRect Type. Otherwise, if xRad is at least half rect.width and yRad is at least half rect.height, sets to kOval Type. Otherwise, sets to kSimple Type.
Parameters
rect |
bounds of rounded rectangle |
xRad |
x-axis radius of corners |
yRad |
y-axis radius of corners |
Example
See Also
MakeRectXY SkPath::addRoundRect^{[2]}
setNinePatch
void setNinePatch(const SkRect& rect, SkScalar leftRad, SkScalar topRad, SkScalar rightRad, SkScalar bottomRad)
Sets bounds to rect. Sets radii to (leftRad, topRad), (rightRad, topRad), (rightRad, bottomRad), (leftRad, bottomRad).
If rect is empty, sets to kEmpty Type. Otherwise, if leftRad and rightRad are zero, sets to kRect Type. Otherwise, if topRad and bottomRad are zero, sets to kRect Type. Otherwise, if leftRad and rightRad are equal and at least half rect.width, and topRad and bottomRad are equal at least half rect.height, sets to kOval Type. Otherwise, if leftRad and rightRad are equal, and topRad and bottomRad are equal, sets to kSimple Type. Otherwise, sets to kNinePatch Type.
Nine patch refers to the nine parts defined by the radii: one center rectangle, four edge patches, and four corner patches.
Parameters
rect |
bounds of rounded rectangle |
leftRad |
left-top and left-bottom x-axis radius |
topRad |
left-top and right-top y-axis radius |
rightRad |
right-top and right-bottom x-axis radius |
bottomRad |
left-bottom and right-bottom y-axis radius |
Example
See Also
setRectRadii
void setRectRadii(const SkRect& rect, const SkVector radii[4])
Sets bounds to rect. Sets radii array for individual control of all for corners.
If rect is empty, sets to kEmpty Type. Otherwise, if one of each corner radii are zero, sets to kRect Type. Otherwise, if all x-axis radii are equal and at least half rect.width, and all y-axis radii are equal at least half rect.height, sets to kOval Type. Otherwise, if all x-axis radii are equal, and all y-axis radii are equal, sets to kSimple Type. Otherwise, sets to kNinePatch Type.
Parameters
rect |
bounds of rounded rectangle |
radii |
corner x-axis and y-axis radii |
Example
See Also
setNinePatch SkPath::addRoundRect^{[2]}
Enum SkRRect::Corner
enum Corner { kUpperLeft Corner, kUpperRight Corner, kLowerRight Corner, kLowerLeft Corner, };
The radii are stored: top-left, top-right, bottom-right, bottom-left.
Constants
Const | Value | Description |
---|---|---|
SkRRect::kUpperLeft_Corner |
0 | index of top-left corner radii |
SkRRect::kUpperRight_Corner |
1 | index of top-right corner radii |
SkRRect::kLowerRight_Corner |
2 | index of bottom-right corner radii |
SkRRect::kLowerLeft_Corner |
3 | index of bottom-left corner radii |
Example
See Also
rect
const SkRect& rect() const
Returns bounds. Bounds may have zero width or zero height. Bounds right is greater than or equal to left; bounds bottom is greater than or equal to top. Result is identical to getBounds.
Return Value
bounding box
Example
See Also
radii
SkVector radii(Corner corner) const
Returns Scalar pair for radius of curve on x-axis and y-axis for one corner. Both radii may be zero. If not zero, both are positive and finite.
Parameters
corner |
one of: kUpperLeft Corner, kUpperRight Corner, kLowerRight Corner, kLowerLeft Corner |
Return Value
x-axis and y-axis radii for one corner
Example
Example Output
left corner: (nan) 0
left corner: (inf) 0
left corner: (100) 25
left corner: (50) 25
left corner: (25) 12.5
See Also
getBounds
const SkRect& getBounds() const
Returns bounds. Bounds may have zero width or zero height. Bounds right is greater than or equal to left; bounds bottom is greater than or equal to top. Result is identical to rect.
Return Value
bounding box
Example
See Also
operator==
bool operator==(const SkRRect& a, const SkRRect& b)
Returns true if bounds and radii in a are equal to bounds and radii 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
a |
Rect bounds and radii to compare |
b |
Rect bounds and radii to compare |
Return Value
true if members are equal
Example
See Also
operator!=(const SkRRect& a, const SkRRect& b)
operator!=
bool operator!=(const SkRRect& a, const SkRRect& b)
Returns true if bounds and radii in a are not equal to bounds and radii 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
a |
Rect bounds and radii to compare |
b |
Rect bounds and radii to compare |
Return Value
true if members are not equal
Example
See Also
operator==(const SkRRect& a, const SkRRect& b)
inset
void inset(SkScalar dx, SkScalar dy, SkRRect* dst) const
Copies Round Rect to dst, then insets dst bounds by dx and dy, and adjusts dst radii by dx and dy. dx and dy may be positive, negative, or zero. dst may be Round Rect.
If either corner radius is zero, the corner has no curvature and is unchanged. Otherwise, if adjusted radius becomes negative, pins radius to zero. If dx exceeds half dst bounds width, dst bounds left and right are set to bounds x-axis center. If dy exceeds half dst bounds height, dst bounds top and bottom are set to bounds y-axis center.
If dx or dy cause the bounds to become infinite, dst bounds is zeroed.
Parameters
dx |
added to rect.fLeft, and subtracted from rect.fRight |
dy |
added to rect.fTop, and subtracted from rect.fBottom |
dst |
insets bounds and radii |
Example
See Also
outset^{[2]} offset makeOffset
void inset(SkScalar dx, SkScalar dy)
Insets bounds by dx and dy, and adjusts radii by dx and dy. dx and dy may be positive, negative, or zero.
If either corner radius is zero, the corner has no curvature and is unchanged. Otherwise, if adjusted radius becomes negative, pins radius to zero. If dx exceeds half bounds width, bounds left and right are set to bounds x-axis center. If dy exceeds half bounds height, bounds top and bottom are set to bounds y-axis center.
If dx or dy cause the bounds to become infinite, bounds is zeroed.
Parameters
dx |
added to rect.fLeft, and subtracted from rect.fRight |
dy |
added to rect.fTop, and subtracted from rect.fBottom |
Example
See Also
outset^{[2]} offset makeOffset
outset
void outset(SkScalar dx, SkScalar dy, SkRRect* dst) const
Outsets dst bounds by dx and dy, and adjusts radii by dx and dy. dx and dy may be positive, negative, or zero.
If either corner radius is zero, the corner has no curvature and is unchanged. Otherwise, if adjusted radius becomes negative, pins radius to zero. If dx exceeds half dst bounds width, dst bounds left and right are set to bounds x-axis center. If dy exceeds half dst bounds height, dst bounds top and bottom are set to bounds y-axis center.
If dx or dy cause the bounds to become infinite, dst bounds is zeroed.
Parameters
dx |
subtracted from rect.fLeft, and added to rect.fRight |
dy |
subtracted from rect.fTop, and added to rect.fBottom |
dst |
outset bounds and radii |
Example
See Also
inset^{[2]} offset makeOffset
void outset(SkScalar dx, SkScalar dy)
Outsets bounds by dx and dy, and adjusts radii by dx and dy. dx and dy may be positive, negative, or zero.
If either corner radius is zero, the corner has no curvature and is unchanged. Otherwise, if adjusted radius becomes negative, pins radius to zero. If dx exceeds half bounds width, bounds left and right are set to bounds x-axis center. If dy exceeds half bounds height, bounds top and bottom are set to bounds y-axis center.
If dx or dy cause the bounds to become infinite, bounds is zeroed.
Parameters
dx |
subtracted from rect.fLeft, and added to rect.fRight |
dy |
subtracted from rect.fTop, and added to rect.fBottom |
Example
See Also
inset^{[2]} offset makeOffset
offset
void offset(SkScalar dx, SkScalar dy)
Translates Round Rect by (dx, dy).
Parameters
dx |
offset added to rect.fLeft and rect.fRight |
dy |
offset added to rect.fTop and rect.fBottom |
Example
See Also
makeOffset inset^{[2]} outset^{[2]}
makeOffset
SkRRect SK_WARN_UNUSED_RESULT makeOffset(SkScalar dx, SkScalar dy) const
Returns Round Rect translated by (dx, dy).
Parameters
dx |
offset added to rect.fLeft and rect.fRight |
dy |
offset added to rect.fTop and rect.fBottom |
Return Value
Round Rect bounds offset by (dx, dy), with unchanged corner radii
Example
See Also
offset inset^{[2]} outset^{[2]}
contains
bool contains(const SkRect& rect) const
Returns true if rect is inside the bounds and corner radii, and if Round Rect and rect are not empty.
Parameters
rect |
area tested for containment |
Return Value
true if Round Rect contains rect
Example
See Also
SkRect::contains^{[2]}^{[3]}
isValid
bool isValid() const
Returns true if bounds and radii values are finite and describe a Round Rect Type that matches getType. All Round Rect methods construct valid types, even if the input values are not valid. Invalid Round Rect data can only be generated by corrupting memory.
Return Value
true if bounds and radii match type
Example
See Also
Constants
Const | Value | Description |
---|---|---|
SkRRect::kSizeInMemory |
48 | Space required to serialize SkRRect into a buffer. Always a multiple of four. |
writeToMemory
size_t writeToMemory(void* buffer) const
Writes Round Rect to buffer. Writes kSizeInMemory bytes, and returns kSizeInMemory, the number of bytes written.
Parameters
buffer |
storage for Round Rect |
Return Value
bytes written, kSizeInMemory
Example
See Also
readFromMemory
size_t readFromMemory(const void* buffer, size_t length)
Reads Round Rect from buffer, reading kSizeInMemory bytes. Returns kSizeInMemory, bytes read if length is at least kSizeInMemory. Otherwise, returns zero.
Parameters
buffer |
memory to read from |
length |
size of buffer |
Return Value
bytes read, or 0 if length is less than kSizeInMemory
Example
See Also
transform
bool transform(const SkMatrix& matrix, SkRRect* dst) const
Transforms by Round Rect by matrix, storing result in dst. Returns true if Round Rect transformed can be represented by another Round Rect. Returns false if matrix contains transformations other than scale and translate.
Asserts in debug builds if Round Rect equals dst.
Parameters
matrix |
SkMatrix specifying the transform |
dst |
SkRRect to store the result |
Return Value
true if transformation succeeded.
Example
See Also
SkPath::transform^{[2]}
dump
void dump(bool asHex) const
Writes text representation of Round Rect to standard output. Set asHex true to generate exact binary representations of floating point numbers.
Parameters
asHex |
true if SkScalar values are written as hexadecimal |
Example
See Also
dumpHex SkRect::dump^{[2]} SkPath::dump^{[2]} SkPathMeasure::dump
void dump() const
Writes text representation of Round 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 Round Rect from output.
Example
See Also
dumpHex SkRect::dump^{[2]} SkPath::dump^{[2]} SkPathMeasure::dump
dumpHex
void dumpHex() const
Writes text representation of Round 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 Round Rect.
Example
See Also
dump^{[2]} SkRect::dumpHex SkPath::dumpHex