dali/integration-api/adaptor-framework/render-surface-interface.h

   1 #ifndef DALI_RENDER_SURFACE_INTERFACE_H
   2 #define DALI_RENDER_SURFACE_INTERFACE_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/integration-api/core-enumerations.h>
  23 #include <dali/integration-api/scene.h>
  24 #include <dali/public-api/common/vector-wrapper.h>
  25 #include <dali/public-api/math/rect.h>
  26 #include <dali/public-api/math/uint-16-pair.h>
  27 #include <dali/public-api/math/vector4.h>
  28 #include <dali/public-api/object/any.h>
  29 #include <dali/public-api/object/weak-handle.h>
  30
  31 namespace Dali
  32 {
  33 class DisplayConnection;
  34 class ThreadSynchronizationInterface;
  35
  36 namespace Internal
  37 {
  38 namespace Adaptor
  39 {
  40 class AdaptorInternalServices;
  41 class GraphicsInterface;
  42 } // namespace Adaptor
  43 } // namespace Internal
  44
  45 /**
  46  * @brief The position and size of the render surface.
  47  */
  48 using PositionSize = Dali::Rect<int>;
  49 using SurfaceSize  = Uint16Pair;
  50
  51 /**
  52  * @brief Interface for a render surface onto which Dali draws.
  53  *
  54  * Dali::Adaptor requires a render surface to draw on to. This is
  55  * usually a window in the native windowing system, or some other
  56  * mapped pixel buffer.
  57  *
  58  * Dali::Application will automatically create a render surface using a window.
  59  *
  60  * The implementation of the factory method below should choose an appropriate
  61  * implementation of RenderSurface for the given platform
  62  */
  63
  64 class RenderSurfaceInterface
  65 {
  66 public:
  67   enum Type
  68   {
  69     WINDOW_RENDER_SURFACE,
  70     PIXMAP_RENDER_SURFACE,
  71     NATIVE_RENDER_SURFACE
  72   };
  73
  74   /**
  75    * @brief Constructor
  76    * Inlined as this is a pure abstract interface
  77    */
  78   RenderSurfaceInterface()
  79   : mAdaptor(nullptr),
  80     mGraphics(nullptr),
  81     mDisplayConnection(nullptr),
  82     mScene(),
  83     mFullSwapNextFrame(true),
  84     mDepthBufferRequired(Integration::DepthBufferAvailable::FALSE),
  85     mStencilBufferRequired(Integration::StencilBufferAvailable::FALSE)
  86   {
  87   }
  88
  89   /**
  90    * @brief Virtual Destructor.
  91    * Inlined as this is a pure abstract interface
  92    */
  93   virtual ~RenderSurfaceInterface()
  94   {
  95   }
  96
  97   /**
  98    * @brief Return the size and position of the surface.
  99    * @return The position and size
 100    */
 101   virtual Dali::PositionSize GetPositionSize() const = 0;
 102
 103   /**
 104    * @brief Get DPI
 105    * @param[out] dpiHorizontal set to the horizontal dpi
 106    * @param[out] dpiVertical set to the vertical dpi
 107    */
 108   virtual void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) = 0;
 109
 110   /**
 111    * @brief Return the orientation of the surface.
 112    * @return The orientation
 113    */
 114   virtual int GetSurfaceOrientation() const = 0;
 115
 116   /**
 117    * @brief Return the orientation of the screen.
 118    * @return The screen orientation
 119    */
 120   virtual int GetScreenOrientation() const = 0;
 121
 122   /**
 123    * @brief InitializeGraphics the platform specific graphics surface interfaces
 124    */
 125   virtual void InitializeGraphics() = 0;
 126
 127   /**
 128    * @brief Creates the Surface
 129    */
 130   virtual void CreateSurface() = 0;
 131
 132   /**
 133    * @brief Destroys the Surface
 134    */
 135   virtual void DestroySurface() = 0;
 136
 137   /**
 138    * @brief Replace the Surface
 139    * @return true if context was lost
 140    */
 141   virtual bool ReplaceGraphicsSurface() = 0;
 142
 143   /**
 144    * @brief Resizes the underlying surface.
 145    * @param[in] The dimensions of the new position
 146    */
 147   virtual void MoveResize(Dali::PositionSize positionSize) = 0;
 148
 149   /**
 150    * @brief Called when Render thread has started
 151    */
 152   virtual void StartRender() = 0;
 153
 154   /**
 155    * @brief Invoked by render thread before Core::RenderScene
 156    * If the operation fails, then Core::Render should not be called until there is
 157    * a surface to render onto.
 158    * @param[in] resizingSurface True if the surface is being resized
 159    * @param[in] damagedRects List of damaged rects this render pass
 160    * @return True if the operation is successful, False if the operation failed
 161    */
 162   virtual bool PreRender(bool resizingSurface, const std::vector<Rect<int>>& damagedRects, Rect<int>& clippingRect) = 0;
 163
 164   /**
 165    * @brief Invoked by render thread after Core::RenderScene
 166    */
 167   virtual void PostRender() = 0;
 168
 169   /**
 170    * @brief Invoked by render thread when the thread should be stop
 171    */
 172   virtual void StopRender() = 0;
 173
 174   /**
 175    * @brief Invoked by Event Thread when the compositor lock should be released and rendering should resume.
 176    */
 177   virtual void ReleaseLock() = 0;
 178
 179   /**
 180    * @brief Sets the ThreadSynchronizationInterface
 181    *
 182    * @param threadSynchronization The thread-synchronization implementation.
 183    */
 184   virtual void SetThreadSynchronization(ThreadSynchronizationInterface& threadSynchronization) = 0;
 185
 186   /**
 187    * @brief Gets the surface type
 188    */
 189   virtual Dali::RenderSurfaceInterface::Type GetSurfaceType() = 0;
 190
 191   /**
 192    * @brief Makes the graphics context current
 193    */
 194   virtual void MakeContextCurrent() = 0;
 195
 196   /**
 197    * @brief Get whether the depth buffer is required
 198    * @return TRUE if the depth buffer is required
 199    */
 200   virtual Integration::DepthBufferAvailable GetDepthBufferRequired() = 0;
 201
 202   /**
 203    * @brief Get whether the stencil buffer is required
 204    * @return TRUE if the stencil buffer is required
 205    */
 206   virtual Integration::StencilBufferAvailable GetStencilBufferRequired() = 0;
 207
 208 public:
 209   void SetAdaptor(Dali::Internal::Adaptor::AdaptorInternalServices& adaptor)
 210   {
 211     mAdaptor = &adaptor;
 212   }
 213
 214   void SetGraphicsInterface(Dali::Internal::Adaptor::GraphicsInterface& graphics)
 215   {
 216     mGraphics = &graphics;
 217   }
 218
 219   void SetDisplayConnection(Dali::DisplayConnection& displayConnection)
 220   {
 221     mDisplayConnection = &displayConnection;
 222   }
 223
 224   /**
 225    * @brief Sets a Scene that is rendered on this surface.
 226    * @param scene The Scene object
 227    */
 228   void SetScene(Dali::Integration::Scene& scene)
 229   {
 230     mScene = scene;
 231   }
 232
 233   /**
 234    * @brief Forces full surface swap next frame, resets current partial update state.
 235    */
 236   void SetFullSwapNextFrame()
 237   {
 238     mFullSwapNextFrame = true;
 239   }
 240
 241 private:
 242   /**
 243    * @brief Undefined copy constructor. RenderSurface cannot be copied
 244    */
 245   RenderSurfaceInterface(const RenderSurfaceInterface& rhs);
 246
 247   /**
 248    * @brief Undefined assignment operator. RenderSurface cannot be copied
 249    */
 250   RenderSurfaceInterface& operator=(const RenderSurfaceInterface& rhs);
 251
 252 protected:
 253   Dali::Internal::Adaptor::AdaptorInternalServices* mAdaptor;
 254   Dali::Internal::Adaptor::GraphicsInterface*       mGraphics;
 255   Dali::DisplayConnection*                          mDisplayConnection;
 256   WeakHandle<Dali::Integration::Scene>              mScene;
 257   bool                                              mFullSwapNextFrame; ///< Whether the full surface swap is required
 258
 259 private:
 260   Integration::DepthBufferAvailable   mDepthBufferRequired;   ///< Whether the depth buffer is required
 261   Integration::StencilBufferAvailable mStencilBufferRequired; ///< Whether the stencil buffer is required
 262
 263   Vector4 mBackgroundColor; ///< The background color of the surface
 264 };
 265
 266 } // namespace Dali
 267
 268 #endif // DALI_RENDER_SURFACE_INTERFACE_H