| SkRegion Reference |
| === |
| <a href='SkRegion_Reference#Region'>Region</a> is a compressed one bit mask. <a href='SkRegion_Reference#Region'>Region</a> describes an <a href='undocumented#Alias'>aliased</a> clipping area |
| on integer boundaries. <a href='SkRegion_Reference#Region'>Region</a> can also describe an array of integer rectangles. |
| |
| <a href='SkCanvas_Reference#Canvas'>Canvas</a> uses <a href='SkRegion_Reference#Region'>Region</a> to reduce the current clip. <a href='SkRegion_Reference#Region'>Region</a> may be drawn to <a href='SkCanvas_Reference#Canvas'>Canvas</a>; |
| <a href='SkPaint_Reference#Paint'>Paint</a> determines if <a href='SkRegion_Reference#Region'>Region</a> is filled or stroked, its <a href='SkColor_Reference#Color'>Color</a>, and so on. |
| |
| <a href='SkRegion_Reference#Region'>Region</a> may be constructed from <a href='SkIRect_Reference#IRect'>IRect</a> array or <a href='SkPath_Reference#Path'>Path</a>. Diagonal <a href='undocumented#Line'>lines</a> and <a href='undocumented#Curve'>curves</a> |
| in <a href='SkPath_Reference#Path'>Path</a> become integer rectangle edges. <a href='SkRegion_Reference#Region'>Regions</a> operators compute union, |
| intersection, difference, and so on. <a href='SkCanvas_Reference#Canvas'>Canvas</a> allows only intersection and |
| difference; successive clips can only reduce available <a href='SkCanvas_Reference#Canvas'>Canvas</a> area. |
| |
| <a name='SkRegion'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
| class <a href='SkRegion_Reference#SkRegion'>SkRegion</a> { |
| |
| <a href='#SkRegion_empty_constructor'>SkRegion()</a>; |
| <a href='#SkRegion_copy_const_SkRegion'>SkRegion</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>); |
| explicit <a href='#SkRegion_copy_const_SkIRect'>SkRegion</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>); |
| <a href='#SkRegion_destructor'>~SkRegion()</a>; |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='#SkRegion_copy_operator'>operator=</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>); |
| bool <a href='#SkRegion_equal1_operator'>operator==</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& other) const; |
| bool <a href='#SkRegion_notequal1_operator'>operator!=</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& other) const; |
| bool <a href='#SkRegion_set'>set</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& src); |
| void <a href='#SkRegion_swap'>swap</a>(<a href='SkRegion_Reference#SkRegion'>SkRegion</a>& other); |
| bool <a href='#SkRegion_isEmpty'>isEmpty</a>() const; |
| bool <a href='#SkRegion_isRect'>isRect</a>() const; |
| bool <a href='#SkRegion_isComplex'>isComplex</a>() const; |
| const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='#SkRegion_getBounds'>getBounds</a>() const; |
| int <a href='#SkRegion_computeRegionComplexity'>computeRegionComplexity</a>() const; |
| bool <a href='#SkRegion_getBoundaryPath'>getBoundaryPath</a>(<a href='SkPath_Reference#SkPath'>SkPath</a>* <a href='SkPath_Reference#Path'>path</a>) const; |
| bool <a href='#SkRegion_setEmpty'>setEmpty</a>(); |
| bool <a href='#SkRegion_setRect'>setRect</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>); |
| bool <a href='#SkRegion_setRect'>setRect</a>(int32_t left, int32_t top, int32_t right, int32_t bottom); |
| bool <a href='#SkRegion_setRects'>setRects</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a> <a href='SkRect_Reference#Rect'>rects</a>[], int count); |
| bool <a href='#SkRegion_setRegion'>setRegion</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>); |
| bool <a href='#SkRegion_setPath'>setPath</a>(const <a href='SkPath_Reference#SkPath'>SkPath</a>& <a href='SkPath_Reference#Path'>path</a>, const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& clip); |
| bool <a href='#SkRegion_intersects'>intersects</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>) const; |
| bool <a href='#SkRegion_intersects'>intersects</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& other) const; |
| bool <a href='#SkRegion_contains'>contains</a>(int32_t x, int32_t y) const; |
| bool <a href='#SkRegion_contains'>contains</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& other) const; |
| bool <a href='#SkRegion_contains'>contains</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& other) const; |
| bool <a href='#SkRegion_quickContains'>quickContains</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& r) const; |
| bool <a href='#SkRegion_quickContains'>quickContains</a>(int32_t left, int32_t top, int32_t right, |
| int32_t bottom) const; |
| bool <a href='#SkRegion_quickReject'>quickReject</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>) const; |
| bool <a href='#SkRegion_quickReject'>quickReject</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& rgn) const; |
| void <a href='#SkRegion_translate'>translate</a>(int dx, int dy); |
| void <a href='#SkRegion_translate'>translate</a>(int dx, int dy, <a href='SkRegion_Reference#SkRegion'>SkRegion</a>* dst) const; |
| |
| enum <a href='#SkRegion_Op'>Op</a> { |
| <a href='#SkRegion_kDifference_Op'>kDifference_Op</a>, |
| <a href='#SkRegion_kIntersect_Op'>kIntersect_Op</a>, |
| <a href='#SkRegion_kUnion_Op'>kUnion_Op</a>, |
| <a href='#SkRegion_kXOR_Op'>kXOR_Op</a>, |
| <a href='#SkRegion_kReverseDifference_Op'>kReverseDifference_Op</a>, |
| <a href='#SkRegion_kReplace_Op'>kReplace_Op</a>, |
| <a href='#SkRegion_kLastOp'>kLastOp</a> = <a href='#SkRegion_kReplace_Op'>kReplace_Op</a>, |
| }; |
| |
| static const int <a href='#SkRegion_kOpCnt'>kOpCnt</a> = <a href='#SkRegion_kLastOp'>kLastOp</a> + 1 |
| bool <a href='#SkRegion_op'>op</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>, <a href='#SkRegion_Op'>Op</a> op); |
| bool <a href='#SkRegion_op'>op</a>(int left, int top, int right, int bottom, <a href='#SkRegion_Op'>Op</a> op); |
| bool <a href='#SkRegion_op'>op</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& rgn, <a href='#SkRegion_Op'>Op</a> op); |
| bool <a href='#SkRegion_op'>op</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>, const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& rgn, <a href='#SkRegion_Op'>Op</a> op); |
| bool <a href='#SkRegion_op'>op</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& rgn, const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>, <a href='#SkRegion_Op'>Op</a> op); |
| bool <a href='#SkRegion_op'>op</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& rgna, const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& rgnb, <a href='#SkRegion_Op'>Op</a> op); |
| size_t <a href='#SkRegion_writeToMemory'>writeToMemory</a>(void* buffer) const; |
| size_t <a href='#SkRegion_readFromMemory'>readFromMemory</a>(const void* buffer, size_t length); |
| }; |
| |
| </pre> |
| |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> describes the set of pixels used to clip <a href='SkCanvas_Reference#Canvas'>Canvas</a>. <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is compact, |
| efficiently storing a single integer rectangle, or a run length encoded array |
| of rectangles. <a href='SkRegion_Reference#SkRegion'>SkRegion</a> may reduce the current <a href='#Canvas_Clip'>Canvas_Clip</a>, or may be drawn as |
| one or more integer rectangles. <a href='SkRegion_Reference#SkRegion'>SkRegion</a> iterator returns the scan <a href='undocumented#Line'>lines</a> or |
| rectangles contained by it, optionally intersecting a bounding rectangle. |
| |
| <a name='SkRegion_Iterator'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
| class <a href='#SkRegion_Iterator'>Iterator</a> { |
| public: |
| <a href='#SkRegion_Iterator_Iterator'>Iterator()</a>; |
| <a href='#SkRegion_Iterator_Iterator'>Iterator</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>); |
| bool <a href='#SkRegion_Iterator_rewind'>rewind()</a>; |
| void <a href='#SkRegion_Iterator_reset'>reset</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>); |
| bool <a href='#SkRegion_Iterator_done'>done()</a> const; |
| void <a href='#SkRegion_Iterator_next'>next()</a>; |
| const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='#SkRegion_Iterator_rect'>rect()</a>; |
| const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>* <a href='#SkRegion_Iterator_rgn'>rgn()</a>; |
| }; |
| </pre> |
| |
| Returns sequence of rectangles, sorted along y-axis, then x-axis, that make |
| up <a href='SkRegion_Reference#Region'>Region</a>. |
| |
| <a name='SkRegion_Iterator_Iterator'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| <a href='#SkRegion_Iterator_Iterator'>Iterator()</a> |
| </pre> |
| |
| Initializes <a href='SkRegion_Reference#SkRegion'>SkRegion</a>::<a href='#SkRegion_Iterator'>Iterator</a> with an empty <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. <a href='#SkRegion_Iterator_done'>done()</a> on <a href='SkRegion_Reference#SkRegion'>SkRegion</a>::<a href='#SkRegion_Iterator'>Iterator</a> |
| returns true. |
| Call <a href='#SkRegion_Iterator_reset'>reset()</a> to initialized <a href='SkRegion_Reference#SkRegion'>SkRegion</a>::<a href='#SkRegion_Iterator'>Iterator</a> at a later time. |
| |
| ### Return Value |
| |
| empty <a href='SkRegion_Reference#SkRegion'>SkRegion</a> iterator |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Iterator_Iterator"> |
| |
| #### Example Output |
| |
| ~~~~ |
| rect={1,2,3,4} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_Iterator_reset'>reset</a> <a href='SkRegion_Reference#SkRegion'>SkRegion</a> |
| |
| <a name='SkRegion_Iterator_copy_const_SkRegion'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| <a href='#SkRegion_Iterator'>Iterator</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) |
| </pre> |
| |
| Sets <a href='SkRegion_Reference#SkRegion'>SkRegion</a>::<a href='#SkRegion_Iterator'>Iterator</a> to return elements of <a href='SkIRect_Reference#SkIRect'>SkIRect</a> array in <a href='#SkRegion_Iterator_copy_const_SkRegion_region'>region</a>. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_Iterator_copy_const_SkRegion_region'><code><strong>region</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to iterate</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> iterator |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Iterator_copy_const_SkRegion"> |
| |
| #### Example Output |
| |
| ~~~~ |
| rect={1,2,3,4} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_Iterator_reset'>reset</a> <a href='SkRegion_Reference#SkRegion'>SkRegion</a> <a href='#SkRegion_Cliperator'>Cliperator</a> <a href='#SkRegion_Spanerator'>Spanerator</a> |
| |
| <a name='SkRegion_Iterator_rewind'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_Iterator_rewind'>rewind()</a> |
| </pre> |
| |
| <a href='SkPoint_Reference#SkPoint'>SkPoint</a> <a href='SkRegion_Reference#SkRegion'>SkRegion</a>::<a href='#SkRegion_Iterator'>Iterator</a> to start of <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> was set; otherwise, returns false. |
| |
| ### Return Value |
| |
| true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> was set |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Iterator_rewind"> |
| |
| #### Example Output |
| |
| ~~~~ |
| #Volatile |
| empty iter rewind success=false |
| empty iter rect={0,0,0,0} |
| empty region rewind success=true |
| empty region rect={0,0,0,0} |
| after set rect rect={1,2,3,4} |
| after rewind rewind success=true |
| after rewind rect={1,2,3,4} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_Iterator_reset'>reset</a> |
| |
| <a name='SkRegion_Iterator_reset'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| void reset(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) |
| </pre> |
| |
| Resets iterator, using the new <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_Iterator_reset_region'><code><strong>region</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to iterate</td> |
| </tr> |
| </table> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Iterator_reset"> |
| |
| #### Example Output |
| |
| ~~~~ |
| empty region: done=true |
| after set rect: done=true |
| after reset: done=false |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_Iterator_rewind'>rewind</a> |
| |
| <a name='SkRegion_Iterator_done'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_Iterator_done'>done()</a>const |
| </pre> |
| |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a>::<a href='#SkRegion_Iterator'>Iterator</a> is pointing to final <a href='SkIRect_Reference#SkIRect'>SkIRect</a> in <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. |
| |
| ### Return Value |
| |
| true if <a href='undocumented#Data'>data</a> parsing is complete |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Iterator_done"> |
| |
| #### Example Output |
| |
| ~~~~ |
| done=true |
| done=false |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_Iterator_next'>next</a> <a href='#SkRegion_Iterator_rect'>rect</a> |
| |
| <a name='SkRegion_Iterator_next'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| void <a href='#SkRegion_Iterator_next'>next()</a> |
| </pre> |
| |
| Advances <a href='SkRegion_Reference#SkRegion'>SkRegion</a>::<a href='#SkRegion_Iterator'>Iterator</a> to next <a href='SkIRect_Reference#SkIRect'>SkIRect</a> in <a href='SkRegion_Reference#SkRegion'>SkRegion</a> if it is not done. |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Iterator_next"> |
| |
| #### Example Output |
| |
| ~~~~ |
| rect={1,2,3,4} |
| rect={5,6,7,8} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_Iterator_done'>done</a> <a href='#SkRegion_Iterator_rect'>rect</a> |
| |
| <a name='SkRegion_Iterator_rect'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='#SkRegion_Iterator_rect'>rect()</a>const |
| </pre> |
| |
| Returns <a href='SkIRect_Reference#SkIRect'>SkIRect</a> element in <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. Does not return predictable results if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> |
| is empty. |
| |
| ### Return Value |
| |
| part of <a href='SkRegion_Reference#SkRegion'>SkRegion</a> as <a href='SkIRect_Reference#SkIRect'>SkIRect</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Iterator_rect"> |
| |
| #### Example Output |
| |
| ~~~~ |
| #Volatile |
| rect={0,0,0,0} |
| rect={1,2,3,4} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_Iterator_next'>next</a> <a href='#SkRegion_Iterator_done'>done</a> |
| |
| <a name='SkRegion_Iterator_rgn'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>* <a href='#SkRegion_Iterator_rgn'>rgn()</a>const |
| </pre> |
| |
| Returns <a href='SkRegion_Reference#SkRegion'>SkRegion</a> if set; otherwise, returns nullptr. |
| |
| ### Return Value |
| |
| iterated <a href='SkRegion_Reference#SkRegion'>SkRegion</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Iterator_rgn"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_Iterator'>Iterator</a> <a href='#SkRegion_Iterator_reset'>reset</a> |
| |
| <a name='SkRegion_Cliperator'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
| class <a href='#SkRegion_Cliperator'>Cliperator</a> { |
| public: |
| <a href='#SkRegion_Cliperator'>Cliperator</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>, const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& clip); |
| bool <a href='#SkRegion_Cliperator_done'>done()</a>; |
| void <a href='#SkRegion_Cliperator_next'>next()</a>; |
| const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='#SkRegion_Cliperator_rect'>rect()</a> const; |
| }; |
| </pre> |
| |
| Returns the sequence of rectangles, sorted along y-axis, then x-axis, that make |
| up <a href='SkRegion_Reference#Region'>Region</a> intersected with the specified clip rectangle. |
| |
| <a name='SkRegion_Cliperator_const_SkRegion_const_SkIRect'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| <a href='#SkRegion_Cliperator'>Cliperator</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>, const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& clip) |
| </pre> |
| |
| Sets <a href='SkRegion_Reference#SkRegion'>SkRegion</a>::<a href='#SkRegion_Cliperator'>Cliperator</a> to return elements of <a href='SkIRect_Reference#SkIRect'>SkIRect</a> array in <a href='SkRegion_Reference#SkRegion'>SkRegion</a> within <a href='#SkRegion_Cliperator_const_SkRegion_const_SkIRect_clip'>clip</a>. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_Cliperator_const_SkRegion_const_SkIRect_region'><code><strong>region</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to iterate</td> |
| </tr> |
| <tr> <td><a name='SkRegion_Cliperator_const_SkRegion_const_SkIRect_clip'><code><strong>clip</strong></code></a></td> |
| <td>bounds of iteration</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> iterator |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Cliperator_const_SkRegion_const_SkIRect"> |
| |
| #### Example Output |
| |
| ~~~~ |
| rect={1,2,2,3} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> <a href='#SkRegion_Iterator'>Iterator</a> <a href='#SkRegion_Spanerator'>Spanerator</a> |
| |
| <a name='SkRegion_Cliperator_done'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_Cliperator_done'>done()</a> |
| </pre> |
| |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a>::<a href='#SkRegion_Cliperator'>Cliperator</a> is pointing to final <a href='SkIRect_Reference#SkIRect'>SkIRect</a> in <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. |
| |
| ### Return Value |
| |
| true if <a href='undocumented#Data'>data</a> parsing is complete |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Cliperator_done"> |
| |
| #### Example Output |
| |
| ~~~~ |
| empty region done=true |
| after add rect done=false |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_Cliperator_next'>next</a> <a href='#SkRegion_Cliperator_rect'>rect</a> |
| |
| <a name='SkRegion_Cliperator_next'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| void <a href='#SkRegion_Cliperator_next'>next()</a> |
| </pre> |
| |
| Advances iterator to next <a href='SkIRect_Reference#SkIRect'>SkIRect</a> in <a href='SkRegion_Reference#SkRegion'>SkRegion</a> contained by clip. |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Cliperator_next"> |
| |
| #### Example Output |
| |
| ~~~~ |
| rect={1,3,3,4} |
| rect={5,6,7,7} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_Cliperator_done'>done</a> |
| |
| <a name='SkRegion_Cliperator_rect'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='#SkRegion_Cliperator_rect'>rect()</a>const |
| </pre> |
| |
| Returns <a href='SkIRect_Reference#SkIRect'>SkIRect</a> element in <a href='SkRegion_Reference#SkRegion'>SkRegion</a>, intersected with clip passed to |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a>::<a href='#SkRegion_Cliperator'>Cliperator</a> constructor. Does not return predictable results if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> |
| is empty. |
| |
| ### Return Value |
| |
| part of <a href='SkRegion_Reference#SkRegion'>SkRegion</a> inside clip as <a href='SkIRect_Reference#SkIRect'>SkIRect</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Cliperator_rect"> |
| |
| #### Example Output |
| |
| ~~~~ |
| #Volatile |
| empty region rect={1094713344,1065353216,0,-1} |
| after set rect rect={1,2,3,3} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_Cliperator_next'>next</a> <a href='#SkRegion_Cliperator_done'>done</a> |
| |
| <a name='SkRegion_Spanerator'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
| class <a href='#SkRegion_Spanerator'>Spanerator</a> { |
| public: |
| <a href='#SkRegion_Spanerator'>Spanerator</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>, int y, int left, int right); |
| bool <a href='#SkRegion_Spanerator_next'>next</a>(int* left, int* right); |
| }; |
| </pre> |
| |
| Returns the <a href='undocumented#Line'>line</a> segment ends within <a href='SkRegion_Reference#Region'>Region</a> that intersect a horizontal <a href='undocumented#Line'>line</a>. |
| |
| <a name='SkRegion_Spanerator_const_SkRegion_int_int_int'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| <a href='#SkRegion_Spanerator'>Spanerator</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>, int y, int left, int right) |
| </pre> |
| |
| Sets <a href='SkRegion_Reference#SkRegion'>SkRegion</a>::<a href='#SkRegion_Spanerator'>Spanerator</a> to return <a href='undocumented#Line'>line</a> segments in <a href='SkRegion_Reference#SkRegion'>SkRegion</a> on scan <a href='undocumented#Line'>line</a>. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_Spanerator_const_SkRegion_int_int_int_region'><code><strong>region</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to iterate</td> |
| </tr> |
| <tr> <td><a name='SkRegion_Spanerator_const_SkRegion_int_int_int_y'><code><strong>y</strong></code></a></td> |
| <td>horizontal <a href='undocumented#Line'>line</a> to intersect</td> |
| </tr> |
| <tr> <td><a name='SkRegion_Spanerator_const_SkRegion_int_int_int_left'><code><strong>left</strong></code></a></td> |
| <td>bounds of iteration</td> |
| </tr> |
| <tr> <td><a name='SkRegion_Spanerator_const_SkRegion_int_int_int_right'><code><strong>right</strong></code></a></td> |
| <td>bounds of iteration</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> iterator |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Spanerator_const_SkRegion_int_int_int"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> <a href='#SkRegion_Iterator'>Iterator</a> <a href='#SkRegion_Cliperator'>Cliperator</a> |
| |
| <a name='SkRegion_Spanerator_next'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool next(int* left, int* right) |
| </pre> |
| |
| Advances iterator to next span intersecting <a href='SkRegion_Reference#SkRegion'>SkRegion</a> within <a href='undocumented#Line'>line</a> segment provided |
| in constructor. Returns true if interval was found. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_Spanerator_next_left'><code><strong>left</strong></code></a></td> |
| <td>pointer to span start; may be nullptr</td> |
| </tr> |
| <tr> <td><a name='SkRegion_Spanerator_next_right'><code><strong>right</strong></code></a></td> |
| <td>pointer to span end; may be nullptr</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if interval was found |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_Spanerator_next"> |
| |
| #### Example Output |
| |
| ~~~~ |
| empty region: result=false |
| after set rect: result=true left=2 right=3 |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| done |
| |
| <a name='SkRegion_empty_constructor'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| <a href='#SkRegion_empty_constructor'>SkRegion()</a> |
| </pre> |
| |
| Constructs an empty <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is set to empty bounds |
| at (0, 0) with zero width and height. |
| |
| ### Return Value |
| |
| empty <a href='SkRegion_Reference#SkRegion'>SkRegion</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_empty_constructor"> |
| |
| #### Example Output |
| |
| ~~~~ |
| region bounds: {0, 0, 0, 0} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_setEmpty'>setEmpty</a> |
| |
| <a name='SkRegion_copy_const_SkRegion'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| <a href='#SkRegion_copy_const_SkRegion'>SkRegion</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) |
| </pre> |
| |
| Constructs a copy of an existing <a href='#SkRegion_copy_const_SkRegion_region'>region</a>. |
| Copy constructor makes two <a href='SkRegion_Reference#Region'>regions</a> identical by value. Internally, <a href='#SkRegion_copy_const_SkRegion_region'>region</a> and |
| the returned result share pointer values. The underlying <a href='SkRect_Reference#SkRect'>SkRect</a> array is |
| copied when modified. |
| |
| Creating a <a href='SkRegion_Reference#SkRegion'>SkRegion</a> copy is very efficient and never allocates memory. |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> are always copied by value from the interface; the underlying shared |
| pointers are not exposed. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_copy_const_SkRegion_region'><code><strong>region</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to copy by value</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| copy of <a href='SkRegion_Reference#SkRegion'>SkRegion</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_copy_const_SkRegion"> |
| |
| #### Example Output |
| |
| ~~~~ |
| region bounds: {1,2,3,4} |
| region2 bounds: {1,2,3,4} |
| after region set empty: |
| region bounds: {0,0,0,0} |
| region2 bounds: {1,2,3,4} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_setRegion'>setRegion</a> <a href='#SkRegion_copy_operator'>operator=</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='#SkRegion_copy_const_SkRegion_region'>region</a>) |
| |
| <a name='SkRegion_copy_const_SkIRect'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| explicit <a href='#SkRegion_copy_const_SkIRect'>SkRegion</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>) |
| </pre> |
| |
| Constructs a rectangular <a href='SkRegion_Reference#SkRegion'>SkRegion</a> matching the bounds of <a href='#SkRegion_copy_const_SkIRect_rect'>rect</a>. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_copy_const_SkIRect_rect'><code><strong>rect</strong></code></a></td> |
| <td>bounds of constructed <a href='SkRegion_Reference#SkRegion'>SkRegion</a></td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| rectangular <a href='SkRegion_Reference#SkRegion'>SkRegion</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_copy_const_SkIRect"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_setRect'>setRect</a> <a href='#SkRegion_setRegion'>setRegion</a> |
| |
| <a name='SkRegion_destructor'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| <a href='#SkRegion_destructor'>~SkRegion()</a> |
| </pre> |
| |
| Releases ownership of any shared <a href='undocumented#Data'>data</a> and deletes <a href='undocumented#Data'>data</a> if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is sole owner. |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_destructor"><div>delete calls <a href='SkRegion_Reference#Region'>Region</a> destructor, but copy of original in region2 is unaffected. |
| </div> |
| |
| #### Example Output |
| |
| ~~~~ |
| region2 bounds: {1,2,3,4} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_empty_constructor'>SkRegion()</a> <a href='#SkRegion_copy_const_SkRegion'>SkRegion</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) <a href='#SkRegion_copy_const_SkIRect'>SkRegion</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>) <a href='#SkRegion_copy_operator'>operator=</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) |
| |
| <a name='SkRegion_copy_operator'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='#SkRegion_copy_operator'>operator=</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) |
| </pre> |
| |
| Constructs a copy of an existing <a href='#SkRegion_copy_operator_region'>region</a>. |
| Makes two <a href='SkRegion_Reference#Region'>regions</a> identical by value. Internally, <a href='#SkRegion_copy_operator_region'>region</a> and |
| the returned result share pointer values. The underlying <a href='SkRect_Reference#SkRect'>SkRect</a> array is |
| copied when modified. |
| |
| Creating a <a href='SkRegion_Reference#SkRegion'>SkRegion</a> copy is very efficient and never allocates memory. |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> are always copied by value from the interface; the underlying shared |
| pointers are not exposed. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_copy_operator_region'><code><strong>region</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to copy by value</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> to copy by value |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_copy_operator"> |
| |
| #### Example Output |
| |
| ~~~~ |
| region1 bounds: {1,2,3,4} |
| region2 bounds: {1,2,3,4} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_set'>set</a> <a href='#SkRegion_swap'>swap</a> <a href='#SkRegion_copy_const_SkRegion'>SkRegion</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='#SkRegion_copy_operator_region'>region</a>) |
| |
| <a name='SkRegion_equal1_operator'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool operator==(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& other)const |
| </pre> |
| |
| Compares <a href='SkRegion_Reference#SkRegion'>SkRegion</a> and <a href='#SkRegion_equal1_operator_other'>other</a>; returns true if they enclose exactly |
| the same area. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_equal1_operator_other'><code><strong>other</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to compare</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> pair are equivalent |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_equal1_operator"> |
| |
| #### Example Output |
| |
| ~~~~ |
| empty one == two |
| set rect one != two |
| set empty one == two |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_notequal1_operator'>operator!=</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='#SkRegion_equal1_operator_other'>other</a>) const <a href='#SkRegion_copy_operator'>operator=</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) |
| |
| <a name='SkRegion_notequal1_operator'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool operator!=(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& other)const |
| </pre> |
| |
| Compares <a href='SkRegion_Reference#SkRegion'>SkRegion</a> and <a href='#SkRegion_notequal1_operator_other'>other</a>; returns true if they do not enclose the same area. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_notequal1_operator_other'><code><strong>other</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to compare</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> pair are not equivalent |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_notequal1_operator"> |
| |
| #### Example Output |
| |
| ~~~~ |
| empty one == two |
| set rect one != two |
| union rect one == two |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_equal1_operator'>operator==</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='#SkRegion_notequal1_operator_other'>other</a>) const <a href='#SkRegion_copy_operator'>operator=</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) |
| |
| <a name='SkRegion_set'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool set(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& src) |
| </pre> |
| |
| Sets <a href='SkRegion_Reference#SkRegion'>SkRegion</a> to <a href='#SkRegion_set_src'>src</a>, and returns true if <a href='#SkRegion_set_src'>src</a> bounds is not empty. |
| This makes <a href='SkRegion_Reference#SkRegion'>SkRegion</a> and <a href='#SkRegion_set_src'>src</a> identical by value. Internally, |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> and <a href='#SkRegion_set_src'>src</a> share pointer values. The underlying <a href='SkRect_Reference#SkRect'>SkRect</a> array is |
| copied when modified. |
| |
| Creating a <a href='SkRegion_Reference#SkRegion'>SkRegion</a> copy is very efficient and never allocates memory. |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> are always copied by value from the interface; the underlying shared |
| pointers are not exposed. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_set_src'><code><strong>src</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to copy</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| copy of <a href='#SkRegion_set_src'>src</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_set"> |
| |
| #### Example Output |
| |
| ~~~~ |
| region1 bounds: {1,2,3,4} |
| region2 bounds: {1,2,3,4} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_copy_operator'>operator=</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) <a href='#SkRegion_swap'>swap</a> <a href='#SkRegion_copy_const_SkRegion'>SkRegion</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) |
| |
| <a name='SkRegion_swap'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| void <a href='#SkRegion_swap'>swap</a>(<a href='SkRegion_Reference#SkRegion'>SkRegion</a>& other) |
| </pre> |
| |
| Exchanges <a href='SkIRect_Reference#SkIRect'>SkIRect</a> array of <a href='SkRegion_Reference#SkRegion'>SkRegion</a> and <a href='#SkRegion_swap_other'>other</a>. <a href='#SkRegion_swap'>swap()</a> internally exchanges pointers, |
| so it is lightweight and does not allocate memory. |
| |
| <a href='#SkRegion_swap'>swap()</a> usage has largely been replaced by <a href='#SkRegion_copy_operator'>operator=</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>). |
| <a href='SkPath_Reference#SkPath'>SkPath</a> do not copy their content on assignment until they are written to, |
| making assignment as efficient as <a href='#SkRegion_swap'>swap()</a>. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_swap_other'><code><strong>other</strong></code></a></td> |
| <td><a href='#SkRegion_copy_operator'>operator=</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) set</td> |
| </tr> |
| </table> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_swap"> |
| |
| #### Example Output |
| |
| ~~~~ |
| region1 bounds: {0,0,0,0} |
| region2 bounds: {1,2,3,4} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_copy_operator'>operator=</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) <a href='#SkRegion_set'>set</a> <a href='#SkRegion_copy_const_SkRegion'>SkRegion</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) |
| |
| <a name='SkRegion_isEmpty'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_isEmpty'>isEmpty</a>()const |
| </pre> |
| |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty. |
| Empty <a href='SkRegion_Reference#SkRegion'>SkRegion</a> has bounds width or height less than or equal to zero. |
| <a href='#SkRegion_empty_constructor'>SkRegion()</a> constructs empty <a href='SkRegion_Reference#SkRegion'>SkRegion</a>; <a href='#SkRegion_setEmpty'>setEmpty</a>() |
| and <a href='#SkRegion_setRect'>setRect</a>() with dimensionless <a href='undocumented#Data'>data</a> make <a href='SkRegion_Reference#SkRegion'>SkRegion</a> empty. |
| |
| ### Return Value |
| |
| true if bounds has no width or height |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_isEmpty"> |
| |
| #### Example Output |
| |
| ~~~~ |
| initial: region is empty |
| set rect: region is not empty |
| set empty: region is empty |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_isRect'>isRect</a> <a href='#SkRegion_isComplex'>isComplex</a> <a href='#SkRegion_equal1_operator'>operator==</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& other) const |
| |
| <a name='SkRegion_isRect'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_isRect'>isRect</a>()const |
| </pre> |
| |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is one <a href='SkIRect_Reference#SkIRect'>SkIRect</a> with positive dimensions. |
| |
| ### Return Value |
| |
| true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> contains one <a href='SkIRect_Reference#SkIRect'>SkIRect</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_isRect"> |
| |
| #### Example Output |
| |
| ~~~~ |
| initial: region is not rect |
| set rect: region is rect |
| set empty: region is not rect |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_isEmpty'>isEmpty</a> <a href='#SkRegion_isComplex'>isComplex</a> |
| |
| <a name='SkRegion_isComplex'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_isComplex'>isComplex</a>()const |
| </pre> |
| |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is described by more than one rectangle. |
| |
| ### Return Value |
| |
| true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> contains more than one <a href='SkIRect_Reference#SkIRect'>SkIRect</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_isComplex"> |
| |
| #### Example Output |
| |
| ~~~~ |
| initial: region is not complex |
| set rect: region is not complex |
| op rect: region is complex |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_isEmpty'>isEmpty</a> <a href='#SkRegion_isRect'>isRect</a> |
| |
| <a name='SkRegion_getBounds'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='#SkRegion_getBounds'>getBounds</a>()const |
| </pre> |
| |
| Returns minimum and maximum axes values of <a href='SkIRect_Reference#SkIRect'>SkIRect</a> array. |
| Returns (0, 0, 0, 0) if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty. |
| |
| ### Return Value |
| |
| combined bounds of all <a href='SkIRect_Reference#SkIRect'>SkIRect</a> elements |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_getBounds"> |
| |
| #### Example Output |
| |
| ~~~~ |
| bounds: {1,2,4,5} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_isEmpty'>isEmpty</a> <a href='#SkRegion_isRect'>isRect</a> |
| |
| <a name='SkRegion_computeRegionComplexity'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| int <a href='#SkRegion_computeRegionComplexity'>computeRegionComplexity</a>()const |
| </pre> |
| |
| Returns a value that increases with the number of |
| elements in <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. Returns zero if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty. |
| Returns one if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> equals <a href='SkIRect_Reference#SkIRect'>SkIRect</a>; otherwise, returns |
| value greater than one indicating that <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is complex. |
| |
| Call to compare <a href='SkRegion_Reference#SkRegion'>SkRegion</a> for relative complexity. |
| |
| ### Return Value |
| |
| relative complexity |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_computeRegionComplexity"> |
| |
| #### Example Output |
| |
| ~~~~ |
| initial: region complexity 0 |
| set rect: region complexity 1 |
| op rect: region complexity 3 |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_isRect'>isRect</a> <a href='#SkRegion_isComplex'>isComplex</a> |
| |
| <a name='SkRegion_getBoundaryPath'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_getBoundaryPath'>getBoundaryPath</a>(<a href='SkPath_Reference#SkPath'>SkPath</a>* <a href='SkPath_Reference#Path'>path</a>)const |
| </pre> |
| |
| Appends outline of <a href='SkRegion_Reference#SkRegion'>SkRegion</a> to <a href='#SkRegion_getBoundaryPath_path'>path</a>. |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is not empty; otherwise, returns false, and leaves <a href='#SkRegion_getBoundaryPath_path'>path</a> |
| unmodified. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_getBoundaryPath_path'><code><strong>path</strong></code></a></td> |
| <td><a href='SkPath_Reference#SkPath'>SkPath</a> to append to</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if <a href='#SkRegion_getBoundaryPath_path'>path</a> changed |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_getBoundaryPath"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_isEmpty'>isEmpty</a> <a href='#SkRegion_isComplex'>isComplex</a> |
| |
| <a name='SkRegion_setEmpty'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_setEmpty'>setEmpty</a>() |
| </pre> |
| |
| Constructs an empty <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is set to empty bounds |
| at (0, 0) with zero width and height. Always returns false. |
| |
| ### Return Value |
| |
| false |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_setEmpty"> |
| |
| #### Example Output |
| |
| ~~~~ |
| region bounds: {1,2,3,4} |
| after region set empty: |
| region bounds: {0,0,0,0} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_empty_constructor'>SkRegion()</a> |
| |
| <a name='SkRegion_setRect'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_setRect'>setRect</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>) |
| </pre> |
| |
| Constructs a rectangular <a href='SkRegion_Reference#SkRegion'>SkRegion</a> matching the bounds of <a href='#SkRegion_setRect_rect'>rect</a>. |
| If <a href='#SkRegion_setRect_rect'>rect</a> is empty, constructs empty and returns false. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_setRect_rect'><code><strong>rect</strong></code></a></td> |
| <td>bounds of constructed <a href='SkRegion_Reference#SkRegion'>SkRegion</a></td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if <a href='#SkRegion_setRect_rect'>rect</a> is not empty |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_setRect"> |
| |
| #### Example Output |
| |
| ~~~~ |
| region is not empty |
| region is empty |
| setEmpty: false |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_copy_const_SkIRect'>SkRegion</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='#SkRegion_setRect_rect'>rect</a>) |
| |
| <a name='SkRegion_setRect_2'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_setRect'>setRect</a>(int32_t left, int32_t top, int32_t right, int32_t bottom) |
| </pre> |
| |
| Constructs <a href='SkRegion_Reference#SkRegion'>SkRegion</a> with bounds (<a href='#SkRegion_setRect_2_left'>left</a>, <a href='#SkRegion_setRect_2_top'>top</a>, <a href='#SkRegion_setRect_2_right'>right</a>, <a href='#SkRegion_setRect_2_bottom'>bottom</a>). |
| Returns true if <a href='#SkRegion_setRect_2_left'>left</a> is less than <a href='#SkRegion_setRect_2_right'>right</a> and <a href='#SkRegion_setRect_2_top'>top</a> is less than <a href='#SkRegion_setRect_2_bottom'>bottom</a>; otherwise, |
| constructs empty <a href='SkRegion_Reference#SkRegion'>SkRegion</a> and returns false. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_setRect_2_left'><code><strong>left</strong></code></a></td> |
| <td>edge of bounds on x-axis</td> |
| </tr> |
| <tr> <td><a name='SkRegion_setRect_2_top'><code><strong>top</strong></code></a></td> |
| <td>edge of bounds on y-axis</td> |
| </tr> |
| <tr> <td><a name='SkRegion_setRect_2_right'><code><strong>right</strong></code></a></td> |
| <td>edge of bounds on x-axis</td> |
| </tr> |
| <tr> <td><a name='SkRegion_setRect_2_bottom'><code><strong>bottom</strong></code></a></td> |
| <td>edge of bounds on y-axis</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| rectangular <a href='SkRegion_Reference#SkRegion'>SkRegion</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="5b31a1b077818a8150ad50f3b19e7bfe"> |
| |
| #### Example Output |
| |
| ~~~~ |
| set to: 1,2,3,4: success:true {1,2,3,4} |
| set to: 3,2,1,4: success:false {0,0,0,0} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_copy_const_SkIRect'>SkRegion</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>) |
| |
| <a name='SkRegion_setRects'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_setRects'>setRects</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a> <a href='SkRect_Reference#Rect'>rects</a>[], int count) |
| </pre> |
| |
| Constructs <a href='SkRegion_Reference#SkRegion'>SkRegion</a> as the union of <a href='SkIRect_Reference#SkIRect'>SkIRect</a> in <a href='#SkRegion_setRects_rects'>rects</a> array. If <a href='#SkRegion_setRects_count'>count</a> is |
| zero, constructs empty <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. Returns false if constructed <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty. |
| |
| May be faster than repeated calls to <a href='#SkRegion_op'>op()</a>. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_setRects_rects'><code><strong>rects</strong></code></a></td> |
| <td>array of <a href='SkIRect_Reference#SkIRect'>SkIRect</a></td> |
| </tr> |
| <tr> <td><a name='SkRegion_setRects_count'><code><strong>count</strong></code></a></td> |
| <td>array <a href='undocumented#Size'>size</a></td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if constructed <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is not empty |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_setRects"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_setRect'>setRect</a> <a href='#SkRegion_op'>op</a> |
| |
| <a name='SkRegion_setRegion'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_setRegion'>setRegion</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='SkRegion_Reference#Region'>region</a>) |
| </pre> |
| |
| Constructs a copy of an existing <a href='#SkRegion_setRegion_region'>region</a>. |
| Makes two <a href='SkRegion_Reference#Region'>regions</a> identical by value. Internally, <a href='#SkRegion_setRegion_region'>region</a> and |
| the returned result share pointer values. The underlying <a href='SkRect_Reference#SkRect'>SkRect</a> array is |
| copied when modified. |
| |
| Creating a <a href='SkRegion_Reference#SkRegion'>SkRegion</a> copy is very efficient and never allocates memory. |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> are always copied by value from the interface; the underlying shared |
| pointers are not exposed. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_setRegion_region'><code><strong>region</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to copy by value</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| <a href='SkRegion_Reference#SkRegion'>SkRegion</a> to copy by value |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_setRegion"> |
| |
| #### Example Output |
| |
| ~~~~ |
| region bounds: {1,2,3,4} |
| region2 bounds: {1,2,3,4} |
| after region set empty: |
| region bounds: {1,2,3,4} |
| region2 bounds: {0,0,0,0} |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_copy_const_SkRegion'>SkRegion</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& <a href='#SkRegion_setRegion_region'>region</a>) |
| |
| <a name='SkRegion_setPath'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_setPath'>setPath</a>(const <a href='SkPath_Reference#SkPath'>SkPath</a>& <a href='SkPath_Reference#Path'>path</a>, const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& clip) |
| </pre> |
| |
| Constructs <a href='SkRegion_Reference#SkRegion'>SkRegion</a> to match outline of <a href='#SkRegion_setPath_path'>path</a> within <a href='#SkRegion_setPath_clip'>clip</a>. |
| Returns false if constructed <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty. |
| |
| Constructed <a href='SkRegion_Reference#SkRegion'>SkRegion</a> draws the same pixels as <a href='#SkRegion_setPath_path'>path</a> through <a href='#SkRegion_setPath_clip'>clip</a> when |
| <a href='SkPaint_Reference#Anti_Alias'>anti-aliasing</a> is disabled. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_setPath_path'><code><strong>path</strong></code></a></td> |
| <td><a href='SkPath_Reference#SkPath'>SkPath</a> providing outline</td> |
| </tr> |
| <tr> <td><a name='SkRegion_setPath_clip'><code><strong>clip</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> containing <a href='#SkRegion_setPath_path'>path</a></td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if constructed <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is not empty |
| |
| ### Example |
| |
| <div><fiddle-embed name="45b9ea2247b9ca7f10aa22ea29a426f4"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_setRects'>setRects</a> <a href='#SkRegion_op'>op</a> |
| |
| <a name='SkRegion_intersects'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool intersects(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>)const |
| </pre> |
| |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> intersects <a href='#SkRegion_intersects_rect'>rect</a>. |
| Returns false if either <a href='#SkRegion_intersects_rect'>rect</a> or <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty, or do not intersect. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_intersects_rect'><code><strong>rect</strong></code></a></td> |
| <td><a href='SkIRect_Reference#SkIRect'>SkIRect</a> to intersect</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if <a href='#SkRegion_intersects_rect'>rect</a> and <a href='SkRegion_Reference#SkRegion'>SkRegion</a> have area in common |
| |
| ### Example |
| |
| <div><fiddle-embed name="42bde0ef8c2ee372751428cd6e21c1ca"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_contains'>contains</a> <a href='SkRect_Reference#SkRect'>SkRect</a>::<a href='#SkRect_intersects'>intersects</a> |
| |
| <a name='SkRegion_intersects_2'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool intersects(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& other)const |
| </pre> |
| |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> intersects <a href='#SkRegion_intersects_2_other'>other</a>. |
| Returns false if either <a href='#SkRegion_intersects_2_other'>other</a> or <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty, or do not intersect. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_intersects_2_other'><code><strong>other</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to intersect</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if <a href='#SkRegion_intersects_2_other'>other</a> and <a href='SkRegion_Reference#SkRegion'>SkRegion</a> have area in common |
| |
| ### Example |
| |
| <div><fiddle-embed name="4263d79ac0e7df02e90948fdde9fa965"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_contains'>contains</a> <a href='SkRect_Reference#SkRect'>SkRect</a>::<a href='#SkRect_intersects'>intersects</a> |
| |
| <a name='SkRegion_contains'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool contains(int32_t x, int32_t y)const |
| </pre> |
| |
| Returns true if <a href='SkIPoint_Reference#SkIPoint'>SkIPoint</a> (<a href='#SkRegion_contains_x'>x</a>, <a href='#SkRegion_contains_y'>y</a>) is inside <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. |
| Returns false if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_contains_x'><code><strong>x</strong></code></a></td> |
| <td>test <a href='SkIPoint_Reference#SkIPoint'>SkIPoint</a> x-coordinate</td> |
| </tr> |
| <tr> <td><a name='SkRegion_contains_y'><code><strong>y</strong></code></a></td> |
| <td>test <a href='SkIPoint_Reference#SkIPoint'>SkIPoint</a> y-coordinate</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if (<a href='#SkRegion_contains_x'>x</a>, <a href='#SkRegion_contains_y'>y</a>) is inside <a href='SkRegion_Reference#SkRegion'>SkRegion</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="e3899c2715c332bfc7648d5f2b9eefc6"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_intersects'>intersects</a> <a href='SkRect_Reference#SkRect'>SkRect</a>::<a href='#SkRect_contains'>contains</a> |
| |
| <a name='SkRegion_contains_2'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool contains(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& other)const |
| </pre> |
| |
| Returns true if <a href='#SkRegion_contains_2_other'>other</a> is completely inside <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. |
| Returns false if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> or <a href='#SkRegion_contains_2_other'>other</a> is empty. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_contains_2_other'><code><strong>other</strong></code></a></td> |
| <td><a href='SkIRect_Reference#SkIRect'>SkIRect</a> to contain</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if <a href='#SkRegion_contains_2_other'>other</a> is inside <a href='SkRegion_Reference#SkRegion'>SkRegion</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="100b4cbd5dd7406804e40035833a433c"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_intersects'>intersects</a> <a href='SkRect_Reference#SkRect'>SkRect</a>::<a href='#SkRect_contains'>contains</a> |
| |
| <a name='SkRegion_contains_3'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool contains(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& other)const |
| </pre> |
| |
| Returns true if <a href='#SkRegion_contains_3_other'>other</a> is completely inside <a href='SkRegion_Reference#SkRegion'>SkRegion</a>. |
| Returns false if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> or <a href='#SkRegion_contains_3_other'>other</a> is empty. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_contains_3_other'><code><strong>other</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to contain</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if <a href='#SkRegion_contains_3_other'>other</a> is inside <a href='SkRegion_Reference#SkRegion'>SkRegion</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="46de22da2f3e08a8d7f064634fc1c7b5"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_intersects'>intersects</a> <a href='SkRect_Reference#SkRect'>SkRect</a>::<a href='#SkRect_contains'>contains</a> |
| |
| <a name='SkRegion_quickContains'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_quickContains'>quickContains</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& r)const |
| </pre> |
| |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is a single rectangle and contains <a href='#SkRegion_quickContains_r'>r</a>. |
| May return false even though <a href='SkRegion_Reference#SkRegion'>SkRegion</a> contains <a href='#SkRegion_quickContains_r'>r</a>. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_quickContains_r'><code><strong>r</strong></code></a></td> |
| <td><a href='SkIRect_Reference#SkIRect'>SkIRect</a> to contain</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true quickly if <a href='#SkRegion_quickContains_r'>r</a> <a href='SkPoint_Reference#Point'>points</a> are equal or inside |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_quickContains"> |
| |
| #### Example Output |
| |
| ~~~~ |
| quickContains 1: true |
| quickContains 2: true |
| quickContains 3: false |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_contains'>contains</a> <a href='#SkRegion_quickReject'>quickReject</a> <a href='#SkRegion_intersects'>intersects</a> |
| |
| <a name='SkRegion_quickContains_2'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_quickContains'>quickContains</a>(int32_t left, int32_t top, int32_t right, int32_t bottom)const |
| </pre> |
| |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is a single rectangle and contains <a href='SkIRect_Reference#SkIRect'>SkIRect</a> |
| (<a href='#SkRegion_quickContains_2_left'>left</a>, <a href='#SkRegion_quickContains_2_top'>top</a>, <a href='#SkRegion_quickContains_2_right'>right</a>, <a href='#SkRegion_quickContains_2_bottom'>bottom</a>). |
| Returns false if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty or <a href='SkIRect_Reference#SkIRect'>SkIRect</a> (<a href='#SkRegion_quickContains_2_left'>left</a>, <a href='#SkRegion_quickContains_2_top'>top</a>, <a href='#SkRegion_quickContains_2_right'>right</a>, <a href='#SkRegion_quickContains_2_bottom'>bottom</a>) is empty. |
| May return false even though <a href='SkRegion_Reference#SkRegion'>SkRegion</a> contains (<a href='#SkRegion_quickContains_2_left'>left</a>, <a href='#SkRegion_quickContains_2_top'>top</a>, <a href='#SkRegion_quickContains_2_right'>right</a>, <a href='#SkRegion_quickContains_2_bottom'>bottom</a>). |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_quickContains_2_left'><code><strong>left</strong></code></a></td> |
| <td>edge of bounds on x-axis</td> |
| </tr> |
| <tr> <td><a name='SkRegion_quickContains_2_top'><code><strong>top</strong></code></a></td> |
| <td>edge of bounds on y-axis</td> |
| </tr> |
| <tr> <td><a name='SkRegion_quickContains_2_right'><code><strong>right</strong></code></a></td> |
| <td>edge of bounds on x-axis</td> |
| </tr> |
| <tr> <td><a name='SkRegion_quickContains_2_bottom'><code><strong>bottom</strong></code></a></td> |
| <td>edge of bounds on y-axis</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true quickly if <a href='SkIRect_Reference#SkIRect'>SkIRect</a> are equal or inside |
| |
| ### Example |
| |
| <div><fiddle-embed name="eb6d290887e1a3a0b051b4d7b012f5e1"> |
| |
| #### Example Output |
| |
| ~~~~ |
| quickContains 1: true |
| quickContains 2: true |
| quickContains 3: false |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_contains'>contains</a> <a href='#SkRegion_quickReject'>quickReject</a> <a href='#SkRegion_intersects'>intersects</a> |
| |
| <a name='SkRegion_quickReject'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_quickReject'>quickReject</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>)const |
| </pre> |
| |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> does not intersect <a href='#SkRegion_quickReject_rect'>rect</a>. |
| Returns true if <a href='#SkRegion_quickReject_rect'>rect</a> is empty or <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty. |
| May return false even though <a href='SkRegion_Reference#SkRegion'>SkRegion</a> does not intersect <a href='#SkRegion_quickReject_rect'>rect</a>. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_quickReject_rect'><code><strong>rect</strong></code></a></td> |
| <td><a href='SkIRect_Reference#SkIRect'>SkIRect</a> to intersect</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if <a href='#SkRegion_quickReject_rect'>rect</a> does not intersect |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_quickReject"> |
| |
| #### Example Output |
| |
| ~~~~ |
| quickReject 1: true |
| quickReject 2: true |
| quickReject 3: false |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_quickContains'>quickContains</a> <a href='#SkRegion_contains'>contains</a> <a href='#SkRegion_intersects'>intersects</a> |
| |
| <a name='SkRegion_quickReject_2'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_quickReject'>quickReject</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& rgn)const |
| </pre> |
| |
| Returns true if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> does not intersect <a href='#SkRegion_quickReject_2_rgn'>rgn</a>. |
| Returns true if <a href='#SkRegion_quickReject_2_rgn'>rgn</a> is empty or <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty. |
| May return false even though <a href='SkRegion_Reference#SkRegion'>SkRegion</a> does not intersect <a href='#SkRegion_quickReject_2_rgn'>rgn</a>. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_quickReject_2_rgn'><code><strong>rgn</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> to intersect</td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| true if <a href='#SkRegion_quickReject_2_rgn'>rgn</a> does not intersect |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_quickReject_2"> |
| |
| #### Example Output |
| |
| ~~~~ |
| quickReject 1: true |
| quickReject 2: true |
| quickReject 3: false |
| ~~~~ |
| |
| </fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_quickContains'>quickContains</a> <a href='#SkRegion_contains'>contains</a> <a href='#SkRegion_intersects'>intersects</a> |
| |
| <a name='SkRegion_translate'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| void translate(int dx, int dy) |
| </pre> |
| |
| Offsets <a href='SkRegion_Reference#SkRegion'>SkRegion</a> by <a href='SkIPoint_Reference#IVector'>ivector</a> (<a href='#SkRegion_translate_dx'>dx</a>, <a href='#SkRegion_translate_dy'>dy</a>). Has no effect if <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_translate_dx'><code><strong>dx</strong></code></a></td> |
| <td>x-axis offset</td> |
| </tr> |
| <tr> <td><a name='SkRegion_translate_dy'><code><strong>dy</strong></code></a></td> |
| <td>y-axis offset</td> |
| </tr> |
| </table> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_translate"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='SkCanvas_Reference#SkCanvas'>SkCanvas</a>::<a href='#SkCanvas_translate'>translate</a> <a href='SkIRect_Reference#SkIRect'>SkIRect</a>::<a href='#SkIRect_offset'>offset</a> <a href='SkPath_Reference#SkPath'>SkPath</a>::<a href='#SkPath_offset'>offset</a> |
| |
| <a name='SkRegion_translate_2'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| void translate(int dx, int dy, <a href='SkRegion_Reference#SkRegion'>SkRegion</a>* dst)const |
| </pre> |
| |
| Offsets <a href='SkRegion_Reference#SkRegion'>SkRegion</a> by <a href='SkIPoint_Reference#IVector'>ivector</a> (<a href='#SkRegion_translate_2_dx'>dx</a>, <a href='#SkRegion_translate_2_dy'>dy</a>), writing result to <a href='#SkRegion_translate_2_dst'>dst</a>. <a href='SkRegion_Reference#SkRegion'>SkRegion</a> may be passed |
| as <a href='#SkRegion_translate_2_dst'>dst</a> parameter, translating <a href='SkRegion_Reference#SkRegion'>SkRegion</a> in place. Has no effect if <a href='#SkRegion_translate_2_dst'>dst</a> is nullptr. |
| If <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is empty, sets <a href='#SkRegion_translate_2_dst'>dst</a> to empty. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_translate_2_dx'><code><strong>dx</strong></code></a></td> |
| <td>x-axis offset</td> |
| </tr> |
| <tr> <td><a name='SkRegion_translate_2_dy'><code><strong>dy</strong></code></a></td> |
| <td>y-axis offset</td> |
| </tr> |
| <tr> <td><a name='SkRegion_translate_2_dst'><code><strong>dst</strong></code></a></td> |
| <td>translated result</td> |
| </tr> |
| </table> |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_translate_2"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='SkCanvas_Reference#SkCanvas'>SkCanvas</a>::<a href='#SkCanvas_translate'>translate</a> <a href='SkIRect_Reference#SkIRect'>SkIRect</a>::<a href='#SkIRect_offset'>offset</a> <a href='SkPath_Reference#SkPath'>SkPath</a>::<a href='#SkPath_offset'>offset</a> |
| |
| <a name='SkRegion_Op'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
| enum <a href='#SkRegion_Op'>Op</a> { |
| <a href='#SkRegion_kDifference_Op'>kDifference_Op</a>, |
| <a href='#SkRegion_kIntersect_Op'>kIntersect_Op</a>, |
| <a href='#SkRegion_kUnion_Op'>kUnion_Op</a>, |
| <a href='#SkRegion_kXOR_Op'>kXOR_Op</a>, |
| <a href='#SkRegion_kReverseDifference_Op'>kReverseDifference_Op</a>, |
| <a href='#SkRegion_kReplace_Op'>kReplace_Op</a>, |
| <a href='#SkRegion_kLastOp'>kLastOp</a> = <a href='#SkRegion_kReplace_Op'>kReplace_Op</a>, |
| }; |
| </pre> |
| |
| The logical operations that can be performed when combining two <a href='SkRegion_Reference#Region'>Regions</a>. |
| |
| ### Constants |
| |
| <table style='border-collapse: collapse; width: 62.5em'> |
| <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| <tr style='background-color: #f0f0f0; '> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkRegion_kDifference_Op'><code>SkRegion::kDifference_Op</code></a></td> |
| <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| Subtracts operand <a href='SkRegion_Reference#Region'>Region</a> from target <a href='SkRegion_Reference#Region'>Region</a>. |
| </td> |
| </tr> |
| <tr> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkRegion_kIntersect_Op'><code>SkRegion::kIntersect_Op</code></a></td> |
| <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| Intersects operand <a href='SkRegion_Reference#Region'>Region</a> and target <a href='SkRegion_Reference#Region'>Region</a>. |
| </td> |
| </tr> |
| <tr style='background-color: #f0f0f0; '> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkRegion_kUnion_Op'><code>SkRegion::kUnion_Op</code></a></td> |
| <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| Unions operand <a href='SkRegion_Reference#Region'>Region</a> and target <a href='SkRegion_Reference#Region'>Region</a>. |
| </td> |
| </tr> |
| <tr> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkRegion_kXOR_Op'><code>SkRegion::kXOR_Op</code></a></td> |
| <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| Replaces target <a href='SkRegion_Reference#Region'>Region</a> with area exclusive to both <a href='SkRegion_Reference#Region'>Regions</a>. |
| </td> |
| </tr> |
| <tr style='background-color: #f0f0f0; '> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkRegion_kReverseDifference_Op'><code>SkRegion::kReverseDifference_Op</code></a></td> |
| <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>4</td> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| Subtracts target <a href='SkRegion_Reference#Region'>Region</a> from operand <a href='SkRegion_Reference#Region'>Region</a>. |
| </td> |
| </tr> |
| <tr> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkRegion_kReplace_Op'><code>SkRegion::kReplace_Op</code></a></td> |
| <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>5</td> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| Replaces target <a href='SkRegion_Reference#Region'>Region</a> with operand <a href='SkRegion_Reference#Region'>Region</a>. |
| </td> |
| </tr> |
| <tr style='background-color: #f0f0f0; '> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkRegion_kLastOp'><code>SkRegion::kLastOp</code></a></td> |
| <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>5</td> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| last operator</td> |
| </tr> |
| </table> |
| |
| ### Example |
| |
| <div><fiddle-embed name="026dd8b180fe8e43f477fce43e9217b3"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='undocumented#SkPathOp'>SkPathOp</a> |
| |
| ### Constants |
| |
| <table style='border-collapse: collapse; width: 62.5em'> |
| <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| <tr style='background-color: #f0f0f0; '> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkRegion_kOpCnt'><code>SkRegion::kOpCnt</code></a></td> |
| <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>6</td> |
| <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| May be used to verify that <a href='#SkRegion_Op'>Op</a> is a legal value.</td> |
| </tr> |
| </table> |
| |
| <a name='SkRegion_op'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_op'>op</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>, <a href='#SkRegion_Op'>Op</a> op) |
| </pre> |
| |
| Replaces <a href='SkRegion_Reference#SkRegion'>SkRegion</a> with the result of <a href='SkRegion_Reference#SkRegion'>SkRegion</a> <a href='#SkRegion_op_op'>op</a> <a href='#SkRegion_op_rect'>rect</a>. |
| Returns true if replaced <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is not empty. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_op_rect'><code><strong>rect</strong></code></a></td> |
| <td><a href='SkIRect_Reference#SkIRect'>SkIRect</a> operand</td> |
| </tr> |
| <tr> <td><a name='SkRegion_op_op'><code><strong>op</strong></code></a></td> |
| <td>operator, one of:</td> |
| </tr> |
| </table> |
| |
| <a href='#SkRegion_kDifference_Op'>kDifference_Op</a>, <a href='#SkRegion_kIntersect_Op'>kIntersect_Op</a>, <a href='#SkRegion_kUnion_Op'>kUnion_Op</a>, <a href='#SkRegion_kXOR_Op'>kXOR_Op</a>, <a href='#SkRegion_kReverseDifference_Op'>kReverseDifference_Op</a>, |
| <a href='#SkRegion_kReplace_Op'>kReplace_Op</a> |
| |
| ### Return Value |
| |
| false if result is empty |
| |
| ### Example |
| |
| <div><fiddle-embed name="1790b2e054c536a54601138365700ac3"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_setRects'>setRects</a> <a href='#SkRegion_Op'>Op</a> |
| |
| <a name='SkRegion_op_2'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_op'>op</a>(int left, int top, int right, int bottom, <a href='#SkRegion_Op'>Op</a> op) |
| </pre> |
| |
| Replaces <a href='SkRegion_Reference#SkRegion'>SkRegion</a> with the result of <a href='SkRegion_Reference#SkRegion'>SkRegion</a> <a href='#SkRegion_op_2_op'>op</a> <a href='SkIRect_Reference#SkIRect'>SkIRect</a> (<a href='#SkRegion_op_2_left'>left</a>, <a href='#SkRegion_op_2_top'>top</a>, <a href='#SkRegion_op_2_right'>right</a>, <a href='#SkRegion_op_2_bottom'>bottom</a>). |
| Returns true if replaced <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is not empty. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_op_2_left'><code><strong>left</strong></code></a></td> |
| <td>edge of bounds on x-axis</td> |
| </tr> |
| <tr> <td><a name='SkRegion_op_2_top'><code><strong>top</strong></code></a></td> |
| <td>edge of bounds on y-axis</td> |
| </tr> |
| <tr> <td><a name='SkRegion_op_2_right'><code><strong>right</strong></code></a></td> |
| <td>edge of bounds on x-axis</td> |
| </tr> |
| <tr> <td><a name='SkRegion_op_2_bottom'><code><strong>bottom</strong></code></a></td> |
| <td>edge of bounds on y-axis</td> |
| </tr> |
| <tr> <td><a name='SkRegion_op_2_op'><code><strong>op</strong></code></a></td> |
| <td>operator, one of:</td> |
| </tr> |
| </table> |
| |
| <a href='#SkRegion_kDifference_Op'>kDifference_Op</a>, <a href='#SkRegion_kIntersect_Op'>kIntersect_Op</a>, <a href='#SkRegion_kUnion_Op'>kUnion_Op</a>, <a href='#SkRegion_kXOR_Op'>kXOR_Op</a>, <a href='#SkRegion_kReverseDifference_Op'>kReverseDifference_Op</a>, |
| <a href='#SkRegion_kReplace_Op'>kReplace_Op</a> |
| |
| ### Return Value |
| |
| false if result is empty |
| |
| ### Example |
| |
| <div><fiddle-embed name="2e3497890d523235f96680716c321098"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_setRects'>setRects</a> <a href='#SkRegion_Op'>Op</a> |
| |
| <a name='SkRegion_op_3'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_op'>op</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& rgn, <a href='#SkRegion_Op'>Op</a> op) |
| </pre> |
| |
| Replaces <a href='SkRegion_Reference#SkRegion'>SkRegion</a> with the result of <a href='SkRegion_Reference#SkRegion'>SkRegion</a> <a href='#SkRegion_op_3_op'>op</a> <a href='#SkRegion_op_3_rgn'>rgn</a>. |
| Returns true if replaced <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is not empty. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_op_3_rgn'><code><strong>rgn</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> operand</td> |
| </tr> |
| <tr> <td><a name='SkRegion_op_3_op'><code><strong>op</strong></code></a></td> |
| <td>operator, one of:</td> |
| </tr> |
| </table> |
| |
| <a href='#SkRegion_kDifference_Op'>kDifference_Op</a>, <a href='#SkRegion_kIntersect_Op'>kIntersect_Op</a>, <a href='#SkRegion_kUnion_Op'>kUnion_Op</a>, <a href='#SkRegion_kXOR_Op'>kXOR_Op</a>, <a href='#SkRegion_kReverseDifference_Op'>kReverseDifference_Op</a>, |
| <a href='#SkRegion_kReplace_Op'>kReplace_Op</a> |
| |
| ### Return Value |
| |
| false if result is empty |
| |
| ### Example |
| |
| <div><fiddle-embed name="65f4eccea3514ed7e37b5067e15efddb"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_setRects'>setRects</a> <a href='#SkRegion_Op'>Op</a> |
| |
| <a name='SkRegion_op_4'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_op'>op</a>(const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>, const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& rgn, <a href='#SkRegion_Op'>Op</a> op) |
| </pre> |
| |
| Replaces <a href='SkRegion_Reference#SkRegion'>SkRegion</a> with the result of <a href='#SkRegion_op_4_rect'>rect</a> <a href='#SkRegion_op_4_op'>op</a> <a href='#SkRegion_op_4_rgn'>rgn</a>. |
| Returns true if replaced <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is not empty. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_op_4_rect'><code><strong>rect</strong></code></a></td> |
| <td><a href='SkIRect_Reference#SkIRect'>SkIRect</a> operand</td> |
| </tr> |
| <tr> <td><a name='SkRegion_op_4_rgn'><code><strong>rgn</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> operand</td> |
| </tr> |
| <tr> <td><a name='SkRegion_op_4_op'><code><strong>op</strong></code></a></td> |
| <td>operator, one of:</td> |
| </tr> |
| </table> |
| |
| <a href='#SkRegion_kDifference_Op'>kDifference_Op</a>, <a href='#SkRegion_kIntersect_Op'>kIntersect_Op</a>, <a href='#SkRegion_kUnion_Op'>kUnion_Op</a>, <a href='#SkRegion_kXOR_Op'>kXOR_Op</a>, <a href='#SkRegion_kReverseDifference_Op'>kReverseDifference_Op</a>, |
| <a href='#SkRegion_kReplace_Op'>kReplace_Op</a> |
| |
| ### Return Value |
| |
| false if result is empty |
| |
| ### Example |
| |
| <div><fiddle-embed name="3f964be1e1fd2fbb977b655d3a928f0a"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_setRects'>setRects</a> <a href='#SkRegion_Op'>Op</a> |
| |
| <a name='SkRegion_op_5'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_op'>op</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& rgn, const <a href='SkIRect_Reference#SkIRect'>SkIRect</a>& <a href='SkRect_Reference#Rect'>rect</a>, <a href='#SkRegion_Op'>Op</a> op) |
| </pre> |
| |
| Replaces <a href='SkRegion_Reference#SkRegion'>SkRegion</a> with the result of <a href='#SkRegion_op_5_rgn'>rgn</a> <a href='#SkRegion_op_5_op'>op</a> <a href='#SkRegion_op_5_rect'>rect</a>. |
| Returns true if replaced <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is not empty. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_op_5_rgn'><code><strong>rgn</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> operand</td> |
| </tr> |
| <tr> <td><a name='SkRegion_op_5_rect'><code><strong>rect</strong></code></a></td> |
| <td><a href='SkIRect_Reference#SkIRect'>SkIRect</a> operand</td> |
| </tr> |
| <tr> <td><a name='SkRegion_op_5_op'><code><strong>op</strong></code></a></td> |
| <td>operator, one of:</td> |
| </tr> |
| </table> |
| |
| <a href='#SkRegion_kDifference_Op'>kDifference_Op</a>, <a href='#SkRegion_kIntersect_Op'>kIntersect_Op</a>, <a href='#SkRegion_kUnion_Op'>kUnion_Op</a>, <a href='#SkRegion_kXOR_Op'>kXOR_Op</a>, <a href='#SkRegion_kReverseDifference_Op'>kReverseDifference_Op</a>, |
| <a href='#SkRegion_kReplace_Op'>kReplace_Op</a> |
| |
| ### Return Value |
| |
| false if result is empty |
| |
| ### Example |
| |
| <div><fiddle-embed name="e623208dd44f0b24499ac5f1593d1b39"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_setRects'>setRects</a> <a href='#SkRegion_Op'>Op</a> |
| |
| <a name='SkRegion_op_6'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| bool <a href='#SkRegion_op'>op</a>(const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& rgna, const <a href='SkRegion_Reference#SkRegion'>SkRegion</a>& rgnb, <a href='#SkRegion_Op'>Op</a> op) |
| </pre> |
| |
| Replaces <a href='SkRegion_Reference#SkRegion'>SkRegion</a> with the result of <a href='#SkRegion_op_6_rgna'>rgna</a> <a href='#SkRegion_op_6_op'>op</a> <a href='#SkRegion_op_6_rgnb'>rgnb</a>. |
| Returns true if replaced <a href='SkRegion_Reference#SkRegion'>SkRegion</a> is not empty. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_op_6_rgna'><code><strong>rgna</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> operand</td> |
| </tr> |
| <tr> <td><a name='SkRegion_op_6_rgnb'><code><strong>rgnb</strong></code></a></td> |
| <td><a href='SkRegion_Reference#SkRegion'>SkRegion</a> operand</td> |
| </tr> |
| <tr> <td><a name='SkRegion_op_6_op'><code><strong>op</strong></code></a></td> |
| <td>operator, one of:</td> |
| </tr> |
| </table> |
| |
| <a href='#SkRegion_kDifference_Op'>kDifference_Op</a>, <a href='#SkRegion_kIntersect_Op'>kIntersect_Op</a>, <a href='#SkRegion_kUnion_Op'>kUnion_Op</a>, <a href='#SkRegion_kXOR_Op'>kXOR_Op</a>, <a href='#SkRegion_kReverseDifference_Op'>kReverseDifference_Op</a>, |
| <a href='#SkRegion_kReplace_Op'>kReplace_Op</a> |
| |
| ### Return Value |
| |
| false if result is empty |
| |
| ### Example |
| |
| <div><fiddle-embed name="13de1a6fcb2302a2a30278cb88d3e17d"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_setRects'>setRects</a> <a href='#SkRegion_Op'>Op</a> |
| |
| <a name='SkRegion_writeToMemory'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| size_t <a href='#SkRegion_writeToMemory'>writeToMemory</a>(void* buffer)const |
| </pre> |
| |
| Writes <a href='SkRegion_Reference#SkRegion'>SkRegion</a> to <a href='#SkRegion_writeToMemory_buffer'>buffer</a>, and returns number of bytes written. |
| If <a href='#SkRegion_writeToMemory_buffer'>buffer</a> is nullptr, returns number number of bytes that would be written. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_writeToMemory_buffer'><code><strong>buffer</strong></code></a></td> |
| <td>storage for binary <a href='undocumented#Data'>data</a></td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| <a href='undocumented#Size'>size</a> of <a href='SkRegion_Reference#SkRegion'>SkRegion</a> |
| |
| ### Example |
| |
| <div><fiddle-embed name="1419d2a8c22c355ab46240865d056ee5"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_readFromMemory'>readFromMemory</a> |
| |
| <a name='SkRegion_readFromMemory'></a> |
| |
| --- |
| |
| <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| size_t <a href='#SkRegion_readFromMemory'>readFromMemory</a>(const void* buffer, size_t length) |
| </pre> |
| |
| Constructs <a href='SkRegion_Reference#SkRegion'>SkRegion</a> from <a href='#SkRegion_readFromMemory_buffer'>buffer</a> of <a href='undocumented#Size'>size</a> <a href='#SkRegion_readFromMemory_length'>length</a>. Returns bytes read. |
| Returned value will be multiple of four or zero if <a href='#SkRegion_readFromMemory_length'>length</a> was too small. |
| |
| ### Parameters |
| |
| <table> <tr> <td><a name='SkRegion_readFromMemory_buffer'><code><strong>buffer</strong></code></a></td> |
| <td>storage for binary <a href='undocumented#Data'>data</a></td> |
| </tr> |
| <tr> <td><a name='SkRegion_readFromMemory_length'><code><strong>length</strong></code></a></td> |
| <td><a href='undocumented#Size'>size</a> of <a href='#SkRegion_readFromMemory_buffer'>buffer</a></td> |
| </tr> |
| </table> |
| |
| ### Return Value |
| |
| bytes read |
| |
| ### Example |
| |
| <div><fiddle-embed name="@Region_readFromMemory"></fiddle-embed></div> |
| |
| ### See Also |
| |
| <a href='#SkRegion_writeToMemory'>writeToMemory</a> |
| |
