widget/gtk/GtkCompositorWidget.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef widget_gtk_GtkCompositorWidget_h
   7 #define widget_gtk_GtkCompositorWidget_h
   8
   9 #include "GLDefs.h"
  10 #include "mozilla/DataMutex.h"
  11 #include "mozilla/widget/CompositorWidget.h"
  12 #include "WindowSurfaceProvider.h"
  13
  14 class nsIWidget;
  15 class nsWindow;
  16
  17 namespace mozilla {
  18 namespace widget {
  19
  20 class PlatformCompositorWidgetDelegate : public CompositorWidgetDelegate {
  21  public:
  22   virtual void NotifyClientSizeChanged(
  23       const LayoutDeviceIntSize& aClientSize) = 0;
  24
  25   // CompositorWidgetDelegate Overrides
  26
  27   PlatformCompositorWidgetDelegate* AsPlatformSpecificDelegate() override {
  28     return this;
  29   }
  30 };
  31
  32 class GtkCompositorWidgetInitData;
  33
  34 class GtkCompositorWidget : public CompositorWidget,
  35                             public PlatformCompositorWidgetDelegate {
  36  public:
  37   GtkCompositorWidget(const GtkCompositorWidgetInitData& aInitData,
  38                       const layers::CompositorOptions& aOptions,
  39                       nsWindow* aWindow /* = nullptr*/);
  40   ~GtkCompositorWidget();
  41
  42   // CompositorWidget Overrides
  43
  44   already_AddRefed<gfx::DrawTarget> StartRemoteDrawing() override;
  45   void EndRemoteDrawing() override;
  46
  47   already_AddRefed<gfx::DrawTarget> StartRemoteDrawingInRegion(
  48       LayoutDeviceIntRegion& aInvalidRegion,
  49       layers::BufferMode* aBufferMode) override;
  50   void EndRemoteDrawingInRegion(
  51       gfx::DrawTarget* aDrawTarget,
  52       const LayoutDeviceIntRegion& aInvalidRegion) override;
  53   uintptr_t GetWidgetKey() override;
  54
  55   LayoutDeviceIntSize GetClientSize() override;
  56
  57   nsIWidget* RealWidget() override;
  58   GtkCompositorWidget* AsX11() override { return this; }
  59   CompositorWidgetDelegate* AsDelegate() override { return this; }
  60
  61   EGLNativeWindowType GetEGLNativeWindow();
  62   int32_t GetDepth();
  63
  64 #if defined(MOZ_X11)
  65   Display* XDisplay() const { return mXDisplay; }
  66   Window XWindow() const { return mXWindow; }
  67 #endif
  68 #if defined(MOZ_WAYLAND)
  69   void SetEGLNativeWindowSize(const LayoutDeviceIntSize& aEGLWindowSize);
  70 #endif
  71
  72   // PlatformCompositorWidgetDelegate Overrides
  73
  74   void NotifyClientSizeChanged(const LayoutDeviceIntSize& aClientSize) override;
  75
  76  protected:
  77   nsWindow* mWidget;
  78
  79  private:
  80   // This field is written to on the main thread and read from on the compositor
  81   // or renderer thread. During window resizing, this is subject to a (largely
  82   // benign) read/write race, see bug 1665726. The DataMutex doesn't prevent the
  83   // read/write race, but it does make it Not Undefined Behaviour, and also
  84   // ensures we only ever use the old or new size, and not some weird synthesis
  85   // of the two.
  86   DataMutex<LayoutDeviceIntSize> mClientSize;
  87
  88   WindowSurfaceProvider mProvider;
  89
  90 #if defined(MOZ_X11)
  91   Display* mXDisplay = {};
  92   Window mXWindow = {};
  93 #endif
  94   int32_t mDepth = {};
  95 };
  96
  97 }  // namespace widget
  98 }  // namespace mozilla
  99
 100 #endif  // widget_gtk_GtkCompositorWidget_h