#include <SkRRect.h>

Public Types
enum	Type { kEmpty_Type , kRect_Type , kOval_Type , kSimple_Type , kNinePatch_Type , kComplex_Type , kLastType = kComplex_Type }

enum	Corner { kUpperLeft_Corner , kUpperRight_Corner , kLowerRight_Corner , kLowerLeft_Corner }

Public Member Functions
	SkRRect ()=default

	SkRRect (const SkRRect &rrect)=default

SkRRect &	operator= (const SkRRect &rrect)=default

Type	getType () const

Type	type () const

bool	isEmpty () const

bool	isRect () const

bool	isOval () const

bool	isSimple () const

bool	isNinePatch () const

bool	isComplex () const

SkScalar	width () const

SkScalar	height () const

SkVector	getSimpleRadii () const

void	setEmpty ()

void	setRect (const SkRect &rect)

void	setOval (const SkRect &oval)

void	setRectXY (const SkRect &rect, SkScalar xRad, SkScalar yRad)

void	setNinePatch (const SkRect &rect, SkScalar leftRad, SkScalar topRad, SkScalar rightRad, SkScalar bottomRad)

void	setRectRadii (const SkRect &rect, const SkVector radii[4])

const SkRect &	rect () const

SkVector	radii (Corner corner) const

const SkRect &	getBounds () const

void	inset (SkScalar dx, SkScalar dy, SkRRect *dst) const

void	inset (SkScalar dx, SkScalar dy)

void	outset (SkScalar dx, SkScalar dy, SkRRect *dst) const

void	outset (SkScalar dx, SkScalar dy)

void	offset (SkScalar dx, SkScalar dy)

SkRRect	makeOffset (SkScalar dx, SkScalar dy) const

bool	contains (const SkRect &rect) const

bool	isValid () const

size_t	writeToMemory (void *buffer) const

size_t	readFromMemory (const void *buffer, size_t length)

bool	transform (const SkMatrix &matrix, SkRRect *dst) const

void	dump (bool asHex) const

SkString	dumpToString (bool asHex) const

void	dump () const

void	dumpHex () const

Static Public Member Functions
static SkRRect	MakeEmpty ()

static SkRRect	MakeRect (const SkRect &r)

static SkRRect	MakeOval (const SkRect &oval)

static SkRRect	MakeRectXY (const SkRect &rect, SkScalar xRad, SkScalar yRad)

Static Public Attributes
static constexpr size_t	kSizeInMemory = 12 * sizeof(SkScalar)

Friends
class	SkPath

class	SkRRectPriv

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

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

Detailed Description

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.

Definition at line 35 of file SkRRect.h.

Member Enumeration Documentation

◆ Corner

enum SkRRect::Corner

Enumerator
kUpperLeft_Corner	index of top-left corner radii
kUpperRight_Corner	index of top-right corner radii
kLowerRight_Corner	index of bottom-right corner radii
kLowerLeft_Corner	index of bottom-left corner radii

Definition at line 251 of file SkRRect.h.

                {
        kUpperLeft_Corner,  //!< index of top-left corner radii
        kUpperRight_Corner, //!< index of top-right corner radii
        kLowerRight_Corner, //!< index of bottom-right corner radii
        kLowerLeft_Corner,  //!< index of bottom-left corner radii
    };

◆ Type

enum SkRRect::Type

Enumerator
kEmpty_Type	zero width or height
kRect_Type	non-zero width and height, and zeroed radii
kOval_Type	non-zero width and height filled with radii
kSimple_Type	non-zero width and height with equal radii
kNinePatch_Type	non-zero width and height with axis-aligned radii
kComplex_Type	non-zero width and height with arbitrary radii
kLastType	largest Type value

Definition at line 66 of file SkRRect.h.

              {
        kEmpty_Type,                     //!< zero width or height
        kRect_Type,                      //!< non-zero width and height, and zeroed radii
        kOval_Type,                      //!< non-zero width and height filled with radii
        kSimple_Type,                    //!< non-zero width and height with equal radii
        kNinePatch_Type,                 //!< non-zero width and height with axis-aligned radii
        kComplex_Type,                   //!< non-zero width and height with arbitrary radii
        kLastType       = kComplex_Type, //!< largest Type value
    };

Constructor & Destructor Documentation

◆ SkRRect() [1/2]

SkRRect::SkRRect ( )

default

Initializes bounds at (0, 0), the origin, with zero width and height. Initializes corner radii to (0, 0), and sets type of kEmpty_Type.

Returns: empty SkRRect

◆ SkRRect() [2/2]

SkRRect::SkRRect ( const SkRRect & rrect )

default

Initializes to copy of rrect bounds and corner radii.

Parameters

rrect bounds and corner to copy

Returns: copy of rrect

Member Function Documentation

◆ contains()

bool SkRRect::contains ( const SkRect & rect ) const

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

Parameters

rect	area tested for containment

Returns: true if SkRRect contains rect

example: https://fiddle.skia.org/c/@RRect_contains

Definition at line 360 of file SkRRect.cpp.

                                               {
    if (!this->getBounds().contains(rect)) {
        // If 'rect' isn't contained by the RR's bounds then the
        // RR definitely doesn't contain it
        return false;
    }
 
    if (this->isRect()) {
        // the prior test was sufficient
        return true;
    }
 
    // At this point we know all four corners of 'rect' are inside the
    // bounds of of this RR. Check to make sure all the corners are inside
    // all the curves
    return this->checkCornerContainment(rect.fLeft, rect.fTop) &&
           this->checkCornerContainment(rect.fRight, rect.fTop) &&
           this->checkCornerContainment(rect.fRight, rect.fBottom) &&
           this->checkCornerContainment(rect.fLeft, rect.fBottom);
}

◆ dump() [1/2]

void SkRRect::dump ( ) const

inline

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.

Definition at line 476 of file SkRRect.h.

476{ this->dump(false); }

SkRRect::dump

void dump() const

Definition: SkRRect.h:476

◆ dump() [2/2]

void SkRRect::dump ( bool asHex ) const

Writes text representation of SkRRect 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: https://fiddle.skia.org/c/@RRect_dump

Definition at line 651 of file SkRRect.cpp.

651{ SkDebugf("%s\n", this->dumpToString(asHex).c_str()); }

SkDebugf

void SK_SPI SkDebugf(const char format[],...) SK_PRINTF_LIKE(1

SkRRect::dumpToString

SkString dumpToString(bool asHex) const

Definition: SkRRect.cpp:632

◆ dumpHex()

void SkRRect::dumpHex ( ) const

inline

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.

Definition at line 483 of file SkRRect.h.

483{ this->dump(true); }

◆ dumpToString()

SkString SkRRect::dumpToString ( bool asHex ) const

Definition at line 632 of file SkRRect.cpp.

                                               {
    SkScalarAsStringType asType = asHex ? kHex_SkScalarAsStringType : kDec_SkScalarAsStringType;
 
    fRect.dump(asHex);
    SkString line("const SkPoint corners[] = {\n");
    for (int i = 0; i < 4; ++i) {
        SkString strX, strY;
        SkAppendScalar(&strX, fRadii[i].x(), asType);
        SkAppendScalar(&strY, fRadii[i].y(), asType);
        line.appendf("    { %s, %s },", strX.c_str(), strY.c_str());
        if (asHex) {
            line.appendf(" /* %f %f */", fRadii[i].x(), fRadii[i].y());
        }
        line.append("\n");
    }
    line.append("};");
    return line;
}

◆ getBounds()

const SkRect & SkRRect::getBounds ( ) const

inline

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().

Returns: bounding box

Definition at line 279 of file SkRRect.h.

279{ return fRect; }

◆ getSimpleRadii()

SkVector SkRRect::getSimpleRadii ( ) const

inline

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.

Returns: corner radii for simple types

Definition at line 111 of file SkRRect.h.

                                    {
        return fRadii[0];
    }

◆ getType()

Type SkRRect::getType ( ) const

inline

Definition at line 76 of file SkRRect.h.

                         {
        SkASSERT(this->isValid());
        return static_cast<Type>(fType);
    }

◆ height()

SkScalar SkRRect::height ( ) const

inline

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

Returns: rect().fBottom minus rect().fTop

Definition at line 102 of file SkRRect.h.

102{ return fRect.height(); }

SkRect::height

constexpr float height() const

Definition: SkRect.h:769

◆ inset() [1/2]

void SkRRect::inset	(	SkScalar	dx,
		SkScalar	dy
	)

inline

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

Definition at line 341 of file SkRRect.h.

                                         {
        this->inset(dx, dy, this);
    }

◆ inset() [2/2]

void SkRRect::inset	(	SkScalar	dx,
		SkScalar	dy,
		SkRRect *	dst
	)		const

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

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: https://fiddle.skia.org/c/@RRect_inset

Definition at line 562 of file SkRRect.cpp.

                                                                {
    SkRect r = fRect.makeInset(dx, dy);
    bool degenerate = false;
    if (r.fRight <= r.fLeft) {
        degenerate = true;
        r.fLeft = r.fRight = SkScalarAve(r.fLeft, r.fRight);
    }
    if (r.fBottom <= r.fTop) {
        degenerate = true;
        r.fTop = r.fBottom = SkScalarAve(r.fTop, r.fBottom);
    }
    if (degenerate) {
        dst->fRect = r;
        memset(dst->fRadii, 0, sizeof(dst->fRadii));
        dst->fType = kEmpty_Type;
        return;
    }
    if (!r.isFinite()) {
        *dst = SkRRect();
        return;
    }
 
    SkVector radii[4];
    memcpy(radii, fRadii, sizeof(radii));
    for (int i = 0; i < 4; ++i) {
        if (radii[i].fX) {
            radii[i].fX -= dx;
        }
        if (radii[i].fY) {
            radii[i].fY -= dy;
        }
    }
    dst->setRectRadii(r, radii);
}

◆ isComplex()

bool SkRRect::isComplex ( ) const

inline

Definition at line 88 of file SkRRect.h.

88{ return kComplex_Type == this->getType(); }

SkRRect::getType

Type getType() const

Definition: SkRRect.h:76

◆ isEmpty()

bool SkRRect::isEmpty ( ) const

inline

Definition at line 83 of file SkRRect.h.

83{ return kEmpty_Type == this->getType(); }

◆ isNinePatch()

bool SkRRect::isNinePatch ( ) const

inline

Definition at line 87 of file SkRRect.h.

87{ return kNinePatch_Type == this->getType(); }

◆ isOval()

bool SkRRect::isOval ( ) const

inline

Definition at line 85 of file SkRRect.h.

85{ return kOval_Type == this->getType(); }

◆ isRect()

bool SkRRect::isRect ( ) const

inline

Definition at line 84 of file SkRRect.h.

84{ return kRect_Type == this->getType(); }

◆ isSimple()

bool SkRRect::isSimple ( ) const

inline

Definition at line 86 of file SkRRect.h.

86{ return kSimple_Type == this->getType(); }

◆ isValid()

bool SkRRect::isValid ( ) const

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.

Returns: true if bounds and radii match type()

example: https://fiddle.skia.org/c/@RRect_isValid

Definition at line 663 of file SkRRect.cpp.

                            {
    if (!AreRectAndRadiiValid(fRect, fRadii)) {
        return false;
    }
 
    bool allRadiiZero = (0 == fRadii[0].fX && 0 == fRadii[0].fY);
    bool allCornersSquare = (0 == fRadii[0].fX || 0 == fRadii[0].fY);
    bool allRadiiSame = true;
 
    for (int i = 1; i < 4; ++i) {
        if (0 != fRadii[i].fX || 0 != fRadii[i].fY) {
            allRadiiZero = false;
        }
 
        if (fRadii[i].fX != fRadii[i-1].fX || fRadii[i].fY != fRadii[i-1].fY) {
            allRadiiSame = false;
        }
 
        if (0 != fRadii[i].fX && 0 != fRadii[i].fY) {
            allCornersSquare = false;
        }
    }
    bool patchesOfNine = radii_are_nine_patch(fRadii);
 
    if (fType < 0 || fType > kLastType) {
        return false;
    }
 
    switch (fType) {
        case kEmpty_Type:
            if (!fRect.isEmpty() || !allRadiiZero || !allRadiiSame || !allCornersSquare) {
                return false;
            }
            break;
        case kRect_Type:
            if (fRect.isEmpty() || !allRadiiZero || !allRadiiSame || !allCornersSquare) {
                return false;
            }
            break;
        case kOval_Type:
            if (fRect.isEmpty() || allRadiiZero || !allRadiiSame || allCornersSquare) {
                return false;
            }
 
            for (int i = 0; i < 4; ++i) {
                if (!SkScalarNearlyEqual(fRadii[i].fX, SkRectPriv::HalfWidth(fRect)) ||
                    !SkScalarNearlyEqual(fRadii[i].fY, SkRectPriv::HalfHeight(fRect))) {
                    return false;
                }
            }
            break;
        case kSimple_Type:
            if (fRect.isEmpty() || allRadiiZero || !allRadiiSame || allCornersSquare) {
                return false;
            }
            break;
        case kNinePatch_Type:
            if (fRect.isEmpty() || allRadiiZero || allRadiiSame || allCornersSquare ||
                !patchesOfNine) {
                return false;
            }
            break;
        case kComplex_Type:
            if (fRect.isEmpty() || allRadiiZero || allRadiiSame || allCornersSquare ||
                patchesOfNine) {
                return false;
            }
            break;
    }
 
    return true;
}

◆ MakeEmpty()

static SkRRect SkRRect::MakeEmpty ( )

inlinestatic

Initializes bounds at (0, 0), the origin, with zero width and height. Initializes corner radii to (0, 0), and sets type of kEmpty_Type.

Returns: empty SkRRect

Definition at line 142 of file SkRRect.h.

142{ return SkRRect(); }

◆ makeOffset()

SkRRect SkRRect::makeOffset	(	SkScalar	dx,
		SkScalar	dy
	)		const

inline

Returns SkRRect translated by (dx, dy).

Parameters

dx	offset added to rect().fLeft and rect().fRight
dy	offset added to rect().fTop and rect().fBottom

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

Definition at line 397 of file SkRRect.h.

                                                                     {
        return SkRRect(fRect.makeOffset(dx, dy), fRadii, fType);
    }

◆ MakeOval()

static SkRRect SkRRect::MakeOval ( const SkRect & oval )

inlinestatic

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

Returns: oval

Definition at line 162 of file SkRRect.h.

                                                {
        SkRRect rr;
        rr.setOval(oval);
        return rr;
    }

◆ MakeRect()

static SkRRect SkRRect::MakeRect ( const SkRect & r )

inlinestatic

Initializes to copy of r bounds and zeroes corner radii.

Parameters

r	bounds to copy

Returns: copy of r

Definition at line 149 of file SkRRect.h.

                                             {
        SkRRect rr;
        rr.setRect(r);
        return rr;
    }

◆ MakeRectXY()

static SkRRect SkRRect::MakeRectXY	(	const SkRect &	rect,
		SkScalar	xRad,
		SkScalar	yRad
	)

inlinestatic

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

Returns: rounded rectangle

Definition at line 180 of file SkRRect.h.

                                                                                {
        SkRRect rr;
        rr.setRectXY(rect, xRad, yRad);
        return rr;
    }

◆ offset()

void SkRRect::offset	(	SkScalar	dx,
		SkScalar	dy
	)

inline

Translates SkRRect by (dx, dy).

Parameters

dx	offset added to rect().fLeft and rect().fRight
dy	offset added to rect().fTop and rect().fBottom

Definition at line 387 of file SkRRect.h.

                                          {
        fRect.offset(dx, dy);
    }

◆ operator=()

SkRRect & SkRRect::operator= ( const SkRRect & rrect )

default

Copies rrect bounds and corner radii.

Parameters

rrect bounds and corner to copy

Returns: copy of rrect

◆ outset() [1/2]

void SkRRect::outset	(	SkScalar	dx,
		SkScalar	dy
	)

inline

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

Definition at line 378 of file SkRRect.h.

                                          {
        this->inset(-dx, -dy, this);
    }

◆ outset() [2/2]

void SkRRect::outset	(	SkScalar	dx,
		SkScalar	dy,
		SkRRect *	dst
	)		const

inline

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

Definition at line 360 of file SkRRect.h.

                                                              {
        this->inset(-dx, -dy, dst);
    }

◆ radii()

SkVector SkRRect::radii ( Corner corner ) const

inline

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.

Returns: x-axis and y-axis radii for one corner

Definition at line 271 of file SkRRect.h.

271{ return fRadii[corner]; }

◆ readFromMemory()

size_t SkRRect::readFromMemory	(	const void *	buffer,
		size_t	length
	)

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

Returns: bytes read, or 0 if length is less than kSizeInMemory

example: https://fiddle.skia.org/c/@RRect_readFromMemory

Definition at line 610 of file SkRRect.cpp.

                                                                {
    if (length < kSizeInMemory) {
        return 0;
    }
 
    // The extra (void*) tells GCC not to worry that kSizeInMemory < sizeof(SkRRect).
 
    SkRRect raw;
    memcpy((void*)&raw, buffer, kSizeInMemory);
    this->setRectRadii(raw.fRect, raw.fRadii);
    return kSizeInMemory;
}

◆ rect()

const SkRect & SkRRect::rect ( ) const

inline

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().

Returns: bounding box

Definition at line 264 of file SkRRect.h.

264{ return fRect; }

◆ setEmpty()

void SkRRect::setEmpty ( )

inline

Sets bounds to zero width and height at (0, 0), the origin. Sets corner radii to zero and sets type to kEmpty_Type.

Definition at line 118 of file SkRRect.h.

118{ *this = SkRRect(); }

◆ setNinePatch()

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

Definition at line 115 of file SkRRect.cpp.

                                                                  {
    if (!this->initializeRect(rect)) {
        return;
    }
 
    if (!SkIsFinite(leftRad, topRad, rightRad, bottomRad)) {
        this->setRect(rect);    // devolve into a simple rect
        return;
    }
 
    leftRad = std::max(leftRad, 0.0f);
    topRad = std::max(topRad, 0.0f);
    rightRad = std::max(rightRad, 0.0f);
    bottomRad = std::max(bottomRad, 0.0f);
 
    SkScalar scale = SK_Scalar1;
    if (leftRad + rightRad > fRect.width()) {
        scale = fRect.width() / (leftRad + rightRad);
    }
    if (topRad + bottomRad > fRect.height()) {
        scale = std::min(scale, fRect.height() / (topRad + bottomRad));
    }
 
    if (scale < SK_Scalar1) {
        leftRad *= scale;
        topRad *= scale;
        rightRad *= scale;
        bottomRad *= scale;
    }
 
    if (leftRad == rightRad && topRad == bottomRad) {
        if (leftRad >= SkScalarHalf(fRect.width()) && topRad >= SkScalarHalf(fRect.height())) {
            fType = kOval_Type;
        } else if (0 == leftRad || 0 == topRad) {
            // If the left and (by equality check above) right radii are zero then it is a rect.
            // Same goes for top/bottom.
            fType = kRect_Type;
            leftRad = 0;
            topRad = 0;
            rightRad = 0;
            bottomRad = 0;
        } else {
            fType = kSimple_Type;
        }
    } else {
        fType = kNinePatch_Type;
    }
 
    fRadii[kUpperLeft_Corner].set(leftRad, topRad);
    fRadii[kUpperRight_Corner].set(rightRad, topRad);
    fRadii[kLowerRight_Corner].set(rightRad, bottomRad);
    fRadii[kLowerLeft_Corner].set(leftRad, bottomRad);
    if (clamp_to_zero(fRadii)) {
        this->setRect(rect);    // devolve into a simple rect
        return;
    }
    if (fType == kNinePatch_Type && !radii_are_nine_patch(fRadii)) {
        fType = kComplex_Type;
    }
 
    SkASSERT(this->isValid());
}

◆ setOval()

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

Definition at line 30 of file SkRRect.cpp.

                                        {
    if (!this->initializeRect(oval)) {
        return;
    }
 
    SkScalar xRad = SkRectPriv::HalfWidth(fRect);
    SkScalar yRad = SkRectPriv::HalfHeight(fRect);
 
    if (xRad == 0.0f || yRad == 0.0f) {
        // All the corners will be square
        memset(fRadii, 0, sizeof(fRadii));
        fType = kRect_Type;
    } else {
        for (int i = 0; i < 4; ++i) {
            fRadii[i].set(xRad, yRad);
        }
        fType = kOval_Type;
    }
 
    SkASSERT(this->isValid());
}

◆ setRect()

void SkRRect::setRect ( const SkRect & rect )

inline

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

Definition at line 126 of file SkRRect.h.

                                     {
        if (!this->initializeRect(rect)) {
            return;
        }
 
        memset(fRadii, 0, sizeof(fRadii));
        fType = kRect_Type;
 
        SkASSERT(this->isValid());
    }

◆ setRectRadii()

void SkRRect::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: https://fiddle.skia.org/c/@RRect_setRectRadii

Definition at line 189 of file SkRRect.cpp.

                                                                      {
    if (!this->initializeRect(rect)) {
        return;
    }
 
    if (!SkIsFinite(&radii[0].fX, 8)) {
        this->setRect(rect);    // devolve into a simple rect
        return;
    }
 
    memcpy(fRadii, radii, sizeof(fRadii));
 
    if (clamp_to_zero(fRadii)) {
        this->setRect(rect);
        return;
    }
 
    this->scaleRadii();
 
    if (!this->isValid()) {
        this->setRect(rect);
        return;
    }
}

◆ setRectXY()

void SkRRect::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: https://fiddle.skia.org/c/@RRect_setRectXY

Definition at line 52 of file SkRRect.cpp.

                                                                        {
    if (!this->initializeRect(rect)) {
        return;
    }
 
    if (!SkIsFinite(xRad, yRad)) {
        xRad = yRad = 0;    // devolve into a simple rect
    }
 
    if (fRect.width() < xRad+xRad || fRect.height() < yRad+yRad) {
        // At most one of these two divides will be by zero, and neither numerator is zero.
        SkScalar scale = std::min(sk_ieee_float_divide(fRect. width(), xRad + xRad),
                                     sk_ieee_float_divide(fRect.height(), yRad + yRad));
        SkASSERT(scale < SK_Scalar1);
        xRad *= scale;
        yRad *= scale;
    }
 
    if (xRad <= 0 || yRad <= 0) {
        // all corners are square in this case
        this->setRect(rect);
        return;
    }
 
    for (int i = 0; i < 4; ++i) {
        fRadii[i].set(xRad, yRad);
    }
    fType = kSimple_Type;
    if (xRad >= SkScalarHalf(fRect.width()) && yRad >= SkScalarHalf(fRect.height())) {
        fType = kOval_Type;
        // TODO: assert that all the x&y radii are already W/2 & H/2
    }
 
    SkASSERT(this->isValid());
}

◆ transform()

bool SkRRect::transform	(	const SkMatrix &	matrix,
		SkRRect *	dst
	)		const

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 that are not axis aligned.

Asserts in debug builds if SkRRect equals dst.

Parameters

matrix	SkMatrix specifying the transform
dst	SkRRect to store the result

Returns: true if transformation succeeded.

example: https://fiddle.skia.org/c/@RRect_transform

Definition at line 436 of file SkRRect.cpp.

                                                                  {
    if (nullptr == dst) {
        return false;
    }
 
    // Assert that the caller is not trying to do this in place, which
    // would violate const-ness. Do not return false though, so that
    // if they know what they're doing and want to violate it they can.
    SkASSERT(dst != this);
 
    if (matrix.isIdentity()) {
        *dst = *this;
        return true;
    }
 
    if (!matrix.preservesAxisAlignment()) {
        return false;
    }
 
    SkRect newRect;
    if (!matrix.mapRect(&newRect, fRect)) {
        return false;
    }
 
    // The matrix may have scaled us to zero (or due to float madness, we now have collapsed
    // some dimension of the rect, so we need to check for that. Note that matrix must be
    // scale and translate and mapRect() produces a sorted rect. So an empty rect indicates
    // loss of precision.
    if (!newRect.isFinite() || newRect.isEmpty()) {
        return false;
    }
 
    // At this point, this is guaranteed to succeed, so we can modify dst.
    dst->fRect = newRect;
 
    // Since the only transforms that were allowed are axis aligned, the type
    // remains unchanged.
    dst->fType = fType;
 
    if (kRect_Type == fType) {
        SkASSERT(dst->isValid());
        return true;
    }
    if (kOval_Type == fType) {
        for (int i = 0; i < 4; ++i) {
            dst->fRadii[i].fX = SkScalarHalf(newRect.width());
            dst->fRadii[i].fY = SkScalarHalf(newRect.height());
        }
        SkASSERT(dst->isValid());
        return true;
    }
 
    // Now scale each corner
    SkScalar xScale = matrix.getScaleX();
    SkScalar yScale = matrix.getScaleY();
 
    // There is a rotation of 90 (Clockwise 90) or 270 (Counter clockwise 90).
    // 180 degrees rotations are simply flipX with a flipY and would come under
    // a scale transform.
    if (!matrix.isScaleTranslate()) {
        const bool isClockwise = matrix.getSkewX() < 0;
 
        // The matrix location for scale changes if there is a rotation.
        xScale = matrix.getSkewY() * (isClockwise ? 1 : -1);
        yScale = matrix.getSkewX() * (isClockwise ? -1 : 1);
 
        const int dir = isClockwise ? 3 : 1;
        for (int i = 0; i < 4; ++i) {
            const int src = (i + dir) >= 4 ? (i + dir) % 4 : (i + dir);
            // Swap X and Y axis for the radii.
            dst->fRadii[i].fX = fRadii[src].fY;
            dst->fRadii[i].fY = fRadii[src].fX;
        }
    } else {
        for (int i = 0; i < 4; ++i) {
            dst->fRadii[i].fX = fRadii[i].fX;
            dst->fRadii[i].fY = fRadii[i].fY;
        }
    }
 
    const bool flipX = xScale < 0;
    if (flipX) {
        xScale = -xScale;
    }
 
    const bool flipY = yScale < 0;
    if (flipY) {
        yScale = -yScale;
    }
 
    // Scale the radii without respecting the flip.
    for (int i = 0; i < 4; ++i) {
        dst->fRadii[i].fX *= xScale;
        dst->fRadii[i].fY *= yScale;
    }
 
    // Now swap as necessary.
    using std::swap;
    if (flipX) {
        if (flipY) {
            // Swap with opposite corners
            swap(dst->fRadii[kUpperLeft_Corner], dst->fRadii[kLowerRight_Corner]);
            swap(dst->fRadii[kUpperRight_Corner], dst->fRadii[kLowerLeft_Corner]);
        } else {
            // Only swap in x
            swap(dst->fRadii[kUpperRight_Corner], dst->fRadii[kUpperLeft_Corner]);
            swap(dst->fRadii[kLowerRight_Corner], dst->fRadii[kLowerLeft_Corner]);
        }
    } else if (flipY) {
        // Only swap in y
        swap(dst->fRadii[kUpperLeft_Corner], dst->fRadii[kLowerLeft_Corner]);
        swap(dst->fRadii[kUpperRight_Corner], dst->fRadii[kLowerRight_Corner]);
    }
 
    if (!AreRectAndRadiiValid(dst->fRect, dst->fRadii)) {
        return false;
    }
 
    dst->scaleRadii();
    dst->isValid();  // TODO: is this meant to be SkASSERT(dst->isValid())?
 
    return true;
}

◆ type()

Type SkRRect::type ( ) const

inline

Definition at line 81 of file SkRRect.h.

81{ return this->getType(); }

◆ width()

SkScalar SkRRect::width ( ) const

inline

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

Returns: rect().fRight minus rect().fLeft

Definition at line 95 of file SkRRect.h.

95{ return fRect.width(); }

◆ writeToMemory()

size_t SkRRect::writeToMemory ( void * buffer ) const

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

Parameters

buffer storage for SkRRect

Returns: bytes written, kSizeInMemory

example: https://fiddle.skia.org/c/@RRect_writeToMemory

Definition at line 599 of file SkRRect.cpp.

                                                {
    // Serialize only the rect and corners, but not the derived type tag.
    memcpy(buffer, this, kSizeInMemory);
    return kSizeInMemory;
}

Friends And Related Function Documentation

◆ operator!=

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

friend

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

a	SkRect bounds and radii to compare
b	SkRect bounds and radii to compare

Returns: true if members are not equal

Definition at line 303 of file SkRRect.h.

                                                               {
        return a.fRect != b.fRect || !SkScalarsEqual(&a.fRadii[0].fX, &b.fRadii[0].fX, 8);
    }

◆ operator==

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

friend

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

a	SkRect bounds and radii to compare
b	SkRect bounds and radii to compare

Returns: true if members are equal

Definition at line 290 of file SkRRect.h.

                                                               {
        return a.fRect == b.fRect && SkScalarsEqual(&a.fRadii[0].fX, &b.fRadii[0].fX, 8);
    }

◆ SkPath

friend class SkPath

friend

Definition at line 512 of file SkRRect.h.

◆ SkRRectPriv

friend class SkRRectPriv

friend

Definition at line 513 of file SkRRect.h.

Member Data Documentation

◆ kSizeInMemory

constexpr size_t SkRRect::kSizeInMemory = 12 * sizeof(SkScalar)

staticconstexpr

Definition at line 422 of file SkRRect.h.

The documentation for this class was generated from the following files:

third_party/skia/include/core/SkRRect.h
third_party/skia/src/core/SkRRect.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Corner

◆ Type

Constructor & Destructor Documentation

◆ SkRRect() [1/2]

◆ SkRRect() [2/2]

Member Function Documentation

◆ contains()

◆ dump() [1/2]

◆ dump() [2/2]

◆ dumpHex()

◆ dumpToString()

◆ getBounds()

◆ getSimpleRadii()

◆ getType()

◆ height()

◆ inset() [1/2]

◆ inset() [2/2]

◆ isComplex()

◆ isEmpty()

◆ isNinePatch()

◆ isOval()

◆ isRect()

◆ isSimple()

◆ isValid()

◆ MakeEmpty()

◆ makeOffset()

◆ MakeOval()

◆ MakeRect()

◆ MakeRectXY()

◆ offset()

◆ operator=()

◆ outset() [1/2]

◆ outset() [2/2]

◆ radii()

◆ readFromMemory()

◆ rect()

◆ setEmpty()

◆ setNinePatch()

◆ setOval()

◆ setRect()

◆ setRectRadii()

◆ setRectXY()

◆ transform()

◆ type()

◆ width()

◆ writeToMemory()

Friends And Related Function Documentation

◆ operator!=

◆ operator==

◆ SkPath

◆ SkRRectPriv

Member Data Documentation

◆ kSizeInMemory