1 #ifndef DALI_INTEGRATION_ADAPTOR_H
2 #define DALI_INTEGRATION_ADAPTOR_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/public-api/signals/callback.h>
23 #include <dali/public-api/signals/dali-signal.h>
24 #include <dali/public-api/math/uint-16-pair.h>
25 #include <dali/public-api/math/rect.h>
26 #include <dali/public-api/events/touch-event.h>
27 #include <dali/public-api/object/any.h>
28 #include <dali/integration-api/processor-interface.h>
31 #include <dali/public-api/adaptor-framework/window.h>
32 #include <dali/public-api/adaptor-framework/application-configuration.h>
33 #include <dali/public-api/dali-adaptor-common.h>
34 #include <dali/integration-api/adaptor-framework/log-factory-interface.h>
39 class RenderSurfaceInterface;
41 using WindowContainer = std::vector<Window>;
48 using SceneHolderList = std::vector<Dali::Integration::SceneHolder>;
55 class GraphicsFactory;
61 * @brief An Adaptor object is used to initialize and control how Dali runs.
63 * It provides a lifecycle interface that allows the application
64 * writer to provide their own main loop and other platform related
67 * The Adaptor class provides a means for initialising the resources required by the Dali::Core.
69 * When dealing with platform events, the application writer MUST ensure that Dali is called in a
72 * As soon as the Adaptor class is created and started, the application writer can initialise their
73 * Dali::Actor objects straight away or as required by the main loop they intend to use (there is no
74 * need to wait for an initialise signal as per the Dali::Application class).
76 * The Adaptor does emit a Resize signal which informs the user when the surface is resized.
77 * Tizen and Linux Adaptors should follow the example below:
80 * void CreateProgram(DaliAdaptor& adaptor)
82 * // Create Dali components...
83 * // Can instantiate adaptor here instead, if required
88 * // Initialise platform
91 * // Create an 800 by 1280 window positioned at (0,0).
92 * Dali::PositionSize positionSize(0, 0, 800, 1280);
93 * Dali::Window window = Dali::Window::New( positionSize, "My Application" );
95 * // Create an adaptor which uses that window for rendering
96 * Dali::Adaptor adaptor = Dali::Adaptor::New( window );
99 * CreateProgram(adaptor);
100 * // Or use this as a callback function depending on the platform initialisation sequence.
102 * // Start Main Loop of your platform
103 * MyPlatform.StartMainLoop();
109 * If required, you can also connect class member functions to a signal:
112 * MyApplication application;
113 * adaptor.ResizedSignal().Connect(&application, &MyApplication::Resize);
118 class DALI_ADAPTOR_API Adaptor
122 typedef Signal< void (Adaptor&) > AdaptorSignalType; ///< Generic Type for adaptor signals
123 typedef Signal< void (Dali::Integration::SceneHolder&) > WindowCreatedSignalType; ///< SceneHolder created signal type
125 using SurfaceSize = Uint16Pair; ///< Surface size type
129 * @brief Create a new adaptor using the window.
131 * @param[in] window The window to draw onto
132 * @return a reference to the adaptor handle
134 static Adaptor& New( Window window );
137 * @brief Create a new adaptor using the window.
139 * @param[in] window The window to draw onto
140 * @param[in] configuration The context loss configuration.
141 * @return a reference to the adaptor handle
143 static Adaptor& New( Window window, Configuration::ContextLoss configuration );
146 * @brief Create a new adaptor using render surface.
148 * @param[in] window The window to draw onto
149 * @param[in] surface The surface to draw onto
150 * @return a reference to the adaptor handle
152 static Adaptor& New( Window window, const Dali::RenderSurfaceInterface& surface );
155 * @brief Create a new adaptor using render surface.
157 * @param[in] window The window to draw onto
158 * @param[in] surface The surface to draw onto
159 * @param[in] configuration The context loss configuration.
160 * @return a reference to the adaptor handle
162 static Adaptor& New( Window window, const Dali::RenderSurfaceInterface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
165 * @brief Create a new adaptor using the SceneHolder.
167 * @param[in] sceneHolder The SceneHolder to draw onto
168 * @return a reference to the adaptor handle
170 static Adaptor& New( Dali::Integration::SceneHolder sceneHolder );
173 * @brief Create a new adaptor using the SceneHolder.
175 * @param[in] sceneHolder The SceneHolder to draw onto
176 * @param[in] configuration The context loss configuration.
177 * @return a reference to the adaptor handle
179 static Adaptor& New( Dali::Integration::SceneHolder sceneHolder, Configuration::ContextLoss configuration );
182 * @brief Create a new adaptor using render surface.
184 * @param[in] sceneHolder The SceneHolder to draw onto
185 * @param[in] surface The surface to draw onto
186 * @return a reference to the adaptor handle
188 static Adaptor& New( Dali::Integration::SceneHolder sceneHolder, const Dali::RenderSurfaceInterface& surface );
191 * @brief Create a new adaptor using render surface.
193 * @param[in] sceneHolder The SceneHolder to draw onto
194 * @param[in] surface The surface to draw onto
195 * @param[in] configuration The context loss configuration.
196 * @return a reference to the adaptor handle
198 static Adaptor& New( Dali::Integration::SceneHolder sceneHolder, const Dali::RenderSurfaceInterface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
201 * @brief Virtual Destructor.
208 * @brief Starts the Adaptor.
213 * @brief Pauses the Adaptor.
218 * @brief Resumes the Adaptor, if previously paused.
220 * @note If the adaptor is not paused, this does not do anything.
225 * @brief Stops the Adaptor.
230 * @brief Ensures that the function passed in is called from the main loop when it is idle.
231 * @note Function must be called from the main event thread only.
233 * Callbacks of the following types may be used:
237 * This callback will be deleted once it is called.
242 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
244 * @param[in] callback The function to call.
245 * @param[in] hasReturnValue Sould be set to true if the callback function has a return value.
246 * @return true if added successfully, false otherwise
248 * @note Ownership of the callback is passed onto this class.
250 bool AddIdle( CallbackBase* callback, bool hasReturnValue );
253 * @brief Adds a new Window instance to the Adaptor
255 * @param[in] childWindow The child window instance
256 * @param[in] childWindowName The child window title/name
257 * @param[in] childWindowClassName The class name that the child window belongs to
258 * @param[in] childWindowMode The mode of the child window
260 bool AddWindow( Dali::Integration::SceneHolder childWindow,
261 const std::string& childWindowName,
262 const std::string& childWindowClassName,
263 bool childWindowMode );
266 * @brief Removes a previously added @p callback.
267 * @note Function must be called from the main event thread only.
269 * Does nothing if the @p callback doesn't exist.
271 * @param[in] callback The callback to be removed.
273 void RemoveIdle( CallbackBase* callback );
276 * @brief Processes the idle callbacks.
278 * @note This function is intended to be used in the case there is no instance of a Dali::Application i.e. DALi is used in a implementation of a plugin of an application.
283 * @brief Replaces the rendering surface
285 * @param[in] window The window to replace the surface for
286 * @param[in] surface to use
288 void ReplaceSurface( Window window, Dali::RenderSurfaceInterface& surface );
291 * @brief Replaces the rendering surface
293 * @param[in] sceneHolder The SceneHolder to replace the surface for
294 * @param[in] surface to use
296 void ReplaceSurface( Dali::Integration::SceneHolder sceneHolder, Dali::RenderSurfaceInterface& surface );
299 * @brief Get the render surface the adaptor is using to render to.
301 * @return reference to current render surface
303 Dali::RenderSurfaceInterface& GetSurface();
306 * @brief Gets native window handle
308 * @return Native window handle
310 Any GetNativeWindowHandle();
313 * @brief Retrieve native window handle that the given actor is added to.
315 * @param[in] actor The actor
316 * @return native window handle
318 Any GetNativeWindowHandle( Actor actor );
321 * @brief Get the native display associated with the graphics backend
323 * @return A handle to the native display
325 Any GetGraphicsDisplay();
328 * @brief Release any locks the surface may hold.
330 * For example, after compositing an offscreen surface, use this method to allow
331 * rendering to continue.
333 void ReleaseSurfaceLock();
336 * @brief Set the number of frames per render.
338 * This enables an application to deliberately render with a reduced FPS.
339 * @param[in] numberOfVSyncsPerRender The number of vsyncs between successive renders.
340 * Suggest this is a power of two:
341 * 1 - render each vsync frame
342 * 2 - render every other vsync frame
343 * 4 - render every fourth vsync frame
344 * 8 - render every eighth vsync frame
346 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
349 * @brief The callback is called from the Update/Render thread prior to rendering.
351 * @param[in] callback The function to call
353 * @note The function is called from the Update thread, so should do as little processing as possible.
354 * It is not possible to call any DALi event side APIs from within the callback; doing so will cause
355 * instability. Only 1 callback is supported. Setting the callback to NULL will remove the current callback.
357 * A callback of the following type should be used:
361 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
363 void SetPreRenderCallback( CallbackBase* callback );
366 * @brief Returns a reference to the instance of the adaptor used by the current thread.
368 * @return A reference to the adaptor.
369 * @pre The adaptor has been initialised.
370 * @note This is only valid in the main thread.
372 static Adaptor& Get();
375 * @brief Checks whether the adaptor is available.
377 * @return true, if it is available, false otherwise.
379 static bool IsAvailable();
382 * @brief Call this method to notify Dali when scene is created and initialized.
384 * Notify Adaptor that the scene has been created.
386 void NotifySceneCreated();
389 * @brief Call this method to notify Dali when the system language changes.
391 * Use this only when NOT using Dali::Application, As Application created using
392 * Dali::Application will automatically receive notification of language change.
393 * When Dali::Application is not used, the application developer should
394 * use app-core to receive language change notifications and should update Dali
395 * by calling this method.
397 void NotifyLanguageChanged();
400 * @brief Feed a touch point to the adaptor.
402 * @param[in] point touch point
403 * @param[in] timeStamp time value of event
405 void FeedTouchPoint( TouchPoint& point, int timeStamp );
408 * @brief Feed a wheel event to the adaptor.
410 * @param[in] wheelEvent wheel event
412 void FeedWheelEvent( WheelEvent& wheelEvent );
415 * @brief Feed a key event to the adaptor.
417 * @param[in] keyEvent The key event holding the key information.
419 void FeedKeyEvent( KeyEvent& keyEvent );
422 * @copydoc Dali::Core::SceneCreated();
427 * @brief Informs core the surface size has changed.
429 * @param[in] surface The current render surface
430 * @param[in] surfaceSize The new surface size
432 void SurfaceResizePrepare( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
435 * @brief Informs ThreadController the surface size has changed.
437 * @param[in] surface The current render surface
438 * @param[in] surfaceSize The new surface size
440 void SurfaceResizeComplete( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
443 * @brief Renders once more even if we're paused
444 * @note Will not work if the window is hidden.
449 * @brief The log factory allows installation of a logger function in worker threads.
450 * @return An interface to a logging factory
452 const LogFactoryInterface& GetLogFactory();
455 * @brief Register a processor implementing the Integration::Processor interface with dali-core.
456 * @param[in] processor the Processor to register
457 * @note using this api does not maintain the processor's lifecycle, must be done elsewhere.
459 void RegisterProcessor( Integration::Processor& processor );
462 * @brief Unregister a previously registered processor from dali-core.
463 * @param[in] processor the Processor to unregister
465 void UnregisterProcessor( Integration::Processor& processor );
468 * @brief Get the list of windows created.
469 * @return The list of windows
471 Dali::WindowContainer GetWindows() const;
474 * @brief Get the list of scene holders.
475 * @return The list of scene holers
477 SceneHolderList GetSceneHolders() const;
480 * @brief Called when the window becomes fully or partially visible.
482 void OnWindowShown();
485 * @brief Called when the window is fully hidden.
487 void OnWindowHidden();
492 * @brief The user should connect to this signal if they need to perform any
493 * special activities when the surface Dali is being rendered on is resized.
495 * @return The signal to connect to
497 AdaptorSignalType& ResizedSignal();
500 * @brief This signal is emitted when the language is changed on the device.
502 * @return The signal to connect to
504 AdaptorSignalType& LanguageChangedSignal();
507 * @brief This signal is emitted when a new window (scene holder) is created
509 * @return The signal to connect to
511 WindowCreatedSignalType& WindowCreatedSignal();
516 Adaptor(const Adaptor&);
517 Adaptor& operator=(Adaptor&);
522 * @brief Create an uninitialized Adaptor.
526 Internal::Adaptor::Adaptor* mImpl; ///< Implementation object
527 friend class Internal::Adaptor::Adaptor;
532 #endif // DALI_INTEGRATION_ADAPTOR_H