adaptors/devel-api/adaptor-framework/render-surface.h

   1 #ifndef __DALI_RENDER_SURFACE_H__
   2 #define __DALI_RENDER_SURFACE_H__
   3
   4 /*
   5  * Copyright (c) 2015 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/dali-common.h>
  25 #include <dali/public-api/common/view-mode.h>
  26
  27 // INTERNAL INCLUDES
  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   /**
  66    * @brief Constructor
  67    * Inlined as this is a pure abstract interface
  68    */
  69   RenderSurface() {}
  70
  71   /**
  72    * @brief Virtual Destructor.
  73    * Inlined as this is a pure abstract interface
  74    */
  75   virtual ~RenderSurface() {}
  76
  77   /**
  78    * @brief Return the size and position of the surface.
  79    * @return The position and size
  80    */
  81   virtual PositionSize GetPositionSize() const = 0;
  82
  83   /**
  84    * Initialize EGL, RenderSurface should create egl display and initialize
  85    * @param egl implementation to use for the creation
  86    */
  87   virtual void InitializeEgl( EglInterface& egl ) = 0;
  88
  89   /**
  90    * @brief Creates EGL Surface
  91    * @param egl implementation to use for the creation
  92    */
  93   virtual void CreateEglSurface( EglInterface& egl ) = 0;
  94
  95   /**
  96    * @brief Destroys EGL Surface
  97    * @param egl implementation to use for the destruction
  98    */
  99   virtual void DestroyEglSurface( EglInterface& egl ) = 0;
 100
 101   /**
 102    * @brief Replace the EGL Surface
 103    * @param egl implementation to use for the creation
 104    * @return true if context was lost
 105    */
 106   virtual bool ReplaceEGLSurface( EglInterface& egl ) = 0;
 107
 108   /**
 109    * @brief Resizes the underlying surface. Only available for x window
 110    */
 111   virtual void MoveResize( Dali::PositionSize positionSize ) = 0;
 112
 113   /**
 114    * @brief Set the stereoscopic 3D view mode
 115    * @param[in] viewMode The new view mode
 116    */
 117   virtual void SetViewMode( ViewMode viewMode ) = 0;
 118
 119   /**
 120    * @brief Called when Render thread has started
 121    */
 122   virtual void StartRender() = 0;
 123
 124   /**
 125    * @brief Invoked by render thread before Core::Render
 126    * If the operation fails, then Core::Render should not be called until there is
 127    * a surface to render onto.
 128    * @param[in] egl The Egl interface
 129    * @param[in] glAbstraction OpenGLES abstraction interface
 130    * @return True if the operation is successful, False if the operation failed
 131    */
 132   virtual bool PreRender( EglInterface& egl, Integration::GlAbstraction& glAbstraction ) = 0;
 133
 134   /**
 135    * @brief Invoked by render thread after Core::Render
 136    * @param[in] egl The Egl interface
 137    * @param[in] glAbstraction OpenGLES abstraction interface
 138    * @param[in] displayConnection display connection
 139    * @param[in] replacingSurface True if the surface is being replaced.
 140    */
 141   virtual void PostRender( EglInterface& egl, Integration::GlAbstraction& glAbstraction, DisplayConnection* displayConnection, bool replacingSurface ) = 0;
 142
 143   /**
 144    * @brief Invoked by render thread when the thread should be stop
 145    */
 146   virtual void StopRender() = 0;
 147
 148   /**
 149    * @brief Invoked by Event Thread when the compositor lock should be released and rendering should resume.
 150    */
 151   virtual void ReleaseLock() = 0;
 152
 153   /**
 154    * @brief Sets the ThreadSynchronizationInterface
 155    *
 156    * @param threadSynchronization The thread-synchronization implementation.
 157    */
 158   virtual void SetThreadSynchronization( ThreadSynchronizationInterface& threadSynchronization ) = 0;
 159
 160 private:
 161
 162   /**
 163    * @brief Undefined copy constructor. RenderSurface cannot be copied
 164    */
 165   RenderSurface( const RenderSurface& rhs );
 166
 167   /**
 168    * @brief Undefined assignment operator. RenderSurface cannot be copied
 169    */
 170   RenderSurface& operator=( const RenderSurface& rhs );
 171 };
 172
 173 } // namespace Dali
 174
 175 #endif // __DALI_RENDER_SURFACE_H__