#include <SkPictureRecorder.h>

Public Member Functions
	SkPictureRecorder ()

	~SkPictureRecorder ()

SkCanvas *	beginRecording (const SkRect &bounds, sk_sp< SkBBoxHierarchy > bbh)

SkCanvas *	beginRecording (const SkRect &bounds, SkBBHFactory *bbhFactory=nullptr)

SkCanvas *	beginRecording (SkScalar width, SkScalar height, SkBBHFactory *bbhFactory=nullptr)

SkCanvas *	getRecordingCanvas ()

sk_sp< SkPicture >	finishRecordingAsPicture ()

sk_sp< SkPicture >	finishRecordingAsPictureWithCull (const SkRect &cullRect)

sk_sp< SkDrawable >	finishRecordingAsDrawable ()

Friends
class	SkPictureRecorderReplayTester

Detailed Description

Definition at line 32 of file SkPictureRecorder.h.

Constructor & Destructor Documentation

◆ SkPictureRecorder()

SkPictureRecorder::SkPictureRecorder ( )

Definition at line 28 of file SkPictureRecorder.cpp.

                                     {
    fActivelyRecording = false;
    fRecorder = std::make_unique<SkRecorder>(nullptr, SkRect::MakeEmpty());
}

◆ ~SkPictureRecorder()

SkPictureRecorder::~SkPictureRecorder ( )

Definition at line 33 of file SkPictureRecorder.cpp.

33{}

Member Function Documentation

◆ beginRecording() [1/3]

SkCanvas * SkPictureRecorder::beginRecording	(	const SkRect &	bounds,
		sk_sp< SkBBoxHierarchy >	bbh
	)

Returns the canvas that records the drawing commands.

Parameters

bounds	the cull rect used when recording this picture. Any drawing the falls outside of this rect is undefined, and may be drawn or it may not.
bbh	optional acceleration structure
recordFlags	optional flags that control recording.

Returns: the canvas.

Definition at line 35 of file SkPictureRecorder.cpp.

                                                                        {
    const SkRect cullRect = userCullRect.isEmpty() ? SkRect::MakeEmpty() : userCullRect;
 
    fCullRect = cullRect;
    fBBH = std::move(bbh);
 
    if (!fRecord) {
        fRecord.reset(new SkRecord);
    }
    fRecorder->reset(fRecord.get(), cullRect);
    fActivelyRecording = true;
    return this->getRecordingCanvas();
}

◆ beginRecording() [2/3]

SkCanvas * SkPictureRecorder::beginRecording	(	const SkRect &	bounds,
		SkBBHFactory *	bbhFactory = `nullptr`
	)

Definition at line 50 of file SkPictureRecorder.cpp.

                                                                                       {
    return this->beginRecording(bounds, factory ? (*factory)() : nullptr);
}

◆ beginRecording() [3/3]

SkCanvas * SkPictureRecorder::beginRecording	(	SkScalar	width,
		SkScalar	height,
		SkBBHFactory *	bbhFactory = `nullptr`
	)

inline

Definition at line 48 of file SkPictureRecorder.h.

                                                                 {
        return this->beginRecording(SkRect::MakeWH(width, height), bbhFactory);
    }

◆ finishRecordingAsDrawable()

sk_sp< SkDrawable > SkPictureRecorder::finishRecordingAsDrawable ( )

Signal that the caller is done recording. This invalidates the canvas returned by beginRecording/getRecordingCanvas. Ownership of the object is passed to the caller, who must call unref() when they are done using it.

Unlike finishRecordingAsPicture(), which returns an immutable picture, the returned drawable may contain live references to other drawables (if they were added to the recording canvas) and therefore this drawable will reflect the current state of those nested drawables anytime it is drawn or a new picture is snapped from it (by calling drawable->makePictureSnapshot()).

Definition at line 132 of file SkPictureRecorder.cpp.

                                                               {
    fActivelyRecording = false;
    fRecorder->restoreToCount(1);  // If we were missing any restores, add them now.
 
    SkRecordOptimize(fRecord.get());
 
    if (fBBH) {
        AutoTArray<SkRect> bounds(fRecord->count());
        AutoTMalloc<SkBBoxHierarchy::Metadata> meta(fRecord->count());
        SkRecordFillBounds(fCullRect, *fRecord, bounds.data(), meta);
        fBBH->insert(bounds.data(), meta, fRecord->count());
    }
 
    sk_sp<SkDrawable> drawable =
         sk_make_sp<SkRecordedDrawable>(std::move(fRecord), std::move(fBBH),
                                        fRecorder->detachDrawableList(), fCullRect);
 
    return drawable;
}

◆ finishRecordingAsPicture()

sk_sp< SkPicture > SkPictureRecorder::finishRecordingAsPicture ( )

Signal that the caller is done recording. This invalidates the canvas returned by beginRecording/getRecordingCanvas. Ownership of the object is passed to the caller, who must call unref() when they are done using it.

The returned picture is immutable. If during recording drawables were added to the canvas, these will have been "drawn" into a recording canvas, so that this resulting picture will reflect their current state, but will not contain a live reference to the drawables themselves.

Definition at line 67 of file SkPictureRecorder.cpp.

                                                             {
    fActivelyRecording = false;
    fRecorder->restoreToCount(1);  // If we were missing any restores, add them now.
 
    if (fRecord->count() == 0) {
        return sk_make_sp<SkEmptyPicture>();
    }
 
    // TODO: delay as much of this work until just before first playback?
    SkRecordOptimize(fRecord.get());
 
    SkDrawableList* drawableList = fRecorder->getDrawableList();
    std::unique_ptr<SkBigPicture::SnapshotArray> pictList{
        drawableList ? drawableList->newDrawableSnapshot() : nullptr
    };
 
    if (fBBH) {
        AutoTArray<SkRect> bounds(fRecord->count());
        AutoTMalloc<SkBBoxHierarchy::Metadata> meta(fRecord->count());
        SkRecordFillBounds(fCullRect, *fRecord, bounds.data(), meta);
 
        fBBH->insert(bounds.data(), meta, fRecord->count());
 
        // Now that we've calculated content bounds, we can update fCullRect, often trimming it.
        SkRect bbhBound = SkRect::MakeEmpty();
        for (int i = 0; i < fRecord->count(); i++) {
            bbhBound.join(bounds[i]);
        }
        SkASSERT((bbhBound.isEmpty() || fCullRect.contains(bbhBound))
              || (bbhBound.isEmpty() && fCullRect.isEmpty()));
        fCullRect = bbhBound;
    }
 
    size_t subPictureBytes = fRecorder->approxBytesUsedBySubPictures();
    for (int i = 0; pictList && i < pictList->count(); i++) {
        subPictureBytes += pictList->begin()[i]->approximateBytesUsed();
    }
    return sk_make_sp<SkBigPicture>(fCullRect,
                                    std::move(fRecord),
                                    std::move(pictList),
                                    std::move(fBBH),
                                    subPictureBytes);
}

◆ finishRecordingAsPictureWithCull()

sk_sp< SkPicture > SkPictureRecorder::finishRecordingAsPictureWithCull ( const SkRect & cullRect )

Signal that the caller is done recording, and update the cull rect to use for bounding box hierarchy (BBH) generation. The behavior is the same as calling finishRecordingAsPicture(), except that this method updates the cull rect initially passed into beginRecording.

Parameters

cullRect the new culling rectangle to use as the overall bound for BBH generation and subsequent culling operations.

Returns: the picture containing the recorded content.

Definition at line 111 of file SkPictureRecorder.cpp.

                                                                                           {
    fCullRect = cullRect;
    return this->finishRecordingAsPicture();
}

◆ getRecordingCanvas()

SkCanvas * SkPictureRecorder::getRecordingCanvas ( )

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).

Definition at line 54 of file SkPictureRecorder.cpp.

                                                {
    return fActivelyRecording ? fRecorder.get() : nullptr;
}

Friends And Related Function Documentation

◆ SkPictureRecorderReplayTester

friend class SkPictureRecorderReplayTester

friend

Replay the current (partially recorded) operation stream into canvas. This call doesn't close the current recording.

Definition at line 102 of file SkPictureRecorder.h.

The documentation for this class was generated from the following files:

third_party/skia/include/core/SkPictureRecorder.h
third_party/skia/src/core/SkPictureRecorder.cpp

Public Member Functions

Friends