1 #ifndef DALI_INTEGRATION_ADAPTOR_H
2 #define DALI_INTEGRATION_ADAPTOR_H
5 * Copyright (c) 2019 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/common/view-mode.h>
28 #include <dali/public-api/object/any.h>
29 #include <dali/integration-api/processor-interface.h>
32 #include <dali/public-api/adaptor-framework/window.h>
33 #include <dali/public-api/adaptor-framework/application-configuration.h>
34 #include <dali/public-api/dali-adaptor-common.h>
36 #ifdef DALI_ADAPTOR_COMPILATION
37 #include <dali/integration-api/log-factory-interface.h>
39 #include <dali/integration-api/adaptors/log-factory-interface.h>
46 class RenderSurfaceInterface;
48 using WindowContainer = std::vector<Window>;
60 class GraphicsFactory;
66 * @brief An Adaptor object is used to initialize and control how Dali runs.
68 * It provides a lifecycle interface that allows the application
69 * writer to provide their own main loop and other platform related
72 * The Adaptor class provides a means for initialising the resources required by the Dali::Core.
74 * When dealing with platform events, the application writer MUST ensure that Dali is called in a
77 * As soon as the Adaptor class is created and started, the application writer can initialise their
78 * Dali::Actor objects straight away or as required by the main loop they intend to use (there is no
79 * need to wait for an initialise signal as per the Dali::Application class).
81 * The Adaptor does emit a Resize signal which informs the user when the surface is resized.
82 * Tizen and Linux Adaptors should follow the example below:
85 * void CreateProgram(DaliAdaptor& adaptor)
87 * // Create Dali components...
88 * // Can instantiate adaptor here instead, if required
93 * // Initialise platform
96 * // Create an 800 by 1280 window positioned at (0,0).
97 * Dali::PositionSize positionSize(0, 0, 800, 1280);
98 * Dali::Window window = Dali::Window::New( positionSize, "My Application" );
100 * // Create an adaptor which uses that window for rendering
101 * Dali::Adaptor adaptor = Dali::Adaptor::New( window );
104 * CreateProgram(adaptor);
105 * // Or use this as a callback function depending on the platform initialisation sequence.
107 * // Start Main Loop of your platform
108 * MyPlatform.StartMainLoop();
114 * If required, you can also connect class member functions to a signal:
117 * MyApplication application;
118 * adaptor.ResizedSignal().Connect(&application, &MyApplication::Resize);
123 class DALI_ADAPTOR_API Adaptor
127 typedef Signal< void (Adaptor&) > AdaptorSignalType; ///< Generic Type for adaptor signals
128 typedef Signal< void (Window&) > WindowCreatedSignalType; ///< Window created signal type
130 using SurfaceSize = Uint16Pair; ///< Surface size type
134 * @brief Create a new adaptor using the window.
136 * @param[in] window The window to draw onto
137 * @return a reference to the adaptor handle
139 static Adaptor& New( Window window );
142 * @brief Create a new adaptor using the window.
144 * @param[in] window The window to draw onto
145 * @param[in] configuration The context loss configuration.
146 * @return a reference to the adaptor handle
148 static Adaptor& New( Window window, Configuration::ContextLoss configuration );
151 * @brief Create a new adaptor using render surface.
153 * @param[in] window The window to draw onto
154 * @param[in] surface The surface to draw onto
155 * @return a reference to the adaptor handle
157 static Adaptor& New( Window window, const Dali::RenderSurfaceInterface& surface );
160 * @brief Create a new adaptor using render surface.
162 * @param[in] window The window to draw onto
163 * @param[in] surface The surface to draw onto
164 * @param[in] configuration The context loss configuration.
165 * @return a reference to the adaptor handle
167 static Adaptor& New( Window window, const Dali::RenderSurfaceInterface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
170 * @brief Create a new adaptor using the SceneHolder.
172 * @param[in] sceneHolder The SceneHolder to draw onto
173 * @return a reference to the adaptor handle
175 static Adaptor& New( Dali::Integration::SceneHolder sceneHolder );
178 * @brief Create a new adaptor using the SceneHolder.
180 * @param[in] sceneHolder The SceneHolder to draw onto
181 * @param[in] configuration The context loss configuration.
182 * @return a reference to the adaptor handle
184 static Adaptor& New( Dali::Integration::SceneHolder sceneHolder, Configuration::ContextLoss configuration );
187 * @brief Create a new adaptor using render surface.
189 * @param[in] sceneHolder The SceneHolder to draw onto
190 * @param[in] surface The surface to draw onto
191 * @return a reference to the adaptor handle
193 static Adaptor& New( Dali::Integration::SceneHolder sceneHolder, const Dali::RenderSurfaceInterface& surface );
196 * @brief Create a new adaptor using render surface.
198 * @param[in] sceneHolder The SceneHolder to draw onto
199 * @param[in] surface The surface to draw onto
200 * @param[in] configuration The context loss configuration.
201 * @return a reference to the adaptor handle
203 static Adaptor& New( Dali::Integration::SceneHolder sceneHolder, const Dali::RenderSurfaceInterface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
206 * @brief Virtual Destructor.
213 * @brief Starts the Adaptor.
218 * @brief Pauses the Adaptor.
223 * @brief Resumes the Adaptor, if previously paused.
225 * @note If the adaptor is not paused, this does not do anything.
230 * @brief Stops the Adaptor.
235 * @brief Ensures that the function passed in is called from the main loop when it is idle.
236 * @note Function must be called from the main event thread only.
238 * Callbacks of the following types may be used:
242 * This callback will be deleted once it is called.
247 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
249 * @param[in] callback The function to call.
250 * @param[in] hasReturnValue Sould be set to true if the callback function has a return value.
251 * @return true if added successfully, false otherwise
253 * @note Ownership of the callback is passed onto this class.
255 bool AddIdle( CallbackBase* callback, bool hasReturnValue );
258 * @brief Adds a new Window instance to the Adaptor
260 * @param[in] childWindow The child window instance
261 * @param[in] childWindowName The child window title/name
262 * @param[in] childWindowClassName The class name that the child window belongs to
263 * @param[in] childWindowMode The mode of the child window
265 bool AddWindow( Dali::Integration::SceneHolder childWindow,
266 const std::string& childWindowName,
267 const std::string& childWindowClassName,
268 bool childWindowMode );
271 * @brief Removes a previously added @p callback.
272 * @note Function must be called from the main event thread only.
274 * Does nothing if the @p callback doesn't exist.
276 * @param[in] callback The callback to be removed.
278 void RemoveIdle( CallbackBase* callback );
281 * @brief Replaces the rendering surface
283 * @param[in] window The window to replace the surface for
284 * @param[in] surface to use
286 void ReplaceSurface( Window window, Dali::RenderSurfaceInterface& surface );
289 * @brief Replaces the rendering surface
291 * @param[in] sceneHolder The SceneHolder to replace the surface for
292 * @param[in] surface to use
294 void ReplaceSurface( Dali::Integration::SceneHolder sceneHolder, Dali::RenderSurfaceInterface& surface );
297 * @brief Get the render surface the adaptor is using to render to.
299 * @return reference to current render surface
301 Dali::RenderSurfaceInterface& GetSurface();
304 * @brief Gets native window handle
306 * @return Native window handle
308 Any GetNativeWindowHandle();
311 * @brief Get the native display associated with the graphics backend
313 * @return A handle to the native display
315 Any GetGraphicsDisplay();
318 * @brief Release any locks the surface may hold.
320 * For example, after compositing an offscreen surface, use this method to allow
321 * rendering to continue.
323 void ReleaseSurfaceLock();
326 * @brief Set the number of frames per render.
328 * This enables an application to deliberately render with a reduced FPS.
329 * @param[in] numberOfVSyncsPerRender The number of vsyncs between successive renders.
330 * Suggest this is a power of two:
331 * 1 - render each vsync frame
332 * 2 - render every other vsync frame
333 * 4 - render every fourth vsync frame
334 * 8 - render every eighth vsync frame
336 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
339 * @brief The callback is called from the Update/Render thread prior to rendering.
341 * @param[in] callback The function to call
343 * @note The function is called from the Update thread, so should do as little processing as possible.
344 * It is not possible to call any DALi event side APIs from within the callback; doing so will cause
345 * instability. Only 1 callback is supported. Setting the callback to NULL will remove the current callback.
347 * A callback of the following type should be used:
351 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
353 void SetPreRenderCallback( CallbackBase* callback );
356 * @brief Returns a reference to the instance of the adaptor used by the current thread.
358 * @return A reference to the adaptor.
359 * @pre The adaptor has been initialised.
360 * @note This is only valid in the main thread.
362 static Adaptor& Get();
365 * @brief Checks whether the adaptor is available.
367 * @return true, if it is available, false otherwise.
369 static bool IsAvailable();
372 * @brief Call this method to notify Dali when scene is created and initialized.
374 * Notify Adaptor that the scene has been created.
376 void NotifySceneCreated();
379 * @brief Call this method to notify Dali when the system language changes.
381 * Use this only when NOT using Dali::Application, As Application created using
382 * Dali::Application will automatically receive notification of language change.
383 * When Dali::Application is not used, the application developer should
384 * use app-core to receive language change notifications and should update Dali
385 * by calling this method.
387 void NotifyLanguageChanged();
390 * @brief Feed a touch point to the adaptor.
392 * @param[in] point touch point
393 * @param[in] timeStamp time value of event
395 void FeedTouchPoint( TouchPoint& point, int timeStamp );
398 * @brief Feed a wheel event to the adaptor.
400 * @param[in] wheelEvent wheel event
402 void FeedWheelEvent( WheelEvent& wheelEvent );
405 * @brief Feed a key event to the adaptor.
407 * @param[in] keyEvent The key event holding the key information.
409 void FeedKeyEvent( KeyEvent& keyEvent );
412 * @copydoc Dali::Core::SceneCreated();
417 * @brief Informs core the surface size has changed.
419 * @param[in] surface The current render surface
420 * @param[in] surfaceSize The new surface size
422 void SurfaceResizePrepare( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
425 * @brief Informs ThreadController the surface size has changed.
427 * @param[in] surface The current render surface
428 * @param[in] surfaceSize The new surface size
430 void SurfaceResizeComplete( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
433 * @brief Renders once more even if we're paused
434 * @note Will not work if the window is hidden.
439 * @brief The log factory allows installation of a logger function in worker threads.
440 * @return An interface to a logging factory
442 const LogFactoryInterface& GetLogFactory();
445 * @brief Register a processor implementing the Integration::Processor interface with dali-core.
446 * @param[in] processor the Processor to register
447 * @note using this api does not maintain the processor's lifecycle, must be done elsewhere.
449 void RegisterProcessor( Integration::Processor& processor );
452 * @brief Unregister a previously registered processor from dali-core.
453 * @param[in] processor the Processor to unregister
455 void UnregisterProcessor( Integration::Processor& processor );
458 * @brief Get the list of windows created.
459 * @return The list of windows
461 Dali::WindowContainer GetWindows() const;
464 * @brief Called when the window becomes fully or partially visible.
466 void OnWindowShown();
469 * @brief Called when the window is fully hidden.
471 void OnWindowHidden();
476 * @brief The user should connect to this signal if they need to perform any
477 * special activities when the surface Dali is being rendered on is resized.
479 * @return The signal to connect to
481 AdaptorSignalType& ResizedSignal();
484 * @brief This signal is emitted when the language is changed on the device.
486 * @return The signal to connect to
488 AdaptorSignalType& LanguageChangedSignal();
491 * @brief This signal is emitted when a new window is created
493 * @return The signal to connect to
495 WindowCreatedSignalType& WindowCreatedSignal();
500 Adaptor(const Adaptor&);
501 Adaptor& operator=(Adaptor&);
506 * @brief Create an uninitialized Adaptor.
510 Internal::Adaptor::Adaptor* mImpl; ///< Implementation object
511 friend class Internal::Adaptor::Adaptor;
516 #endif // DALI_INTEGRATION_ADAPTOR_H