dali/integration-api/render-surface.h

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