skia2/include/android/SkAndroidFrameworkUtils.h
Michael Ludwig c19b9c5886 androidFramework_replaceClip proposal
Expose a android framework-only function to reset the saved clip geometry
a device-space pixel rect (e.g. the device clip restriction). Using a
regular intersect clip operation after this call should match the
behavior of the legacy replace operation with a clip restriction.

This is a step to removing the separate device clip
restriction API and the deprecated expanding clip ops, as part of the
plan described here: https://docs.google.com/document/d/1ddIk74A1rL5Kj5kGcnInOYKVAXs3J2IsSgU5BLit0Ng/edit?usp=sharing

Bug: skia:10207
Bug: skia:10209

Change-Id: I57d3bcc7b5b257935eb2bf2099d472f2ef354d5b
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/298824
Reviewed-by: Derek Sollenberger <djsollen@google.com>
Reviewed-by: Mike Reed <reed@google.com>
Commit-Queue: Michael Ludwig <michaelludwig@google.com>
2020-06-25 21:54:11 +00:00

66 lines
2.0 KiB
C++

/*
* Copyright 2017 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef SkAndroidFrameworkUtils_DEFINED
#define SkAndroidFrameworkUtils_DEFINED
#include "include/core/SkRefCnt.h"
#include "include/core/SkTypes.h"
#ifdef SK_BUILD_FOR_ANDROID_FRAMEWORK
class SkCanvas;
struct SkIRect;
struct SkRect;
class SkSurface;
/**
* SkAndroidFrameworkUtils expose private APIs used only by Android framework.
*/
class SkAndroidFrameworkUtils {
public:
#if SK_SUPPORT_GPU
/**
* clipWithStencil draws the current clip into a stencil buffer with reference value and mask
* set to 0x1. This function works only on a GPU canvas.
*
* @param canvas A GPU canvas that has a non-empty clip.
*
* @return true on success or false if clip is empty or not a GPU canvas.
*/
static bool clipWithStencil(SkCanvas* canvas);
#endif //SK_SUPPORT_GPU
static void SafetyNetLog(const char*);
static sk_sp<SkSurface> getSurfaceFromCanvas(SkCanvas* canvas);
static int SaveBehind(SkCanvas* canvas, const SkRect* subset);
// Operating within the canvas' clip stack, this resets the geometry of the clip to be an
// intersection with the device-space 'rect'. If 'rect' is null, this will use the rect that
// was last set using androidFramework_setDeviceClipRestriction on the canvas. If that was never
// set, it will restrict the clip to the canvas' dimensions.
//
// TODO: Eventually, make 'rect' non-optional and no longer store the restriction per canvas.
static void ReplaceClip(SkCanvas* canvas, const SkIRect* rect = nullptr);
/**
* Unrolls a chain of nested SkPaintFilterCanvas to return the base wrapped canvas.
*
* @param canvas A SkPaintFilterCanvas or any other SkCanvas subclass.
*
* @return SkCanvas that was found in the innermost SkPaintFilterCanvas.
*/
static SkCanvas* getBaseWrappedCanvas(SkCanvas* canvas);
};
#endif // SK_BUILD_FOR_ANDROID_ANDROID
#endif // SkAndroidFrameworkUtils_DEFINED