Skia
2D Graphics Library

SkRRect describes a rounded rectangle with a bounds and a pair of radii for each corner. More...
#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  
Initializes bounds at (0, 0), the origin, with zero width and height. More...  
SkRRect (const SkRRect &rrect)=default  
Initializes to copy of rrect bounds and corner radii. More...  
SkRRect &  operator= (const SkRRect &rrect)=default 
Copies rrect bounds and corner radii. More...  
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 
Returns span on the xaxis. More...  
SkScalar  height () const 
Returns span on the yaxis. More...  
SkVector  getSimpleRadii () const 
Returns topleft corner radii. More...  
void  setEmpty () 
Sets bounds to zero width and height at (0, 0), the origin. More...  
void  setRect (const SkRect &rect) 
Sets bounds to sorted rect, and sets corner radii to zero. More...  
void  setOval (const SkRect &oval) 
Sets bounds to oval, xaxis radii to half oval.width(), and all yaxis radii to half oval.height(). More...  
void  setRectXY (const SkRect &rect, SkScalar xRad, SkScalar yRad) 
Sets to rounded rectangle with the same radii for all four corners. More...  
void  setNinePatch (const SkRect &rect, SkScalar leftRad, SkScalar topRad, SkScalar rightRad, SkScalar bottomRad) 
Sets bounds to rect. More...  
void  setRectRadii (const SkRect &rect, const SkVector radii[4]) 
Sets bounds to rect. More...  
const SkRect &  rect () const 
Returns bounds. More...  
SkVector  radii (Corner corner) const 
Returns scalar pair for radius of curve on xaxis and yaxis for one corner. More...  
const SkRect &  getBounds () const 
Returns bounds. More...  
void  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. More...  
void  inset (SkScalar dx, SkScalar dy) 
Insets bounds by dx and dy, and adjusts radii by dx and dy. More...  
void  outset (SkScalar dx, SkScalar dy, SkRRect *dst) const 
Outsets dst bounds by dx and dy, and adjusts radii by dx and dy. More...  
void  outset (SkScalar dx, SkScalar dy) 
Outsets bounds by dx and dy, and adjusts radii by dx and dy. More...  
void  offset (SkScalar dx, SkScalar dy) 
Translates SkRRect by (dx, dy). More...  
SkRRect  makeOffset (SkScalar dx, SkScalar dy) const 
Returns SkRRect translated by (dx, dy). More...  
bool  contains (const SkRect &rect) const 
Returns true if rect is inside the bounds and corner radii, and if SkRRect and rect are not empty. More...  
bool  isValid () const 
Returns true if bounds and radii values are finite and describe a SkRRect SkRRect::Type that matches getType(). More...  
size_t  writeToMemory (void *buffer) const 
Writes SkRRect to buffer. More...  
size_t  readFromMemory (const void *buffer, size_t length) 
Reads SkRRect from buffer, reading kSizeInMemory bytes. More...  
bool  transform (const SkMatrix &matrix, SkRRect *dst) const 
Transforms by SkRRect by matrix, storing result in dst. More...  
void  dump (bool asHex) const 
Writes text representation of SkRRect to standard output. More...  
SkString  dumpToString (bool asHex) const 
void  dump () const 
Writes text representation of SkRRect to standard output. More...  
void  dumpHex () const 
Writes text representation of SkRRect to standard output. More...  
Static Public Member Functions  
static SkRRect  MakeEmpty () 
Initializes bounds at (0, 0), the origin, with zero width and height. More...  
static SkRRect  MakeRect (const SkRect &r) 
Initializes to copy of r bounds and zeroes corner radii. More...  
static SkRRect  MakeOval (const SkRect &oval) 
Sets bounds to oval, xaxis radii to half oval.width(), and all yaxis radii to half oval.height(). More...  
static SkRRect  MakeRectXY (const SkRect &rect, SkScalar xRad, SkScalar yRad) 
Sets to rounded rectangle with the same radii for all four corners. More...  
Static Public Attributes  
static constexpr size_t  kSizeInMemory = 12 * sizeof(SkScalar) 
Friends  
class  SkPath 
class  SkRRectPriv 
bool  operator== (const SkRRect &a, const SkRRect &b) 
Returns true if bounds and radii in a are equal to bounds and radii in b. More...  
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. More...  
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.
enum SkRRect::Corner 
enum SkRRect::Type 

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.

default 
Initializes to copy of rrect bounds and corner radii.
rrect  bounds and corner to copy 
bool SkRRect::contains  (  const SkRect &  rect  )  const 

inline 
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.
asHex  true if SkScalar values are written as hexadecimal 

inline 
SkString SkRRect::dumpToString  (  bool  asHex  )  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().

inline 
Returns topleft 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.

inline 

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 xaxis center. If dy exceeds half bounds height, bounds top and bottom are set to bounds yaxis center.
If dx or dy cause the bounds to become infinite, bounds is zeroed.
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 xaxis center. If dy exceeds half dst bounds height, dst bounds top and bottom are set to bounds yaxis center.
If dx or dy cause the bounds to become infinite, dst bounds is zeroed.

inline 

inline 

inline 

inline 

inline 

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

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.
Sets bounds to oval, xaxis radii to half oval.width(), and all yaxis radii to half oval.height().
If oval bounds is empty, sets to kEmpty_Type. Otherwise, sets to kOval_Type.
oval  bounds of oval 
Initializes to copy of r bounds and zeroes corner radii.
r  bounds to copy 

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.
rect  bounds of rounded rectangle 
xRad  xaxis radius of corners 
yRad  yaxis radius of corners 
Copies rrect bounds and corner radii.
rrect  bounds and corner to copy 
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 xaxis center. If dy exceeds half bounds height, bounds top and bottom are set to bounds yaxis center.
If dx or dy cause the bounds to become infinite, bounds is zeroed.
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 xaxis center. If dy exceeds half dst bounds height, dst bounds top and bottom are set to bounds yaxis center.
If dx or dy cause the bounds to become infinite, dst bounds is zeroed.

inline 
Returns scalar pair for radius of curve on xaxis and yaxis for one corner.
Both radii may be zero. If not zero, both are positive and finite.
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.
buffer  memory to read from 
length  size of buffer 

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

inline 
Sets bounds to zero width and height at (0, 0), the origin.
Sets corner radii to zero and sets type to kEmpty_Type.
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.
rect  bounds of rounded rectangle 
leftRad  lefttop and leftbottom xaxis radius 
topRad  lefttop and righttop yaxis radius 
rightRad  righttop and rightbottom xaxis radius 
bottomRad  leftbottom and rightbottom yaxis radius 
void SkRRect::setOval  (  const SkRect &  oval  ) 
Sets bounds to oval, xaxis radii to half oval.width(), and all yaxis radii to half oval.height().
If oval bounds is empty, sets to kEmpty_Type. Otherwise, sets to kOval_Type.
oval  bounds of oval 

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.
rect  bounds to set 
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 xaxis radii are equal and at least half rect.width(), and all yaxis radii are equal at least half rect.height(), sets to kOval_Type. Otherwise, if all xaxis radii are equal, and all yaxis radii are equal, sets to kSimple_Type. Otherwise, sets to kNinePatch_Type.
rect  bounds of rounded rectangle 
radii  corner xaxis and yaxis radii 
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.
rect  bounds of rounded rectangle 
xRad  xaxis radius of corners 
yRad  yaxis radius of corners 

inline 

inline 
size_t SkRRect::writeToMemory  (  void *  buffer  )  const 
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.
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.

friend 

friend 

staticconstexpr 