72c9faab45
This fixes every case where virtual and SK_OVERRIDE were on the same line, which should be the bulk of cases. We'll have to manually clean up the rest over time unless I level up in regexes. for f in (find . -type f); perl -p -i -e 's/virtual (.*)SK_OVERRIDE/\1SK_OVERRIDE/g' $f; end BUG=skia: Review URL: https://codereview.chromium.org/806653007
263 lines
10 KiB
C++
263 lines
10 KiB
C++
/*
|
|
* Copyright 2012 Google Inc.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
* found in the LICENSE file.
|
|
*/
|
|
|
|
#ifndef SkDeferredCanvas_DEFINED
|
|
#define SkDeferredCanvas_DEFINED
|
|
|
|
#include "SkCanvas.h"
|
|
#include "SkPixelRef.h"
|
|
|
|
class SkDeferredDevice;
|
|
class SkImage;
|
|
class SkSurface;
|
|
|
|
/** \class SkDeferredCanvas
|
|
Subclass of SkCanvas that encapsulates an SkPicture or SkGPipe for deferred
|
|
drawing. The main difference between this class and SkPictureRecord (the
|
|
canvas provided by SkPicture) is that this is a full drop-in replacement
|
|
for SkCanvas, while SkPictureRecord only supports draw operations.
|
|
SkDeferredCanvas will transparently trigger the flushing of deferred
|
|
draw operations when an attempt is made to access the pixel data.
|
|
*/
|
|
class SK_API SkDeferredCanvas : public SkCanvas {
|
|
public:
|
|
class SK_API NotificationClient;
|
|
|
|
/** Construct a canvas with the specified surface to draw into.
|
|
This factory must be used for newImageSnapshot to work.
|
|
@param surface Specifies a surface for the canvas to draw into.
|
|
*/
|
|
static SkDeferredCanvas* Create(SkSurface* surface);
|
|
|
|
// static SkDeferredCanvas* Create(SkBaseDevice* device);
|
|
|
|
virtual ~SkDeferredCanvas();
|
|
|
|
/**
|
|
* Specify the surface to be used by this canvas. Calling setSurface will
|
|
* release the previously set surface or device. Takes a reference on the
|
|
* surface.
|
|
*
|
|
* @param surface The surface that the canvas will raw into
|
|
* @return The surface argument, for convenience.
|
|
*/
|
|
SkSurface* setSurface(SkSurface* surface);
|
|
|
|
/**
|
|
* Specify a NotificationClient to be used by this canvas. Calling
|
|
* setNotificationClient will release the previously set
|
|
* NotificationClient, if any. SkDeferredCanvas does not take ownership
|
|
* of the notification client. Therefore user code is resposible
|
|
* for its destruction. The notification client must be unregistered
|
|
* by calling setNotificationClient(NULL) if it is destroyed before
|
|
* this canvas.
|
|
* Note: Must be called after the device is set with setDevice.
|
|
*
|
|
* @param notificationClient interface for dispatching notifications
|
|
* @return The notificationClient argument, for convenience.
|
|
*/
|
|
NotificationClient* setNotificationClient(NotificationClient* notificationClient);
|
|
|
|
/**
|
|
* Enable or disable deferred drawing. When deferral is disabled,
|
|
* pending draw operations are immediately flushed and from then on,
|
|
* the SkDeferredCanvas behaves just like a regular SkCanvas.
|
|
* This method must not be called while the save/restore stack is in use.
|
|
* @param deferred true/false
|
|
*/
|
|
void setDeferredDrawing(bool deferred);
|
|
|
|
/**
|
|
* Returns true if deferred drawing is currenlty enabled.
|
|
*/
|
|
bool isDeferredDrawing() const;
|
|
|
|
/**
|
|
* Returns true if the canvas contains a fresh frame. A frame is
|
|
* considered fresh when its content do not depend on the contents
|
|
* of the previous frame. For example, if a canvas is cleared before
|
|
* drawing each frame, the frames will all be considered fresh.
|
|
* A frame is defined as the graphics image produced by as a result
|
|
* of all the canvas draws operation executed between two successive
|
|
* calls to isFreshFrame. The result of isFreshFrame is computed
|
|
* conservatively, so it may report false negatives.
|
|
*/
|
|
bool isFreshFrame() const;
|
|
|
|
/**
|
|
* Returns canvas's size.
|
|
*/
|
|
SkISize getCanvasSize() const;
|
|
|
|
/**
|
|
* Returns true if the canvas has recorded draw commands that have
|
|
* not yet been played back.
|
|
*/
|
|
bool hasPendingCommands() const;
|
|
|
|
/**
|
|
* Flushes pending draw commands, if any, and returns an image of the
|
|
* current state of the surface pixels up to this point. Subsequent
|
|
* changes to the surface (by drawing into its canvas) will not be
|
|
* reflected in this image. Will return NULL if the deferred canvas
|
|
* was not constructed from an SkSurface.
|
|
*/
|
|
SkImage* newImageSnapshot();
|
|
|
|
/**
|
|
* Specify the maximum number of bytes to be allocated for the purpose
|
|
* of recording draw commands to this canvas. The default limit, is
|
|
* 64MB.
|
|
* @param maxStorage The maximum number of bytes to be allocated.
|
|
*/
|
|
void setMaxRecordingStorage(size_t maxStorage);
|
|
|
|
/**
|
|
* Returns the number of bytes currently allocated for the purpose of
|
|
* recording draw commands.
|
|
*/
|
|
size_t storageAllocatedForRecording() const;
|
|
|
|
/**
|
|
* Attempt to reduce the storage allocated for recording by evicting
|
|
* cache resources.
|
|
* @param bytesToFree minimum number of bytes that should be attempted to
|
|
* be freed.
|
|
* @return number of bytes actually freed.
|
|
*/
|
|
size_t freeMemoryIfPossible(size_t bytesToFree);
|
|
|
|
/**
|
|
* Specifies the maximum size (in bytes) allowed for a given image to be
|
|
* rendered using the deferred canvas.
|
|
*/
|
|
void setBitmapSizeThreshold(size_t sizeThreshold);
|
|
size_t getBitmapSizeThreshold() const { return fBitmapSizeThreshold; }
|
|
|
|
/**
|
|
* Executes all pending commands without drawing
|
|
*/
|
|
void silentFlush();
|
|
|
|
SkDrawFilter* setDrawFilter(SkDrawFilter* filter) SK_OVERRIDE;
|
|
|
|
protected:
|
|
void willSave() SK_OVERRIDE;
|
|
SaveLayerStrategy willSaveLayer(const SkRect*, const SkPaint*, SaveFlags) SK_OVERRIDE;
|
|
void willRestore() SK_OVERRIDE;
|
|
|
|
void didConcat(const SkMatrix&) SK_OVERRIDE;
|
|
void didSetMatrix(const SkMatrix&) SK_OVERRIDE;
|
|
|
|
void onDrawDRRect(const SkRRect&, const SkRRect&, const SkPaint&) SK_OVERRIDE;
|
|
virtual void onDrawText(const void* text, size_t byteLength, SkScalar x, SkScalar y,
|
|
const SkPaint&) SK_OVERRIDE;
|
|
virtual void onDrawPosText(const void* text, size_t byteLength, const SkPoint pos[],
|
|
const SkPaint&) SK_OVERRIDE;
|
|
virtual void onDrawPosTextH(const void* text, size_t byteLength, const SkScalar xpos[],
|
|
SkScalar constY, const SkPaint&) SK_OVERRIDE;
|
|
virtual void onDrawTextOnPath(const void* text, size_t byteLength, const SkPath& path,
|
|
const SkMatrix* matrix, const SkPaint&) SK_OVERRIDE;
|
|
virtual void onDrawTextBlob(const SkTextBlob* blob, SkScalar x, SkScalar y,
|
|
const SkPaint& paint) SK_OVERRIDE;
|
|
virtual void onDrawPatch(const SkPoint cubics[12], const SkColor colors[4],
|
|
const SkPoint texCoords[4], SkXfermode* xmode,
|
|
const SkPaint& paint) SK_OVERRIDE;
|
|
|
|
void onDrawPaint(const SkPaint&) SK_OVERRIDE;
|
|
void onDrawPoints(PointMode, size_t count, const SkPoint pts[], const SkPaint&) SK_OVERRIDE;
|
|
void onDrawRect(const SkRect&, const SkPaint&) SK_OVERRIDE;
|
|
void onDrawOval(const SkRect&, const SkPaint&) SK_OVERRIDE;
|
|
void onDrawRRect(const SkRRect&, const SkPaint&) SK_OVERRIDE;
|
|
void onDrawPath(const SkPath&, const SkPaint&) SK_OVERRIDE;
|
|
void onDrawBitmap(const SkBitmap&, SkScalar left, SkScalar top, const SkPaint*) SK_OVERRIDE;
|
|
void onDrawBitmapRect(const SkBitmap&, const SkRect* src, const SkRect& dst, const SkPaint*,
|
|
DrawBitmapRectFlags flags) SK_OVERRIDE;
|
|
#if 0
|
|
// rely on conversion to bitmap(for now)
|
|
void onDrawImage(const SkImage*, SkScalar left, SkScalar top, const SkPaint*) SK_OVERRIDE;
|
|
void onDrawImageRect(const SkImage*, const SkRect* src, const SkRect& dst,
|
|
const SkPaint*) SK_OVERRIDE;
|
|
#endif
|
|
void onDrawBitmapNine(const SkBitmap&, const SkIRect& center, const SkRect& dst,
|
|
const SkPaint*) SK_OVERRIDE;
|
|
void onDrawSprite(const SkBitmap&, int left, int top, const SkPaint*) SK_OVERRIDE;
|
|
void onDrawVertices(VertexMode vmode, int vertexCount,
|
|
const SkPoint vertices[], const SkPoint texs[],
|
|
const SkColor colors[], SkXfermode* xmode,
|
|
const uint16_t indices[], int indexCount,
|
|
const SkPaint&) SK_OVERRIDE;
|
|
|
|
void onClipRect(const SkRect&, SkRegion::Op, ClipEdgeStyle) SK_OVERRIDE;
|
|
void onClipRRect(const SkRRect&, SkRegion::Op, ClipEdgeStyle) SK_OVERRIDE;
|
|
void onClipPath(const SkPath&, SkRegion::Op, ClipEdgeStyle) SK_OVERRIDE;
|
|
void onClipRegion(const SkRegion&, SkRegion::Op) SK_OVERRIDE;
|
|
|
|
void onDrawPicture(const SkPicture*, const SkMatrix*, const SkPaint*) SK_OVERRIDE;
|
|
|
|
public:
|
|
class NotificationClient {
|
|
public:
|
|
virtual ~NotificationClient() {}
|
|
|
|
/**
|
|
* Called before executing one or several draw commands, which means
|
|
* once per flush when deferred rendering is enabled.
|
|
*/
|
|
virtual void prepareForDraw() {}
|
|
|
|
/**
|
|
* Called after a recording a draw command if additional memory
|
|
* had to be allocated for recording.
|
|
* @param newAllocatedStorage same value as would be returned by
|
|
* storageAllocatedForRecording(), for convenience.
|
|
*/
|
|
virtual void storageAllocatedForRecordingChanged(size_t /*newAllocatedStorage*/) {}
|
|
|
|
/**
|
|
* Called after pending draw commands have been flushed
|
|
*/
|
|
virtual void flushedDrawCommands() {}
|
|
|
|
/**
|
|
* Called after pending draw commands have been skipped, meaning
|
|
* that they were optimized-out because the canvas is cleared
|
|
* or completely overwritten by the command currently being recorded.
|
|
*/
|
|
virtual void skippedPendingDrawCommands() {}
|
|
};
|
|
|
|
protected:
|
|
SkCanvas* canvasForDrawIter() SK_OVERRIDE;
|
|
SkDeferredDevice* getDeferredDevice() const;
|
|
|
|
private:
|
|
SkDeferredCanvas(SkDeferredDevice*);
|
|
|
|
void recordedDrawCommand();
|
|
SkCanvas* drawingCanvas() const;
|
|
SkCanvas* immediateCanvas() const;
|
|
bool isFullFrame(const SkRect*, const SkPaint*) const;
|
|
void validate() const;
|
|
void init();
|
|
|
|
|
|
int fSaveLevel;
|
|
int fFirstSaveLayerIndex;
|
|
size_t fBitmapSizeThreshold;
|
|
bool fDeferredDrawing;
|
|
|
|
mutable SkISize fCachedCanvasSize;
|
|
mutable bool fCachedCanvasSizeDirty;
|
|
|
|
friend class SkDeferredCanvasTester; // for unit testing
|
|
typedef SkCanvas INHERITED;
|
|
};
|
|
|
|
|
|
#endif
|