1 #ifndef DALI_RENDER_SURFACE_INTERFACE_H
2 #define DALI_RENDER_SURFACE_INTERFACE_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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 #include <dali/public-api/object/weak-handle.h>
28 #include <dali/integration-api/scene.h>
33 class DisplayConnection;
34 class ThreadSynchronizationInterface;
40 class AdaptorInternalServices;
41 class GraphicsInterface;
46 * @brief The position and size of the render surface.
48 typedef Dali::Rect<int> PositionSize;
51 * @brief Interface for a render surface onto which Dali draws.
53 * Dali::Adaptor requires a render surface to draw on to. This is
54 * usually a window in the native windowing system, or some other
55 * mapped pixel buffer.
57 * Dali::Application will automatically create a render surface using a window.
59 * The implementation of the factory method below should choose an appropriate
60 * implementation of RenderSurface for the given platform
63 class RenderSurfaceInterface
69 WINDOW_RENDER_SURFACE,
70 PIXMAP_RENDER_SURFACE,
76 * Inlined as this is a pure abstract interface
78 RenderSurfaceInterface()
79 : mAdaptor( nullptr ),
81 mDisplayConnection( nullptr ),
83 mDepthBufferRequired( Integration::DepthBufferAvailable::FALSE ),
84 mStencilBufferRequired( Integration::StencilBufferAvailable::FALSE )
88 * @brief Virtual Destructor.
89 * Inlined as this is a pure abstract interface
91 virtual ~RenderSurfaceInterface() {}
94 * @brief Return the size and position of the surface.
95 * @return The position and size
97 virtual Dali::PositionSize GetPositionSize() const = 0;
101 * @param[out] dpiHorizontal set to the horizontal dpi
102 * @param[out] dpiVertical set to the vertical dpi
104 virtual void GetDpi( unsigned int& dpiHorizontal, unsigned int& dpiVertical ) = 0;
107 * @brief Return the orientation of the surface.
108 * @return The orientation
110 virtual int GetOrientation() const = 0;
113 * @brief InitializeGraphics the platform specific graphics surface interfaces
115 virtual void InitializeGraphics() = 0;
118 * @brief Creates the Surface
120 virtual void CreateSurface() = 0;
123 * @brief Destroys the Surface
125 virtual void DestroySurface() = 0;
128 * @brief Replace the Surface
129 * @return true if context was lost
131 virtual bool ReplaceGraphicsSurface() = 0;
134 * @brief Resizes the underlying surface.
135 * @param[in] The dimensions of the new position
137 virtual void MoveResize( Dali::PositionSize positionSize ) = 0;
140 * @brief Called when Render thread has started
142 virtual void StartRender() = 0;
145 * @brief Invoked by render thread before Core::Render
146 * If the operation fails, then Core::Render should not be called until there is
147 * a surface to render onto.
148 * @param[in] resizingSurface True if the surface is being resized
149 * @param[in] damagedRects List of damaged rects this render pass
150 * @return True if the operation is successful, False if the operation failed
152 virtual bool PreRender( bool resizingSurface, const std::vector<Rect<int>>& damagedRects, Rect<int>& clippingRect ) = 0;
155 * @brief Invoked by render thread after Core::Render
156 * @param[in] renderToFbo True if render to FBO.
157 * @param[in] replacingSurface True if the surface is being replaced.
158 * @param[in] resizingSurface True if the surface is being resized.
160 virtual void PostRender( bool renderToFbo, bool replacingSurface, bool resizingSurface, const std::vector<Rect<int>>& damagedRects ) = 0;
163 * @brief Invoked by render thread when the thread should be stop
165 virtual void StopRender() = 0;
168 * @brief Invoked by Event Thread when the compositor lock should be released and rendering should resume.
170 virtual void ReleaseLock() = 0;
173 * @brief Sets the ThreadSynchronizationInterface
175 * @param threadSynchronization The thread-synchronization implementation.
177 virtual void SetThreadSynchronization( ThreadSynchronizationInterface& threadSynchronization ) = 0;
180 * @brief Gets the surface type
182 virtual Dali::RenderSurfaceInterface::Type GetSurfaceType() = 0;
185 * @brief Makes the graphics context current
187 virtual void MakeContextCurrent() = 0;
190 * @brief Get whether the depth buffer is required
191 * @return TRUE if the depth buffer is required
193 virtual Integration::DepthBufferAvailable GetDepthBufferRequired() = 0;
196 * @brief Get whether the stencil buffer is required
197 * @return TRUE if the stencil buffer is required
199 virtual Integration::StencilBufferAvailable GetStencilBufferRequired() = 0;
203 void SetAdaptor( Dali::Internal::Adaptor::AdaptorInternalServices& adaptor )
208 void SetGraphicsInterface( Dali::Internal::Adaptor::GraphicsInterface& graphics )
210 mGraphics = &graphics;
213 void SetDisplayConnection( Dali::DisplayConnection& displayConnection )
215 mDisplayConnection = &displayConnection;
219 * @brief Sets a Scene that is rendered on this surface.
220 * @param scene The Scene object
222 void SetScene( Dali::Integration::Scene& scene )
230 * @brief Undefined copy constructor. RenderSurface cannot be copied
232 RenderSurfaceInterface( const RenderSurfaceInterface& rhs );
235 * @brief Undefined assignment operator. RenderSurface cannot be copied
237 RenderSurfaceInterface& operator=( const RenderSurfaceInterface& rhs );
241 Dali::Internal::Adaptor::AdaptorInternalServices* mAdaptor;
242 Dali::Internal::Adaptor::GraphicsInterface* mGraphics;
243 Dali::DisplayConnection* mDisplayConnection;
244 WeakHandle< Dali::Integration::Scene > mScene;
248 Integration::DepthBufferAvailable mDepthBufferRequired; ///< Whether the depth buffer is required
249 Integration::StencilBufferAvailable mStencilBufferRequired; ///< Whether the stencil buffer is required
251 Vector4 mBackgroundColor; ///< The background color of the surface
256 #endif // DALI_RENDER_SURFACE_INTERFACE_H