summaryrefslogtreecommitdiffstats
path: root/gfx/layers/basic/BasicImplData.h
diff options
context:
space:
mode:
authorMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
committerMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
commit5f8de423f190bbb79a62f804151bc24824fa32d8 (patch)
tree10027f336435511475e392454359edea8e25895d /gfx/layers/basic/BasicImplData.h
parent49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff)
downloadUXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip
Add m-esr52 at 52.6.0
Diffstat (limited to 'gfx/layers/basic/BasicImplData.h')
-rw-r--r--gfx/layers/basic/BasicImplData.h132
1 files changed, 132 insertions, 0 deletions
diff --git a/gfx/layers/basic/BasicImplData.h b/gfx/layers/basic/BasicImplData.h
new file mode 100644
index 000000000..2ffa310a9
--- /dev/null
+++ b/gfx/layers/basic/BasicImplData.h
@@ -0,0 +1,132 @@
+/* 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/. */
+
+#ifndef GFX_BASICIMPLDATA_H
+#define GFX_BASICIMPLDATA_H
+
+#include "Layers.h" // for Layer (ptr only), etc
+#include "gfxContext.h" // for gfxContext, etc
+#include "nsDebug.h" // for NS_ASSERTION
+#include "nsISupportsImpl.h" // for MOZ_COUNT_CTOR, etc
+#include "mozilla/gfx/Types.h"
+
+namespace mozilla {
+namespace layers {
+
+class ReadbackProcessor;
+
+/**
+ * This is the ImplData for all Basic layers. It also exposes methods
+ * private to the Basic implementation that are common to all Basic layer types.
+ * In particular, there is an internal Paint() method that we can use
+ * to paint the contents of non-PaintedLayers.
+ *
+ * The class hierarchy for Basic layers is like this:
+ * BasicImplData
+ * Layer | | |
+ * | | | |
+ * +-> ContainerLayer | | |
+ * | | | | |
+ * | +-> BasicContainerLayer <--+ | |
+ * | | |
+ * +-> PaintedLayer | |
+ * | | | |
+ * | +-> BasicPaintedLayer <---------+ |
+ * | |
+ * +-> ImageLayer |
+ * | |
+ * +-> BasicImageLayer <--------------+
+ */
+class BasicImplData {
+public:
+ BasicImplData() : mHidden(false),
+ mClipToVisibleRegion(false),
+ mDrawAtomically(false),
+ mOperator(gfx::CompositionOp::OP_OVER)
+ {
+ MOZ_COUNT_CTOR(BasicImplData);
+ }
+ virtual ~BasicImplData()
+ {
+ MOZ_COUNT_DTOR(BasicImplData);
+ }
+
+ /**
+ * Layers that paint themselves, such as ImageLayers, should paint
+ * in response to this method call. aContext will already have been
+ * set up to account for all the properties of the layer (transform,
+ * opacity, etc).
+ */
+ virtual void Paint(gfx::DrawTarget* aDT,
+ const gfx::Point& aDeviceOffset,
+ Layer* aMaskLayer) {}
+
+ /**
+ * Like Paint() but called for PaintedLayers with the additional parameters
+ * they need.
+ * If mClipToVisibleRegion is set, then the layer must clip to its
+ * effective visible region (snapped or unsnapped, it doesn't matter).
+ */
+ virtual void PaintThebes(gfxContext* aContext,
+ Layer* aMasklayer,
+ LayerManager::DrawPaintedLayerCallback aCallback,
+ void* aCallbackData) {}
+
+ virtual void Validate(LayerManager::DrawPaintedLayerCallback aCallback,
+ void* aCallbackData,
+ ReadbackProcessor* aReadback) {}
+
+ /**
+ * Layers will get this call when their layer manager is destroyed, this
+ * indicates they should clear resources they don't really need after their
+ * LayerManager ceases to exist.
+ */
+ virtual void ClearCachedResources() {}
+
+ /**
+ * This variable is set by MarkLayersHidden() before painting. It indicates
+ * that the layer should not be composited during this transaction.
+ */
+ void SetHidden(bool aCovered) { mHidden = aCovered; }
+ bool IsHidden() const { return false; }
+ /**
+ * This variable is set by MarkLayersHidden() before painting. This is
+ * the operator to be used when compositing the layer in this transaction. It must
+ * be OVER or SOURCE.
+ */
+ void SetOperator(gfx::CompositionOp aOperator)
+ {
+ NS_ASSERTION(aOperator == gfx::CompositionOp::OP_OVER ||
+ aOperator == gfx::CompositionOp::OP_SOURCE,
+ "Bad composition operator");
+ mOperator = aOperator;
+ }
+
+ gfx::CompositionOp GetOperator() const { return mOperator; }
+
+ /**
+ * Return a surface for this layer. Will use an existing surface, if
+ * possible, or may create a temporary surface. Implement this
+ * method for any layers that might be used as a mask. Should only
+ * return false if a surface cannot be created. If true is
+ * returned, only one of |aSurface| or |aDescriptor| is valid.
+ */
+ virtual already_AddRefed<gfx::SourceSurface> GetAsSourceSurface() { return nullptr; }
+
+ bool GetClipToVisibleRegion() { return mClipToVisibleRegion; }
+ void SetClipToVisibleRegion(bool aClip) { mClipToVisibleRegion = aClip; }
+
+ void SetDrawAtomically(bool aDrawAtomically) { mDrawAtomically = aDrawAtomically; }
+
+protected:
+ bool mHidden;
+ bool mClipToVisibleRegion;
+ bool mDrawAtomically;
+ gfx::CompositionOp mOperator;
+};
+
+} // namespace layers
+} // namespace mozilla
+
+#endif