aboutsummaryrefslogtreecommitdiffhomepage
path: root/include
diff options
context:
space:
mode:
authorGravatar Mike Reed <reed@google.com>2017-03-24 12:54:41 -0400
committerGravatar Skia Commit-Bot <skia-commit-bot@chromium.org>2017-03-24 17:34:55 +0000
commitec715e827a75b839e5ff554bea57d4be42354e18 (patch)
tree2ce5ac6415865103c9869a444718103be936509e /include
parentf4d443fd1bd8cffbcd7a07a48f3488ae871414e9 (diff)
quick-fix to surface dox
BUG=skia: Change-Id: I63cab1d5467fa908358a46199dc44cfe53c20f4f Reviewed-on: https://skia-review.googlesource.com/10115 Commit-Queue: Mike Reed <reed@google.com> Commit-Queue: Mike Klein <mtklein@chromium.org> Reviewed-by: Mike Klein <mtklein@chromium.org>
Diffstat (limited to 'include')
-rw-r--r--include/core/SkSurface.h9
1 files changed, 4 insertions, 5 deletions
diff --git a/include/core/SkSurface.h b/include/core/SkSurface.h
index 52c0e5841a..0e2239a4ad 100644
--- a/include/core/SkSurface.h
+++ b/include/core/SkSurface.h
@@ -18,12 +18,11 @@ class GrContext;
class GrRenderTarget;
/**
- * SkSurface represents the backend/results of drawing to a canvas. For raster
- * drawing, the surface will be pixels, but (for example) when drawing into
- * a PDF or Picture canvas, the surface stores the recorded commands.
+ * SkSurface is responsible for managing the pixels that a canvas draws into. The pixels can be
+ * allocated either in CPU memory (a Raster surface) or on the GPU (a RenderTarget surface).
*
- * To draw into a canvas, first create the appropriate type of Surface, and
- * then request the canvas from the surface.
+ * SkSurface takes care of allocating a SkCanvas that will draw into the surface. Call
+ * surface->getCanvas() to use that canvas (but don't delete it, it is owned by the surface).
*
* SkSurface always has non-zero dimensions. If there is a request for a new surface, and either
* of the requested dimensions are zero, then NULL will be returned.