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

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