1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_RENDER_SURFACE_H
2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_RENDER_SURFACE_H
5 * Copyright (c) 2022 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::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] positionSize A new position and size of the surface
102 void RequestRotation(int angle, PositionSize positionSize);
105 * @brief Gets the window base object
106 * @return The window base object
108 WindowBase* GetWindowBase();
111 * @brief Intiailize Ime Surface for Ime window rendering.
113 * It sets one flag and callback function for Ime window rendering
114 * This callback function calls one special native window function for ready to commit buffer.
115 * The special function notify to display server.
116 * It is only used for Ime window.
118 void InitializeImeSurface();
121 * @brief Sets the necessary for window rotation acknowledge.
122 * After this function called, SendRotationCompletedAcknowledgement() should be called to complete window rotation.
124 * More detail description is written in DevelWindow::SetNeedsRotationCompletedAcknowledgement().
126 * @param[in] window The window instance.
127 * @param[in] needAcknowledgement the flag is true if window rotation acknowledgement is sent.
129 void SetNeedsRotationCompletedAcknowledgement(bool needAcknowledgement);
132 * @brief Updates window surface's position and size.
133 * It is just to update the local variable in window surface.
134 * This function is only called when window's position or size is changed by display server.
136 * @param[in] positionSize The updated window surface's position and size.
138 void UpdatePositionSize(Dali::PositionSize positionSize);
141 * @brief Query whether window is rotating or not.
143 * @return true if window is rotating, false otherwise.
145 bool IsWindowRotating() const;
148 * @brief This signal is emitted when the output is transformed.
150 OutputSignalType& OutputTransformedSignal();
152 public: // from Dali::RenderSurfaceInterface
154 * @copydoc Dali::RenderSurfaceInterface::GetPositionSize()
156 PositionSize GetPositionSize() const override;
160 void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) override;
163 * @copydoc Dali::RenderSurfaceInterface::GetOrientation()
165 int GetOrientation() const override;
168 * @copydoc Dali::RenderSurfaceInterface::InitializeGraphics()
170 void InitializeGraphics() override;
173 * @copydoc Dali::RenderSurfaceInterface::CreateSurface()
175 void CreateSurface() override;
178 * @copydoc Dali::RenderSurfaceInterface::DestroySurface()
180 void DestroySurface() override;
183 * @copydoc Dali::RenderSurfaceInterface::ReplaceGraphicsSurface()
185 bool ReplaceGraphicsSurface() override;
188 * @copydoc Dali::RenderSurfaceInterface::MoveResize()
190 void MoveResize(Dali::PositionSize positionSize) override;
193 * @copydoc Dali::RenderSurfaceInterface::StartRender()
195 void StartRender() override;
198 * @copydoc Dali::RenderSurfaceInterface::PreRender()
200 bool PreRender(bool resizingSurface, const std::vector<Rect<int>>& damagedRects, Rect<int>& clippingRect) override;
203 * @copydoc Dali::RenderSurfaceInterface::PostRender()
205 void PostRender() override;
208 * @copydoc Dali::RenderSurfaceInterface::StopRender()
210 void StopRender() override;
213 * @copydoc Dali::RenderSurfaceInterface::SetThreadSynchronization
215 void SetThreadSynchronization(ThreadSynchronizationInterface& threadSynchronization) override;
218 * @copydoc Dali::RenderSurfaceInterface::ReleaseLock()
220 void ReleaseLock() override;
223 * @copydoc Dali::RenderSurfaceInterface::GetSurfaceType()
225 Dali::RenderSurfaceInterface::Type GetSurfaceType() override;
228 * @copydoc Dali::RenderSurfaceInterface::MakeContextCurrent()
230 void MakeContextCurrent() override;
233 * @copydoc Dali::RenderSurfaceInterface::GetDepthBufferRequired()
235 Integration::DepthBufferAvailable GetDepthBufferRequired() override;
238 * @copydoc Dali::RenderSurfaceInterface::GetStencilBufferRequired()
240 Integration::StencilBufferAvailable GetStencilBufferRequired() override;
244 * @brief Second stage construction
246 void Initialize(Any surface);
249 * Notify output is transformed.
251 void OutputTransformed();
254 * @brief Used as the callback for the post render.
255 * It is used both window rotation and supporting Ime window
257 void ProcessPostRender();
260 * @brief Used as the callback for the frame rendered / presented.
262 void ProcessFrameCallback();
265 * @brief Called when our event file descriptor has been written to.
266 * @param[in] eventBitMask bit mask of events that occured on the file descriptor
267 * @param[in] fileDescriptor The file descriptor
269 void OnFileDescriptorEventDispatched(FileDescriptorMonitor::EventType eventBitMask, int fileDescriptor);
272 * @brief Set the buffer damage rects.
273 * @param[in] damagedRects List of damaged rects
274 * @param[in] clippingRect The rect to clip rendered scene
276 void SetBufferDamagedRects(const std::vector<Rect<int>>& damagedRects, Rect<int>& clippingRect);
279 * @brief Swap buffers.
280 * @param[in] damagedRects List of damaged rects
282 void SwapBuffers(const std::vector<Rect<int>>& damagedRects);
286 WindowRenderSurface(const WindowRenderSurface&) = delete;
289 WindowRenderSurface& operator=(const WindowRenderSurface& rhs) = delete;
292 struct FrameCallbackInfo
294 FrameCallbackInfo(Dali::Integration::Scene::FrameCallbackContainer& callbackList, int fd)
296 fileDescriptorMonitor(),
299 // Transfer owership of the CallbackBase
300 for(auto&& iter : callbackList)
302 callbacks.push_back(std::make_pair(std::move(iter.first), iter.second));
308 // Delete FileDescriptorMonitor before close fd.
309 fileDescriptorMonitor.release();
310 close(fileDescriptor);
313 Dali::Integration::Scene::FrameCallbackContainer callbacks;
314 std::unique_ptr<FileDescriptorMonitor> fileDescriptorMonitor;
318 using FrameCallbackInfoContainer = std::vector<std::unique_ptr<FrameCallbackInfo>>;
322 Dali::DisplayConnection* mDisplayConnection;
323 PositionSize mPositionSize; ///< Position
324 std::unique_ptr<WindowBase> mWindowBase;
325 ThreadSynchronizationInterface* mThreadSynchronization;
326 TriggerEventInterface* mRenderNotification; ///< Render notification trigger
327 std::unique_ptr<TriggerEventInterface> mPostRenderTrigger; ///< Post render callback function
328 std::unique_ptr<TriggerEventInterface> mFrameRenderedTrigger;
329 GraphicsInterface* mGraphics; ///< Graphics interface
330 EGLSurface mEGLSurface;
331 EGLContext mEGLContext;
332 ColorDepth mColorDepth; ///< Color depth of surface (32 bit or 24 bit)
333 OutputSignalType mOutputTransformedSignal;
334 FrameCallbackInfoContainer mFrameCallbackInfoContainer;
335 DamagedRectsContainer mBufferDamagedRects;
337 int mWindowRotationAngle;
338 int mScreenRotationAngle;
339 uint32_t mDpiHorizontal;
340 uint32_t mDpiVertical;
341 std::vector<Rect<int>> mDamagedRects{}; ///< Keeps collected damaged render items rects for one render pass. These rects are rotated by scene orientation.
342 bool mOwnSurface; ///< Whether we own the surface (responsible for deleting it)
343 bool mWindowRotationFinished;
344 bool mScreenRotationFinished;
345 bool mResizeFinished;
346 bool mDefaultScreenRotationAvailable;
347 bool mIsImeWindowSurface;
348 bool mNeedWindowRotationAcknowledgement;
350 }; // class WindowRenderSurface
352 } // namespace Adaptor
354 } // namespace Internal
358 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_RENDER_SURFACE_H