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