update dox

BUG=skia:
TBR=djsollen@google.com

Review URL: https://codereview.chromium.org/697363004
This commit is contained in:
reed 2014-11-11 07:54:10 -08:00 committed by Commit bot
parent 43b46d1f56
commit 79c77a405a

View File

@ -14,9 +14,11 @@ class SkCanvas;
struct SkRect; struct SkRect;
/** /**
* Base-class to capture a set of drawing commands (sent to SkCanvas). Instances of this class * Base-class for objects that draw into SkCanvas.
* need not be thread-safe, but they must be able to be used in a thread different from where *
* they were created. * The object has a generation ID, which is guaranteed to be unique across all drawables. To
* allow for clients of the drawable that may want to cache the results, the drawable must
* change its generation ID whenever its internal state changes such that it will draw differently.
*/ */
class SkCanvasDrawable : public SkRefCnt { class SkCanvasDrawable : public SkRefCnt {
public: public:
@ -45,6 +47,11 @@ public:
*/ */
bool getBounds(SkRect*); bool getBounds(SkRect*);
/**
* Calling this invalidates the previous generation ID, and causes a new one to be computed
* the next time getGenerationID() is called. Typically this is called by the object itself,
* in response to its internal state changing.
*/
void notifyDrawingChanged(); void notifyDrawingChanged();
protected: protected: