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) 2020 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/public-api/math/vector4.h>
  24 #include <dali/public-api/math/rect.h>
  25 #include <dali/public-api/object/any.h>
  26
  27 namespace Dali
  28 {
  29
  30 class DisplayConnection;
  31 class ThreadSynchronizationInterface;
  32
  33 namespace Internal
  34 {
  35 namespace Adaptor
  36 {
  37 class AdaptorInternalServices;
  38 class GraphicsInterface;
  39 }
  40 }
  41
  42 /**
  43  * @brief The position and size of the render surface.
  44  */
  45 typedef Dali::Rect<int> PositionSize;
  46
  47 /**
  48  * @brief Interface for a render surface onto which Dali draws.
  49  *
  50  * Dali::Adaptor requires a render surface to draw on to. This is
  51  * usually a window in the native windowing system, or some other
  52  * mapped pixel buffer.
  53  *
  54  * Dali::Application will automatically create a render surface using a window.
  55  *
  56  * The implementation of the factory method below should choose an appropriate
  57  * implementation of RenderSurface for the given platform
  58  */
  59
  60 class RenderSurfaceInterface
  61 {
  62 public:
  63
  64   enum Type
  65   {
  66     WINDOW_RENDER_SURFACE,
  67     PIXMAP_RENDER_SURFACE,
  68     NATIVE_RENDER_SURFACE
  69   };
  70
  71   /**
  72    * @brief Constructor
  73    * Inlined as this is a pure abstract interface
  74    */
  75   RenderSurfaceInterface()
  76   : mAdaptor( nullptr ),
  77     mGraphics( nullptr ),
  78     mDisplayConnection( nullptr ),
  79     mDepthBufferRequired( Integration::DepthBufferAvailable::FALSE ),
  80     mStencilBufferRequired( Integration::StencilBufferAvailable::FALSE )
  81   {}
  82
  83   /**
  84    * @brief Virtual Destructor.
  85    * Inlined as this is a pure abstract interface
  86    */
  87   virtual ~RenderSurfaceInterface() {}
  88
  89   /**
  90    * @brief Return the size and position of the surface.
  91    * @return The position and size
  92    */
  93   virtual Dali::PositionSize GetPositionSize() const = 0;
  94
  95   /**
  96    * @brief Get DPI
  97    * @param[out] dpiHorizontal set to the horizontal dpi
  98    * @param[out] dpiVertical set to the vertical dpi
  99    */
 100   virtual void GetDpi( unsigned int& dpiHorizontal, unsigned int& dpiVertical ) = 0;
 101
 102   /**
 103    * @brief InitializeGraphics the platform specific graphics surface interfaces
 104    */
 105   virtual void InitializeGraphics() = 0;
 106
 107   /**
 108    * @brief Creates the Surface
 109    */
 110   virtual void CreateSurface() = 0;
 111
 112   /**
 113    * @brief Destroys the Surface
 114    */
 115   virtual void DestroySurface() = 0;
 116
 117   /**
 118    * @brief Replace the Surface
 119    * @return true if context was lost
 120    */
 121   virtual bool ReplaceGraphicsSurface() = 0;
 122
 123   /**
 124    * @brief Resizes the underlying surface.
 125    * @param[in] The dimensions of the new position
 126    */
 127   virtual void MoveResize( Dali::PositionSize positionSize ) = 0;
 128
 129   /**
 130    * @brief Called when Render thread has started
 131    */
 132   virtual void StartRender() = 0;
 133
 134   /**
 135    * @brief Invoked by render thread before Core::Render
 136    * If the operation fails, then Core::Render should not be called until there is
 137    * a surface to render onto.
 138    * @param[in] resizingSurface True if the surface is being resized
 139    * @return True if the operation is successful, False if the operation failed
 140    */
 141   virtual bool PreRender( bool resizingSurface ) = 0;
 142
 143   /**
 144    * @brief Invoked by render thread after Core::Render
 145    * @param[in] renderToFbo True if render to FBO.
 146    * @param[in] replacingSurface True if the surface is being replaced.
 147    * @param[in] resizingSurface True if the surface is being resized.
 148    */
 149   virtual void PostRender( bool renderToFbo, bool replacingSurface, bool resizingSurface ) = 0;
 150   /**
 151    * @brief Invoked by render thread when the thread should be stop
 152    */
 153   virtual void StopRender() = 0;
 154
 155   /**
 156    * @brief Invoked by Event Thread when the compositor lock should be released and rendering should resume.
 157    */
 158   virtual void ReleaseLock() = 0;
 159
 160   /**
 161    * @brief Sets the ThreadSynchronizationInterface
 162    *
 163    * @param threadSynchronization The thread-synchronization implementation.
 164    */
 165   virtual void SetThreadSynchronization( ThreadSynchronizationInterface& threadSynchronization ) = 0;
 166
 167   /**
 168    * @brief Gets the surface type
 169    */
 170   virtual Dali::RenderSurfaceInterface::Type GetSurfaceType() = 0;
 171
 172   /**
 173    * @brief Makes the graphics context current
 174    */
 175   virtual void MakeContextCurrent() = 0;
 176
 177   /**
 178    * @brief Get whether the depth buffer is required
 179    * @return TRUE if the depth buffer is required
 180    */
 181   virtual Integration::DepthBufferAvailable GetDepthBufferRequired() = 0;
 182
 183   /**
 184    * @brief Get whether the stencil buffer is required
 185    * @return TRUE if the stencil buffer is required
 186    */
 187   virtual Integration::StencilBufferAvailable GetStencilBufferRequired() = 0;
 188
 189 public:
 190
 191   void SetAdaptor( Dali::Internal::Adaptor::AdaptorInternalServices& adaptor )
 192   {
 193     mAdaptor = &adaptor;
 194   }
 195
 196   void SetGraphicsInterface( Dali::Internal::Adaptor::GraphicsInterface& graphics )
 197   {
 198     mGraphics = &graphics;
 199   }
 200
 201   void SetDisplayConnection( Dali::DisplayConnection& displayConnection )
 202   {
 203     mDisplayConnection = &displayConnection;
 204   }
 205
 206 private:
 207
 208   /**
 209    * @brief Undefined copy constructor. RenderSurface cannot be copied
 210    */
 211   RenderSurfaceInterface( const RenderSurfaceInterface& rhs );
 212
 213   /**
 214    * @brief Undefined assignment operator. RenderSurface cannot be copied
 215    */
 216   RenderSurfaceInterface& operator=( const RenderSurfaceInterface& rhs );
 217
 218 protected:
 219
 220   Dali::Internal::Adaptor::AdaptorInternalServices* mAdaptor;
 221   Dali::Internal::Adaptor::GraphicsInterface* mGraphics;
 222   Dali::DisplayConnection* mDisplayConnection;
 223
 224 private:
 225
 226   Integration::DepthBufferAvailable mDepthBufferRequired;       ///< Whether the depth buffer is required
 227   Integration::StencilBufferAvailable mStencilBufferRequired;   ///< Whether the stencil buffer is required
 228
 229   Vector4 mBackgroundColor;                                     ///< The background color of the surface
 230 };
 231
 232 } // namespace Dali
 233
 234 #endif // DALI_RENDER_SURFACE_INTERFACE_H