186d08f621
- More rigorous symbol identification creates additional links, and finds spurious errors like unnecessary parentheses. - Fixed code to allow preprocessor directives in #Code blocks (still more to do). - Fixed examples waiting on fiddle updates. - Make SkImageInfo officially documented (update in status.json). - Fixed enum indentation. Docs-Preview: https://skia.org/?cl=115656 Bug: skia:6898 Change-Id: Ifcf5cfd3f6c03b3b83155c898b2b035a2f3d443c Reviewed-on: https://skia-review.googlesource.com/115656 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
117 lines
3.9 KiB
Markdown
117 lines
3.9 KiB
Markdown
SkAutoCanvasRestore Reference
|
|
===
|
|
|
|
# <a name="Automatic_Canvas_Restore"></a> Automatic Canvas Restore
|
|
|
|
## <a name="Overview"></a> Overview
|
|
|
|
## <a name="Overview_Subtopic"></a> Overview Subtopic
|
|
|
|
| name | description |
|
|
| --- | --- |
|
|
| <a href="#Constructor">Constructor</a> | functions that construct <a href="#SkAutoCanvasRestore">SkAutoCanvasRestore</a> |
|
|
| <a href="#Member_Function">Member Function</a> | static functions and member methods |
|
|
|
|
# <a name="SkAutoCanvasRestore"></a> Class SkAutoCanvasRestore
|
|
Stack helper class calls <a href="SkCanvas_Reference#SkCanvas_restoreToCount">SkCanvas::restoreToCount</a> when <a href="#SkAutoCanvasRestore">SkAutoCanvasRestore</a>
|
|
goes out of scope. Use this to guarantee that the canvas is restored to a known
|
|
state.
|
|
|
|
## <a name="Constructor"></a> Constructor
|
|
|
|
| name | description |
|
|
| --- | --- |
|
|
| <a href="#SkAutoCanvasRestore_SkCanvas_star">SkAutoCanvasRestore(SkCanvas* canvas, bool doSave)</a> | preserves <a href="SkCanvas_Reference#Canvas">Canvas</a> save count |
|
|
| <a href="#SkAutoCanvasRestore_destructor">~SkAutoCanvasRestore()</a> | restores <a href="SkCanvas_Reference#Canvas">Canvas</a> to saved state |
|
|
|
|
## <a name="Member_Function"></a> Member Function
|
|
|
|
| name | description |
|
|
| --- | --- |
|
|
| <a href="#SkAutoCanvasRestore_restore">restore</a> | restores <a href="SkCanvas_Reference#Canvas">Canvas</a> to saved state |
|
|
|
|
<a name="SkAutoCanvasRestore_SkCanvas_star"></a>
|
|
## SkAutoCanvasRestore
|
|
|
|
<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0">
|
|
SkAutoCanvasRestore(SkCanvas* canvas, bool doSave)
|
|
</pre>
|
|
|
|
Preserves <a href="SkCanvas_Reference#Canvas">Canvas</a> save count. Optionally saves <a href="SkCanvas_Reference#Clip">Canvas Clip</a> and <a href="SkCanvas_Reference#Matrix">Canvas Matrix</a>.
|
|
|
|
### Parameters
|
|
|
|
<table> <tr> <td><a name="SkAutoCanvasRestore_SkCanvas_star_canvas"> <code><strong>canvas </strong></code> </a></td> <td>
|
|
<a href="SkCanvas_Reference#Canvas">Canvas</a> to guard</td>
|
|
</tr> <tr> <td><a name="SkAutoCanvasRestore_SkCanvas_star_doSave"> <code><strong>doSave </strong></code> </a></td> <td>
|
|
call <a href="SkCanvas_Reference#SkCanvas_save">SkCanvas::save()</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
### Return Value
|
|
|
|
utility to restore <a href="SkCanvas_Reference#Canvas">Canvas</a> state on destructor
|
|
|
|
### Example
|
|
|
|
<div><fiddle-embed name="466ef576b88e29d7252422db7adeed1c"></fiddle-embed></div>
|
|
|
|
### See Also
|
|
|
|
<a href="SkCanvas_Reference#SkCanvas_save">SkCanvas::save</a> <a href="SkCanvas_Reference#SkCanvas_restore">SkCanvas::restore</a>
|
|
|
|
---
|
|
|
|
<a name="SkAutoCanvasRestore_destructor"></a>
|
|
## ~SkAutoCanvasRestore
|
|
|
|
<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0">
|
|
~SkAutoCanvasRestore()
|
|
</pre>
|
|
|
|
Restores <a href="SkCanvas_Reference#Canvas">Canvas</a> to saved state. Destructor is called when container goes out of
|
|
scope.
|
|
|
|
### See Also
|
|
|
|
<a href="SkCanvas_Reference#SkCanvas_save">SkCanvas::save</a> <a href="SkCanvas_Reference#SkCanvas_restore">SkCanvas::restore</a>
|
|
|
|
---
|
|
|
|
<a name="SkAutoCanvasRestore_restore"></a>
|
|
## restore
|
|
|
|
<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0">
|
|
void restore()
|
|
</pre>
|
|
|
|
Restores <a href="SkCanvas_Reference#Canvas">Canvas</a> to saved state immediately. Subsequent calls and
|
|
<a href="#SkAutoCanvasRestore_destructor">~SkAutoCanvasRestore</a> have no effect.
|
|
|
|
### Example
|
|
|
|
<div><fiddle-embed name="9f459b218ec079c1ada23f4412968f9a">
|
|
|
|
#### Example Output
|
|
|
|
~~~~
|
|
saveCanvas: false before restore: 2
|
|
saveCanvas: false after restore: 2
|
|
saveCanvas: true before restore: 2
|
|
saveCanvas: true after restore: 2
|
|
saveCanvas: false before restore: 2
|
|
saveCanvas: false after restore: 1
|
|
saveCanvas: true before restore: 2
|
|
saveCanvas: true after restore: 1
|
|
final count: 1
|
|
~~~~
|
|
|
|
</fiddle-embed></div>
|
|
|
|
### See Also
|
|
|
|
<a href="SkCanvas_Reference#SkCanvas_save">SkCanvas::save</a> <a href="SkCanvas_Reference#SkCanvas_restore">SkCanvas::restore</a>
|
|
|
|
---
|
|
|