SkRRect Reference


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.


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 SkRRect

Example

See Also

setEmpty isEmpty


Initializes to copy of rrect bounds and corner radii.

Parameters

Return Value

copy of rrect

Example

See Also

operator=(const SkRRect& rrect) MakeRect


Copies rrect bounds and corner radii.

Parameters

Return Value

copy of rrect

Example

See Also

SkRRect(const SkRRect& rrect) MakeRect


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


Returns Type, one of: kEmpty_Type, kRect_Type, kOval_Type, kSimple_Type, kNinePatch_Type, kComplex_Type .

Return Value

Type

Example

See Also

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


Example

See Also

SkRect::isEmpty height width


Example

See Also

isEmpty radii


Example

See Also

isEmpty isSimple SkCanvas::drawOval


Example

See Also

isEmpty isRect isOval isNinePatch


Example

See Also

isEmpty isRect isOval isSimple isComplex


Example

See Also

isEmpty isRect isOval isSimple isNinePatch


Returns span on the x-axis. This does not check if result fits in 32-bit float; result may be infinity.

Return Value

rect().fRight minus rect().fLeft

Example

Example Output

unsorted width: 5
large width: inf

See Also

SkRect::width height getBounds


Returns span on the y-axis. This does not check if result fits in 32-bit float; result may be infinity.

Return Value

rect().fBottom minus rect().fTop

Example

Example Output

unsorted height: 5
large height: inf

See Also

SkRect::height width getBounds


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


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


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


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 SkRRect

Example

See Also

SkRRect() SkRect::MakeEmpty


Initializes to copy of r bounds and zeroes corner radii.

Parameters

Return Value

copy of r

Example

See Also

setRect MakeOval MakeRectXY


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


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


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


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


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


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


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

Constants

Example

See Also

radii


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


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

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

Corner


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


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 with different signs.

Parameters

Return Value

true if members are equal

Example

See Also

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 with different signs.

Parameters

Return Value

true if members are not equal

Example

See Also

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


Copies SkRRect 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 SkRRect.

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


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


Translates SkRRect by (dx, dy).

Parameters

Example

See Also

makeOffset inset outset


Returns SkRRect translated by (dx, dy).

Parameters

Return Value

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

Example

See Also

offset inset outset


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

Parameters

Return Value

true if SkRRect contains rect

Example

See Also

SkRect::contains


Returns true if bounds and radii values are finite and describe a SkRRect SkRRect::Type that matches getType(). All SkRRect methods construct valid types, even if the input values are not valid. Invalid SkRRect data can only be generated by corrupting memory.

Return Value

true if bounds and radii match type()

Example

See Also

Type getType

Constants


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

Parameters

Return Value

bytes written, kSizeInMemory

Example

See Also

readFromMemory


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


Transforms by SkRRect by matrix, storing result in dst. Returns true if SkRRect transformed can be represented by another SkRRect. Returns false if matrix contains transformations other than scale and translate.

Asserts in debug builds if SkRRect equals dst.

Parameters

Return Value

true if transformation succeeded.

Example

See Also

SkPath::transform


Writes text representation of SkRRect 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 SkPath::dump SkPathMeasure::dump


Writes text representation of SkRRect 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 SkRRect 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 SkPath::dump SkPathMeasure::dump


Writes text representation of SkRRect 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 SkRRect.

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 SkRect::dumpHex SkPath::dumpHex