2011-07-28 14:26:00 +00:00
|
|
|
|
2008-12-17 15:59:43 +00:00
|
|
|
/*
|
2011-07-28 14:26:00 +00:00
|
|
|
* Copyright 2007 The Android Open Source Project
|
2008-12-17 15:59:43 +00:00
|
|
|
*
|
2011-07-28 14:26:00 +00:00
|
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
|
|
* found in the LICENSE file.
|
2008-12-17 15:59:43 +00:00
|
|
|
*/
|
|
|
|
|
2011-07-28 14:26:00 +00:00
|
|
|
|
2008-12-17 15:59:43 +00:00
|
|
|
#ifndef SkPicture_DEFINED
|
|
|
|
#define SkPicture_DEFINED
|
|
|
|
|
|
|
|
#include "SkRefCnt.h"
|
|
|
|
|
|
|
|
class SkCanvas;
|
|
|
|
class SkPicturePlayback;
|
|
|
|
class SkPictureRecord;
|
|
|
|
class SkStream;
|
|
|
|
class SkWStream;
|
|
|
|
|
|
|
|
/** \class SkPicture
|
|
|
|
|
|
|
|
The SkPicture class records the drawing commands made to a canvas, to
|
|
|
|
be played back at a later time.
|
|
|
|
*/
|
2011-04-25 20:02:38 +00:00
|
|
|
class SK_API SkPicture : public SkRefCnt {
|
2008-12-17 15:59:43 +00:00
|
|
|
public:
|
|
|
|
/** The constructor prepares the picture to record.
|
|
|
|
@param width the width of the virtual device the picture records.
|
|
|
|
@param height the height of the virtual device the picture records.
|
|
|
|
*/
|
|
|
|
SkPicture();
|
|
|
|
/** Make a copy of the contents of src. If src records more drawing after
|
|
|
|
this call, those elements will not appear in this picture.
|
|
|
|
*/
|
|
|
|
SkPicture(const SkPicture& src);
|
|
|
|
explicit SkPicture(SkStream*);
|
|
|
|
virtual ~SkPicture();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Swap the contents of the two pictures. Guaranteed to succeed.
|
|
|
|
*/
|
|
|
|
void swap(SkPicture& other);
|
|
|
|
|
2009-02-13 14:56:09 +00:00
|
|
|
enum RecordingFlags {
|
|
|
|
/* This flag specifies that when clipPath() is called, the path will
|
|
|
|
be faithfully recorded, but the recording canvas' current clip will
|
|
|
|
only see the path's bounds. This speeds up the recording process
|
|
|
|
without compromising the fidelity of the playback. The only side-
|
|
|
|
effect for recording is that calling getTotalClip() or related
|
|
|
|
clip-query calls will reflect the path's bounds, not the actual
|
|
|
|
path.
|
|
|
|
*/
|
|
|
|
kUsePathBoundsForClip_RecordingFlag = 0x01
|
|
|
|
};
|
|
|
|
|
2008-12-17 15:59:43 +00:00
|
|
|
/** Returns the canvas that records the drawing commands.
|
2009-02-13 14:56:09 +00:00
|
|
|
@param width the base width for the picture, as if the recording
|
|
|
|
canvas' bitmap had this width.
|
|
|
|
@param height the base width for the picture, as if the recording
|
|
|
|
canvas' bitmap had this height.
|
|
|
|
@param recordFlags optional flags that control recording.
|
2008-12-17 15:59:43 +00:00
|
|
|
@return the picture canvas.
|
|
|
|
*/
|
2009-02-13 14:56:09 +00:00
|
|
|
SkCanvas* beginRecording(int width, int height, uint32_t recordFlags = 0);
|
|
|
|
|
2008-12-17 15:59:43 +00:00
|
|
|
/** Returns the recording canvas if one is active, or NULL if recording is
|
|
|
|
not active. This does not alter the refcnt on the canvas (if present).
|
|
|
|
*/
|
|
|
|
SkCanvas* getRecordingCanvas() const;
|
|
|
|
/** Signal that the caller is done recording. This invalidates the canvas
|
|
|
|
returned by beginRecording/getRecordingCanvas, and prepares the picture
|
|
|
|
for drawing. Note: this happens implicitly the first time the picture
|
|
|
|
is drawn.
|
|
|
|
*/
|
|
|
|
void endRecording();
|
|
|
|
|
|
|
|
/** Replays the drawing commands on the specified canvas. This internally
|
|
|
|
calls endRecording() if that has not already been called.
|
|
|
|
@param surface the canvas receiving the drawing commands.
|
|
|
|
*/
|
|
|
|
void draw(SkCanvas* surface);
|
|
|
|
|
|
|
|
/** Return the width of the picture's recording canvas. This
|
|
|
|
value reflects what was passed to setSize(), and does not necessarily
|
|
|
|
reflect the bounds of what has been recorded into the picture.
|
|
|
|
@return the width of the picture's recording canvas
|
|
|
|
*/
|
|
|
|
int width() const { return fWidth; }
|
|
|
|
|
|
|
|
/** Return the height of the picture's recording canvas. This
|
|
|
|
value reflects what was passed to setSize(), and does not necessarily
|
|
|
|
reflect the bounds of what has been recorded into the picture.
|
|
|
|
@return the height of the picture's recording canvas
|
|
|
|
*/
|
|
|
|
int height() const { return fHeight; }
|
|
|
|
|
|
|
|
void serialize(SkWStream*) const;
|
|
|
|
|
|
|
|
/** Signals that the caller is prematurely done replaying the drawing
|
|
|
|
commands. This can be called from a canvas virtual while the picture
|
|
|
|
is drawing. Has no effect if the picture is not drawing.
|
|
|
|
*/
|
|
|
|
void abortPlayback();
|
|
|
|
|
|
|
|
private:
|
|
|
|
int fWidth, fHeight;
|
|
|
|
SkPictureRecord* fRecord;
|
|
|
|
SkPicturePlayback* fPlayback;
|
|
|
|
|
|
|
|
friend class SkFlatPicture;
|
|
|
|
friend class SkPicturePlayback;
|
|
|
|
};
|
|
|
|
|
|
|
|
class SkAutoPictureRecord : SkNoncopyable {
|
|
|
|
public:
|
2009-02-13 14:56:09 +00:00
|
|
|
SkAutoPictureRecord(SkPicture* pict, int width, int height,
|
|
|
|
uint32_t recordingFlags = 0) {
|
2008-12-17 15:59:43 +00:00
|
|
|
fPicture = pict;
|
2009-02-13 14:56:09 +00:00
|
|
|
fCanvas = pict->beginRecording(width, height, recordingFlags);
|
2008-12-17 15:59:43 +00:00
|
|
|
}
|
|
|
|
~SkAutoPictureRecord() {
|
|
|
|
fPicture->endRecording();
|
|
|
|
}
|
|
|
|
|
|
|
|
/** Return the canvas to draw into for recording into the picture.
|
|
|
|
*/
|
|
|
|
SkCanvas* getRecordingCanvas() const { return fCanvas; }
|
|
|
|
|
|
|
|
private:
|
|
|
|
SkPicture* fPicture;
|
|
|
|
SkCanvas* fCanvas;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
#endif
|