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>
40 class RenderSurfaceInterface;
42 using WindowContainer = std::vector<Window>;
49 using SceneHolderList = std::vector<Dali::Integration::SceneHolder>;
56 class GraphicsFactory;
62 * @brief An Adaptor object is used to initialize and control how Dali runs.
64 * It provides a lifecycle interface that allows the application
65 * writer to provide their own main loop and other platform related
68 * The Adaptor class provides a means for initialising the resources required by the Dali::Core.
70 * When dealing with platform events, the application writer MUST ensure that Dali is called in a
73 * As soon as the Adaptor class is created and started, the application writer can initialise their
74 * Dali::Actor objects straight away or as required by the main loop they intend to use (there is no
75 * need to wait for an initialise signal as per the Dali::Application class).
77 * The Adaptor does emit a Resize signal which informs the user when the surface is resized.
78 * Tizen and Linux Adaptors should follow the example below:
81 * void CreateProgram(DaliAdaptor& adaptor)
83 * // Create Dali components...
84 * // Can instantiate adaptor here instead, if required
89 * // Initialise platform
92 * // Create an 800 by 1280 window positioned at (0,0).
93 * Dali::PositionSize positionSize(0, 0, 800, 1280);
94 * Dali::Window window = Dali::Window::New( positionSize, "My Application" );
96 * // Create an adaptor which uses that window for rendering
97 * Dali::Adaptor adaptor = Dali::Adaptor::New( window );
100 * CreateProgram(adaptor);
101 * // Or use this as a callback function depending on the platform initialisation sequence.
103 * // Start Main Loop of your platform
104 * MyPlatform.StartMainLoop();
110 * If required, you can also connect class member functions to a signal:
113 * MyApplication application;
114 * adaptor.ResizedSignal().Connect(&application, &MyApplication::Resize);
119 class DALI_ADAPTOR_API Adaptor
123 typedef Signal< void (Adaptor&) > AdaptorSignalType; ///< Generic Type for adaptor signals
124 typedef Signal< void (Dali::Integration::SceneHolder&) > WindowCreatedSignalType; ///< SceneHolder created signal type
126 using SurfaceSize = Uint16Pair; ///< Surface size type
130 * @brief Create a new adaptor using the window.
132 * @param[in] window The window to draw onto
133 * @return a reference to the adaptor handle
135 static Adaptor& New( Window window );
138 * @brief Create a new adaptor using the window.
140 * @param[in] window The window to draw onto
141 * @param[in] configuration The context loss configuration.
142 * @return a reference to the adaptor handle
144 static Adaptor& New( Window window, Configuration::ContextLoss configuration );
147 * @brief Create a new adaptor using render surface.
149 * @param[in] window The window to draw onto
150 * @param[in] surface The surface to draw onto
151 * @return a reference to the adaptor handle
153 static Adaptor& New( Window window, const Dali::RenderSurfaceInterface& surface );
156 * @brief Create a new adaptor using render surface.
158 * @param[in] window The window to draw onto
159 * @param[in] surface The surface to draw onto
160 * @param[in] configuration The context loss configuration.
161 * @return a reference to the adaptor handle
163 static Adaptor& New( Window window, const Dali::RenderSurfaceInterface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
166 * @brief Create a new adaptor using the SceneHolder.
168 * @param[in] sceneHolder The SceneHolder to draw onto
169 * @return a reference to the adaptor handle
171 static Adaptor& New( Dali::Integration::SceneHolder sceneHolder );
174 * @brief Create a new adaptor using the SceneHolder.
176 * @param[in] sceneHolder The SceneHolder to draw onto
177 * @param[in] configuration The context loss configuration.
178 * @return a reference to the adaptor handle
180 static Adaptor& New( Dali::Integration::SceneHolder sceneHolder, Configuration::ContextLoss configuration );
183 * @brief Create a new adaptor using render surface.
185 * @param[in] sceneHolder The SceneHolder to draw onto
186 * @param[in] surface The surface to draw onto
187 * @return a reference to the adaptor handle
189 static Adaptor& New( Dali::Integration::SceneHolder sceneHolder, const Dali::RenderSurfaceInterface& surface );
192 * @brief Create a new adaptor using render surface.
194 * @param[in] sceneHolder The SceneHolder to draw onto
195 * @param[in] surface The surface to draw onto
196 * @param[in] configuration The context loss configuration.
197 * @return a reference to the adaptor handle
199 static Adaptor& New( Dali::Integration::SceneHolder sceneHolder, const Dali::RenderSurfaceInterface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
202 * @brief Virtual Destructor.
209 * @brief Starts the Adaptor.
214 * @brief Pauses the Adaptor.
219 * @brief Resumes the Adaptor, if previously paused.
221 * @note If the adaptor is not paused, this does not do anything.
226 * @brief Stops the Adaptor.
231 * @brief Ensures that the function passed in is called from the main loop when it is idle.
232 * @note Function must be called from the main event thread only.
234 * Callbacks of the following types may be used:
238 * This callback will be deleted once it is called.
243 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
245 * @param[in] callback The function to call.
246 * @param[in] hasReturnValue Sould be set to true if the callback function has a return value.
247 * @return true if added successfully, false otherwise
249 * @note Ownership of the callback is passed onto this class.
251 bool AddIdle( CallbackBase* callback, bool hasReturnValue );
254 * @brief Adds a new Window instance to the Adaptor
256 * @param[in] childWindow The child window instance
257 * @param[in] childWindowName The child window title/name
258 * @param[in] childWindowClassName The class name that the child window belongs to
259 * @param[in] childWindowMode The mode of the child window
261 bool AddWindow( Dali::Integration::SceneHolder childWindow,
262 const std::string& childWindowName,
263 const std::string& childWindowClassName,
264 bool childWindowMode );
267 * @brief Removes a previously added @p callback.
268 * @note Function must be called from the main event thread only.
270 * Does nothing if the @p callback doesn't exist.
272 * @param[in] callback The callback to be removed.
274 void RemoveIdle( CallbackBase* callback );
277 * @brief Processes the idle callbacks.
279 * @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.
284 * @brief Replaces the rendering surface
286 * @param[in] window The window to replace the surface for
287 * @param[in] surface to use
289 void ReplaceSurface( Window window, Dali::RenderSurfaceInterface& surface );
292 * @brief Replaces the rendering surface
294 * @param[in] sceneHolder The SceneHolder to replace the surface for
295 * @param[in] surface to use
297 void ReplaceSurface( Dali::Integration::SceneHolder sceneHolder, Dali::RenderSurfaceInterface& surface );
300 * @brief Get the render surface the adaptor is using to render to.
302 * @return reference to current render surface
304 Dali::RenderSurfaceInterface& GetSurface();
307 * @brief Gets native window handle
309 * @return Native window handle
311 Any GetNativeWindowHandle();
314 * @brief Retrieve native window handle that the given actor is added to.
316 * @param[in] actor The actor
317 * @return native window handle
319 Any GetNativeWindowHandle( Actor actor );
322 * @brief Get the native display associated with the graphics backend
324 * @return A handle to the native display
326 Any GetGraphicsDisplay();
329 * @brief Release any locks the surface may hold.
331 * For example, after compositing an offscreen surface, use this method to allow
332 * rendering to continue.
334 void ReleaseSurfaceLock();
337 * @brief Set the number of frames per render.
339 * This enables an application to deliberately render with a reduced FPS.
340 * @param[in] numberOfVSyncsPerRender The number of vsyncs between successive renders.
341 * Suggest this is a power of two:
342 * 1 - render each vsync frame
343 * 2 - render every other vsync frame
344 * 4 - render every fourth vsync frame
345 * 8 - render every eighth vsync frame
347 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
350 * @brief The callback is called from the Update/Render thread prior to rendering.
352 * @param[in] callback The function to call
354 * @note The function is called from the Update thread, so should do as little processing as possible.
355 * It is not possible to call any DALi event side APIs from within the callback; doing so will cause
356 * instability. Only 1 callback is supported. Setting the callback to NULL will remove the current callback.
358 * A callback of the following type should be used:
362 * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
364 void SetPreRenderCallback( CallbackBase* callback );
367 * @brief Returns a reference to the instance of the adaptor used by the current thread.
369 * @return A reference to the adaptor.
370 * @pre The adaptor has been initialised.
371 * @note This is only valid in the main thread.
373 static Adaptor& Get();
376 * @brief Checks whether the adaptor is available.
378 * @return true, if it is available, false otherwise.
380 static bool IsAvailable();
383 * @brief Call this method to notify Dali when scene is created and initialized.
385 * Notify Adaptor that the scene has been created.
387 void NotifySceneCreated();
390 * @brief Call this method to notify Dali when the system language changes.
392 * Use this only when NOT using Dali::Application, As Application created using
393 * Dali::Application will automatically receive notification of language change.
394 * When Dali::Application is not used, the application developer should
395 * use app-core to receive language change notifications and should update Dali
396 * by calling this method.
398 void NotifyLanguageChanged();
401 * @brief Feed a touch point to the adaptor.
403 * @param[in] point touch point
404 * @param[in] timeStamp time value of event
406 void FeedTouchPoint( TouchPoint& point, int timeStamp );
409 * @brief Feed a wheel event to the adaptor.
411 * @param[in] wheelEvent wheel event
413 void FeedWheelEvent( WheelEvent& wheelEvent );
416 * @brief Feed a key event to the adaptor.
418 * @param[in] keyEvent The key event holding the key information.
420 void FeedKeyEvent( KeyEvent& keyEvent );
423 * @copydoc Dali::Core::SceneCreated();
428 * @brief Informs core the surface size has changed.
430 * @param[in] surface The current render surface
431 * @param[in] surfaceSize The new surface size
433 void SurfaceResizePrepare( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
436 * @brief Informs ThreadController the surface size has changed.
438 * @param[in] surface The current render surface
439 * @param[in] surfaceSize The new surface size
441 void SurfaceResizeComplete( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
444 * @brief Renders once more even if we're paused
445 * @note Will not work if the window is hidden.
450 * @brief The log factory allows installation of a logger function in worker threads.
451 * @return An interface to a logging factory
453 const LogFactoryInterface& GetLogFactory();
456 * @brief Register a processor implementing the Integration::Processor interface with dali-core.
457 * @param[in] processor the Processor to register
458 * @note using this api does not maintain the processor's lifecycle, must be done elsewhere.
460 void RegisterProcessor( Integration::Processor& processor );
463 * @brief Unregister a previously registered processor from dali-core.
464 * @param[in] processor the Processor to unregister
466 void UnregisterProcessor( Integration::Processor& processor );
469 * @brief Get the list of windows created.
470 * @return The list of windows
472 Dali::WindowContainer GetWindows() const;
475 * @brief Get the list of scene holders.
476 * @return The list of scene holers
478 SceneHolderList GetSceneHolders() const;
481 * @brief Gets the Object registry.
482 * @return The object registry
484 Dali::ObjectRegistry GetObjectRegistry() const;
487 * @brief Called when the window becomes fully or partially visible.
489 void OnWindowShown();
492 * @brief Called when the window is fully hidden.
494 void OnWindowHidden();
499 * @brief The user should connect to this signal if they need to perform any
500 * special activities when the surface Dali is being rendered on is resized.
502 * @return The signal to connect to
504 AdaptorSignalType& ResizedSignal();
507 * @brief This signal is emitted when the language is changed on the device.
509 * @return The signal to connect to
511 AdaptorSignalType& LanguageChangedSignal();
514 * @brief This signal is emitted when a new window (scene holder) is created
516 * @return The signal to connect to
518 WindowCreatedSignalType& WindowCreatedSignal();
523 Adaptor(const Adaptor&);
524 Adaptor& operator=(Adaptor&);
529 * @brief Create an uninitialized Adaptor.
533 Internal::Adaptor::Adaptor* mImpl; ///< Implementation object
534 friend class Internal::Adaptor::Adaptor;
539 #endif // DALI_INTEGRATION_ADAPTOR_H