blob: 53522c2110bec734e1add7a7ccb602d89e715591 [file] [log] [blame]
* Copyright 2014 Google Inc.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
#include "SkRecorder.h"
#include "SkPatchUtils.h"
#include "SkPicture.h"
// SkCanvas will fail in mysterious ways if it doesn't know the real width and height.
SkRecorder::SkRecorder(SkRecord* record, int width, int height)
: SkCanvas(width, height), fRecord(record) {}
void SkRecorder::forgetRecord() {
fRecord = NULL;
// To make appending to fRecord a little less verbose.
#define APPEND(T, ...) \
SkNEW_PLACEMENT_ARGS(fRecord->append<SkRecords::T>(), SkRecords::T, (__VA_ARGS__))
// For methods which must call back into SkCanvas.
#define INHERITED(method, ...) this->SkCanvas::method(__VA_ARGS__)
// The structs we're creating all copy their constructor arguments. Given the way the SkRecords
// framework works, sometimes they happen to technically be copied twice, which is fine and elided
// into a single copy unless the class has a non-trivial copy constructor. For classes with
// non-trivial copy constructors, we skip the first copy (and its destruction) by wrapping the value
// with delay_copy(), forcing the argument to be passed by const&.
// This is used below for SkBitmap, SkPaint, SkPath, and SkRegion, which all have non-trivial copy
// constructors and destructors. You'll know you've got a good candidate T if you see ~T() show up
// unexpectedly on a profile of record time. Otherwise don't bother.
template <typename T>
class Reference {
Reference(const T& x) : fX(x) {}
operator const T&() const { return fX; }
const T& fX;
template <typename T>
static Reference<T> delay_copy(const T& x) { return Reference<T>(x); }
// Use copy() only for optional arguments, to be copied if present or skipped if not.
// (For most types we just pass by value and let copy constructors do their thing.)
template <typename T>
T* SkRecorder::copy(const T* src) {
if (NULL == src) {
return NULL;
return SkNEW_PLACEMENT_ARGS(fRecord->alloc<T>(), T, (*src));
// This copy() is for arrays.
// It will work with POD or non-POD, though currently we only use it for POD.
template <typename T>
T* SkRecorder::copy(const T src[], size_t count) {
if (NULL == src) {
return NULL;
T* dst = fRecord->alloc<T>(count);
for (size_t i = 0; i < count; i++) {
SkNEW_PLACEMENT_ARGS(dst + i, T, (src[i]));
return dst;
// Specialization for copying strings, using memcpy.
// This measured around 2x faster for copying code points,
// but I found no corresponding speedup for other arrays.
template <>
char* SkRecorder::copy(const char src[], size_t count) {
if (NULL == src) {
return NULL;
char* dst = fRecord->alloc<char>(count);
memcpy(dst, src, count);
return dst;
void SkRecorder::clear(SkColor color) {
APPEND(Clear, color);
void SkRecorder::drawPaint(const SkPaint& paint) {
APPEND(DrawPaint, delay_copy(paint));
void SkRecorder::drawPoints(PointMode mode,
size_t count,
const SkPoint pts[],
const SkPaint& paint) {
APPEND(DrawPoints, delay_copy(paint), mode, count, this->copy(pts, count));
void SkRecorder::drawRect(const SkRect& rect, const SkPaint& paint) {
APPEND(DrawRect, delay_copy(paint), rect);
void SkRecorder::drawOval(const SkRect& oval, const SkPaint& paint) {
APPEND(DrawOval, delay_copy(paint), oval);
void SkRecorder::drawRRect(const SkRRect& rrect, const SkPaint& paint) {
APPEND(DrawRRect, delay_copy(paint), rrect);
void SkRecorder::onDrawDRRect(const SkRRect& outer, const SkRRect& inner, const SkPaint& paint) {
APPEND(DrawDRRect, delay_copy(paint), outer, inner);
void SkRecorder::drawPath(const SkPath& path, const SkPaint& paint) {
APPEND(DrawPath, delay_copy(paint), delay_copy(path));
void SkRecorder::drawBitmap(const SkBitmap& bitmap,
SkScalar left,
SkScalar top,
const SkPaint* paint) {
APPEND(DrawBitmap, this->copy(paint), delay_copy(bitmap), left, top);
void SkRecorder::drawBitmapRectToRect(const SkBitmap& bitmap,
const SkRect* src,
const SkRect& dst,
const SkPaint* paint,
DrawBitmapRectFlags flags) {
this->copy(paint), delay_copy(bitmap), this->copy(src), dst, flags);
void SkRecorder::drawBitmapMatrix(const SkBitmap& bitmap,
const SkMatrix& matrix,
const SkPaint* paint) {
APPEND(DrawBitmapMatrix, this->copy(paint), delay_copy(bitmap), matrix);
void SkRecorder::drawBitmapNine(const SkBitmap& bitmap,
const SkIRect& center,
const SkRect& dst,
const SkPaint* paint) {
APPEND(DrawBitmapNine, this->copy(paint), delay_copy(bitmap), center, dst);
void SkRecorder::drawSprite(const SkBitmap& bitmap, int left, int top, const SkPaint* paint) {
APPEND(DrawSprite, this->copy(paint), delay_copy(bitmap), left, top);
void SkRecorder::onDrawText(const void* text, size_t byteLength,
SkScalar x, SkScalar y, const SkPaint& paint) {
delay_copy(paint), this->copy((const char*)text, byteLength), byteLength, x, y);
void SkRecorder::onDrawPosText(const void* text, size_t byteLength,
const SkPoint pos[], const SkPaint& paint) {
const unsigned points = paint.countText(text, byteLength);
this->copy((const char*)text, byteLength),
this->copy(pos, points));
void SkRecorder::onDrawPosTextH(const void* text, size_t byteLength,
const SkScalar xpos[], SkScalar constY, const SkPaint& paint) {
const unsigned points = paint.countText(text, byteLength);
this->copy((const char*)text, byteLength),
this->copy(xpos, points),
void SkRecorder::onDrawTextOnPath(const void* text, size_t byteLength, const SkPath& path,
const SkMatrix* matrix, const SkPaint& paint) {
this->copy((const char*)text, byteLength),
void SkRecorder::onDrawPicture(const SkPicture* pic, const SkMatrix* matrix, const SkPaint* paint) {
APPEND(DrawPicture, this->copy(paint), pic, this->copy(matrix));
void SkRecorder::drawVertices(VertexMode vmode,
int vertexCount, const SkPoint vertices[],
const SkPoint texs[], const SkColor colors[],
SkXfermode* xmode,
const uint16_t indices[], int indexCount, const SkPaint& paint) {
APPEND(DrawVertices, delay_copy(paint),
this->copy(vertices, vertexCount),
texs ? this->copy(texs, vertexCount) : NULL,
colors ? this->copy(colors, vertexCount) : NULL,
this->copy(indices, indexCount),
void SkRecorder::onDrawPatch(const SkPoint cubics[12], const SkColor colors[4],
const SkPoint texCoords[4], SkXfermode* xmode, const SkPaint& paint) {
APPEND(DrawPatch, delay_copy(paint),
cubics ? this->copy(cubics, SkPatchUtils::kNumCtrlPts) : NULL,
colors ? this->copy(colors, SkPatchUtils::kNumCorners) : NULL,
texCoords ? this->copy(texCoords, SkPatchUtils::kNumCorners) : NULL,
void SkRecorder::willSave() {
SkCanvas::SaveLayerStrategy SkRecorder::willSaveLayer(const SkRect* bounds,
const SkPaint* paint,
SkCanvas::SaveFlags flags) {
APPEND(SaveLayer, this->copy(bounds), this->copy(paint), flags);
INHERITED(willSaveLayer, bounds, paint, flags);
return SkCanvas::kNoLayer_SaveLayerStrategy;
void SkRecorder::didRestore() {
APPEND(Restore, this->getTotalMatrix());
void SkRecorder::onPushCull(const SkRect& rect) {
APPEND(PushCull, rect);
void SkRecorder::onPopCull() {
void SkRecorder::didConcat(const SkMatrix& matrix) {
APPEND(Concat, matrix);
INHERITED(didConcat, matrix);
void SkRecorder::didSetMatrix(const SkMatrix& matrix) {
SkASSERT(matrix == this->getTotalMatrix());
APPEND(SetMatrix, matrix);
INHERITED(didSetMatrix, matrix);
void SkRecorder::onClipRect(const SkRect& rect, SkRegion::Op op, ClipEdgeStyle edgeStyle) {
APPEND(ClipRect, rect, op, edgeStyle == kSoft_ClipEdgeStyle);
INHERITED(onClipRect, rect, op, edgeStyle);
void SkRecorder::onClipRRect(const SkRRect& rrect, SkRegion::Op op, ClipEdgeStyle edgeStyle) {
APPEND(ClipRRect, rrect, op, edgeStyle == kSoft_ClipEdgeStyle);
INHERITED(updateClipConservativelyUsingBounds, rrect.getBounds(), op, false);
void SkRecorder::onClipPath(const SkPath& path, SkRegion::Op op, ClipEdgeStyle edgeStyle) {
APPEND(ClipPath, delay_copy(path), op, edgeStyle == kSoft_ClipEdgeStyle);
INHERITED(updateClipConservativelyUsingBounds, path.getBounds(), op, path.isInverseFillType());
void SkRecorder::onClipRegion(const SkRegion& deviceRgn, SkRegion::Op op) {
APPEND(ClipRegion, delay_copy(deviceRgn), op);
INHERITED(onClipRegion, deviceRgn, op);