gfx/2d/DrawTargetCairo.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef _MOZILLA_GFX_DRAWTARGET_CAIRO_H_
   8 #define _MOZILLA_GFX_DRAWTARGET_CAIRO_H_
   9
  10 #include "2D.h"
  11 #include "cairo.h"
  12 #include "PathCairo.h"
  13
  14 #include <vector>
  15
  16 namespace mozilla {
  17 namespace gfx {
  18
  19 class SourceSurfaceCairo;
  20
  21 class GradientStopsCairo : public GradientStops {
  22  public:
  23   MOZ_DECLARE_REFCOUNTED_VIRTUAL_TYPENAME(GradientStopsCairo, override)
  24
  25   GradientStopsCairo(GradientStop* aStops, uint32_t aNumStops,
  26                      ExtendMode aExtendMode)
  27       : mExtendMode(aExtendMode) {
  28     for (uint32_t i = 0; i < aNumStops; ++i) {
  29       mStops.push_back(aStops[i]);
  30     }
  31   }
  32
  33   virtual ~GradientStopsCairo() = default;
  34
  35   const std::vector<GradientStop>& GetStops() const { return mStops; }
  36
  37   ExtendMode GetExtendMode() const { return mExtendMode; }
  38
  39   virtual BackendType GetBackendType() const override {
  40     return BackendType::CAIRO;
  41   }
  42
  43  private:
  44   std::vector<GradientStop> mStops;
  45   ExtendMode mExtendMode;
  46 };
  47
  48 class DrawTargetCairo final : public DrawTarget {
  49  public:
  50   MOZ_DECLARE_REFCOUNTED_VIRTUAL_TYPENAME(DrawTargetCairo, override)
  51   friend class BorrowedXlibDrawable;
  52
  53   DrawTargetCairo();
  54   virtual ~DrawTargetCairo();
  55
  56   virtual bool IsValid() const override;
  57   virtual DrawTargetType GetType() const override;
  58   virtual BackendType GetBackendType() const override {
  59     return BackendType::CAIRO;
  60   }
  61
  62   virtual void Link(const char* aDestination, const Rect& aRect) override;
  63   virtual void Destination(const char* aDestination,
  64                            const Point& aPoint) override;
  65
  66   virtual already_AddRefed<SourceSurface> Snapshot() override;
  67   virtual IntSize GetSize() const override;
  68
  69   virtual bool IsCurrentGroupOpaque() override;
  70
  71   virtual void SetPermitSubpixelAA(bool aPermitSubpixelAA) override;
  72
  73   virtual bool LockBits(uint8_t** aData, IntSize* aSize, int32_t* aStride,
  74                         SurfaceFormat* aFormat,
  75                         IntPoint* aOrigin = nullptr) override;
  76   virtual void ReleaseBits(uint8_t* aData) override;
  77
  78   virtual void Flush() override;
  79   virtual void DrawSurface(
  80       SourceSurface* aSurface, const Rect& aDest, const Rect& aSource,
  81       const DrawSurfaceOptions& aSurfOptions = DrawSurfaceOptions(),
  82       const DrawOptions& aOptions = DrawOptions()) override;
  83   virtual void DrawFilter(FilterNode* aNode, const Rect& aSourceRect,
  84                           const Point& aDestPoint,
  85                           const DrawOptions& aOptions = DrawOptions()) override;
  86   virtual void DrawSurfaceWithShadow(SourceSurface* aSurface,
  87                                      const Point& aDest,
  88                                      const DeviceColor& aColor,
  89                                      const Point& aOffset, Float aSigma,
  90                                      CompositionOp aOperator) override;
  91
  92   virtual void ClearRect(const Rect& aRect) override;
  93
  94   virtual void CopySurface(SourceSurface* aSurface, const IntRect& aSourceRect,
  95                            const IntPoint& aDestination) override;
  96   virtual void CopyRect(const IntRect& aSourceRect,
  97                         const IntPoint& aDestination) override;
  98
  99   virtual void FillRect(const Rect& aRect, const Pattern& aPattern,
 100                         const DrawOptions& aOptions = DrawOptions()) override;
 101   virtual void StrokeRect(const Rect& aRect, const Pattern& aPattern,
 102                           const StrokeOptions& aStrokeOptions = StrokeOptions(),
 103                           const DrawOptions& aOptions = DrawOptions()) override;
 104   virtual void StrokeLine(const Point& aStart, const Point& aEnd,
 105                           const Pattern& aPattern,
 106                           const StrokeOptions& aStrokeOptions = StrokeOptions(),
 107                           const DrawOptions& aOptions = DrawOptions()) override;
 108
 109   virtual void Stroke(const Path* aPath, const Pattern& aPattern,
 110                       const StrokeOptions& aStrokeOptions = StrokeOptions(),
 111                       const DrawOptions& aOptions = DrawOptions()) override;
 112
 113   virtual void Fill(const Path* aPath, const Pattern& aPattern,
 114                     const DrawOptions& aOptions = DrawOptions()) override;
 115
 116   virtual void FillGlyphs(ScaledFont* aFont, const GlyphBuffer& aBuffer,
 117                           const Pattern& aPattern,
 118                           const DrawOptions& aOptions) override;
 119   virtual void Mask(const Pattern& aSource, const Pattern& aMask,
 120                     const DrawOptions& aOptions = DrawOptions()) override;
 121   virtual void MaskSurface(
 122       const Pattern& aSource, SourceSurface* aMask, Point aOffset,
 123       const DrawOptions& aOptions = DrawOptions()) override;
 124
 125   virtual bool Draw3DTransformedSurface(SourceSurface* aSurface,
 126                                         const Matrix4x4& aMatrix) override;
 127
 128   virtual void PushClip(const Path* aPath) override;
 129   virtual void PushClipRect(const Rect& aRect) override;
 130   virtual void PopClip() override;
 131   virtual void PushLayer(bool aOpaque, Float aOpacity, SourceSurface* aMask,
 132                          const Matrix& aMaskTransform,
 133                          const IntRect& aBounds = IntRect(),
 134                          bool aCopyBackground = false) override;
 135   virtual void PushLayerWithBlend(
 136       bool aOpaque, Float aOpacity, SourceSurface* aMask,
 137       const Matrix& aMaskTransform, const IntRect& aBounds = IntRect(),
 138       bool aCopyBackground = false,
 139       CompositionOp = CompositionOp::OP_OVER) override;
 140   virtual void PopLayer() override;
 141
 142   virtual already_AddRefed<PathBuilder> CreatePathBuilder(
 143       FillRule aFillRule = FillRule::FILL_WINDING) const override;
 144
 145   virtual already_AddRefed<SourceSurface> CreateSourceSurfaceFromData(
 146       unsigned char* aData, const IntSize& aSize, int32_t aStride,
 147       SurfaceFormat aFormat) const override;
 148   virtual already_AddRefed<SourceSurface> OptimizeSourceSurface(
 149       SourceSurface* aSurface) const override;
 150   virtual already_AddRefed<SourceSurface> CreateSourceSurfaceFromNativeSurface(
 151       const NativeSurface& aSurface) const override;
 152   virtual already_AddRefed<DrawTarget> CreateSimilarDrawTarget(
 153       const IntSize& aSize, SurfaceFormat aFormat) const override;
 154   virtual already_AddRefed<DrawTarget> CreateShadowDrawTarget(
 155       const IntSize& aSize, SurfaceFormat aFormat, float aSigma) const override;
 156   virtual RefPtr<DrawTarget> CreateClippedDrawTarget(
 157       const Rect& aBounds, SurfaceFormat aFormat) override;
 158
 159   virtual already_AddRefed<GradientStops> CreateGradientStops(
 160       GradientStop* aStops, uint32_t aNumStops,
 161       ExtendMode aExtendMode = ExtendMode::CLAMP) const override;
 162
 163   virtual already_AddRefed<FilterNode> CreateFilter(FilterType aType) override;
 164
 165   virtual void* GetNativeSurface(NativeSurfaceType aType) override;
 166
 167   bool Init(cairo_surface_t* aSurface, const IntSize& aSize,
 168             SurfaceFormat* aFormat = nullptr);
 169   bool Init(const IntSize& aSize, SurfaceFormat aFormat);
 170   bool Init(unsigned char* aData, const IntSize& aSize, int32_t aStride,
 171             SurfaceFormat aFormat);
 172
 173   virtual void SetTransform(const Matrix& aTransform) override;
 174
 175   virtual void DetachAllSnapshots() override { MarkSnapshotIndependent(); }
 176
 177   // Call to set up aContext for drawing (with the current transform, etc).
 178   // Pass the path you're going to be using if you have one.
 179   // Implicitly calls WillChange(aPath).
 180   void PrepareForDrawing(cairo_t* aContext, const Path* aPath = nullptr);
 181
 182   static cairo_surface_t* GetDummySurface();
 183
 184   // Cairo hardcodes this as its maximum surface size.
 185   static size_t GetMaxSurfaceSize() { return 32766; }
 186
 187  private:  // methods
 188   // Init cairo surface without doing a cairo_surface_reference() call.
 189   bool InitAlreadyReferenced(cairo_surface_t* aSurface, const IntSize& aSize,
 190                              SurfaceFormat* aFormat = nullptr);
 191   enum DrawPatternType { DRAW_FILL, DRAW_STROKE };
 192   void DrawPattern(const Pattern& aPattern, const StrokeOptions& aStrokeOptions,
 193                    const DrawOptions& aOptions, DrawPatternType aDrawType,
 194                    bool aPathBoundsClip = false);
 195
 196   void CopySurfaceInternal(cairo_surface_t* aSurface, const IntRect& aSource,
 197                            const IntPoint& aDest);
 198
 199   Rect GetUserSpaceClip() const;
 200
 201   // Call before you make any changes to the backing surface with which this
 202   // context is associated. Pass the path you're going to be using if you have
 203   // one.
 204   void WillChange(const Path* aPath = nullptr);
 205
 206   // Call if there is any reason to disassociate the snapshot from this draw
 207   // target; for example, because we're going to be destroyed.
 208   void MarkSnapshotIndependent();
 209
 210   // If the current operator is "source" then clear the destination before we
 211   // draw into it, to simulate the effect of an unbounded source operator.
 212   void ClearSurfaceForUnboundedSource(const CompositionOp& aOperator);
 213
 214   // Set the Cairo context font options according to the current draw target
 215   // font state.
 216   void SetFontOptions(cairo_antialias_t aAAMode = CAIRO_ANTIALIAS_DEFAULT);
 217
 218  private:  // data
 219   cairo_t* mContext;
 220   cairo_surface_t* mSurface;
 221   IntSize mSize;
 222   bool mTransformSingular;
 223
 224   uint8_t* mLockedBits;
 225
 226   cairo_font_options_t* mFontOptions;
 227
 228   struct PushedLayer {
 229     PushedLayer(Float aOpacity, CompositionOp aCompositionOp,
 230                 bool aWasPermittingSubpixelAA)
 231         : mOpacity(aOpacity),
 232           mCompositionOp(aCompositionOp),
 233           mMaskPattern(nullptr),
 234           mWasPermittingSubpixelAA(aWasPermittingSubpixelAA) {}
 235     Float mOpacity;
 236     CompositionOp mCompositionOp;
 237     cairo_pattern_t* mMaskPattern;
 238     bool mWasPermittingSubpixelAA;
 239   };
 240   std::vector<PushedLayer> mPushedLayers;
 241
 242   // The latest snapshot of this surface. This needs to be told when this
 243   // target is modified. We keep it alive as a cache.
 244   RefPtr<SourceSurfaceCairo> mSnapshot;
 245   static cairo_surface_t* mDummySurface;
 246 };
 247
 248 }  // namespace gfx
 249 }  // namespace mozilla
 250
 251 #endif  // _MOZILLA_GFX_DRAWTARGET_CAIRO_H_