1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
|
/* -*- 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 <skia/utils.hxx>
#include <SkPaint.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, double fAlpha) override;
virtual bool hasFastDrawTransformedBitmap() const 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;
// Dump contents to a file for debugging.
void dump(const char* file) const;
// 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, int srcScaling = 1,
SkBlendMode eBlendMode = SkBlendMode::kSrcOver);
void drawShader(const SalTwoRect& rPosAry, const sk_sp<SkShader>& shader,
SkBlendMode blendMode = SkBlendMode::kSrcOver);
void drawGenericLayout(const GenericSalLayout& layout, Color textColor, const SkFont& font,
const SkFont& verticalFont);
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;
void createWindowSurface(bool forceRaster = false);
virtual void createWindowSurfaceInternal(bool forceRaster = false) = 0;
void createOffscreenSurface();
virtual void flushSurfaceToWindowContext();
void privateDrawAlphaRect(tools::Long nX, tools::Long nY, tools::Long nWidth,
tools::Long nHeight, double nTransparency, bool blockAA = false);
void privateCopyBits(const SalTwoRect& rPosAry, SkiaSalGraphicsImpl* src);
void setProvider(SalGeometryProvider* provider) { mProvider = provider; }
bool isOffscreen() const;
bool isGPU() const { return mIsGPU; }
void invert(basegfx::B2DPolygon const& rPoly, SalInvert eFlags);
// Called by SkiaFlushIdle.
void performFlush();
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; }
// Get the global HiDPI scaling factor.
virtual int getWindowScaling() const;
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);
}
void setCanvasScalingAndClipping();
void resetCanvasScalingAndClipping();
static void setCanvasClipRegion(SkCanvas* canvas, const vcl::Region& region);
sk_sp<SkImage> mergeCacheBitmaps(const SkiaSalBitmap& bitmap, const SkiaSalBitmap* alphaBitmap,
const Size& targetSize);
using DirectImage = SkiaHelper::DirectImage;
static OString makeCachedImageKey(const SkiaSalBitmap& bitmap, const SkiaSalBitmap* alphaBitmap,
const Size& targetSize, DirectImage bitmapType,
DirectImage alphaBitmapType);
// 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);
// Create SkPaint set up for drawing lines (using mLineColor etc.).
SkPaint makeLinePaint(double transparency = 0) const
{
assert(mLineColor != SALCOLOR_NONE);
SkPaint paint;
paint.setColor(transparency == 0
? SkiaHelper::toSkColor(mLineColor)
: SkiaHelper::toSkColorWithTransparency(mLineColor, transparency));
paint.setStyle(SkPaint::kStroke_Style);
return paint;
}
// Create SkPaint set up for filling (using mFillColor etc.).
SkPaint makeFillPaint(double transparency = 0) const
{
assert(mFillColor != SALCOLOR_NONE);
SkPaint paint;
paint.setColor(transparency == 0
? SkiaHelper::toSkColor(mFillColor)
: SkiaHelper::toSkColorWithTransparency(mFillColor, transparency));
if (mLineColor == mFillColor)
paint.setStyle(SkPaint::kStrokeAndFill_Style);
else
paint.setStyle(SkPaint::kFill_Style);
return paint;
}
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
stream << static_cast<const void*>(graphics) << " "
<< Size(graphics->GetWidth(), graphics->GetHeight());
if (graphics->mScaling != 1)
stream << "*" << graphics->mScaling;
stream << (graphics->isGPU() ? "G" : "R") << (graphics->isOffscreen() ? "O" : "");
return stream;
}
SalGraphics& mParent;
/// Pointer to the SalFrame or SalVirtualDevice
SalGeometryProvider* mProvider;
// The Skia surface that is target of all the rendering.
sk_sp<SkSurface> mSurface;
// Note that mSurface may be a proxy surface and not the one from the window context.
std::unique_ptr<sk_app::WindowContext> mWindowContext;
bool mIsGPU; // whether the surface is GPU-backed
// Note that we generally use VCL coordinates, which is not mSurface coordinates if mScaling!=1.
SkIRect mDirtyRect; // The area that has been changed since the last performFlush().
vcl::Region mClipRegion;
SkRegion mXorRegion; // The area that needs updating for the xor operation.
Color mLineColor;
Color mFillColor;
bool mXorMode;
SkBitmap mXorBitmap;
std::unique_ptr<SkCanvas> mXorCanvas;
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;
int mScaling; // The scale factor for HiDPI screens.
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|