dali/integration-api/render-surface.h

   1 #ifndef __DALI_RENDER_SURFACE_H__
   2 #define __DALI_RENDER_SURFACE_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/public-api/math/rect.h>
  23 #include <dali/public-api/object/any.h>
  24 #include <dali/public-api/common/view-mode.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali/public-api/dali-adaptor-common.h>
  28
  29 namespace Dali
  30 {
  31
  32 class EglInterface;
  33 class DisplayConnection;
  34 class ThreadSynchronizationInterface;
  35
  36 namespace Integration
  37 {
  38
  39 class GlAbstraction;
  40
  41 } // namespace Integration
  42
  43 /**
  44  * @brief The position and size of the render surface.
  45  */
  46 typedef Dali::Rect<int> PositionSize;
  47
  48 /**
  49  * @brief Interface for a render surface onto which Dali draws.
  50  *
  51  * Dali::Adaptor requires a render surface to draw on to. This is
  52  * usually a window in the native windowing system, or some other
  53  * mapped pixel buffer.
  54  *
  55  * Dali::Application will automatically create a render surface using a window.
  56  *
  57  * The implementation of the factory method below should choose an appropriate
  58  * implementation of RenderSurface for the given platform
  59  */
  60
  61 class RenderSurface
  62 {
  63 public:
  64
  65   enum Type
  66   {
  67     WINDOW_RENDER_SURFACE,
  68     PIXMAP_RENDER_SURFACE,
  69     NATIVE_RENDER_SURFACE
  70   };
  71
  72   /**
  73    * @brief Constructor
  74    * Inlined as this is a pure abstract interface
  75    */
  76   RenderSurface() {}
  77
  78   /**
  79    * @brief Virtual Destructor.
  80    * Inlined as this is a pure abstract interface
  81    */
  82   virtual ~RenderSurface() {}
  83
  84   /**
  85    * @brief Return the size and position of the surface.
  86    * @return The position and size
  87    */
  88   virtual PositionSize GetPositionSize() const = 0;
  89
  90   /**
  91    * @brief Get DPI
  92    * @param[out] dpiHorizontal set to the horizontal dpi
  93    * @param[out] dpiVertical set to the vertical dpi
  94    */
  95   virtual void GetDpi( unsigned int& dpiHorizontal, unsigned int& dpiVertical ) = 0;
  96
  97   /**
  98    * Initialize EGL, RenderSurface should create egl display and initialize
  99    * @param egl implementation to use for the creation
 100    */
 101   virtual void InitializeEgl( EglInterface& egl ) = 0;
 102
 103   /**
 104    * @brief Creates EGL Surface
 105    * @param egl implementation to use for the creation
 106    */
 107   virtual void CreateEglSurface( EglInterface& egl ) = 0;
 108
 109   /**
 110    * @brief Destroys EGL Surface
 111    * @param egl implementation to use for the destruction
 112    */
 113   virtual void DestroyEglSurface( EglInterface& egl ) = 0;
 114
 115   /**
 116    * @brief Replace the EGL Surface
 117    * @param egl implementation to use for the creation
 118    * @return true if context was lost
 119    */
 120   virtual bool ReplaceEGLSurface( EglInterface& egl ) = 0;
 121
 122   /**
 123    * @brief Resizes the underlying surface.
 124    */
 125   virtual void MoveResize( Dali::PositionSize positionSize ) = 0;
 126
 127   /**
 128    * @brief Set the stereoscopic 3D view mode
 129    * @param[in] viewMode The new view mode
 130    */
 131   virtual void SetViewMode( ViewMode viewMode ) = 0;
 132
 133   /**
 134    * @brief Called when Render thread has started
 135    */
 136   virtual void StartRender() = 0;
 137
 138   /**
 139    * @brief Invoked by render thread before Core::Render
 140    * If the operation fails, then Core::Render should not be called until there is
 141    * a surface to render onto.
 142    * @param[in] egl The Egl interface
 143    * @param[in] glAbstraction OpenGLES abstraction interface
 144    * @param[in] resizingSurface True if the surface is being resized
 145    * @return True if the operation is successful, False if the operation failed
 146    */
 147   virtual bool PreRender( EglInterface& egl, Integration::GlAbstraction& glAbstraction, bool resizingSurface ) = 0;
 148
 149   /**
 150    * @brief Invoked by render thread after Core::Render
 151    * @param[in] egl The Egl interface
 152    * @param[in] glAbstraction OpenGLES abstraction interface
 153    * @param[in] displayConnection display connection
 154    * @param[in] replacingSurface True if the surface is being replaced.
 155    * @param[in] resizingSurface True if the surface is being resized.
 156    */
 157   virtual void PostRender( EglInterface& egl, Integration::GlAbstraction& glAbstraction, DisplayConnection* displayConnection, bool replacingSurface, bool resizingSurface ) = 0;
 158
 159   /**
 160    * @brief Invoked by render thread when the thread should be stop
 161    */
 162   virtual void StopRender() = 0;
 163
 164   /**
 165    * @brief Invoked by Event Thread when the compositor lock should be released and rendering should resume.
 166    */
 167   virtual void ReleaseLock() = 0;
 168
 169   /**
 170    * @brief Sets the ThreadSynchronizationInterface
 171    *
 172    * @param threadSynchronization The thread-synchronization implementation.
 173    */
 174   virtual void SetThreadSynchronization( ThreadSynchronizationInterface& threadSynchronization ) = 0;
 175
 176   /**
 177    * @brief Gets the surface type
 178    */
 179   virtual RenderSurface::Type GetSurfaceType() = 0;
 180
 181 private:
 182
 183   /**
 184    * @brief Undefined copy constructor. RenderSurface cannot be copied
 185    */
 186   RenderSurface( const RenderSurface& rhs );
 187
 188   /**
 189    * @brief Undefined assignment operator. RenderSurface cannot be copied
 190    */
 191   RenderSurface& operator=( const RenderSurface& rhs );
 192 };
 193
 194 } // namespace Dali
 195
 196 #endif // __DALI_RENDER_SURFACE_H__