layout/svg/nsSVGMaskFrame.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 __NS_SVGMASKFRAME_H__
   8 #define __NS_SVGMASKFRAME_H__
   9
  10 #include "mozilla/Attributes.h"
  11 #include "mozilla/gfx/2D.h"
  12 #include "mozilla/RefPtr.h"
  13 #include "gfxPattern.h"
  14 #include "gfxMatrix.h"
  15 #include "nsSVGContainerFrame.h"
  16 #include "nsSVGUtils.h"
  17
  18 class gfxContext;
  19
  20 namespace mozilla {
  21 class PresShell;
  22 }  // namespace mozilla
  23
  24 class nsSVGMaskFrame final : public nsSVGContainerFrame {
  25   friend nsIFrame* NS_NewSVGMaskFrame(mozilla::PresShell* aPresShell,
  26                                       ComputedStyle* aStyle);
  27
  28   typedef mozilla::gfx::Matrix Matrix;
  29   typedef mozilla::gfx::SourceSurface SourceSurface;
  30   typedef mozilla::image::imgDrawingParams imgDrawingParams;
  31
  32  protected:
  33   explicit nsSVGMaskFrame(ComputedStyle* aStyle, nsPresContext* aPresContext)
  34       : nsSVGContainerFrame(aStyle, aPresContext, kClassID), mInUse(false) {
  35     AddStateBits(NS_FRAME_IS_NONDISPLAY);
  36   }
  37
  38  public:
  39   NS_DECL_FRAMEARENA_HELPERS(nsSVGMaskFrame)
  40
  41   struct MaskParams {
  42     gfxContext* ctx;
  43     nsIFrame* maskedFrame;
  44     const gfxMatrix& toUserSpace;
  45     float opacity;
  46     mozilla::StyleMaskMode maskMode;
  47     imgDrawingParams& imgParams;
  48
  49     explicit MaskParams(gfxContext* aCtx, nsIFrame* aMaskedFrame,
  50                         const gfxMatrix& aToUserSpace, float aOpacity,
  51                         mozilla::StyleMaskMode aMaskMode,
  52                         imgDrawingParams& aImgParams)
  53         : ctx(aCtx),
  54           maskedFrame(aMaskedFrame),
  55           toUserSpace(aToUserSpace),
  56           opacity(aOpacity),
  57           maskMode(aMaskMode),
  58           imgParams(aImgParams) {}
  59   };
  60
  61   // nsSVGMaskFrame method:
  62
  63   /**
  64    * Generate a mask surface for the target frame.
  65    *
  66    * The return surface can be null, it's the caller's responsibility to
  67    * null-check before dereferencing.
  68    */
  69   already_AddRefed<SourceSurface> GetMaskForMaskedFrame(MaskParams& aParams);
  70
  71   gfxRect GetMaskArea(nsIFrame* aMaskedFrame);
  72
  73   virtual nsresult AttributeChanged(int32_t aNameSpaceID, nsAtom* aAttribute,
  74                                     int32_t aModType) override;
  75
  76 #ifdef DEBUG
  77   virtual void Init(nsIContent* aContent, nsContainerFrame* aParent,
  78                     nsIFrame* aPrevInFlow) override;
  79 #endif
  80
  81   virtual void BuildDisplayList(nsDisplayListBuilder* aBuilder,
  82                                 const nsDisplayListSet& aLists) override {}
  83
  84 #ifdef DEBUG_FRAME_DUMP
  85   virtual nsresult GetFrameName(nsAString& aResult) const override {
  86     return MakeFrameName(NS_LITERAL_STRING("SVGMask"), aResult);
  87   }
  88 #endif
  89
  90  private:
  91   /**
  92    * If the mask element transforms its children due to
  93    * maskContentUnits="objectBoundingBox" being set on it, this function
  94    * returns the resulting transform.
  95    */
  96   gfxMatrix GetMaskTransform(nsIFrame* aMaskedFrame);
  97
  98   gfxMatrix mMatrixForChildren;
  99   // recursion prevention flag
 100   bool mInUse;
 101
 102   // nsSVGContainerFrame methods:
 103   virtual gfxMatrix GetCanvasTM() override;
 104 };
 105
 106 #endif