1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_RENDER_SURFACE_H
2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_RENDER_SURFACE_H
5 * Copyright (c) 2021 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/devel-api/threading/mutex.h>
23 #include <dali/integration-api/scene.h>
24 #include <dali/public-api/signals/connection-tracker.h>
25 #include <dali/public-api/signals/dali-signal.h>
29 #include <dali/integration-api/adaptor-framework/egl-interface.h>
30 #include <dali/integration-api/adaptor-framework/render-surface-interface.h>
31 #include <dali/internal/graphics/common/graphics-interface.h>
32 #include <dali/internal/system/common/file-descriptor-monitor.h>
36 class TriggerEventInterface;
43 class AdaptorInternalServices;
46 * Window interface of render surface.
48 class WindowRenderSurface : public Dali::RenderSurfaceInterface, public ConnectionTracker
51 using OutputSignalType = Signal<void()>;
52 using DamagedRectsContainer = std::list<std::vector<Rect<int>>>;
55 * Uses an window surface to render to.
56 * @param [in] positionSize the position and size of the surface
57 * @param [in] surface can be a window or pixmap.
58 * @param [in] isTransparent if it is true, surface has 32 bit color depth, otherwise, 24 bit
60 WindowRenderSurface(Dali::PositionSize positionSize, Any surface, bool isTransparent = false);
65 virtual ~WindowRenderSurface();
69 * @brief Get the native window handle
70 * @return The native window handle
72 Any GetNativeWindow();
75 * @brief Get the native window id
76 * @return The native window id
78 int GetNativeWindowId();
86 * @brief Sets the render notification trigger to call when render thread is completed a frame
87 * @param renderNotification to use
89 void SetRenderNotification(TriggerEventInterface* renderNotification);
92 * @brief Sets whether the surface is transparent or not.
93 * @param[in] transparent Whether the surface is transparent
95 void SetTransparency(bool transparent);
98 * Request surface rotation
99 * @param[in] angle A new angle of the surface
100 * @param[in] width A new width of the surface
101 * @param[in] height A new height of the surface
103 void RequestRotation(int angle, int width, int height);
106 * @brief Gets the window base object
107 * @return The window base object
109 WindowBase* GetWindowBase();
112 * @brief Intiailize Ime Surface for Ime window rendering.
114 * It sets one flag and callback function for Ime window rendering
115 * This callback function calls one special native window function for ready to commit buffer.
116 * The special function notify to display server.
117 * It is only used for Ime window.
119 void InitializeImeSurface();
122 * @brief Sets the necessary for window rotation acknowledge.
123 * After this function called, SendRotationCompletedAcknowledgement() should be called to complete window rotation.
125 * More detail description is written in DevelWindow::SetNeedsRotationCompletedAcknowledgement().
127 * @param[in] window The window instance.
128 * @param[in] needAcknowledgement the flag is true if window rotation acknowledgement is sent.
130 void SetNeedsRotationCompletedAcknowledgement(bool needAcknowledgement);
133 * @brief This signal is emitted when the output is transformed.
135 OutputSignalType& OutputTransformedSignal();
137 public: // from Dali::RenderSurfaceInterface
139 * @copydoc Dali::RenderSurfaceInterface::GetPositionSize()
141 PositionSize GetPositionSize() const override;
145 void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) override;
148 * @copydoc Dali::RenderSurfaceInterface::GetOrientation()
150 int GetOrientation() const override;
153 * @copydoc Dali::RenderSurfaceInterface::InitializeGraphics()
155 void InitializeGraphics() override;
158 * @copydoc Dali::RenderSurfaceInterface::CreateSurface()
160 void CreateSurface() override;
163 * @copydoc Dali::RenderSurfaceInterface::DestroySurface()
165 void DestroySurface() override;
168 * @copydoc Dali::RenderSurfaceInterface::ReplaceGraphicsSurface()
170 bool ReplaceGraphicsSurface() override;
173 * @copydoc Dali::RenderSurfaceInterface::MoveResize()
175 void MoveResize(Dali::PositionSize positionSize) override;
178 * @copydoc Dali::RenderSurfaceInterface::StartRender()
180 void StartRender() override;
183 * @copydoc Dali::RenderSurfaceInterface::PreRender()
185 bool PreRender(bool resizingSurface, const std::vector<Rect<int>>& damagedRects, Rect<int>& clippingRect) override;
188 * @copydoc Dali::RenderSurfaceInterface::PostRender()
190 void PostRender() override;
193 * @copydoc Dali::RenderSurfaceInterface::StopRender()
195 void StopRender() override;
198 * @copydoc Dali::RenderSurfaceInterface::SetThreadSynchronization
200 void SetThreadSynchronization(ThreadSynchronizationInterface& threadSynchronization) override;
203 * @copydoc Dali::RenderSurfaceInterface::ReleaseLock()
205 void ReleaseLock() override;
208 * @copydoc Dali::RenderSurfaceInterface::GetSurfaceType()
210 Dali::RenderSurfaceInterface::Type GetSurfaceType() override;
213 * @copydoc Dali::RenderSurfaceInterface::MakeContextCurrent()
215 void MakeContextCurrent() override;
218 * @copydoc Dali::RenderSurfaceInterface::GetDepthBufferRequired()
220 Integration::DepthBufferAvailable GetDepthBufferRequired() override;
223 * @copydoc Dali::RenderSurfaceInterface::GetStencilBufferRequired()
225 Integration::StencilBufferAvailable GetStencilBufferRequired() override;
229 * @brief Second stage construction
231 void Initialize(Any surface);
234 * Notify output is transformed.
236 void OutputTransformed();
239 * @brief Used as the callback for the post render.
240 * It is used both window rotation and supporting Ime window
242 void ProcessPostRender();
245 * @brief Used as the callback for the frame rendered / presented.
247 void ProcessFrameCallback();
250 * @brief Called when our event file descriptor has been written to.
251 * @param[in] eventBitMask bit mask of events that occured on the file descriptor
252 * @param[in] fileDescriptor The file descriptor
254 void OnFileDescriptorEventDispatched(FileDescriptorMonitor::EventType eventBitMask, int fileDescriptor);
257 * @brief Set the buffer damage rects.
258 * @param[in] damagedRects List of damaged rects
259 * @param[in] clippingRect The rect to clip rendered scene
261 void SetBufferDamagedRects(const std::vector<Rect<int>>& damagedRects, Rect<int>& clippingRect);
264 * @brief Swap buffers.
265 * @param[in] damagedRects List of damaged rects
267 void SwapBuffers(const std::vector<Rect<int>>& damagedRects);
271 WindowRenderSurface(const WindowRenderSurface&) = delete;
274 WindowRenderSurface& operator=(const WindowRenderSurface& rhs) = delete;
277 struct FrameCallbackInfo
279 FrameCallbackInfo(Dali::Integration::Scene::FrameCallbackContainer& callbackList, int fd)
281 fileDescriptorMonitor(),
284 // Transfer owership of the CallbackBase
285 for(auto&& iter : callbackList)
287 callbacks.push_back(std::make_pair(std::move(iter.first), iter.second));
293 // Delete FileDescriptorMonitor before close fd.
294 fileDescriptorMonitor.release();
295 close(fileDescriptor);
298 Dali::Integration::Scene::FrameCallbackContainer callbacks;
299 std::unique_ptr<FileDescriptorMonitor> fileDescriptorMonitor;
303 using FrameCallbackInfoContainer = std::vector<std::unique_ptr<FrameCallbackInfo>>;
307 Dali::DisplayConnection* mDisplayConnection;
308 PositionSize mPositionSize; ///< Position
309 std::unique_ptr<WindowBase> mWindowBase;
310 ThreadSynchronizationInterface* mThreadSynchronization;
311 TriggerEventInterface* mRenderNotification; ///< Render notification trigger
312 std::unique_ptr<TriggerEventInterface> mPostRenderTrigger; ///< Post render callback function
313 std::unique_ptr<TriggerEventInterface> mFrameRenderedTrigger;
314 GraphicsInterface* mGraphics; ///< Graphics interface
315 EGLSurface mEGLSurface;
316 EGLContext mEGLContext;
317 ColorDepth mColorDepth; ///< Color depth of surface (32 bit or 24 bit)
318 OutputSignalType mOutputTransformedSignal;
319 FrameCallbackInfoContainer mFrameCallbackInfoContainer;
320 DamagedRectsContainer mBufferDamagedRects;
322 int mWindowRotationAngle;
323 int mScreenRotationAngle;
324 uint32_t mDpiHorizontal;
325 uint32_t mDpiVertical;
326 std::vector<Rect<int>> mDamagedRects{}; ///< Keeps collected damaged render items rects for one render pass
327 bool mOwnSurface; ///< Whether we own the surface (responsible for deleting it)
328 bool mWindowRotationFinished;
329 bool mScreenRotationFinished;
330 bool mResizeFinished;
331 bool mDefaultScreenRotationAvailable;
332 bool mIsImeWindowSurface;
333 bool mNeedWindowRotationAcknowledgement;
335 }; // class WindowRenderSurface
337 } // namespace Adaptor
339 } // namespace Internal
343 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_RENDER_SURFACE_H