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>
31 class DisplayConnection;
32 class ThreadSynchronizationInterface;
43 class AdaptorInternalServices;
44 class GraphicsInterface;
49 * @brief The position and size of the render surface.
51 typedef Dali::Rect<int> PositionSize;
54 * @brief Interface for a render surface onto which Dali draws.
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.
60 * Dali::Application will automatically create a render surface using a window.
62 * The implementation of the factory method below should choose an appropriate
63 * implementation of RenderSurface for the given platform
66 class RenderSurfaceInterface
72 WINDOW_RENDER_SURFACE,
73 PIXMAP_RENDER_SURFACE,
79 * Inlined as this is a pure abstract interface
81 RenderSurfaceInterface()
82 : mAdaptor( nullptr ),
84 mDisplayConnection( nullptr ),
86 mDepthBufferRequired( Integration::DepthBufferAvailable::FALSE ),
87 mStencilBufferRequired( Integration::StencilBufferAvailable::FALSE )
91 * @brief Virtual Destructor.
92 * Inlined as this is a pure abstract interface
94 virtual ~RenderSurfaceInterface() {}
97 * @brief Return the size and position of the surface.
98 * @return The position and size
100 virtual Dali::PositionSize GetPositionSize() const = 0;
104 * @param[out] dpiHorizontal set to the horizontal dpi
105 * @param[out] dpiVertical set to the vertical dpi
107 virtual void GetDpi( unsigned int& dpiHorizontal, unsigned int& dpiVertical ) = 0;
110 * @brief Return the orientation of the surface.
111 * @return The orientation
113 virtual int GetOrientation() const = 0;
116 * @brief InitializeGraphics the platform specific graphics surface interfaces
118 virtual void InitializeGraphics() = 0;
121 * @brief Creates the Surface
123 virtual void CreateSurface() = 0;
126 * @brief Destroys the Surface
128 virtual void DestroySurface() = 0;
131 * @brief Replace the Surface
132 * @return true if context was lost
134 virtual bool ReplaceGraphicsSurface() = 0;
137 * @brief Resizes the underlying surface.
138 * @param[in] The dimensions of the new position
140 virtual void MoveResize( Dali::PositionSize positionSize ) = 0;
143 * @brief Called when Render thread has started
145 virtual void StartRender() = 0;
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
155 virtual bool PreRender( bool resizingSurface, const std::vector<Rect<int>>& damagedRects, Rect<int>& clippingRect ) = 0;
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.
163 virtual void PostRender( bool renderToFbo, bool replacingSurface, bool resizingSurface, const std::vector<Rect<int>>& damagedRects ) = 0;
166 * @brief Invoked by render thread when the thread should be stop
168 virtual void StopRender() = 0;
171 * @brief Invoked by Event Thread when the compositor lock should be released and rendering should resume.
173 virtual void ReleaseLock() = 0;
176 * @brief Sets the ThreadSynchronizationInterface
178 * @param threadSynchronization The thread-synchronization implementation.
180 virtual void SetThreadSynchronization( ThreadSynchronizationInterface& threadSynchronization ) = 0;
183 * @brief Gets the surface type
185 virtual Dali::RenderSurfaceInterface::Type GetSurfaceType() = 0;
188 * @brief Makes the graphics context current
190 virtual void MakeContextCurrent() = 0;
193 * @brief Get whether the depth buffer is required
194 * @return TRUE if the depth buffer is required
196 virtual Integration::DepthBufferAvailable GetDepthBufferRequired() = 0;
199 * @brief Get whether the stencil buffer is required
200 * @return TRUE if the stencil buffer is required
202 virtual Integration::StencilBufferAvailable GetStencilBufferRequired() = 0;
206 void SetAdaptor( Dali::Internal::Adaptor::AdaptorInternalServices& adaptor )
211 void SetGraphicsInterface( Dali::Internal::Adaptor::GraphicsInterface& graphics )
213 mGraphics = &graphics;
216 void SetDisplayConnection( Dali::DisplayConnection& displayConnection )
218 mDisplayConnection = &displayConnection;
222 * @brief Sets a Scene that is rendered on this surface.
223 * @param scene The Scene object
225 void SetScene( Dali::Integration::Scene& scene )
227 // This will be changed to use the WeakHandle later.
234 * @brief Undefined copy constructor. RenderSurface cannot be copied
236 RenderSurfaceInterface( const RenderSurfaceInterface& rhs );
239 * @brief Undefined assignment operator. RenderSurface cannot be copied
241 RenderSurfaceInterface& operator=( const RenderSurfaceInterface& rhs );
245 Dali::Internal::Adaptor::AdaptorInternalServices* mAdaptor;
246 Dali::Internal::Adaptor::GraphicsInterface* mGraphics;
247 Dali::DisplayConnection* mDisplayConnection;
248 Dali::Integration::Scene* mScene;
252 Integration::DepthBufferAvailable mDepthBufferRequired; ///< Whether the depth buffer is required
253 Integration::StencilBufferAvailable mStencilBufferRequired; ///< Whether the stencil buffer is required
255 Vector4 mBackgroundColor; ///< The background color of the surface
260 #endif // DALI_RENDER_SURFACE_INTERFACE_H