office-gobmx/vcl/inc/skia/gdiimpl.hxx
Jan-Marek Glogowski 42e30c2461 tdf#138022 Skia don't recreate empty surfaces
Skia can't create empty surfaces, so the recreation will hit the
std::abort() in SkiaSalGraphicsImpl::createWindowSurface. Origin
of the backtrace is some queued Resize event, which will hit
this a few times via SkiaSalGraphicsImpl::checkSurface.

This feels a bit like tdf#130831, where VCL tried to track damange
for an empty Qt image...

Change-Id: I75e22c987ba633e7a403541db8d580df33c68964
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/105963
Tested-by: Jenkins
Reviewed-by: Luboš Luňák <l.lunak@collabora.com>
2020-11-17 11:33:32 +01:00

349 lines
14 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_VCL_SKIA_GDIIMPL_HXX
#define INCLUDED_VCL_SKIA_GDIIMPL_HXX
#include <vcl/dllapi.h>
#include <salgdiimpl.hxx>
#include <salgeom.hxx>
#include <SkSurface.h>
#include <SkRegion.h>
#include <prewin.h>
#include <tools/sk_app/WindowContext.h>
#include <postwin.h>
class SkiaFlushIdle;
class GenericSalLayout;
class SkFont;
class SkiaSalBitmap;
class VCL_DLLPUBLIC SkiaSalGraphicsImpl : public SalGraphicsImpl
{
public:
SkiaSalGraphicsImpl(SalGraphics& pParent, SalGeometryProvider* pProvider);
virtual ~SkiaSalGraphicsImpl() override;
virtual void Init() override;
virtual void DeInit() override;
virtual OUString getRenderBackendName() const override { return "skia"; }
const vcl::Region& getClipRegion() const;
virtual bool setClipRegion(const vcl::Region&) override;
//
// get the depth of the device
virtual sal_uInt16 GetBitCount() const override;
// get the width of the device
virtual tools::Long GetGraphicsWidth() const override;
// set the clip region to empty
virtual void ResetClipRegion() override;
// set the line color to transparent (= don't draw lines)
virtual void SetLineColor() override;
// set the line color to a specific color
virtual void SetLineColor(Color nColor) override;
// set the fill color to transparent (= don't fill)
virtual void SetFillColor() override;
// set the fill color to a specific color, shapes will be
// filled accordingly
virtual void SetFillColor(Color nColor) override;
// enable/disable XOR drawing
virtual void SetXORMode(bool bSet, bool bInvertOnly) override;
// set line color for raster operations
virtual void SetROPLineColor(SalROPColor nROPColor) override;
// set fill color for raster operations
virtual void SetROPFillColor(SalROPColor nROPColor) override;
// draw --> LineColor and FillColor and RasterOp and ClipRegion
virtual void drawPixel(tools::Long nX, tools::Long nY) override;
virtual void drawPixel(tools::Long nX, tools::Long nY, Color nColor) override;
virtual void drawLine(tools::Long nX1, tools::Long nY1, tools::Long nX2,
tools::Long nY2) override;
virtual void drawRect(tools::Long nX, tools::Long nY, tools::Long nWidth,
tools::Long nHeight) override;
virtual void drawPolyLine(sal_uInt32 nPoints, const Point* pPtAry) override;
virtual void drawPolygon(sal_uInt32 nPoints, const Point* pPtAry) override;
virtual void drawPolyPolygon(sal_uInt32 nPoly, const sal_uInt32* pPoints,
const Point** pPtAry) override;
virtual bool drawPolyPolygon(const basegfx::B2DHomMatrix& rObjectToDevice,
const basegfx::B2DPolyPolygon&, double fTransparency) override;
virtual bool drawPolyLine(const basegfx::B2DHomMatrix& rObjectToDevice,
const basegfx::B2DPolygon&, double fTransparency, double fLineWidth,
const std::vector<double>* pStroke, basegfx::B2DLineJoin,
css::drawing::LineCap, double fMiterMinimumAngle,
bool bPixelSnapHairline) override;
virtual bool drawPolyLineBezier(sal_uInt32 nPoints, const Point* pPtAry,
const PolyFlags* pFlgAry) override;
virtual bool drawPolygonBezier(sal_uInt32 nPoints, const Point* pPtAry,
const PolyFlags* pFlgAry) override;
virtual bool drawPolyPolygonBezier(sal_uInt32 nPoly, const sal_uInt32* pPoints,
const Point* const* pPtAry,
const PolyFlags* const* pFlgAry) override;
// CopyArea --> No RasterOp, but ClipRegion
virtual void copyArea(tools::Long nDestX, tools::Long nDestY, tools::Long nSrcX,
tools::Long nSrcY, tools::Long nSrcWidth, tools::Long nSrcHeight,
bool bWindowInvalidate) override;
virtual void copyBits(const SalTwoRect& rPosAry, SalGraphics* pSrcGraphics) override;
virtual bool blendBitmap(const SalTwoRect&, const SalBitmap& rBitmap) override;
virtual bool blendAlphaBitmap(const SalTwoRect&, const SalBitmap& rSrcBitmap,
const SalBitmap& rMaskBitmap,
const SalBitmap& rAlphaBitmap) override;
virtual void drawBitmap(const SalTwoRect& rPosAry, const SalBitmap& rSalBitmap) override;
virtual void drawBitmap(const SalTwoRect& rPosAry, const SalBitmap& rSalBitmap,
const SalBitmap& rMaskBitmap) override;
virtual void drawMask(const SalTwoRect& rPosAry, const SalBitmap& rSalBitmap,
Color nMaskColor) override;
virtual std::shared_ptr<SalBitmap> getBitmap(tools::Long nX, tools::Long nY, tools::Long nWidth,
tools::Long nHeight) override;
virtual Color getPixel(tools::Long nX, tools::Long nY) override;
// invert --> ClipRegion (only Windows or VirDevs)
virtual void invert(tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight,
SalInvert nFlags) override;
virtual void invert(sal_uInt32 nPoints, const Point* pPtAry, SalInvert nFlags) override;
virtual bool drawEPS(tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight,
void* pPtr, sal_uInt32 nSize) override;
/** Render bitmap with alpha channel
@param rSourceBitmap
Source bitmap to blit
@param rAlphaBitmap
Alpha channel to use for blitting
@return true, if the operation succeeded, and false
otherwise. In this case, clients should try to emulate alpha
compositing themselves
*/
virtual bool drawAlphaBitmap(const SalTwoRect&, const SalBitmap& rSourceBitmap,
const SalBitmap& rAlphaBitmap) override;
/** draw transformed bitmap (maybe with alpha) where Null, X, Y define the coordinate system */
virtual bool drawTransformedBitmap(const basegfx::B2DPoint& rNull, const basegfx::B2DPoint& rX,
const basegfx::B2DPoint& rY, const SalBitmap& rSourceBitmap,
const SalBitmap* pAlphaBitmap) override;
/** Render solid rectangle with given transparency
@param nX Top left coordinate of rectangle
@param nY Bottom right coordinate of rectangle
@param nWidth Width of rectangle
@param nHeight Height of rectangle
@param nTransparency Transparency value (0-255) to use. 0 blits and opaque, 255 a
fully transparent rectangle
@returns true if successfully drawn, false if not able to draw rectangle
*/
virtual bool drawAlphaRect(tools::Long nX, tools::Long nY, tools::Long nWidth,
tools::Long nHeight, sal_uInt8 nTransparency) override;
virtual bool drawGradient(const tools::PolyPolygon& rPolygon,
const Gradient& rGradient) override;
virtual bool implDrawGradient(const basegfx::B2DPolyPolygon& rPolyPolygon,
const SalGradient& rGradient) override;
virtual bool supportsOperation(OutDevSupportType eType) const override;
#ifdef DBG_UTIL
void dump(const char* file) const;
#endif
// Default blend mode for SkPaint is SkBlendMode::kSrcOver
void drawBitmap(const SalTwoRect& rPosAry, const SkiaSalBitmap& bitmap,
SkBlendMode blendMode = SkBlendMode::kSrcOver);
void drawImage(const SalTwoRect& rPosAry, const sk_sp<SkImage>& aImage,
SkBlendMode eBlendMode = SkBlendMode::kSrcOver);
void drawShader(const SalTwoRect& rPosAry, const sk_sp<SkShader>& shader,
SkBlendMode blendMode = SkBlendMode::kSrcOver);
enum class GlyphOrientation
{
Apply,
Ignore
};
void drawGenericLayout(const GenericSalLayout& layout, Color textColor, const SkFont& font,
GlyphOrientation glyphOrientation);
protected:
// To be called before any drawing.
void preDraw();
// To be called after any drawing.
void postDraw();
// The canvas to draw to. Will be diverted to a temporary for Xor mode.
SkCanvas* getDrawCanvas() { return mXorMode ? getXorCanvas() : mSurface->getCanvas(); }
// Call before makeImageSnapshot(), ensures the content is up to date.
void flushDrawing();
virtual void createSurface();
// Call to ensure that mSurface is valid. If mSurface is going to be modified,
// use preDraw() instead of this.
void checkSurface();
void destroySurface();
// Reimplemented for X11.
virtual bool avoidRecreateByResize() const { return false; }
void createWindowSurface(bool forceRaster = false);
virtual void createWindowContext(bool forceRaster = false) = 0;
void createOffscreenSurface();
void privateDrawAlphaRect(tools::Long nX, tools::Long nY, tools::Long nWidth,
tools::Long nHeight, double nTransparency, bool blockAA = false);
void setProvider(SalGeometryProvider* provider) { mProvider = provider; }
bool isOffscreen() const { return mProvider == nullptr || mProvider->IsOffScreen(); }
bool isGPU() const { return mIsGPU; }
void invert(basegfx::B2DPolygon const& rPoly, SalInvert eFlags);
// Called by SkiaFlushIdle.
virtual void performFlush() = 0;
void scheduleFlush();
friend class SkiaFlushIdle;
// get the width of the device
int GetWidth() const { return mProvider ? mProvider->GetWidth() : 1; }
// get the height of the device
int GetHeight() const { return mProvider ? mProvider->GetHeight() : 1; }
SkCanvas* getXorCanvas();
void applyXor();
// NOTE: This must be called before the operation does any drawing.
void addUpdateRegion(const SkRect& rect)
{
// Make slightly larger, just in case (rounding, antialiasing,...).
SkIRect addedRect = rect.makeOutset(2, 2).round();
if (mXorMode)
{
// Two xor operations should cancel each other out. We batch xor operations,
// but if they can overlap, apply xor now, since applyXor() does the operation
// just once.
if (mXorRegion.intersects(addedRect))
applyXor();
mXorRegion.op(addedRect, SkRegion::kUnion_Op);
}
// Using SkIRect should be enough, SkRegion would be too slow with many operations
// and swapping to the screen is not _that_slow.
mDirtyRect.join(addedRect);
}
static void setCanvasClipRegion(SkCanvas* canvas, const vcl::Region& region);
sk_sp<SkImage> mergeCacheBitmaps(const SkiaSalBitmap& bitmap, const SkiaSalBitmap* alphaBitmap,
const Size targetSize);
// Skia uses floating point coordinates, so when we use integer coordinates, sometimes
// rounding results in off-by-one errors (down), especially when drawing using GPU,
// see https://bugs.chromium.org/p/skia/issues/detail?id=9611 . Compensate for
// it by using centers of pixels. Using 0.5 may sometimes round up, so go with 0.495 .
static constexpr SkScalar toSkX(tools::Long x) { return x + 0.495; }
static constexpr SkScalar toSkY(tools::Long y) { return y + 0.495; }
// Value to add to be exactly in the middle of the pixel.
static constexpr SkScalar toSkXYFix = SkScalar(0.005);
// Perform any pending drawing such as delayed merging of polygons. Called by preDraw()
// and anything that means the next operation cannot be another one in a series (e.g.
// changing colors).
void checkPendingDrawing();
bool delayDrawPolyPolygon(const basegfx::B2DPolyPolygon& polygon, double transparency);
void performDrawPolyPolygon(const basegfx::B2DPolyPolygon& polygon, double transparency,
bool useAA);
template <typename charT, typename traits>
friend inline std::basic_ostream<charT, traits>&
operator<<(std::basic_ostream<charT, traits>& stream, const SkiaSalGraphicsImpl* graphics)
{
if (graphics == nullptr)
return stream << "(null)";
// O - offscreen, G - GPU-based, R - raster
return stream << static_cast<const void*>(graphics) << " "
<< Size(graphics->GetWidth(), graphics->GetHeight())
<< (graphics->isGPU() ? "G" : "R") << (graphics->isOffscreen() ? "O" : "");
}
SalGraphics& mParent;
/// Pointer to the SalFrame or SalVirtualDevice
SalGeometryProvider* mProvider;
std::unique_ptr<sk_app::WindowContext> mWindowContext;
// The Skia surface that is target of all the rendering.
sk_sp<SkSurface> mSurface;
bool mIsGPU; // whether the surface is GPU-backed
SkIRect mDirtyRect; // the area that has been changed since the last performFlush()
vcl::Region mClipRegion;
Color mLineColor;
Color mFillColor;
bool mXorMode;
SkBitmap mXorBitmap;
std::unique_ptr<SkCanvas> mXorCanvas;
SkRegion mXorRegion; // the area that needs updating for the xor operation
std::unique_ptr<SkiaFlushIdle> mFlush;
// Info about pending polygons to draw (we try to merge adjacent polygons into one).
struct LastPolyPolygonInfo
{
basegfx::B2DPolyPolygonVector polygons;
basegfx::B2DRange bounds;
double transparency;
};
LastPolyPolygonInfo mLastPolyPolygonInfo;
int mPendingOperationsToFlush;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */