SkRRect Reference

RRect

Class SkRRect

Constant

SkRRect related constants are defined by enum, enum class, #define, const, and constexpr.

Related_Function

SkRRect global, struct, and class related member functions share a topic.

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

Constructor

SkRRect can be constructed or initialized by these functions, including C++ class constructors.

Operator

SkRRect operators inline class member functions with arithmetic equivalents.

Member Function

SkRRect member functions read and modify the structure properties.

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

setEmpty isEmpty


SkRRect

Initializes to copy of rrect bounds and corner radii.

Parameters

Return Value

copy of rrect

Example

See Also

operator=(const SkRRect& rrect) MakeRect


operator=

Copies rrect bounds and corner radii.

Parameters

Return Value

copy of rrect

Example

See Also

SkRRect(const SkRRect& rrect) MakeRect


Type

Enum SkRRect::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

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.

Example

See Also

Rect Path

getType

Returns Type, one of: kEmpty Type, kRect Type, kOval Type, kSimple Type, kNinePatch Type, kComplex Type.

Return Value

Type

Example

See Also

Type type


type

Returns Type, one of: kEmpty Type, kRect Type, kOval Type, kSimple Type, kNinePatch Type, kComplex Type.

Return Value

Type

Example

See Also

Type getType


isEmpty

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

SkRect::isEmpty height width


isRect

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

isEmpty radii


isOval

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

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

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

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

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

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

SkRect.height width getBounds


getSimpleRadii

Returns top-left corner x-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

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

MakeEmpty setRect


setRect

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

Example

See Also

MakeRect setRectXY


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

SkRRect() SkRect::MakeEmpty


MakeRect

Initializes to copy of r bounds and zeroes corner radii.

Parameters

Return Value

copy of r

Example

See Also

setRect MakeOval MakeRectXY


MakeOval

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

Return Value

Oval

Example

See Also

setOval MakeRect MakeRectXY


MakeRectXY

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

Return Value

rounded rectangle

Example

See Also

setRectXY


setOval

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

Example

See Also

MakeOval


setRectXY

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

Example

See Also

MakeRectXY SkPath::addRoundRect[2]


setNinePatch

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

Example

See Also

setRectRadii


setRectRadii

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

Example

See Also

setNinePatch SkPath::addRoundRect[2]


Enum SkRRect::Corner

The radii are stored: top-left, top-right, bottom-right, bottom-left.

Constants

Example

See Also

radii

rect

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

Example Output

left bounds: (nan) 0
left bounds: (inf) 0
left bounds: (100) 60
left bounds: (50) 50
left bounds: (25) 25

See Also

getBounds


radii

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

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

Corner


getBounds

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

rect


operator==

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

Return Value

true if members are equal

Example

See Also

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


operator!=

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

Return Value

true if members are not equal

Example

See Also

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


inset

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

Example

See Also

outset[2] offset makeOffset


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

Example

See Also

outset[2] offset makeOffset


outset

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

Example

See Also

inset[2] offset makeOffset


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

Example

See Also

inset[2] offset makeOffset


offset

Translates Round Rect by (dx, dy).

Parameters

Example

See Also

makeOffset inset[2] outset[2]


makeOffset

Returns Round Rect translated by (dx, dy).

Parameters

Return Value

Round Rect bounds offset by (dx, dy), with unchanged corner radii

Example

See Also

offset inset[2] outset[2]


contains

Returns true if rect is inside the bounds and corner radii, and if Round Rect and rect are not empty.

Parameters

Return Value

true if Round Rect contains rect

Example

See Also

SkRect::contains[2][3]


isValid

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

Type getType


Constants

writeToMemory

Writes Round Rect to buffer. Writes kSizeInMemory bytes, and returns kSizeInMemory, the number of bytes written.

Parameters

Return Value

bytes written, kSizeInMemory

Example

See Also

readFromMemory


readFromMemory

Reads Round Rect from buffer, reading kSizeInMemory bytes. Returns kSizeInMemory, bytes read if length is at least kSizeInMemory. Otherwise, returns zero.

Parameters

Return Value

bytes read, or 0 if length is less than kSizeInMemory

Example

See Also

writeToMemory


transform

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

Return Value

true if transformation succeeded.

Example

See Also

SkPath::transform[2]


dump

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

Parameters

Example

Example Output

SkRect::MakeLTRB(0.857143f, 0.666667f, 0.857143f, 0.666667f);
const SkPoint corners[] = {
{ 0, 0 },
{ 0, 0 },
{ 0, 0 },
{ 0, 0 },
};
SkRect::MakeLTRB(SkBits2Float(0x3f5b6db7), /* 0.857143 */
SkBits2Float(0x3f2aaaab), /* 0.666667 */
SkBits2Float(0x3f5b6db7), /* 0.857143 */
SkBits2Float(0x3f2aaaab)  /* 0.666667 */);
const SkPoint corners[] = {
{ SkBits2Float(0x00000000), SkBits2Float(0x00000000) }, /* 0.000000 0.000000 */
{ SkBits2Float(0x00000000), SkBits2Float(0x00000000) }, /* 0.000000 0.000000 */
{ SkBits2Float(0x00000000), SkBits2Float(0x00000000) }, /* 0.000000 0.000000 */
{ SkBits2Float(0x00000000), SkBits2Float(0x00000000) }, /* 0.000000 0.000000 */
};

See Also

dumpHex SkRect::dump[2] SkPath::dump[2] SkPathMeasure::dump


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

Example Output

SkRect::MakeLTRB(0.857143f, 0.666667f, 0.857143f, 0.666667f);
const SkPoint corners[] = {
{ 0, 0 },
{ 0, 0 },
{ 0, 0 },
{ 0, 0 },
};
rrect is not equal to copy

See Also

dumpHex SkRect::dump[2] SkPath::dump[2] SkPathMeasure::dump


dumpHex

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

Example Output

SkRect::MakeLTRB(SkBits2Float(0x3f5b6db7), /* 0.857143 */
SkBits2Float(0x3f2aaaab), /* 0.666667 */
SkBits2Float(0x3f5b6db7), /* 0.857143 */
SkBits2Float(0x3f2aaaab)  /* 0.666667 */);
const SkPoint corners[] = {
{ SkBits2Float(0x00000000), SkBits2Float(0x00000000) }, /* 0.000000 0.000000 */
{ SkBits2Float(0x00000000), SkBits2Float(0x00000000) }, /* 0.000000 0.000000 */
{ SkBits2Float(0x00000000), SkBits2Float(0x00000000) }, /* 0.000000 0.000000 */
{ SkBits2Float(0x00000000), SkBits2Float(0x00000000) }, /* 0.000000 0.000000 */
};
rrect is equal to copy

See Also

dump[2] SkRect::dumpHex SkPath::dumpHex