Update comment for SkMallocPixelRef::NewWithProc.

Add a comment about using a NULL ReleaseProc.

BUG=skia:2185

Review URL: https://codereview.chromium.org/885573005

1 files changed, 5 insertions, 0 deletions

diff --git a/include/core/SkMallocPixelRef.h b/include/core/SkMallocPixelRef.h
index 259692da64..4cb187597e 100644
--- a/include/core/SkMallocPixelRef.h
+++ b/include/core/SkMallocPixelRef.h
@@ -50,6 +50,11 @@ public:
      *
      *  This pixelref will ref() the specified colortable (if not NULL).
      *
+     *  If ReleaseProc is NULL, the pixels will never be released. This
+     *  can be useful if the pixels were stack allocated. However, such an
+     *  SkMallocPixelRef must not live beyond its pixels (e.g. by copying
+     *  an SkBitmap pointing to it, or drawing to an SkPicture).
+     *
      *  Returns NULL on failure.
      */
     typedef void (*ReleaseProc)(void* addr, void* context);