Google Git
Sign in
skia / skia / f72bd467feb15edd9323e46eab1b74ab6025bc5b / . / src / core / SkCanvas.cpp
blob: 3b582d4e41f9e833827d53c22f64c195fc461148 [file] [log] [blame]
/*
* Copyright 2008 The Android Open Source Project
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#include "include/core/SkCanvas.h"
#include "include/core/SkAlphaType.h"
#include "include/core/SkBitmap.h"
#include "include/core/SkBlendMode.h"
#include "include/core/SkBlender.h"
#include "include/core/SkColorFilter.h"
#include "include/core/SkColorSpace.h"
#include "include/core/SkColorType.h"
#include "include/core/SkImage.h"
#include "include/core/SkImageFilter.h"
#include "include/core/SkMaskFilter.h"
#include "include/core/SkPath.h"
#include "include/core/SkPathEffect.h"
#include "include/core/SkPicture.h"
#include "include/core/SkPixmap.h"
#include "include/core/SkRRect.h"
#include "include/core/SkRSXform.h"
#include "include/core/SkRasterHandleAllocator.h"
#include "include/core/SkRefCnt.h"
#include "include/core/SkRegion.h"
#include "include/core/SkShader.h"
#include "include/core/SkSurface.h"
#include "include/core/SkTextBlob.h"
#include "include/core/SkTileMode.h"
#include "include/core/SkTypes.h"
#include "include/core/SkVertices.h"
#include "include/private/base/SkDebug.h"
#include "include/private/base/SkSafe32.h"
#include "include/private/base/SkTPin.h"
#include "include/private/base/SkTemplates.h"
#include "include/private/base/SkTo.h"
#include "include/private/chromium/Slug.h"
#include "include/utils/SkNoDrawCanvas.h"
#include "src/base/SkEnumBitMask.h"
#include "src/base/SkMSAN.h"
#include "src/core/SkBlenderBase.h"
#include "src/core/SkCanvasPriv.h"
#include "src/core/SkDevice.h"
#include "src/core/SkImageFilterTypes.h"
#include "src/core/SkImageFilter_Base.h"
#include "src/core/SkImagePriv.h"
#include "src/core/SkLatticeIter.h"
#include "src/core/SkMatrixPriv.h"
#include "src/core/SkPaintPriv.h"
#include "src/core/SkSpecialImage.h"
#include "src/core/SkSurfacePriv.h"
#include "src/core/SkTraceEvent.h"
#include "src/core/SkVerticesPriv.h"
#include "src/effects/colorfilters/SkColorFilterBase.h"
#include "src/image/SkSurface_Base.h"
#include "src/text/GlyphRun.h"
#include "src/utils/SkPatchUtils.h"
#include <algorithm>
#include <memory>
#include <new>
#include <optional>
#include <tuple>
#include <utility>
#if defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE)
#include "src/core/SkMatrixUtils.h"
#endif
#define RETURN_ON_NULL(ptr) do { if (nullptr == (ptr)) return; } while (0)
#define RETURN_ON_FALSE(pred) do { if (!(pred)) return; } while (0)
// This is a test: static_assert with no message is a c++17 feature,
// and std::max() is constexpr only since the c++14 stdlib.
static_assert(std::max(3,4) == 4);
using Slug = sktext::gpu::Slug;
///////////////////////////////////////////////////////////////////////////////////////////////////
SK_MAKE_BITMASK_OPS(SkCanvas::PredrawFlags)
/*
* Return true if the drawing this rect would hit every pixels in the canvas.
*
* Returns false if
* - rect does not contain the canvas' bounds
* - paint is not fill
* - paint would blur or otherwise change the coverage of the rect
*/
bool SkCanvas::wouldOverwriteEntireSurface(const SkRect* rect, const SkPaint* paint,
SkEnumBitMask<PredrawFlags> flags) const {
// Convert flags to a ShaderOverrideOpacity enum
auto overrideOpacity = (flags & PredrawFlags::kOpaqueShaderOverride) ?
SkPaintPriv::kOpaque_ShaderOverrideOpacity :
(flags & PredrawFlags::kNonOpaqueShaderOverride) ?
SkPaintPriv::kNotOpaque_ShaderOverrideOpacity :
SkPaintPriv::kNone_ShaderOverrideOpacity;
const SkISize size = this->getBaseLayerSize();
const SkRect bounds = SkRect::MakeIWH(size.width(), size.height());
// if we're clipped at all, we can't overwrite the entire surface
{
const SkDevice* root = this->rootDevice();
const SkDevice* top = this->topDevice();
if (root != top) {
return false; // we're in a saveLayer, so conservatively don't assume we'll overwrite
}
if (!root->isClipWideOpen()) {
return false;
}
}
if (rect) {
if (!this->getTotalMatrix().isScaleTranslate()) {
return false; // conservative
}
SkRect devRect;
this->getTotalMatrix().mapRectScaleTranslate(&devRect, *rect);
if (!devRect.contains(bounds)) {
return false;
}
}
if (paint) {
SkPaint::Style paintStyle = paint->getStyle();
if (!(paintStyle == SkPaint::kFill_Style ||
paintStyle == SkPaint::kStrokeAndFill_Style)) {
return false;
}
if (paint->getMaskFilter() || paint->getPathEffect() || paint->getImageFilter()) {
return false; // conservative
}
}
return SkPaintPriv::Overwrites(paint, overrideOpacity);
}
///////////////////////////////////////////////////////////////////////////////////////////////////
bool SkCanvas::predrawNotify(bool willOverwritesEntireSurface) {
if (fSurfaceBase) {
if (!fSurfaceBase->aboutToDraw(willOverwritesEntireSurface
? SkSurface::kDiscard_ContentChangeMode
: SkSurface::kRetain_ContentChangeMode)) {
return false;
}
}
return true;
}
bool SkCanvas::predrawNotify(const SkRect* rect, const SkPaint* paint,
SkEnumBitMask<PredrawFlags> flags) {
if (fSurfaceBase) {
SkSurface::ContentChangeMode mode = SkSurface::kRetain_ContentChangeMode;
// Since willOverwriteAllPixels() may not be complete free to call, we only do so if
// there is an outstanding snapshot, since w/o that, there will be no copy-on-write
// and therefore we don't care which mode we're in.
//
if (fSurfaceBase->outstandingImageSnapshot()) {
if (this->wouldOverwriteEntireSurface(rect, paint, flags)) {
mode = SkSurface::kDiscard_ContentChangeMode;
}
}
if (!fSurfaceBase->aboutToDraw(mode)) {
return false;
}
}
return true;
}
///////////////////////////////////////////////////////////////////////////////
SkCanvas::Layer::Layer(sk_sp<SkDevice> device,
FilterSpan imageFilters,
const SkPaint& paint,
bool isCoverage)
: fDevice(std::move(device))
, fImageFilters(imageFilters.data(), imageFilters.size())
, fPaint(paint)
, fIsCoverage(isCoverage)
, fDiscard(false) {
SkASSERT(fDevice);
// Any image filter should have been pulled out and stored in 'imageFilter' so that 'paint'
// can be used as-is to draw the result of the filter to the dst device.
SkASSERT(!fPaint.getImageFilter());
}
SkCanvas::BackImage::BackImage(sk_sp<SkSpecialImage> img, SkIPoint loc)
:fImage(img), fLoc(loc) {}
SkCanvas::BackImage::BackImage(const BackImage&) = default;
SkCanvas::BackImage::BackImage(BackImage&&) = default;
SkCanvas::BackImage& SkCanvas::BackImage::operator=(const BackImage&) = default;
SkCanvas::BackImage::~BackImage() = default;
SkCanvas::MCRec::MCRec(SkDevice* device) : fDevice(device) {
SkASSERT(fDevice);
}
SkCanvas::MCRec::MCRec(const MCRec* prev) : fDevice(prev->fDevice), fMatrix(prev->fMatrix) {
SkASSERT(fDevice);
}
SkCanvas::MCRec::~MCRec() {}
void SkCanvas::MCRec::newLayer(sk_sp<SkDevice> layerDevice,
FilterSpan filters,
const SkPaint& restorePaint,
bool layerIsCoverage) {
SkASSERT(!fBackImage);
fLayer =
std::make_unique<Layer>(std::move(layerDevice), filters, restorePaint, layerIsCoverage);
fDevice = fLayer->fDevice.get();
}
void SkCanvas::MCRec::reset(SkDevice* device) {
SkASSERT(!fLayer);
SkASSERT(device);
SkASSERT(fDeferredSaveCount == 0);
fDevice = device;
fMatrix.setIdentity();
}
class SkCanvas::AutoUpdateQRBounds {
public:
explicit AutoUpdateQRBounds(SkCanvas* canvas) : fCanvas(canvas) {
// pre-condition, fQuickRejectBounds and other state should be valid before anything
// modifies the device's clip.
fCanvas->validateClip();
}
~AutoUpdateQRBounds() {
fCanvas->fQuickRejectBounds = fCanvas->computeDeviceClipBounds();
// post-condition, we should remain valid after re-computing the bounds
fCanvas->validateClip();
}
private:
SkCanvas* fCanvas;
AutoUpdateQRBounds(AutoUpdateQRBounds&&) = delete;
AutoUpdateQRBounds(const AutoUpdateQRBounds&) = delete;
AutoUpdateQRBounds& operator=(AutoUpdateQRBounds&&) = delete;
AutoUpdateQRBounds& operator=(const AutoUpdateQRBounds&) = delete;
};
/////////////////////////////////////////////////////////////////////////////
std::optional<AutoLayerForImageFilter> SkCanvas::aboutToDraw(
const SkPaint& paint,
const SkRect* rawBounds,
SkEnumBitMask<PredrawFlags> flags) {
if (flags & PredrawFlags::kCheckForOverwrite) {
if (!this->predrawNotify(rawBounds, &paint, flags)) {
return std::nullopt;
}
} else {
if (!this->predrawNotify()) {
return std::nullopt;
}
}
// TODO: Eventually all devices will use this code path and this will just test 'flags'.
const bool skipMaskFilterLayer = (flags & PredrawFlags::kSkipMaskFilterAutoLayer) ||
!this->topDevice()->useDrawCoverageMaskForMaskFilters();
return std::optional<AutoLayerForImageFilter>(
std::in_place, this, paint, rawBounds, skipMaskFilterLayer);
}
std::optional<AutoLayerForImageFilter> SkCanvas::aboutToDraw(
const SkPaint& paint,
const SkRect* rawBounds) {
return this->aboutToDraw(paint, rawBounds, PredrawFlags::kNone);
}
////////////////////////////////////////////////////////////////////////////
void SkCanvas::resetForNextPicture(const SkIRect& bounds) {
this->restoreToCount(1);
// We're peering through a lot of structs here. Only at this scope do we know that the device
// is a SkNoPixelsDevice.
SkASSERT(fRootDevice->isNoPixelsDevice());
SkNoPixelsDevice* asNoPixelsDevice = static_cast<SkNoPixelsDevice*>(fRootDevice.get());
if (!asNoPixelsDevice->resetForNextPicture(bounds)) {
fRootDevice = sk_make_sp<SkNoPixelsDevice>(bounds,
fRootDevice->surfaceProps(),
fRootDevice->imageInfo().refColorSpace());
}
fMCRec->reset(fRootDevice.get());
fQuickRejectBounds = this->computeDeviceClipBounds();
}
void SkCanvas::init(sk_sp<SkDevice> device) {
// SkCanvas.h declares internal storage for the hidden struct MCRec, and this
// assert ensure it's sufficient. <= is used because the struct has pointer fields, so the
// declared size is an upper bound across architectures. When the size is smaller, more stack
static_assert(sizeof(MCRec) <= kMCRecSize);
if (!device) {
device = sk_make_sp<SkNoPixelsDevice>(SkIRect::MakeEmpty(), fProps);
}
// From this point on, SkCanvas will always have a device
SkASSERT(device);
fSaveCount = 1;
fMCRec = new (fMCStack.push_back()) MCRec(device.get());
// The root device and the canvas should always have the same pixel geometry
SkASSERT(fProps.pixelGeometry() == device->surfaceProps().pixelGeometry());
fSurfaceBase = nullptr;
fRootDevice = std::move(device);
fScratchGlyphRunBuilder = std::make_unique<sktext::GlyphRunBuilder>();
fQuickRejectBounds = this->computeDeviceClipBounds();
}
SkCanvas::SkCanvas() : fMCStack(sizeof(MCRec), fMCRecStorage, sizeof(fMCRecStorage)) {
this->init(nullptr);
}
SkCanvas::SkCanvas(int width, int height, const SkSurfaceProps* props)
: fMCStack(sizeof(MCRec), fMCRecStorage, sizeof(fMCRecStorage))
, fProps(SkSurfacePropsCopyOrDefault(props)) {
this->init(sk_make_sp<SkNoPixelsDevice>(
SkIRect::MakeWH(std::max(width, 0), std::max(height, 0)), fProps));
}
SkCanvas::SkCanvas(const SkIRect& bounds)
: fMCStack(sizeof(MCRec), fMCRecStorage, sizeof(fMCRecStorage)) {
SkIRect r = bounds.isEmpty() ? SkIRect::MakeEmpty() : bounds;
this->init(sk_make_sp<SkNoPixelsDevice>(r, fProps));
}
SkCanvas::SkCanvas(sk_sp<SkDevice> device)
: fMCStack(sizeof(MCRec), fMCRecStorage, sizeof(fMCRecStorage))
, fProps(device->surfaceProps()) {
this->init(std::move(device));
}
SkCanvas::~SkCanvas() {
// Mark all pending layers to be discarded during restore (rather than drawn)
SkDeque::Iter iter(fMCStack, SkDeque::Iter::kFront_IterStart);
for (;;) {
MCRec* rec = (MCRec*)iter.next();
if (!rec) {
break;
}
if (rec->fLayer) {
rec->fLayer->fDiscard = true;
}
}
// free up the contents of our deque
this->restoreToCount(1); // restore everything but the last
this->internalRestore(); // restore the last, since we're going away
}
SkSurface* SkCanvas::getSurface() const {
return fSurfaceBase;
}
SkISize SkCanvas::getBaseLayerSize() const {
return this->rootDevice()->imageInfo().dimensions();
}
SkDevice* SkCanvas::topDevice() const {
SkASSERT(fMCRec->fDevice);
return fMCRec->fDevice;
}
bool SkCanvas::readPixels(const SkPixmap& pm, int x, int y) {
return pm.addr() && this->rootDevice()->readPixels(pm, x, y);
}
bool SkCanvas::readPixels(const SkImageInfo& dstInfo, void* dstP, size_t rowBytes, int x, int y) {
return this->readPixels({ dstInfo, dstP, rowBytes}, x, y);
}
bool SkCanvas::readPixels(const SkBitmap& bm, int x, int y) {
SkPixmap pm;
return bm.peekPixels(&pm) && this->readPixels(pm, x, y);
}
bool SkCanvas::writePixels(const SkBitmap& bitmap, int x, int y) {
SkPixmap pm;
if (bitmap.peekPixels(&pm)) {
return this->writePixels(pm.info(), pm.addr(), pm.rowBytes(), x, y);
}
return false;
}
bool SkCanvas::writePixels(const SkImageInfo& srcInfo, const void* pixels, size_t rowBytes,
int x, int y) {
SkDevice* device = this->rootDevice();
// This check gives us an early out and prevents generation ID churn on the surface.
// This is purely optional: it is a subset of the checks performed by SkWritePixelsRec.
SkIRect srcRect = SkIRect::MakeXYWH(x, y, srcInfo.width(), srcInfo.height());
if (!srcRect.intersect({0, 0, device->width(), device->height()})) {
return false;
}
// Tell our owning surface to bump its generation ID.
const bool completeOverwrite = srcRect.size() == device->imageInfo().dimensions();
if (!this->predrawNotify(completeOverwrite)) {
return false;
}
// This can still fail, most notably in the case of a invalid color type or alpha type
// conversion. We could pull those checks into this function and avoid the unnecessary
// generation ID bump. But then we would be performing those checks twice, since they
// are also necessary at the bitmap/pixmap entry points.
return device->writePixels({srcInfo, pixels, rowBytes}, x, y);
}
//////////////////////////////////////////////////////////////////////////////
void SkCanvas::checkForDeferredSave() {
if (fMCRec->fDeferredSaveCount > 0) {
this->doSave();
}
}
int SkCanvas::getSaveCount() const {
#ifdef SK_DEBUG
int count = 0;
SkDeque::Iter iter(fMCStack, SkDeque::Iter::kFront_IterStart);
for (;;) {
const MCRec* rec = (const MCRec*)iter.next();
if (!rec) {
break;
}
count += 1 + rec->fDeferredSaveCount;
}
SkASSERT(count == fSaveCount);
#endif
return fSaveCount;
}
int SkCanvas::save() {
fSaveCount += 1;
fMCRec->fDeferredSaveCount += 1;
return this->getSaveCount() - 1; // return our prev value
}
void SkCanvas::doSave() {
this->willSave();
SkASSERT(fMCRec->fDeferredSaveCount > 0);
fMCRec->fDeferredSaveCount -= 1;
this->internalSave();
}
void SkCanvas::restore() {
if (fMCRec->fDeferredSaveCount > 0) {
SkASSERT(fSaveCount > 1);
fSaveCount -= 1;
fMCRec->fDeferredSaveCount -= 1;
} else {
// check for underflow
if (fMCStack.count() > 1) {
this->willRestore();
SkASSERT(fSaveCount > 1);
fSaveCount -= 1;
this->internalRestore();
this->didRestore();
}
}
}
void SkCanvas::restoreToCount(int count) {
// safety check
if (count < 1) {
count = 1;
}
int n = this->getSaveCount() - count;
for (int i = 0; i < n; ++i) {
this->restore();
}
}
void SkCanvas::internalSave() {
fMCRec = new (fMCStack.push_back()) MCRec(fMCRec);
this->topDevice()->pushClipStack();
}
int SkCanvas::saveLayer(const SkRect* bounds, const SkPaint* paint) {
return this->saveLayer(SaveLayerRec(bounds, paint, 0));
}
int SkCanvas::saveLayer(const SaveLayerRec& rec) {
TRACE_EVENT0("skia", TRACE_FUNC);
if (rec.fPaint && rec.fPaint->nothingToDraw()) {
// no need for the layer (or any of the draws until the matching restore()
this->save();
this->clipRect({0,0,0,0});
} else {
SaveLayerStrategy strategy = this->getSaveLayerStrategy(rec);
fSaveCount += 1;
this->internalSaveLayer(rec, strategy);
}
return this->getSaveCount() - 1;
}
int SkCanvas::only_axis_aligned_saveBehind(const SkRect* bounds) {
if (bounds && !this->getLocalClipBounds().intersects(*bounds)) {
// Assuming clips never expand, if the request bounds is outside of the current clip
// there is no need to copy/restore the area, so just devolve back to a regular save.
this->save();
} else {
bool doTheWork = this->onDoSaveBehind(bounds);
fSaveCount += 1;
this->internalSave();
if (doTheWork) {
this->internalSaveBehind(bounds);
}
}
return this->getSaveCount() - 1;
}
// In our current design/features, we should never have a layer (src) in a different colorspace
// than its parent (dst), so we assert that here. This is called out from other asserts, in case
// we add some feature in the future to allow a given layer/imagefilter to operate in a specific
// colorspace.
static void check_drawdevice_colorspaces(SkDevice* src, SkDevice* dst) {
SkASSERT(dst && (!src || dst->imageInfo().colorSpace() == src->imageInfo().colorSpace()));
}
// Helper function to compute the center reference point used for scale decomposition under
// non-linear transformations.
static skif::ParameterSpace<SkPoint> compute_decomposition_center(
const SkMatrix& dstToLocal,
std::optional<skif::ParameterSpace<SkRect>> contentBounds,
const skif::DeviceSpace<SkIRect>& targetOutput) {
// Will use the inverse and center of the device bounds if the content bounds aren't provided.
SkRect rect = contentBounds ? SkRect(*contentBounds) : SkRect::Make(SkIRect(targetOutput));
SkPoint center = {rect.centerX(), rect.centerY()};
if (!contentBounds) {
// Theoretically, the inverse transform could put center's homogeneous coord behind W = 0,
// but that case is handled automatically in Mapping::decomposeCTM later.
dstToLocal.mapPoints(&center, 1);
}
return skif::ParameterSpace<SkPoint>(center);
}
// Helper when we need to upgrade a single filter to a FilterSpan
struct FilterToSpan {
FilterToSpan(const SkImageFilter* filter) : fFilter(sk_ref_sp(filter)) {}
operator SkCanvas::FilterSpan() {
return fFilter ? SkCanvas::FilterSpan{&fFilter, 1} : SkCanvas::FilterSpan{};
}
sk_sp<SkImageFilter> fFilter;
};
// Compute suitable transformations and layer bounds for a new layer that will be used as the source
// input into 'filter' before being drawn into 'dst' via the returned skif::Mapping.
// Null filters are permitted and act as the identity. The returned mapping will be compatible with
// the image filter.
//
// An empty optional is returned if the layer mapping and bounds couldn't be determined, in which
// case the layer should be skipped. An instantiated optional can have an empty layer bounds rect
// if the image filter doesn't require an input image to produce a valid output.
static std::optional<std::pair<skif::Mapping, skif::LayerSpace<SkIRect>>>
get_layer_mapping_and_bounds(
SkCanvas::FilterSpan filters,
const SkMatrix& localToDst,
const skif::DeviceSpace<SkIRect>& targetOutput,
std::optional<skif::ParameterSpace<SkRect>> contentBounds = {},
#if defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE)
bool mustCoverDst = true,
#endif
SkScalar scaleFactor = 1.0f) {
SkMatrix dstToLocal;
if (!localToDst.isFinite() ||
!localToDst.invert(&dstToLocal)) {
return {};
}
skif::ParameterSpace<SkPoint> center =
compute_decomposition_center(dstToLocal, contentBounds, targetOutput);
#if defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE)
// *after* possibly getting a representative point from the provided content bounds, it might
// be necessary to discard the bounds for subsequent layer calculations.
if (mustCoverDst) {
contentBounds.reset();
}
#endif
// Determine initial mapping and a reasonable maximum dimension to prevent layer-to-device
// transforms with perspective and skew from triggering excessive buffer allocations.
skif::Mapping mapping;
skif::MatrixCapability capability = skif::MatrixCapability::kComplex;
for (const sk_sp<SkImageFilter>& filter : filters) {
if (filter) {
capability = std::min(capability, as_IFB(filter)->getCTMCapability());
}
}
if (!mapping.decomposeCTM(localToDst, capability, center)) {
return {};
}
// Push scale factor into layer matrix and device matrix (net no change, but the layer will have
// its resolution adjusted in comparison to the final device).
if (scaleFactor != 1.0f &&
!mapping.adjustLayerSpace(SkMatrix::Scale(scaleFactor, scaleFactor))) {
return {};
}
// Perspective and skew could exceed this since mapping.deviceToLayer(targetOutput) is
// theoretically unbounded under those conditions. Under a 45 degree rotation, a layer needs to
// be 2X larger per side of the prior device in order to fully cover it. We use the max of that
// and 2048 for a reasonable upper limit (this allows small layers under extreme transforms to
// use more relative resolution than a larger layer).
static const int kMinDimThreshold = 2048;
int maxLayerDim = std::max(Sk64_pin_to_s32(2 * std::max(SkIRect(targetOutput).width64(),
SkIRect(targetOutput).height64())),
kMinDimThreshold);
auto baseLayerBounds = mapping.deviceToLayer(targetOutput);
if (contentBounds) {
// For better or for worse, user bounds currently act as a hard clip on the layer's
// extent (i.e., they implement the CSS filter-effects 'filter region' feature).
skif::LayerSpace<SkIRect> knownBounds = mapping.paramToLayer(*contentBounds).roundOut();
if (!baseLayerBounds.intersect(knownBounds)) {
baseLayerBounds = skif::LayerSpace<SkIRect>::Empty();
}
}
skif::LayerSpace<SkIRect> layerBounds;
if (!filters.empty()) {
layerBounds = skif::LayerSpace<SkIRect>::Union(filters.size(), [&](int i) {
return filters[i] ? as_IFB(filters[i])
->getInputBounds(mapping, targetOutput, contentBounds)
: baseLayerBounds;
});
// When a filter is involved, the layer size may be larger than the default maxLayerDim due
// to required inputs for filters (e.g. a displacement map with a large radius).
if (layerBounds.width() > maxLayerDim || layerBounds.height() > maxLayerDim) {
skif::Mapping idealMapping{mapping.layerMatrix()};
for (const sk_sp<SkImageFilter>& filter : filters) {
if (filter) {
auto idealLayerBounds = as_IFB(filter)->getInputBounds(
idealMapping, targetOutput, contentBounds);
maxLayerDim = std::max(std::max(idealLayerBounds.width(),
idealLayerBounds.height()),
maxLayerDim);
}
}
}
} else {
if (baseLayerBounds.isEmpty()) {
return {};
}
layerBounds = baseLayerBounds;
}
if (layerBounds.width() > maxLayerDim || layerBounds.height() > maxLayerDim) {
skif::LayerSpace<SkIRect> newLayerBounds(
SkIRect::MakeWH(std::min(layerBounds.width(), maxLayerDim),
std::min(layerBounds.height(), maxLayerDim)));
SkMatrix adjust = SkMatrix::MakeRectToRect(SkRect::Make(SkIRect(layerBounds)),
SkRect::Make(SkIRect(newLayerBounds)),
SkMatrix::kFill_ScaleToFit);
if (!mapping.adjustLayerSpace(adjust)) {
return {};
} else {
layerBounds = newLayerBounds;
}
}
return std::make_pair(mapping, layerBounds);
}
// Ideally image filters operate in the dst color type, but if there is insufficient alpha bits
// we move some bits from color channels into the alpha channel since that can greatly improve
// the quality of blurs and other filters.
static SkColorType image_filter_color_type(SkImageInfo dstInfo) {
if (dstInfo.bytesPerPixel() <= 4 &&
dstInfo.colorType() != kRGBA_8888_SkColorType &&
dstInfo.colorType() != kBGRA_8888_SkColorType) {
// "Upgrade" A8, G8, 565, 4444, 1010102, 101010x, and 888x to 8888
return kN32_SkColorType;
} else {
return dstInfo.colorType();
}
}
#if !defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE)
static skif::FilterResult apply_alpha_and_colorfilter(const skif::Context& ctx,
const skif::FilterResult& image,
const SkPaint& paint) {
// The only effects that apply to layers (other than the SkImageFilter that made this image in
// the first place) are transparency and color filters.
skif::FilterResult result = image;
if (paint.getAlphaf() < 1.f) {
result = result.applyColorFilter(ctx, SkColorFilters::Blend(paint.getColor4f(),
/*colorSpace=*/nullptr,
SkBlendMode::kDstIn));
}
if (paint.getColorFilter()) {
result = result.applyColorFilter(ctx, paint.refColorFilter());
}
return result;
}
void SkCanvas::internalDrawDeviceWithFilter(SkDevice* src,
SkDevice* dst,
FilterSpan filters,
const SkPaint& paint,
DeviceCompatibleWithFilter compat,
SkScalar scaleFactor,
bool srcIsCoverageLayer) {
// The dst is always required, the src can be null if 'filter' is non-null and does not require
// a source image.
SkASSERT(dst);
check_drawdevice_colorspaces(src, dst);
sk_sp<SkColorSpace> filterColorSpace = dst->imageInfo().refColorSpace(); // == src.refColorSpace
// 'filterColorType' ends up being the actual color type of the layer, so image filtering is
// effectively done in the layer's format. We get there in a roundabout way due to handling both
// regular and backdrop filters:
// - For regular filters, 'src' is the layer and 'dst' is the parent device. But the layer
// was constructed with a color type equal to image_filter_color_type(dst), so this matches
// the layer.
// - For backdrop filters, 'src' is the parent device and 'dst' is the layer, which was already
// constructed as image_filter_color_type(src). Calling image_filter_color_type twice does
// not change the color type, so it remains the color type of the layer.
const SkColorType filterColorType =
srcIsCoverageLayer ? kAlpha_8_SkColorType : image_filter_color_type(dst->imageInfo());
// 'filter' sees the src device's buffer as the implicit input image, and processes the image
// in this device space (referred to as the "layer" space). However, the filter
// parameters need to respect the current matrix, which is not necessarily the local matrix that
// was set on 'src' (e.g. because we've popped src off the stack already).
// TODO (michaelludwig): Stay in SkM44 once skif::Mapping supports SkM44 instead of SkMatrix.
SkMatrix localToSrc = src ? (src->globalToDevice() * fMCRec->fMatrix).asM33() : SkMatrix::I();
SkISize srcDims = src ? src->imageInfo().dimensions() : SkISize::Make(0, 0);
// Whether or not we need to make a transformed tmp image from 'src', and what that transform is
skif::LayerSpace<SkMatrix> srcToLayer;
skif::Mapping mapping;
skif::LayerSpace<SkIRect> requiredInput;
skif::DeviceSpace<SkIRect> outputBounds{dst->devClipBounds()};
if (compat == DeviceCompatibleWithFilter::kYes) {
// Just use the relative transform from src to dst and the src's whole image, since
// internalSaveLayer should have already determined what was necessary. We explicitly
// construct the inverse (dst->src) to avoid the case where src's and dst's coord transforms
// were individually invertible by SkM44::invert() but their product is considered not
// invertible by SkMatrix::invert(). When this happens the matrices are already poorly
// conditioned so getRelativeTransform() gives us something reasonable.
SkASSERT(src);
SkASSERT(scaleFactor == 1.0f);
SkASSERT(!srcDims.isEmpty());
mapping = skif::Mapping(src->getRelativeTransform(*dst),
dst->getRelativeTransform(*src),
localToSrc);
requiredInput = skif::LayerSpace<SkIRect>(SkIRect::MakeSize(srcDims));
srcToLayer = skif::LayerSpace<SkMatrix>(SkMatrix::I());
} else {
// Compute the image filter mapping by decomposing the local->device matrix of dst and
// re-determining the required input.
auto mappingAndBounds = get_layer_mapping_and_bounds(
filters, dst->localToDevice(), outputBounds, {}, SkTPin(scaleFactor, 0.f, 1.f));
if (!mappingAndBounds) {
return;
}
std::tie(mapping, requiredInput) = *mappingAndBounds;
if (src) {
if (!requiredInput.isEmpty()) {
// The above mapping transforms from local to dst's device space, where the layer
// space represents the intermediate buffer. Now we need to determine the transform
// from src to intermediate to prepare the input to the filter.
SkMatrix srcToLocal;
if (!localToSrc.invert(&srcToLocal)) {
return;
}
srcToLayer = skif::LayerSpace<SkMatrix>(SkMatrix::Concat(mapping.layerMatrix(),
srcToLocal));
} // Else no input is needed which can happen if a backdrop filter that doesn't use src
} else {
// Trust the caller that no input was required, but keep the calculated mapping
requiredInput = skif::LayerSpace<SkIRect>::Empty();
}
}
// Start out with an empty source image, to be replaced with the snapped 'src' device.
auto backend = dst->createImageFilteringBackend(src ? src->surfaceProps() : dst->surfaceProps(),
filterColorType);
skif::Stats stats;
skif::Context ctx{std::move(backend),
mapping,
requiredInput,
skif::FilterResult{},
filterColorSpace.get(),
&stats};
skif::FilterResult source;
if (src && !requiredInput.isEmpty()) {
skif::LayerSpace<SkIRect> srcSubset;
if (!srcToLayer.inverseMapRect(requiredInput, &srcSubset)) {
return;
}
// Include the layer in the offscreen count
ctx.markNewSurface();
auto availSrc = skif::LayerSpace<SkIRect>(src->size()).relevantSubset(
srcSubset, SkTileMode::kClamp);
if (SkMatrix(srcToLayer).isScaleTranslate()) {
// Apply the srcToLayer transformation directly while snapping an image from the src
// device. Calculate the subset of requiredInput that corresponds to srcSubset that was
// restricted to the actual src dimensions.
auto requiredSubset = srcToLayer.mapRect(availSrc);
if (requiredSubset.width() == availSrc.width() &&
requiredSubset.height() == availSrc.height()) {
// Unlike snapSpecialScaled(), snapSpecial() can avoid a copy when the underlying
// representation permits it.
source = {src->snapSpecial(SkIRect(availSrc)), requiredSubset.topLeft()};
} else {
SkASSERT(compat == DeviceCompatibleWithFilter::kUnknown);
source = {src->snapSpecialScaled(SkIRect(availSrc),
SkISize(requiredSubset.size())),
requiredSubset.topLeft()};
ctx.markNewSurface();
}
}
if (compat == DeviceCompatibleWithFilter::kYes) {
#if defined(SK_DONT_PAD_LAYER_IMAGES)
// Technically not needed, but does change the tile mode of the FilterResult, and this
// preserves prior behavior before the layer padding CLs.
source = source.applyCrop(ctx, source.layerBounds(), SkTileMode::kClamp);
#else
// Padding was added to the source image when the 'src' SkDevice was created, so inset
// to allow bounds tracking to skip shader-based tiling when possible.
source = source.insetForSaveLayer();
#endif
} else if (source) {
// A backdrop filter that succeeded in snapSpecial() or snapSpecialScaled(), but since
// the 'src' device wasn't prepared with 'requiredInput' in mind, add clamping.
source = source.applyCrop(ctx, source.layerBounds(), SkTileMode::kClamp);
} else if (!requiredInput.isEmpty()) {
// Otherwise snapSpecialScaled() failed or the transform was complex, so snap the source
// image at its original resolution and then apply srcToLayer to map to the effective
// layer coordinate space.
source = {src->snapSpecial(SkIRect(availSrc)), availSrc.topLeft()};
// We adjust the desired output of the applyCrop() because ctx was original set to
// fulfill 'requiredInput', which is valid *after* we apply srcToLayer. Use the original
// 'srcSubset' for the desired output so that the kClamp applied to the available subset
// is not discarded as a no-op.
source = source.applyCrop(ctx.withNewDesiredOutput(srcSubset),
source.layerBounds(),
SkTileMode::kClamp)
.applyTransform(ctx, srcToLayer, SkFilterMode::kLinear);
}
} // else leave 'source' as the empty image
// Evaluate the image filter, with a context pointing to the source snapped from 'src' and
// possibly transformed into the intermediate layer coordinate space.
ctx = ctx.withNewDesiredOutput(mapping.deviceToLayer(outputBounds))
.withNewSource(source);
// Here, we allow a single-element FilterSpan with a null entry, to simplify the loop:
sk_sp<SkImageFilter> nullFilter;
FilterSpan filtersOrNull = filters.empty() ? FilterSpan{&nullFilter, 1} : filters;
for (const sk_sp<SkImageFilter>& filter : filtersOrNull) {
auto result = filter ? as_IFB(filter)->filterImage(ctx) : source;
if (srcIsCoverageLayer) {
SkASSERT(dst->useDrawCoverageMaskForMaskFilters());
// TODO: Can FilterResult optimize this in any meaningful way if it still has to go
// through drawCoverageMask that requires an image (vs a coverage shader)?
auto [coverageMask, origin] = result.imageAndOffset(ctx);
if (coverageMask) {
SkMatrix deviceMatrixWithOffset = mapping.layerToDevice();
deviceMatrixWithOffset.preTranslate(origin.x(), origin.y());
dst->drawCoverageMask(
coverageMask.get(), deviceMatrixWithOffset, result.sampling(), paint);
}
} else {
result = apply_alpha_and_colorfilter(ctx, result, paint);
result.draw(ctx, dst, paint.getBlender());
}
}
stats.reportStats();
}
#else
static bool can_layer_be_drawn_as_sprite(const SkMatrix& matrix, const SkISize& size) {
// Assume anti-aliasing and highest valid filter mode (linear) for drawing layers and image
// filters. If the layer can be drawn as a sprite, these can be downgraded.
SkPaint paint;
paint.setAntiAlias(true);
SkSamplingOptions sampling{SkFilterMode::kLinear};
return SkTreatAsSprite(matrix, size, sampling, paint.isAntiAlias());
}
void SkCanvas::internalDrawDeviceWithFilter(SkDevice* src,
SkDevice* dst,
FilterSpan filters,
const SkPaint& paint,
DeviceCompatibleWithFilter compat,
SkScalar scaleFactor,
bool srcIsCoverageLayer) {
const SkImageFilter* filter = filters.empty() ? nullptr : filters.front().get();
// coverage image filters won't be supported in the old filter rendering code path
(void) srcIsCoverageLayer;
check_drawdevice_colorspaces(src, dst);
sk_sp<SkColorSpace> filterColorSpace = dst->imageInfo().refColorSpace(); // == src.refColorSpace
// 'filterColorType' ends up being the actual color type of the layer, so image filtering is
// effectively done in the layer's format. We get there in a roundabout way due to handling both
// regular and backdrop filters:
// - For regular filters, 'src' is the layer and 'dst' is the parent device. But the layer
// was constructed with a color type equal to image_filter_color_type(dst), so this matches
// the layer.
// - For backdrop filters, 'src' is the parent device and 'dst' is the layer, which was already
// constructed as image_filter_color_type(src). Calling image_filter_color_type twice does
// not change the color type, so it remains the color type of the layer.
const SkColorType filterColorType = image_filter_color_type(dst->imageInfo());
// 'filter' sees the src device's buffer as the implicit input image, and processes the image
// in this device space (referred to as the "layer" space). However, the filter
// parameters need to respect the current matrix, which is not necessarily the local matrix that
// was set on 'src' (e.g. because we've popped src off the stack already).
// TODO (michaelludwig): Stay in SkM44 once skif::Mapping supports SkM44 instead of SkMatrix.
SkMatrix localToSrc = (src->globalToDevice() * fMCRec->fMatrix).asM33();
SkISize srcDims = src->imageInfo().dimensions();
// Whether or not we need to make a transformed tmp image from 'src', and what that transform is
bool needsIntermediateImage = false;
SkMatrix srcToIntermediate;
skif::Mapping mapping;
skif::LayerSpace<SkIRect> requiredInput;
if (compat == DeviceCompatibleWithFilter::kYes) {
// Just use the relative transform from src to dst and the src's whole image, since
// internalSaveLayer should have already determined what was necessary. We explicitly
// construct the inverse (dst->src) to avoid the case where src's and dst's coord transforms
// were individually invertible by SkM44::invert() but their product is considered not
// invertible by SkMatrix::invert(). When this happens the matrices are already poorly
// conditioned so getRelativeTransform() gives us something reasonable.
SkASSERT(scaleFactor == 1.0f);
mapping = skif::Mapping(src->getRelativeTransform(*dst),
dst->getRelativeTransform(*src),
localToSrc);
requiredInput = skif::LayerSpace<SkIRect>(SkIRect::MakeSize(srcDims));
SkASSERT(!requiredInput.isEmpty());
} else {
// Compute the image filter mapping by decomposing the local->device matrix of dst and
// re-determining the required input.
auto mappingAndBounds = get_layer_mapping_and_bounds(
filters, dst->localToDevice(), skif::DeviceSpace<SkIRect>(dst->devClipBounds()),
{}, true, SkTPin(scaleFactor, 0.f, 1.f));
if (!mappingAndBounds) {
return;
}
std::tie(mapping, requiredInput) = *mappingAndBounds;
if (!requiredInput.isEmpty()) {
// The above mapping transforms from local to dst's device space, where the layer space
// represents the intermediate buffer. Now we need to determine the transform from src
// to intermediate to prepare the input to the filter.
if (!localToSrc.invert(&srcToIntermediate)) {
return;
}
srcToIntermediate.postConcat(mapping.layerMatrix());
if (can_layer_be_drawn_as_sprite(srcToIntermediate, srcDims)) {
// src differs from intermediate by just an integer translation, so it can be
// applied automatically when taking a subset of src if we update the mapping.
skif::LayerSpace<SkIPoint> srcOrigin({(int) srcToIntermediate.getTranslateX(),
(int) srcToIntermediate.getTranslateY()});
mapping.applyOrigin(srcOrigin);
requiredInput.offset(-srcOrigin);
} else {
// The contents of 'src' will be drawn to an intermediate buffer using
// srcToIntermediate and that buffer will be the input to the image filter.
needsIntermediateImage = true;
}
} // Else no input is needed which can happen from a backdrop filter that doesn't use src
}
sk_sp<SkSpecialImage> filterInput;
if (!needsIntermediateImage) {
// The src device can be snapped directly
skif::LayerSpace<SkIRect> srcSubset(SkIRect::MakeSize(srcDims));
if (srcSubset.intersect(requiredInput)) {
filterInput = src->snapSpecial(SkIRect(srcSubset));
// TODO: For now image filter input images need to have a (0,0) origin. The required
// input's top left has been baked into srcSubset so we use that as the image origin.
mapping.applyOrigin(srcSubset.topLeft());
}
} else {
// We need to produce a temporary image that is equivalent to 'src' but transformed to
// a coordinate space compatible with the image filter
SkASSERT(compat == DeviceCompatibleWithFilter::kUnknown);
SkRect srcRect;
if (!SkMatrixPriv::InverseMapRect(srcToIntermediate, &srcRect,
SkRect::Make(SkIRect(requiredInput)))) {
return;
}
if (!srcRect.intersect(SkRect::Make(srcDims))) {
return;
}
SkIRect srcSubset = skif::RoundOut(srcRect);
if (srcToIntermediate.isScaleTranslate()) {
// The transform is from srcRect to requiredInput, but srcRect may have been reduced
// to the src dimensions, so map srcSubset back to the intermediate space to get the
// appropriate scaled dimensions for snapScaledSpecial.
skif::LayerSpace<SkIRect> requiredSubset(
skif::RoundOut(srcToIntermediate.mapRect(srcRect)));
filterInput = src->snapSpecialScaled(srcSubset,
{requiredSubset.width(), requiredSubset.height()});
if (filterInput) {
// TODO: Like the non-intermediate case, we need to apply the image origin
mapping.applyOrigin(requiredSubset.topLeft());
} // else fall through and apply transform using a draw
}
if (!filterInput) {
// Either a complex transform or the scaled copy failed so do a copy-as-draw fallback.
sk_sp<SkSpecialImage> srcImage = src->snapSpecial(srcSubset);
if (!srcImage) {
return;
}
// Make a new surface and draw 'srcImage' into it with the srcToIntermediate transform
// to produce the final input image for the filter
SkDevice::CreateInfo info(SkImageInfo::Make(requiredInput.width(),
requiredInput.height(),
filterColorType,
kPremul_SkAlphaType,
filterColorSpace),
SkPixelGeometry::kUnknown_SkPixelGeometry,
fAllocator.get());
sk_sp<SkDevice> intermediateDevice = src->createDevice(info, &paint);
if (!intermediateDevice) {
return;
}
intermediateDevice->setOrigin(SkM44(srcToIntermediate),
requiredInput.left(), requiredInput.top());
// We use drawPaint to fill the entire device with the src input + clamp tiling, which
// extends the backdrop's edge pixels to the parts of 'requiredInput' that map offscreen
// Without this, the intermediateDevice would contain transparent pixels that may then
// infect blurs and other filters with large kernels.
SkPaint imageFill;
imageFill.setShader(srcImage->asShader(SkTileMode::kClamp,
SkFilterMode::kLinear,
SkMatrix::Translate(srcSubset.topLeft())));
intermediateDevice->drawPaint(imageFill);
filterInput = intermediateDevice->snapSpecial();
// TODO: Like the non-intermediate case, we need to apply the image origin.
mapping.applyOrigin(requiredInput.topLeft());
}
}
if (filterInput || requiredInput.isEmpty()) {
const bool useNN = can_layer_be_drawn_as_sprite(mapping.layerToDevice(),
dst->devClipBounds().size());
SkSamplingOptions sampling{useNN ? SkFilterMode::kNearest : SkFilterMode::kLinear};
if (filter) {
dst->drawFilteredImage(mapping, filterInput.get(), filterColorType, filter,
sampling, paint);
} else {
SkASSERT(filterInput); // A null filter input only makes sense if there was a filter
dst->drawSpecial(filterInput.get(), mapping.layerToDevice(), sampling, paint);
}
}
}
// This is similar to SkCanvasPriv::ImageToColorFilter, but with key changes:
// - ImageToColorFilter requires the entire image filter DAG to be represented as a color filter
// that does not affect transparent black (SkImageFilter::asAColorFilter)
// - when that is met, the image filter's CF is composed around any CF that was on the draw's paint
// since for a draw, the color filtering happens before any image filtering
// - optimize_layer_filter only applies to the last node and does not care about transparent black
// since a layer is being made regardless (SkImageFilter::isColorFilterNode)
// - any extracted CF is composed inside the restore paint's CF because image filters are evaluated
// before the color filter of a restore paint for layers.
//
// Assumes that 'filter', and thus its inputs, will remain owned by the caller. Modifies 'paint'
// to have the updated color filter and returns the image filter to evaluate on restore.
static const SkImageFilter* optimize_layer_filter(const SkImageFilter* filter, SkPaint* paint) {
SkASSERT(paint);
SkColorFilter* cf;
if (filter && filter->isColorFilterNode(&cf)) {
sk_sp<SkColorFilter> inner(cf);
if (paint->getAlphaf() < 1.f) {
// The paint's alpha is applied after the image filter but before the paint's color
// filter. If there is transparency, we have to apply it between the two filters.
// FIXME: The Blend CF should allow composing directly at construction.
inner = SkColorFilters::Compose(
SkColorFilters::Blend(/*src*/paint->getColor4f(), nullptr, SkBlendMode::kDstIn),
/*dst*/std::move(inner));
paint->setAlphaf(1.f);
}
paint->setColorFilter(SkColorFilters::Compose(paint->refColorFilter(), std::move(inner)));
SkASSERT(filter->countInputs() == 1);
return filter->getInput(0);
} else {
return filter;
}
}
// If there is a backdrop filter, or if the restore paint has a color filter or blend mode that
// affects transparent black, then the new layer must be sized such that it covers the entire device
// clip bounds of the prior device (otherwise edges of the temporary layer would be visible).
static bool must_cover_prior_device(const SkImageFilter* backdrop,
const SkPaint& restorePaint) {
const SkColorFilter* cf = restorePaint.getColorFilter();
if (backdrop || (cf && as_CFB(cf)->affectsTransparentBlack())) {
// Backdrop image filters always affect the entire (clip-limited) layer. A color filter
// affecting transparent black will colorize pixels that are outside the drawn bounds hint.
return true;
}
// A custom blender is assumed to modify transparent black; some fixed blend modes also modify
// transparent black and the whole layer must be used for the same reason as color filters.
if (auto blendMode = restorePaint.asBlendMode()) {
SkBlendModeCoeff src, dst;
if (SkBlendMode_AsCoeff(*blendMode, &src, &dst)) {
// If the source is (0,0,0,0), then dst is preserved as long as its coefficient
// evaluates to 1.0. This is true for kOne, kISA, and kISC. Anything else means the
// blend mode affects transparent black.
return dst != SkBlendModeCoeff::kOne &&
dst != SkBlendModeCoeff::kISA &&
dst != SkBlendModeCoeff::kISC;
} else {
// else an advanced blend mode, which preserve transparent black
return false;
}
} else {
// Blenders that aren't blend modes are assumed to modify transparent black.
return true;
}
}
#endif // SK_RESOLVE_FILTERS_BEFORE_RESTORE
void SkCanvas::internalSaveLayer(const SaveLayerRec& rec,
SaveLayerStrategy strategy,
bool coverageOnly) {
TRACE_EVENT0("skia", TRACE_FUNC);
// Do this before we create the layer. We don't call the public save() since that would invoke a
// possibly overridden virtual.
this->internalSave();
if (this->isClipEmpty()) {
// Early out if the layer wouldn't draw anything
return;
}
// Build up the paint for restoring the layer, taking only the pieces of rec.fPaint that are
// relevant. Filtering is automatically chosen in internalDrawDeviceWithFilter based on the
// device's coordinate space.
SkPaint restorePaint(rec.fPaint ? *rec.fPaint : SkPaint());
restorePaint.setStyle(SkPaint::kFill_Style); // a layer is filled out "infinitely"
restorePaint.setPathEffect(nullptr); // path effects are ignored for saved layers
restorePaint.setMaskFilter(nullptr); // mask filters are ignored for saved layers
restorePaint.setImageFilter(nullptr); // the image filter is held separately
// Smooth non-axis-aligned layer edges; this automatically downgrades to non-AA for aligned
// layer restores. This is done to match legacy behavior where the post-applied MatrixTransform
// bilerp also smoothed cropped edges. See skbug.com/11252
restorePaint.setAntiAlias(true);
#if defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE)
sk_sp<SkImageFilter> paintFilter = sk_ref_sp(optimize_layer_filter(
rec.fPaint ? rec.fPaint->getImageFilter() : nullptr, &restorePaint));
// Don't support multiple filters while using the old code path
SkASSERT(rec.fFilters.empty());
FilterSpan filters = paintFilter ? FilterSpan{&paintFilter, 1} : FilterSpan{};
// Size the new layer relative to the prior device, which may already be aligned for filters.
SkDevice* priorDevice = this->topDevice();
skif::Mapping newLayerMapping;
skif::LayerSpace<SkIRect> layerBounds;
std::optional<skif::ParameterSpace<SkRect>> contentBounds;
if (rec.fBounds) {
contentBounds = skif::ParameterSpace<SkRect>(*rec.fBounds);
}
auto mappingAndBounds = get_layer_mapping_and_bounds(
filters, priorDevice->localToDevice(),
skif::DeviceSpace<SkIRect>(priorDevice->devClipBounds()),
contentBounds,
must_cover_prior_device(rec.fBackdrop, restorePaint));
#else
sk_sp<SkImageFilter> paintFilter = rec.fPaint ? rec.fPaint->refImageFilter() : nullptr;
FilterSpan filters = paintFilter ? FilterSpan{&paintFilter, 1} : rec.fFilters;
if (filters.size() > kMaxFiltersPerLayer) {
filters = filters.first(kMaxFiltersPerLayer);
}
const SkColorFilter* cf = restorePaint.getColorFilter();
const SkBlender* blender = restorePaint.getBlender();
// When this is false, restoring the layer filled with unmodified prior contents should be
// identical to the prior contents, so we can restrict the layer even more than just the
// clip bounds.
bool filtersPriorDevice = rec.fBackdrop;
#if !defined(SK_LEGACY_INITWITHPREV_LAYER_SIZING)
// A regular filter applied to a layer initialized with prior contents is somewhat
// analogous to a backdrop filter so they are treated the same.
// TODO(b/314968012): Chrome needs to be updated to clip saveAlphaLayer bounds explicitly when
// it uses kInitWithPrevious and LCD text.
filtersPriorDevice |= ((rec.fSaveLayerFlags & kInitWithPrevious_SaveLayerFlag) &&
(!filters.empty() || cf || blender || restorePaint.getAlphaf() < 1.f));
#endif
// If the restorePaint has a transparency-affecting colorfilter or blender, the output is
// unbounded during restore(). `internalDrawDeviceWithFilter` automatically applies these
// effects. When there's no image filter, SkDevice::drawDevice is used, which does
// not apply effects beyond the layer's image so we mark `trivialRestore` as false too.
// TODO: drawDevice() could be updated to apply transparency-affecting effects to a content-
// clipped image, but this is the simplest solution when considering document-based SkDevices.
const bool drawDeviceMustFillClip = filters.empty() &&
((cf && as_CFB(cf)->affectsTransparentBlack()) ||
(blender && as_BB(blender)->affectsTransparentBlack()));
const bool trivialRestore = !filtersPriorDevice && !drawDeviceMustFillClip;
// Size the new layer relative to the prior device, which may already be aligned for filters.
SkDevice* priorDevice = this->topDevice();
skif::Mapping newLayerMapping;
skif::LayerSpace<SkIRect> layerBounds;
skif::DeviceSpace<SkIRect> outputBounds{priorDevice->devClipBounds()};
std::optional<skif::ParameterSpace<SkRect>> contentBounds;
// Set the bounds hint if provided and there's no further effects on prior device content
if (rec.fBounds && trivialRestore) {
contentBounds = skif::ParameterSpace<SkRect>(*rec.fBounds);
}
auto mappingAndBounds = get_layer_mapping_and_bounds(
filters, priorDevice->localToDevice(), outputBounds, contentBounds);
#endif
auto abortLayer = [this]() {
// The filtered content would not draw anything, or the new device space has an invalid
// coordinate system, in which case we mark the current top device as empty so that nothing
// draws until the canvas is restored past this saveLayer.
AutoUpdateQRBounds aqr(this);
this->topDevice()->clipRect(SkRect::MakeEmpty(), SkClipOp::kIntersect, /* aa */ false);
};
if (!mappingAndBounds) {
abortLayer();
return;
}
std::tie(newLayerMapping, layerBounds) = *mappingAndBounds;
if (layerBounds.isEmpty()) {
// The image filter graph does not require any input, so we don't need to actually render
// a new layer for the source image. This could be because the image filter itself will not
// produce output, or that the filter DAG has no references to the dynamic source image.
// In this case it still has an output that we need to render, but do so now since there is
// no new layer pushed on the stack and the paired restore() will be a no-op.
if (!filters.empty() && !priorDevice->isNoPixelsDevice()) {
#if defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE)
const SkImageFilter* filter = filters.empty() ? nullptr : filters.front().get();
skif::ParameterSpace<SkRect> emptyInput{SkRect::MakeEmpty()};
std::optional<skif::DeviceSpace<SkIRect>> output =
as_IFB(filter)->getOutputBounds(newLayerMapping, emptyInput);
if (!output || SkIRect::Intersects(SkIRect(*output), priorDevice->devClipBounds())) {
SkISize targetSize = output ? SkIRect(*output).size()
: priorDevice->devClipBounds().size();
const bool useNN = can_layer_be_drawn_as_sprite(
newLayerMapping.layerToDevice(), targetSize);
SkSamplingOptions sampling{useNN ? SkFilterMode::kNearest : SkFilterMode::kLinear};
priorDevice->drawFilteredImage(newLayerMapping,
/*src=*/nullptr,
image_filter_color_type(priorDevice->imageInfo()),
filter,
sampling,
restorePaint);
}
#else
this->internalDrawDeviceWithFilter(/*src=*/nullptr, priorDevice, filters, restorePaint,
DeviceCompatibleWithFilter::kUnknown);
#endif
}
// Regardless of if we drew the "restored" image filter or not, mark the layer as empty
// until the restore() since we don't care about any of its content.
abortLayer();
return;
} else {
#if !defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE) && !defined(SK_DONT_PAD_LAYER_IMAGES)
// TODO(b/329700315): Once dithers can be anchored more flexibly, we can return to
// universally adding padding even for layers w/o filters. This change would simplify layer
// prep and restore logic and allow us to flexibly switch the sampling to linear if NN has
// issues on certain hardware.
if (!filters.empty()) {
// Add a buffer of padding so that image filtering can avoid accessing unitialized data
// and switch from shader-decal'ing to clamping.
layerBounds.outset(skif::LayerSpace<SkISize>({1, 1}));
}
#endif
}
sk_sp<SkDevice> newDevice;
if (strategy == kFullLayer_SaveLayerStrategy) {
SkASSERT(!layerBounds.isEmpty());
SkColorType layerColorType;
if (coverageOnly) {
layerColorType = kAlpha_8_SkColorType;
} else {
layerColorType = SkToBool(rec.fSaveLayerFlags & kF16ColorType)
? kRGBA_F16_SkColorType
: image_filter_color_type(priorDevice->imageInfo());
}
SkImageInfo info = SkImageInfo::Make(layerBounds.width(), layerBounds.height(),
layerColorType, kPremul_SkAlphaType,
priorDevice->imageInfo().refColorSpace());
SkPixelGeometry geo = rec.fSaveLayerFlags & kPreserveLCDText_SaveLayerFlag
? fProps.pixelGeometry()
: kUnknown_SkPixelGeometry;
const auto createInfo = SkDevice::CreateInfo(info, geo, fAllocator.get());
// Use the original paint as a hint so that it includes the image filter
newDevice = priorDevice->createDevice(createInfo, rec.fPaint);
}
bool initBackdrop = (rec.fSaveLayerFlags & kInitWithPrevious_SaveLayerFlag) || rec.fBackdrop;
if (!newDevice) {
// Either we weren't meant to allocate a full layer, or the full layer creation failed.
// Using an explicit NoPixelsDevice lets us reflect what the layer state would have been
// on success (or kFull_LayerStrategy) while squashing draw calls that target something that
// doesn't exist.
newDevice = sk_make_sp<SkNoPixelsDevice>(SkIRect::MakeWH(layerBounds.width(),
layerBounds.height()),
fProps, this->imageInfo().refColorSpace());
initBackdrop = false;
}
#if !defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE) && !defined(SK_DONT_PAD_LAYER_IMAGES)
// Clip while the device coordinate space is the identity so it's easy to define the rect that
// excludes the added padding pixels. This ensures they remain cleared to transparent black.
if (!filters.empty()) {
newDevice->clipRect(SkRect::Make(newDevice->devClipBounds().makeInset(1, 1)),
SkClipOp::kIntersect, /*aa=*/false);
}
#endif
// Configure device to match determined mapping for any image filters.
// The setDeviceCoordinateSystem applies the prior device's global transform since
// 'newLayerMapping' only defines the transforms between the two devices and it must be updated
// to the global coordinate system.
newDevice->setDeviceCoordinateSystem(
priorDevice->deviceToGlobal() * SkM44(newLayerMapping.layerToDevice()),
SkM44(newLayerMapping.deviceToLayer()) * priorDevice->globalToDevice(),
SkM44(newLayerMapping.layerMatrix()),
layerBounds.left(),
layerBounds.top());
if (initBackdrop) {
SkASSERT(!coverageOnly);
SkPaint backdropPaint;
#if defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE)
const SkImageFilter* backdropFilter = optimize_layer_filter(rec.fBackdrop, &backdropPaint);
#else
const SkImageFilter* backdropFilter = rec.fBackdrop;
#endif
FilterToSpan backdropAsSpan(backdropFilter);
// The new device was constructed to be compatible with 'filter', not necessarily
// 'rec.fBackdrop', so allow DrawDeviceWithFilter to transform the prior device contents
// if necessary to evaluate the backdrop filter. If no filters are involved, then the
// devices differ by integer translations and are always compatible.
bool scaleBackdrop = rec.fExperimentalBackdropScale != 1.0f;
auto compat = (!filters.empty() || backdropFilter || scaleBackdrop)
? DeviceCompatibleWithFilter::kUnknown : DeviceCompatibleWithFilter::kYes;
this->internalDrawDeviceWithFilter(priorDevice, // src
newDevice.get(), // dst
backdropAsSpan,
backdropPaint,
compat,
rec.fExperimentalBackdropScale);
}
fMCRec->newLayer(std::move(newDevice), filters, restorePaint, coverageOnly);
fQuickRejectBounds = this->computeDeviceClipBounds();
}
int SkCanvas::saveLayerAlphaf(const SkRect* bounds, float alpha) {
if (alpha >= 1.0f) {
return this->saveLayer(bounds, nullptr);
} else {
SkPaint tmpPaint;
tmpPaint.setAlphaf(alpha);
return this->saveLayer(bounds, &tmpPaint);
}
}
void SkCanvas::internalSaveBehind(const SkRect* localBounds) {
SkDevice* device = this->topDevice();
// Map the local bounds into the top device's coordinate space (this is not
// necessarily the full global CTM transform).
SkIRect devBounds;
if (localBounds) {
SkRect tmp;
device->localToDevice().mapRect(&tmp, *localBounds);
if (!devBounds.intersect(tmp.round(), device->devClipBounds())) {
devBounds.setEmpty();
}
} else {
devBounds = device->devClipBounds();
}
if (devBounds.isEmpty()) {
return;
}
// This is getting the special image from the current device, which is then drawn into (both by
// a client, and the drawClippedToSaveBehind below). Since this is not saving a layer, with its
// own device, we need to explicitly copy the back image contents so that its original content
// is available when we splat it back later during restore.
auto backImage = device->snapSpecial(devBounds, /* forceCopy= */ true);
if (!backImage) {
return;
}
// we really need the save, so we can wack the fMCRec
this->checkForDeferredSave();
fMCRec->fBackImage =
std::make_unique<BackImage>(BackImage{std::move(backImage), devBounds.topLeft()});
SkPaint paint;
paint.setBlendMode(SkBlendMode::kClear);
this->drawClippedToSaveBehind(paint);
}
void SkCanvas::internalRestore() {
SkASSERT(!fMCStack.empty());
// now detach these from fMCRec so we can pop(). Gets freed after its drawn
std::unique_ptr<Layer> layer = std::move(fMCRec->fLayer);
std::unique_ptr<BackImage> backImage = std::move(fMCRec->fBackImage);
// now do the normal restore()
fMCRec->~MCRec(); // balanced in save()
fMCStack.pop_back();
fMCRec = (MCRec*) fMCStack.back();
if (!fMCRec) {
// This was the last record, restored during the destruction of the SkCanvas
return;
}
this->topDevice()->popClipStack();
this->topDevice()->setGlobalCTM(fMCRec->fMatrix);
if (backImage) {
SkPaint paint;
paint.setBlendMode(SkBlendMode::kDstOver);
this->topDevice()->drawSpecial(backImage->fImage.get(),
SkMatrix::Translate(backImage->fLoc),
SkSamplingOptions(),
paint);
}
// Draw the layer's device contents into the now-current older device. We can't call public
// draw functions since we don't want to record them.
if (layer && !layer->fDevice->isNoPixelsDevice() && !layer->fDiscard) {
layer->fDevice->setImmutable();
// Don't go through AutoLayerForImageFilter since device draws are so closely tied to
// internalSaveLayer and internalRestore.
if (this->predrawNotify()) {
SkDevice* dstDev = this->topDevice();
if (!layer->fImageFilters.empty()) {
this->internalDrawDeviceWithFilter(layer->fDevice.get(), // src
dstDev, // dst
layer->fImageFilters,
layer->fPaint,
DeviceCompatibleWithFilter::kYes,
/*scaleFactor=*/1.0f,
layer->fIsCoverage);
} else {
// NOTE: We don't just call internalDrawDeviceWithFilter with a null filter
// because we want to take advantage of overridden drawDevice functions for
// document-based devices.
SkASSERT(!layer->fIsCoverage);
SkSamplingOptions sampling;
dstDev->drawDevice(layer->fDevice.get(), sampling, layer->fPaint);
}
}
}
// Reset the clip restriction if the restore went past the save point that had added it.
if (this->getSaveCount() < fClipRestrictionSaveCount) {
fClipRestrictionRect.setEmpty();
fClipRestrictionSaveCount = -1;
}
// Update the quick-reject bounds in case the restore changed the top device or the
// removed save record had included modifications to the clip stack.
fQuickRejectBounds = this->computeDeviceClipBounds();
this->validateClip();
}
sk_sp<SkSurface> SkCanvas::makeSurface(const SkImageInfo& info, const SkSurfaceProps* props) {
if (nullptr == props) {
props = &fProps;
}
return this->onNewSurface(info, *props);
}
sk_sp<SkSurface> SkCanvas::onNewSurface(const SkImageInfo& info, const SkSurfaceProps& props) {
return this->rootDevice()->makeSurface(info, props);
}
SkImageInfo SkCanvas::imageInfo() const {
return this->onImageInfo();
}
SkImageInfo SkCanvas::onImageInfo() const {
return this->rootDevice()->imageInfo();
}
bool SkCanvas::getProps(SkSurfaceProps* props) const {
return this->onGetProps(props, /*top=*/false);
}
SkSurfaceProps SkCanvas::getBaseProps() const {
SkSurfaceProps props;
this->onGetProps(&props, /*top=*/false);
return props;
}
SkSurfaceProps SkCanvas::getTopProps() const {
SkSurfaceProps props;
this->onGetProps(&props, /*top=*/true);
return props;
}
bool SkCanvas::onGetProps(SkSurfaceProps* props, bool top) const {
if (props) {
*props = top ? topDevice()->surfaceProps() : fProps;
}
return true;
}
bool SkCanvas::peekPixels(SkPixmap* pmap) {
return this->onPeekPixels(pmap);
}
bool SkCanvas::onPeekPixels(SkPixmap* pmap) {
return this->rootDevice()->peekPixels(pmap);
}
void* SkCanvas::accessTopLayerPixels(SkImageInfo* info, size_t* rowBytes, SkIPoint* origin) {
SkPixmap pmap;
if (!this->onAccessTopLayerPixels(&pmap)) {
return nullptr;
}
if (info) {
*info = pmap.info();
}
if (rowBytes) {
*rowBytes = pmap.rowBytes();
}
if (origin) {
// If the caller requested the origin, they presumably are expecting the returned pixels to
// be axis-aligned with the root canvas. If the top level device isn't axis aligned, that's
// not the case. Until we update accessTopLayerPixels() to accept a coord space matrix
// instead of an origin, just don't expose the pixels in that case. Note that this means
// that layers with complex coordinate spaces can still report their pixels if the caller
// does not ask for the origin (e.g. just to dump its output to a file, etc).
if (this->topDevice()->isPixelAlignedToGlobal()) {
*origin = this->topDevice()->getOrigin();
} else {
return nullptr;
}
}
return pmap.writable_addr();
}
bool SkCanvas::onAccessTopLayerPixels(SkPixmap* pmap) {
return this->topDevice()->accessPixels(pmap);
}
/////////////////////////////////////////////////////////////////////////////
void SkCanvas::translate(SkScalar dx, SkScalar dy) {
if (dx || dy) {
this->checkForDeferredSave();
fMCRec->fMatrix.preTranslate(dx, dy);
this->topDevice()->setGlobalCTM(fMCRec->fMatrix);
this->didTranslate(dx,dy);
}
}
void SkCanvas::scale(SkScalar sx, SkScalar sy) {
if (sx != 1 || sy != 1) {
this->checkForDeferredSave();
fMCRec->fMatrix.preScale(sx, sy);
this->topDevice()->setGlobalCTM(fMCRec->fMatrix);
this->didScale(sx, sy);
}
}
void SkCanvas::rotate(SkScalar degrees) {
SkMatrix m;
m.setRotate(degrees);
this->concat(m);
}
void SkCanvas::rotate(SkScalar degrees, SkScalar px, SkScalar py) {
SkMatrix m;
m.setRotate(degrees, px, py);
this->concat(m);
}
void SkCanvas::skew(SkScalar sx, SkScalar sy) {
SkMatrix m;
m.setSkew(sx, sy);
this->concat(m);
}
void SkCanvas::concat(const SkMatrix& matrix) {
if (matrix.isIdentity()) {
return;
}
this->concat(SkM44(matrix));
}
void SkCanvas::internalConcat44(const SkM44& m) {
this->checkForDeferredSave();
fMCRec->fMatrix.preConcat(m);
this->topDevice()->setGlobalCTM(fMCRec->fMatrix);
}
void SkCanvas::concat(const SkM44& m) {
this->internalConcat44(m);
// notify subclasses
this->didConcat44(m);
}
void SkCanvas::internalSetMatrix(const SkM44& m) {
fMCRec->fMatrix = m;
this->topDevice()->setGlobalCTM(fMCRec->fMatrix);
}
void SkCanvas::setMatrix(const SkMatrix& matrix) {
this->setMatrix(SkM44(matrix));
}
void SkCanvas::setMatrix(const SkM44& m) {
this->checkForDeferredSave();
this->internalSetMatrix(m);
this->didSetM44(m);
}
void SkCanvas::resetMatrix() {
this->setMatrix(SkM44());
}
//////////////////////////////////////////////////////////////////////////////
void SkCanvas::clipRect(const SkRect& rect, SkClipOp op, bool doAA) {
if (!rect.isFinite()) {
return;
}
this->checkForDeferredSave();
ClipEdgeStyle edgeStyle = doAA ? kSoft_ClipEdgeStyle : kHard_ClipEdgeStyle;
this->onClipRect(rect.makeSorted(), op, edgeStyle);
}
void SkCanvas::onClipRect(const SkRect& rect, SkClipOp op, ClipEdgeStyle edgeStyle) {
SkASSERT(rect.isSorted());
const bool isAA = kSoft_ClipEdgeStyle == edgeStyle;
AutoUpdateQRBounds aqr(this);
this->topDevice()->clipRect(rect, op, isAA);
}
void SkCanvas::androidFramework_setDeviceClipRestriction(const SkIRect& rect) {
// The device clip restriction is a surface-space rectangular intersection that cannot be
// drawn outside of. The rectangle is remembered so that subsequent resetClip calls still
// respect the restriction. Other than clip resetting, all clip operations restrict the set
// of renderable pixels, so once set, the restriction will be respected until the canvas
// save stack is restored past the point this function was invoked. Unfortunately, the current
// implementation relies on the clip stack of the underyling SkDevices, which leads to some
// awkward behavioral interactions (see skbug.com/12252).
//
// Namely, a canvas restore() could undo the clip restriction's rect, and if
// setDeviceClipRestriction were called at a nested save level, there's no way to undo just the
// prior restriction and re-apply the new one. It also only makes sense to apply to the base
// device; any other device for a saved layer will be clipped back to the base device during its
// matched restore. As such, we:
// - Remember the save count that added the clip restriction and reset the rect to empty when
// we've restored past that point to keep our state in sync with the device's clip stack.
// - We assert that we're on the base device when this is invoked.
// - We assert that setDeviceClipRestriction() is only called when there was no prior
// restriction (cannot re-restrict, and prior state must have been reset by restoring the
// canvas state).
// - Historically, the empty rect would reset the clip restriction but it only could do so
// partially since the device's clips wasn't adjusted. Resetting is now handled
// automatically via SkCanvas::restore(), so empty input rects are skipped.
SkASSERT(this->topDevice() == this->rootDevice()); // shouldn't be in a nested layer
// and shouldn't already have a restriction
SkASSERT(fClipRestrictionSaveCount < 0 && fClipRestrictionRect.isEmpty());
if (fClipRestrictionSaveCount < 0 && !rect.isEmpty()) {
fClipRestrictionRect = rect;
fClipRestrictionSaveCount = this->getSaveCount();
// A non-empty clip restriction immediately applies an intersection op (ignoring the ctm).
// so we have to resolve the save.
this->checkForDeferredSave();
AutoUpdateQRBounds aqr(this);
// Use clipRegion() since that operates in canvas-space, whereas clipRect() would apply the
// device's current transform first.
this->topDevice()->clipRegion(SkRegion(rect), SkClipOp::kIntersect);
}
}
void SkCanvas::internal_private_resetClip() {
this->checkForDeferredSave();
this->onResetClip();
}
void SkCanvas::onResetClip() {
SkIRect deviceRestriction = this->topDevice()->imageInfo().bounds();
if (fClipRestrictionSaveCount >= 0 && this->topDevice() == this->rootDevice()) {
// Respect the device clip restriction when resetting the clip if we're on the base device.
// If we're not on the base device, then the "reset" applies to the top device's clip stack,
// and the clip restriction will be respected automatically during a restore of the layer.
if (!deviceRestriction.intersect(fClipRestrictionRect)) {
deviceRestriction = SkIRect::MakeEmpty();
}
}
AutoUpdateQRBounds aqr(this);
this->topDevice()->replaceClip(deviceRestriction);
}
void SkCanvas::clipRRect(const SkRRect& rrect, SkClipOp op, bool doAA) {
this->checkForDeferredSave();
ClipEdgeStyle edgeStyle = doAA ? kSoft_ClipEdgeStyle : kHard_ClipEdgeStyle;
if (rrect.isRect()) {
this->onClipRect(rrect.getBounds(), op, edgeStyle);
} else {
this->onClipRRect(rrect, op, edgeStyle);
}
}
void SkCanvas::onClipRRect(const SkRRect& rrect, SkClipOp op, ClipEdgeStyle edgeStyle) {
bool isAA = kSoft_ClipEdgeStyle == edgeStyle;
AutoUpdateQRBounds aqr(this);
this->topDevice()->clipRRect(rrect, op, isAA);
}
void SkCanvas::clipPath(const SkPath& path, SkClipOp op, bool doAA) {
this->checkForDeferredSave();
ClipEdgeStyle edgeStyle = doAA ? kSoft_ClipEdgeStyle : kHard_ClipEdgeStyle;
if (!path.isInverseFillType() && fMCRec->fMatrix.asM33().rectStaysRect()) {
SkRect r;
if (path.isRect(&r)) {
this->onClipRect(r, op, edgeStyle);
return;
}
SkRRect rrect;
if (path.isOval(&r)) {
rrect.setOval(r);
this->onClipRRect(rrect, op, edgeStyle);
return;
}
if (path.isRRect(&rrect)) {
this->onClipRRect(rrect, op, edgeStyle);
return;
}
}
this->onClipPath(path, op, edgeStyle);
}
void SkCanvas::onClipPath(const SkPath& path, SkClipOp op, ClipEdgeStyle edgeStyle) {
bool isAA = kSoft_ClipEdgeStyle == edgeStyle;
AutoUpdateQRBounds aqr(this);
this->topDevice()->clipPath(path, op, isAA);
}
void SkCanvas::clipShader(sk_sp<SkShader> sh, SkClipOp op) {
if (sh) {
if (sh->isOpaque()) {
if (op == SkClipOp::kIntersect) {
// we don't occlude anything, so skip this call
} else {
SkASSERT(op == SkClipOp::kDifference);
// we occlude everything, so set the clip to empty
this->clipRect({0,0,0,0});
}
} else {
this->checkForDeferredSave();
this->onClipShader(std::move(sh), op);
}
}
}
void SkCanvas::onClipShader(sk_sp<SkShader> sh, SkClipOp op) {
AutoUpdateQRBounds aqr(this);
this->topDevice()->clipShader(sh, op);
}
void SkCanvas::clipRegion(const SkRegion& rgn, SkClipOp op) {
this->checkForDeferredSave();
this->onClipRegion(rgn, op);
}
void SkCanvas::onClipRegion(const SkRegion& rgn, SkClipOp op) {
AutoUpdateQRBounds aqr(this);
this->topDevice()->clipRegion(rgn, op);
}
void SkCanvas::validateClip() const {
#ifdef SK_DEBUG
SkRect tmp = this->computeDeviceClipBounds();
if (this->isClipEmpty()) {
SkASSERT(fQuickRejectBounds.isEmpty());
} else {
SkASSERT(tmp == fQuickRejectBounds);
}
#endif
}
bool SkCanvas::androidFramework_isClipAA() const {
return this->topDevice()->isClipAntiAliased();
}
void SkCanvas::temporary_internal_getRgnClip(SkRegion* rgn) {
rgn->setEmpty();
SkDevice* device = this->topDevice();
if (device && device->isPixelAlignedToGlobal()) {
device->android_utils_clipAsRgn(rgn);
SkIPoint origin = device->getOrigin();
if (origin.x() | origin.y()) {
rgn->translate(origin.x(), origin.y());
}
}
}
///////////////////////////////////////////////////////////////////////////////
bool SkCanvas::isClipEmpty() const {
return this->topDevice()->isClipEmpty();
}
bool SkCanvas::isClipRect() const {
return this->topDevice()->isClipRect();
}
bool SkCanvas::quickReject(const SkRect& src) const {
#ifdef SK_DEBUG
// Verify that fQuickRejectBounds are set properly.
this->validateClip();
#endif
SkRect devRect = SkMatrixPriv::MapRect(fMCRec->fMatrix, src);
return !devRect.isFinite() || !devRect.intersects(fQuickRejectBounds);
}
bool SkCanvas::quickReject(const SkPath& path) const {
return path.isEmpty() || this->quickReject(path.getBounds());
}
bool SkCanvas::internalQuickReject(const SkRect& bounds, const SkPaint& paint,
const SkMatrix* matrix) {
if (!bounds.isFinite() || paint.nothingToDraw()) {
return true;
}
if (paint.canComputeFastBounds()) {
SkRect tmp = matrix ? matrix->mapRect(bounds) : bounds;
return this->quickReject(paint.computeFastBounds(tmp, &tmp));
}
return false;
}
SkRect SkCanvas::getLocalClipBounds() const {
SkIRect ibounds = this->getDeviceClipBounds();
if (ibounds.isEmpty()) {
return SkRect::MakeEmpty();
}
SkMatrix inverse;
// if we can't invert the CTM, we can't return local clip bounds
if (!fMCRec->fMatrix.asM33().invert(&inverse)) {
return SkRect::MakeEmpty();
}
SkRect bounds;
// adjust it outwards in case we are antialiasing
const int margin = 1;
SkRect r = SkRect::Make(ibounds.makeOutset(margin, margin));
inverse.mapRect(&bounds, r);
return bounds;
}
SkIRect SkCanvas::getDeviceClipBounds() const {
return this->computeDeviceClipBounds(/*outsetForAA=*/false).roundOut();
}
SkRect SkCanvas::computeDeviceClipBounds(bool outsetForAA) const {
const SkDevice* dev = this->topDevice();
if (dev->isClipEmpty()) {
return SkRect::MakeEmpty();
} else {
SkRect devClipBounds =
SkMatrixPriv::MapRect(dev->deviceToGlobal(), SkRect::Make(dev->devClipBounds()));
if (outsetForAA) {
// Expand bounds out by 1 in case we are anti-aliasing. We store the
// bounds as floats to enable a faster quick reject implementation.
devClipBounds.outset(1.f, 1.f);
}
return devClipBounds;
}
}
///////////////////////////////////////////////////////////////////////
SkMatrix SkCanvas::getTotalMatrix() const {
return fMCRec->fMatrix.asM33();
}
SkM44 SkCanvas::getLocalToDevice() const {
return fMCRec->fMatrix;
}
GrRecordingContext* SkCanvas::recordingContext() const {
return this->topDevice()->recordingContext();
}
skgpu::graphite::Recorder* SkCanvas::recorder() const {
return this->topDevice()->recorder();
}
void SkCanvas::drawDRRect(const SkRRect& outer, const SkRRect& inner,
const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
if (outer.isEmpty()) {
return;
}
if (inner.isEmpty()) {
this->drawRRect(outer, paint);
return;
}
// We don't have this method (yet), but technically this is what we should
// be able to return ...
// if (!outer.contains(inner))) {
//
// For now at least check for containment of bounds
if (!outer.getBounds().contains(inner.getBounds())) {
return;
}
this->onDrawDRRect(outer, inner, paint);
}
void SkCanvas::drawPaint(const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
this->onDrawPaint(paint);
}
void SkCanvas::drawRect(const SkRect& r, const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
// To avoid redundant logic in our culling code and various backends, we always sort rects
// before passing them along.
this->onDrawRect(r.makeSorted(), paint);
}
void SkCanvas::drawClippedToSaveBehind(const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
this->onDrawBehind(paint);
}
void SkCanvas::drawRegion(const SkRegion& region, const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
if (region.isEmpty()) {
return;
}
if (region.isRect()) {
return this->drawIRect(region.getBounds(), paint);
}
this->onDrawRegion(region, paint);
}
void SkCanvas::drawOval(const SkRect& r, const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
// To avoid redundant logic in our culling code and various backends, we always sort rects
// before passing them along.
this->onDrawOval(r.makeSorted(), paint);
}
void SkCanvas::drawRRect(const SkRRect& rrect, const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
this->onDrawRRect(rrect, paint);
}
void SkCanvas::drawPoints(PointMode mode, size_t count, const SkPoint pts[], const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
this->onDrawPoints(mode, count, pts, paint);
}
void SkCanvas::drawVertices(const sk_sp<SkVertices>& vertices, SkBlendMode mode,
const SkPaint& paint) {
this->drawVertices(vertices.get(), mode, paint);
}
void SkCanvas::drawVertices(const SkVertices* vertices, SkBlendMode mode, const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
RETURN_ON_NULL(vertices);
// We expect fans to be converted to triangles when building or deserializing SkVertices.
SkASSERT(vertices->priv().mode() != SkVertices::kTriangleFan_VertexMode);
#ifdef SK_BUILD_FOR_ANDROID_FRAMEWORK
// Preserve legacy behavior for Android: ignore the SkShader if there are no texCoords present
if (paint.getShader() && !vertices->priv().hasTexCoords()) {
SkPaint noShaderPaint(paint);
noShaderPaint.setShader(nullptr);
this->onDrawVerticesObject(vertices, mode, noShaderPaint);
return;
}
#endif
this->onDrawVerticesObject(vertices, mode, paint);
}
void SkCanvas::drawMesh(const SkMesh& mesh, sk_sp<SkBlender> blender, const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
if (!blender) {
blender = SkBlender::Mode(SkBlendMode::kModulate);
}
this->onDrawMesh(mesh, std::move(blender), paint);
}
void SkCanvas::drawPath(const SkPath& path, const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
this->onDrawPath(path, paint);
}
// Returns true if the rect can be "filled" : non-empty and finite
static bool fillable(const SkRect& r) {
SkScalar w = r.width();
SkScalar h = r.height();
return SkScalarIsFinite(w) && w > 0 && SkScalarIsFinite(h) && h > 0;
}
static SkPaint clean_paint_for_lattice(const SkPaint* paint) {
SkPaint cleaned;
if (paint) {
cleaned = *paint;
cleaned.setMaskFilter(nullptr);
cleaned.setAntiAlias(false);
}
return cleaned;
}
void SkCanvas::drawImageNine(const SkImage* image, const SkIRect& center, const SkRect& dst,
SkFilterMode filter, const SkPaint* paint) {
RETURN_ON_NULL(image);
const int xdivs[] = {center.fLeft, center.fRight};
const int ydivs[] = {center.fTop, center.fBottom};
Lattice lat;
lat.fXDivs = xdivs;
lat.fYDivs = ydivs;
lat.fRectTypes = nullptr;
lat.fXCount = lat.fYCount = 2;
lat.fBounds = nullptr;
lat.fColors = nullptr;
this->drawImageLattice(image, lat, dst, filter, paint);
}
void SkCanvas::drawImageLattice(const SkImage* image, const Lattice& lattice, const SkRect& dst,
SkFilterMode filter, const SkPaint* paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
RETURN_ON_NULL(image);
if (dst.isEmpty()) {
return;
}
SkIRect bounds;
Lattice latticePlusBounds = lattice;
if (!latticePlusBounds.fBounds) {
bounds = SkIRect::MakeWH(image->width(), image->height());
latticePlusBounds.fBounds = &bounds;
}
SkPaint latticePaint = clean_paint_for_lattice(paint);
if (SkLatticeIter::Valid(image->width(), image->height(), latticePlusBounds)) {
this->onDrawImageLattice2(image, latticePlusBounds, dst, filter, &latticePaint);
} else {
this->drawImageRect(image, SkRect::MakeIWH(image->width(), image->height()), dst,
SkSamplingOptions(filter), &latticePaint, kStrict_SrcRectConstraint);
}
}
void SkCanvas::drawAtlas(const SkImage* atlas, const SkRSXform xform[], const SkRect tex[],
const SkColor colors[], int count, SkBlendMode mode,
const SkSamplingOptions& sampling, const SkRect* cull,
const SkPaint* paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
RETURN_ON_NULL(atlas);
if (count <= 0) {
return;
}
SkASSERT(atlas);
SkASSERT(tex);
this->onDrawAtlas2(atlas, xform, tex, colors, count, mode, sampling, cull, paint);
}
void SkCanvas::drawAnnotation(const SkRect& rect, const char key[], SkData* value) {
TRACE_EVENT0("skia", TRACE_FUNC);
if (key) {
this->onDrawAnnotation(rect, key, value);
}
}
void SkCanvas::private_draw_shadow_rec(const SkPath& path, const SkDrawShadowRec& rec) {
TRACE_EVENT0("skia", TRACE_FUNC);
this->onDrawShadowRec(path, rec);
}
void SkCanvas::onDrawShadowRec(const SkPath& path, const SkDrawShadowRec& rec) {
// We don't test quickReject because the shadow outsets the path's bounds.
// TODO(michaelludwig): Is it worth calling SkDrawShadowMetrics::GetLocalBounds here?
if (!this->predrawNotify()) {
return;
}
this->topDevice()->drawShadow(path, rec);
}
void SkCanvas::experimental_DrawEdgeAAQuad(const SkRect& rect, const SkPoint clip[4],
QuadAAFlags aaFlags, const SkColor4f& color,
SkBlendMode mode) {
TRACE_EVENT0("skia", TRACE_FUNC);
// Make sure the rect is sorted before passing it along
this->onDrawEdgeAAQuad(rect.makeSorted(), clip, aaFlags, color, mode);
}
void SkCanvas::experimental_DrawEdgeAAImageSet(const ImageSetEntry imageSet[], int cnt,
const SkPoint dstClips[],
const SkMatrix preViewMatrices[],
const SkSamplingOptions& sampling,
const SkPaint* paint,
SrcRectConstraint constraint) {
TRACE_EVENT0("skia", TRACE_FUNC);
#if !defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE)
// Route single, rectangular quads to drawImageRect() to take advantage of image filter
// optimizations that avoid a layer.
if (paint && paint->getImageFilter() && cnt == 1) {
const auto& entry = imageSet[0];
// If the preViewMatrix is skipped or a positive-scale + translate matrix, we can apply it
// to the entry's dstRect w/o changing output behavior.
const bool canMapDstRect = entry.fMatrixIndex < 0 ||
(preViewMatrices[entry.fMatrixIndex].isScaleTranslate() &&
preViewMatrices[entry.fMatrixIndex].getScaleX() > 0.f &&
preViewMatrices[entry.fMatrixIndex].getScaleY() > 0.f);
if (!entry.fHasClip && canMapDstRect) {
SkRect dst = entry.fDstRect;
if (entry.fMatrixIndex >= 0) {
preViewMatrices[entry.fMatrixIndex].mapRect(&dst);
}
this->drawImageRect(entry.fImage.get(), entry.fSrcRect, dst,
sampling, paint, constraint);
return;
} // Else the entry is doing more than can be represented by drawImageRect
} // Else no filter, or many entries that should be filtered together
#endif
this->onDrawEdgeAAImageSet2(imageSet, cnt, dstClips, preViewMatrices, sampling, paint,
constraint);
}
//////////////////////////////////////////////////////////////////////////////
// These are the virtual drawing methods
//////////////////////////////////////////////////////////////////////////////
void SkCanvas::onDiscard() {
if (fSurfaceBase) {
sk_ignore_unused_variable(fSurfaceBase->aboutToDraw(SkSurface::kDiscard_ContentChangeMode));
}
}
void SkCanvas::onDrawPaint(const SkPaint& paint) {
this->internalDrawPaint(paint);
}
void SkCanvas::internalDrawPaint(const SkPaint& paint) {
// drawPaint does not call internalQuickReject() because computing its geometry is not free
// (see getLocalClipBounds(), and the two conditions below are sufficient.
if (paint.nothingToDraw() || this->isClipEmpty()) {
return;
}
auto layer = this->aboutToDraw(paint, nullptr, PredrawFlags::kCheckForOverwrite);
if (layer) {
this->topDevice()->drawPaint(layer->paint());
}
}
void SkCanvas::onDrawPoints(PointMode mode, size_t count, const SkPoint pts[],
const SkPaint& paint) {
if ((long)count <= 0 || paint.nothingToDraw()) {
return;
}
SkASSERT(pts != nullptr);
SkRect bounds;
// Compute bounds from points (common for drawing a single line)
if (count == 2) {
bounds.set(pts[0], pts[1]);
} else {
bounds.setBounds(pts, SkToInt(count));
}
// Enforce paint style matches implicit behavior of drawPoints
SkPaint strokePaint = paint;
strokePaint.setStyle(SkPaint::kStroke_Style);
if (this->internalQuickReject(bounds, strokePaint)) {
return;
}
auto layer = this->aboutToDraw(strokePaint, &bounds);
if (layer) {
this->topDevice()->drawPoints(mode, count, pts, layer->paint());
}
}
void SkCanvas::onDrawRect(const SkRect& r, const SkPaint& paint) {
SkASSERT(r.isSorted());
if (this->internalQuickReject(r, paint)) {
return;
}
auto layer = this->aboutToDraw(paint, &r, PredrawFlags::kCheckForOverwrite);
if (layer) {
this->topDevice()->drawRect(r, layer->paint());
}
}
void SkCanvas::onDrawRegion(const SkRegion& region, const SkPaint& paint) {
const SkRect bounds = SkRect::Make(region.getBounds());
if (this->internalQuickReject(bounds, paint)) {
return;
}
auto layer = this->aboutToDraw(paint, &bounds);
if (layer) {
this->topDevice()->drawRegion(region, layer->paint());
}
}
void SkCanvas::onDrawBehind(const SkPaint& paint) {
SkDevice* dev = this->topDevice();
if (!dev) {
return;
}
SkIRect bounds;
SkDeque::Iter iter(fMCStack, SkDeque::Iter::kBack_IterStart);
for (;;) {
const MCRec* rec = (const MCRec*)iter.prev();
if (!rec) {
return; // no backimages, so nothing to draw
}
if (rec->fBackImage) {
// drawBehind should only have been called when the saveBehind record is active;
// if this fails, it means a real saveLayer was made w/o being restored first.
SkASSERT(dev == rec->fDevice);
bounds = SkIRect::MakeXYWH(rec->fBackImage->fLoc.fX, rec->fBackImage->fLoc.fY,
rec->fBackImage->fImage->width(),
rec->fBackImage->fImage->height());
break;
}
}
// The backimage location (and thus bounds) were defined in the device's space, so mark it
// as a clip. We use a clip instead of just drawing a rect in case the paint has an image
// filter on it (which is applied before any auto-layer so the filter is clipped).
dev->pushClipStack();
{
// We also have to temporarily whack the device matrix since clipRegion is affected by the
// global-to-device matrix and clipRect is affected by the local-to-device.
SkAutoDeviceTransformRestore adtr(dev, SkMatrix::I());
dev->clipRect(SkRect::Make(bounds), SkClipOp::kIntersect, /* aa */ false);
// ~adtr will reset the local-to-device matrix so that drawPaint() shades correctly.
}
auto layer = this->aboutToDraw(paint);
if (layer) {
this->topDevice()->drawPaint(layer->paint());
}
dev->popClipStack();
}
void SkCanvas::onDrawOval(const SkRect& oval, const SkPaint& paint) {
SkASSERT(oval.isSorted());
if (this->internalQuickReject(oval, paint)) {
return;
}
auto layer = this->aboutToDraw(paint, &oval);
if (layer) {
this->topDevice()->drawOval(oval, layer->paint());
}
}
void SkCanvas::onDrawArc(const SkRect& oval, SkScalar startAngle,
SkScalar sweepAngle, bool useCenter,
const SkPaint& paint) {
SkASSERT(oval.isSorted());
if (this->internalQuickReject(oval, paint)) {
return;
}
auto layer = this->aboutToDraw(paint, &oval);
if (layer) {
this->topDevice()->drawArc(oval, startAngle, sweepAngle, useCenter, layer->paint());
}
}
void SkCanvas::onDrawRRect(const SkRRect& rrect, const SkPaint& paint) {
const SkRect& bounds = rrect.getBounds();
// Delegating to simpler draw operations
if (rrect.isRect()) {
// call the non-virtual version
this->SkCanvas::drawRect(bounds, paint);
return;
} else if (rrect.isOval()) {
// call the non-virtual version
this->SkCanvas::drawOval(bounds, paint);
return;
}
if (this->internalQuickReject(bounds, paint)) {
return;
}
auto layer = this->aboutToDraw(paint, &bounds);
if (layer) {
this->topDevice()->drawRRect(rrect, layer->paint());
}
}
void SkCanvas::onDrawDRRect(const SkRRect& outer, const SkRRect& inner, const SkPaint& paint) {
const SkRect& bounds = outer.getBounds();
if (this->internalQuickReject(bounds, paint)) {
return;
}
auto layer = this->aboutToDraw(paint, &bounds);
if (layer) {
this->topDevice()->drawDRRect(outer, inner, layer->paint());
}
}
void SkCanvas::onDrawPath(const SkPath& path, const SkPaint& paint) {
if (!path.isFinite()) {
return;
}
const SkRect& pathBounds = path.getBounds();
if (!path.isInverseFillType() && this->internalQuickReject(pathBounds, paint)) {
return;
}
if (path.isInverseFillType() && pathBounds.width() <= 0 && pathBounds.height() <= 0) {
this->internalDrawPaint(paint);
return;
}
auto layer = this->aboutToDraw(paint, path.isInverseFillType() ? nullptr : &pathBounds);
if (layer) {
this->topDevice()->drawPath(path, layer->paint());
}
}
// TODO: Delete this once SK_RESOLVE_FILTERS_BEFORE_RESTORE is unneeded
bool SkCanvas::canDrawBitmapAsSprite(SkScalar x, SkScalar y, int w, int h,
const SkSamplingOptions& sampling, const SkPaint& paint) {
#if defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE)
if (!paint.getImageFilter()) {
return false;
}
const SkMatrix& ctm = this->getTotalMatrix();
if (!SkTreatAsSprite(ctm, SkISize::Make(w, h), sampling, paint.isAntiAlias())) {
return false;
}
// The other paint effects need to be applied before the image filter, but the sprite draw
// applies the filter explicitly first.
if (paint.getAlphaf() < 1.f || paint.getColorFilter() || paint.getMaskFilter()) {
return false;
}
// Currently we can only use the filterSprite code if we are clipped to the bitmap's bounds.
// Once we can filter and the filter will return a result larger than itself, we should be
// able to remove this constraint.
// skbug.com/4526
//
SkPoint pt;
ctm.mapXY(x, y, &pt);
SkIRect ir = SkIRect::MakeXYWH(SkScalarRoundToInt(pt.x()), SkScalarRoundToInt(pt.y()), w, h);
// quick bounds have been outset by 1px compared to overall device bounds, so this makes the
// contains check equivalent to between ir and device bounds
ir.outset(1, 1);
return ir.contains(fQuickRejectBounds);
#else
return false;
#endif
}
// Clean-up the paint to match the drawing semantics for drawImage et al. (skbug.com/7804).
static SkPaint clean_paint_for_drawImage(const SkPaint* paint) {
SkPaint cleaned;
if (paint) {
cleaned = *paint;
cleaned.setStyle(SkPaint::kFill_Style);
cleaned.setPathEffect(nullptr);
}
return cleaned;
}
// drawVertices fills triangles and ignores mask filter and path effect,
// so canonicalize the paint before checking quick reject.
static SkPaint clean_paint_for_drawVertices(SkPaint paint) {
paint.setStyle(SkPaint::kFill_Style);
paint.setMaskFilter(nullptr);
paint.setPathEffect(nullptr);
return paint;
}
// TODO: Delete this once SK_RESOLVE_FILTERS_BEFORE_RESTORE is unneeded and clean up subclasses
void SkCanvas::onDrawImage2(const SkImage* image, SkScalar x, SkScalar y,
const SkSamplingOptions& sampling, const SkPaint* paint) {
#if defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE)
SkPaint realPaint = clean_paint_for_drawImage(paint);
SkRect dst = SkRect::MakeXYWH(x, y, image->width(), image->height());
if (this->internalQuickReject(dst, realPaint)) {
return;
}
if (realPaint.getImageFilter() &&
this->canDrawBitmapAsSprite(x, y, image->width(), image->height(), sampling, realPaint) &&
!SkCanvasPriv::ImageToColorFilter(&realPaint)) {
// Evaluate the image filter directly on the input image and then draw the result, instead
// of first drawing the image to a temporary layer and filtering.
SkDevice* device = this->topDevice();
sk_sp<SkSpecialImage> special;
if ((special = device->makeSpecial(image))) {
sk_sp<SkImageFilter> filter = realPaint.refImageFilter();
realPaint.setImageFilter(nullptr);
// TODO(michaelludwig) - Many filters could probably be evaluated like this even if the
// CTM is not translate-only; the post-transformation of the filtered image by the CTM
// will probably look just as good and not require an extra layer.
// TODO(michaelludwig) - Once image filter implementations can support source images
// with non-(0,0) origins, we can just mark the origin as (x,y) instead of doing a
// pre-concat here.
SkMatrix layerToDevice = device->localToDevice();
layerToDevice.preTranslate(x, y);
SkMatrix deviceToLayer;
if (!layerToDevice.invert(&deviceToLayer)) {
return; // bad ctm, draw nothing
}
skif::Mapping mapping(layerToDevice, deviceToLayer, SkMatrix::Translate(-x, -y));
if (this->predrawNotify()) {
// While we are skipping an initial layer, evaluate the rest of the image filter
// pipeline in the same color format as we would have if there was a layer.
const auto filterColorType = image_filter_color_type(device->imageInfo());
device->drawFilteredImage(mapping, special.get(), filterColorType, filter.get(),
sampling,realPaint);
}
return;
} // else fall through to regular drawing path
}
if (this->topDevice()->shouldDrawAsTiledImageRect()) {
if (this->topDevice()->drawAsTiledImageRect(
this, image, nullptr, dst, sampling, realPaint, kFast_SrcRectConstraint)) {
return;
}
}
auto layer = this->aboutToDraw(realPaint, &dst);
if (layer) {
this->topDevice()->drawImageRect(image, nullptr, dst, sampling,
layer->paint(), kFast_SrcRectConstraint);
}
#else
// drawImage() should call into onDrawImageRect() if SK_RESOLVE_FILTERS_BEFORE_RESTORE is off
SkUNREACHABLE;
#endif
}
static SkSamplingOptions clean_sampling_for_constraint(
const SkSamplingOptions& sampling,
SkCanvas::SrcRectConstraint constraint) {
if (constraint == SkCanvas::kStrict_SrcRectConstraint) {
if (sampling.mipmap != SkMipmapMode::kNone) {
return SkSamplingOptions(sampling.filter);
}
if (sampling.isAniso()) {
return SkSamplingOptions(SkFilterMode::kLinear);
}
}
return sampling;
}
void SkCanvas::onDrawImageRect2(const SkImage* image, const SkRect& src, const SkRect& dst,
const SkSamplingOptions& sampling, const SkPaint* paint,
SrcRectConstraint constraint) {
SkPaint realPaint = clean_paint_for_drawImage(paint);
SkSamplingOptions realSampling = clean_sampling_for_constraint(sampling, constraint);
if (this->internalQuickReject(dst, realPaint)) {
return;
}
if (this->topDevice()->shouldDrawAsTiledImageRect()) {
if (this->topDevice()->drawAsTiledImageRect(
this, image, &src, dst, realSampling, realPaint, constraint)) {
return;
}
}
#if !defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE)
// drawImageRect()'s behavior is modified by the presence of an image filter, a mask filter, a
// color filter, the paint's alpha, the paint's blender, and--when it's an alpha-only image--
// the paint's color or shader. When there's an image filter, the paint's blender is applied to
// the result of the image filter function, but every other aspect would influence the source
// image that's then rendered with src-over blending into a transparent temporary layer.
//
// However, skif::FilterResult can apply the paint alpha and any color filter often without
// requiring a layer, and src-over blending onto a transparent dst is a no-op, so we can use the
// input image directly as the source for filtering. When the image is alpha-only and must be
// colorized, or when a mask filter would change the coverage we skip this optimization for
// simplicity since *somehow* embedding colorization or mask blurring into the filter graph
// would likely be equivalent to using the existing AutoLayerForImageFilter functionality.
if (realPaint.getImageFilter() && !image->isAlphaOnly() && !realPaint.getMaskFilter()) {
SkDevice* device = this->topDevice();
skif::ParameterSpace<SkRect> imageBounds{dst};
skif::DeviceSpace<SkIRect> outputBounds{device->devClipBounds()};
FilterToSpan filterAsSpan(realPaint.getImageFilter());
auto mappingAndBounds = get_layer_mapping_and_bounds(filterAsSpan,
device->localToDevice(),
outputBounds,
imageBounds);
if (!mappingAndBounds) {
return;
}
if (!this->predrawNotify()) {
return;
}
// Start out with an empty source image, to be replaced with the converted 'image', and a
// desired output equal to the calculated initial source layer bounds, which accounts for
// how the image filters will access 'image' (possibly different than just 'outputBounds').
auto backend = device->createImageFilteringBackend(
device->surfaceProps(),
image_filter_color_type(device->imageInfo()));
auto [mapping, srcBounds] = *mappingAndBounds;
skif::Stats stats;
skif::Context ctx{std::move(backend),
mapping,
srcBounds,
skif::FilterResult{},
device->imageInfo().colorSpace(),
&stats};
auto source = skif::FilterResult::MakeFromImage(
ctx, sk_ref_sp(image), src, imageBounds, sampling);
// Apply effects that are normally processed on the draw *before* any layer/image filter.
source = apply_alpha_and_colorfilter(ctx, source, realPaint);
// Evaluate the image filter, with a context pointing to the source created directly from
// 'image' (which will not require intermediate renderpasses when 'src' is integer aligned).
// and a desired output matching the device clip bounds.
ctx = ctx.withNewDesiredOutput(mapping.deviceToLayer(outputBounds))
.withNewSource(source);
auto result = as_IFB(realPaint.getImageFilter())->filterImage(ctx);
result.draw(ctx, device, realPaint.getBlender());
stats.reportStats();
return;
}
// When there's a alpha-only image that must be colorized or a mask filter to apply, go through
// the regular auto-layer-for-imagefilter process
#endif
if (realPaint.getMaskFilter() && this->topDevice()->useDrawCoverageMaskForMaskFilters()) {
// Route mask-filtered drawImages to drawRect() to use the auto-layer for mask filters,
// which require all shading to be encoded in the paint.
SkRect drawDst = SkModifyPaintAndDstForDrawImageRect(
image, sampling, src, dst, constraint == kStrict_SrcRectConstraint, &realPaint);
if (drawDst.isEmpty()) {
return;
} else {
this->drawRect(drawDst, realPaint);
return;
}
}
auto layer = this->aboutToDraw(realPaint, &dst,
PredrawFlags::kCheckForOverwrite |
(image->isOpaque() ? PredrawFlags::kOpaqueShaderOverride
: PredrawFlags::kNonOpaqueShaderOverride));
if (layer) {
this->topDevice()->drawImageRect(image, &src, dst, realSampling, layer->paint(),
constraint);
}
}
void SkCanvas::onDrawImageLattice2(const SkImage* image, const Lattice& lattice, const SkRect& dst,
SkFilterMode filter, const SkPaint* paint) {
SkPaint realPaint = clean_paint_for_drawImage(paint);
if (this->internalQuickReject(dst, realPaint)) {
return;
}
auto layer = this->aboutToDraw(realPaint, &dst);
if (layer) {
this->topDevice()->drawImageLattice(image, lattice, dst, filter, layer->paint());
}
}
void SkCanvas::drawImage(const SkImage* image, SkScalar x, SkScalar y,
const SkSamplingOptions& sampling, const SkPaint* paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
RETURN_ON_NULL(image);
#if defined(SK_RESOLVE_FILTERS_BEFORE_RESTORE)
this->onDrawImage2(image, x, y, sampling, paint);
#else
this->drawImageRect(image,
/*src=*/SkRect::MakeWH(image->width(), image->height()),
/*dst=*/SkRect::MakeXYWH(x, y, image->width(), image->height()),
sampling,
paint,
kFast_SrcRectConstraint);
#endif
}
void SkCanvas::drawImageRect(const SkImage* image, const SkRect& src, const SkRect& dst,
const SkSamplingOptions& sampling, const SkPaint* paint,
SrcRectConstraint constraint) {
RETURN_ON_NULL(image);
if (!fillable(dst) || !fillable(src)) {
return;
}
this->onDrawImageRect2(image, src, dst, sampling, paint, constraint);
}
void SkCanvas::drawImageRect(const SkImage* image, const SkRect& dst,
const SkSamplingOptions& sampling, const SkPaint* paint) {
RETURN_ON_NULL(image);
this->drawImageRect(image, SkRect::MakeIWH(image->width(), image->height()), dst, sampling,
paint, kFast_SrcRectConstraint);
}
void SkCanvas::onDrawTextBlob(const SkTextBlob* blob, SkScalar x, SkScalar y,
const SkPaint& paint) {
auto glyphRunList = fScratchGlyphRunBuilder->blobToGlyphRunList(*blob, {x, y});
this->onDrawGlyphRunList(glyphRunList, paint);
}
void SkCanvas::onDrawGlyphRunList(const sktext::GlyphRunList& glyphRunList, const SkPaint& paint) {
SkRect bounds = glyphRunList.sourceBoundsWithOrigin();
if (this->internalQuickReject(bounds, paint)) {
return;
}
// Text attempts to apply any SkMaskFilter internally and save the blurred masks in the
// strike cache; if a glyph must be drawn as a path or drawable, SkDevice routes back to
// this SkCanvas to retry, which will go through a function that does *not* skip the mask
// filter layer.
auto layer = this->aboutToDraw(paint, &bounds, PredrawFlags::kSkipMaskFilterAutoLayer);
if (layer) {
this->topDevice()->drawGlyphRunList(this, glyphRunList, layer->paint());
}
}
sk_sp<Slug> SkCanvas::convertBlobToSlug(
const SkTextBlob& blob, SkPoint origin, const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);
auto glyphRunList = fScratchGlyphRunBuilder->blobToGlyphRunList(blob, origin);
return this->onConvertGlyphRunListToSlug(glyphRunList, paint);
}
sk_sp<Slug> SkCanvas::onConvertGlyphRunListToSlug(const sktext::GlyphRunList& glyphRunList,
const SkPaint& paint) {
SkRect bounds = glyphRunList.sourceBoundsWithOrigin();
if (bounds.isEmpty() || !bounds.isFinite() || paint.nothingToDraw()) {
return nullptr;
}
// See comment in onDrawGlyphRunList()
auto layer = this->aboutToDraw(paint, &bounds, PredrawFlags::kSkipMaskFilterAutoLayer);
if (layer) {
return this->topDevice()->convertGlyphRunListToSlug(glyphRunList, layer->paint());
}
return nullptr;
}
void SkCanvas::drawSlug(const Slug* slug, const SkPaint& paint) {
TRACE_EVENT0("skia", TRACE_FUNC);<