1 #ifndef __DALI_INTEGRATION_ADAPTOR_H__
2 #define __DALI_INTEGRATION_ADAPTOR_H__
5 * Copyright (c) 2017 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/rect.h>
25 #include <dali/public-api/events/touch-event.h>
26 #include <dali/public-api/common/view-mode.h>
27 #include <dali/public-api/math/uint-16-pair.h>
31 #ifdef DALI_ADAPTOR_COMPILATION // full path doesn't exist until adaptor is installed so we have to use relative
32 // @todo Make dali-adaptor code folder structure mirror the folder structure installed to dali-env
34 #include <application-configuration.h>
36 #include <dali/public-api/adaptor-framework/window.h>
37 #include <dali/public-api/adaptor-framework/application-configuration.h>
55 * @brief An Adaptor object is used to initialize and control how Dali runs.
57 * It provides a lifecycle interface that allows the application
58 * writer to provide their own main loop and other platform related
61 * The Adaptor class provides a means for initialising the resources required by the Dali::Core.
63 * When dealing with platform events, the application writer MUST ensure that Dali is called in a
66 * As soon as the Adaptor class is created and started, the application writer can initialise their
67 * Dali::Actor objects straight away or as required by the main loop they intend to use (there is no
68 * need to wait for an initialise signal as per the Dali::Application class).
70 * The Adaptor does emit a Resize signal which informs the user when the surface is resized.
71 * Tizen and Linux Adaptors should follow the example below:
74 * void CreateProgram(DaliAdaptor& adaptor)
76 * // Create Dali components...
77 * // Can instantiate adaptor here instead, if required
82 * // Initialise platform
85 * // Create an 800 by 1280 window positioned at (0,0).
86 * Dali::PositionSize positionSize(0, 0, 800, 1280);
87 * Dali::Window window = Dali::Window::New( positionSize, "My Application" );
89 * // Create an adaptor which uses that window for rendering
90 * Dali::Adaptor adaptor = Dali::Adaptor::New( window );
93 * CreateProgram(adaptor);
94 * // Or use this as a callback function depending on the platform initialisation sequence.
96 * // Start Main Loop of your platform
97 * MyPlatform.StartMainLoop();
103 * If required, you can also connect class member functions to a signal:
106 * MyApplication application;
107 * adaptor.ResizedSignal().Connect(&application, &MyApplication::Resize);
112 class DALI_IMPORT_API Adaptor
116 typedef Signal< void (Adaptor&) > AdaptorSignalType; ///< Generic Type for adaptor signals
118 typedef Uint16Pair SurfaceSize; ///< Surface size type
122 * @brief Create a new adaptor using the window.
124 * @param[in] window The window to draw onto
125 * @return a reference to the adaptor handle
127 static Adaptor& New( Window window );
130 * @brief Create a new adaptor using the window.
132 * @param[in] window The window to draw onto
133 * @param[in] configuration The context loss configuration.
134 * @return a reference to the adaptor handle
136 static Adaptor& New( Window window, Configuration::ContextLoss configuration );
139 * @brief Create a new adaptor using render surface.
141 * @param[in] nativeWindow native window handle
142 * @param[in] surface The surface to draw onto
143 * @return a reference to the adaptor handle
145 static Adaptor& New( Any nativeWindow, const Dali::RenderSurface& surface );
148 * @brief Create a new adaptor using render surface.
150 * @param[in] nativeWindow native window handle
151 * @param[in] surface The surface to draw onto
152 * @param[in] configuration The context loss configuration.
153 * @return a reference to the adaptor handle
155 static Adaptor& New( Any nativeWindow, const Dali::RenderSurface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
158 * @brief Virtual Destructor.
165 * @brief Starts the Adaptor.
170 * @brief Pauses the Adaptor.
175 * @brief Resumes the Adaptor, if previously paused.
177 * @note If the adaptor is not paused, this does not do anything.
182 * @brief Stops the Adaptor.
187 * @brief Ensures that the function passed in is called from the main loop when it is idle.
188 * @note Function must be called from the main event thread only.
190 * A callback of the following type may be used:
195 * @param[in] callback The function to call.
196 * @return true if added successfully, false otherwise
198 * @note Ownership of the callback is passed onto this class.
200 bool AddIdle( CallbackBase* callback );
203 * @brief Removes a previously added @p callback.
204 * @note Function must be called from the main event thread only.
206 * Does nothing if the @p callback doesn't exist.
208 * @param[in] callback The callback to be removed.
210 void RemoveIdle( CallbackBase* callback );
213 * @brief Replaces the rendering surface
215 * @param[in] nativeWindow native window handle
216 * @param[in] surface to use
218 void ReplaceSurface( Any nativeWindow, Dali::RenderSurface& surface );
221 * @brief Get the render surface the adaptor is using to render to.
223 * @return reference to current render surface
225 RenderSurface& GetSurface();
228 * @brief Gets native window handle
230 * @return Native window handle
232 Any GetNativeWindowHandle();
235 * @brief Release any locks the surface may hold.
237 * For example, after compositing an offscreen surface, use this method to allow
238 * rendering to continue.
240 void ReleaseSurfaceLock();
243 * @brief Set the number of frames per render.
245 * This enables an application to deliberately render with a reduced FPS.
246 * @param[in] numberOfVSyncsPerRender The number of vsyncs between successive renders.
247 * Suggest this is a power of two:
248 * 1 - render each vsync frame
249 * 2 - render every other vsync frame
250 * 4 - render every fourth vsync frame
251 * 8 - render every eighth vsync frame
253 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
256 * @brief Set whether the frame count per render is managed using the hardware VSync or
259 * @param[in] useHardware True if the hardware VSync should be used
261 void SetUseHardwareVSync(bool useHardware);
264 * @brief Returns a reference to the instance of the adaptor used by the current thread.
266 * @return A reference to the adaptor.
267 * @pre The adaptor has been initialised.
268 * @note This is only valid in the main thread.
270 static Adaptor& Get();
273 * @brief Checks whether the adaptor is available.
275 * @return true, if it is available, false otherwise.
277 static bool IsAvailable();
280 * @brief Call this method to notify Dali when scene is created and initialized.
282 * Notify Adaptor that the scene has been created.
284 void NotifySceneCreated();
287 * @brief Call this method to notify Dali when the system language changes.
289 * Use this only when NOT using Dali::Application, As Application created using
290 * Dali::Application will automatically receive notification of language change.
291 * When Dali::Application is not used, the application developer should
292 * use app-core to receive language change notifications and should update Dali
293 * by calling this method.
295 void NotifyLanguageChanged();
298 * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
299 * trigger a pinch gesture
301 * @param[in] distance The minimum pinch distance in pixels
303 void SetMinimumPinchDistance(float distance);
306 * @brief Feed a touch point to the adaptor.
308 * @param[in] point touch point
309 * @param[in] timeStamp time value of event
311 void FeedTouchPoint( TouchPoint& point, int timeStamp );
314 * @brief Feed a wheel event to the adaptor.
316 * @param[in] wheelEvent wheel event
318 void FeedWheelEvent( WheelEvent& wheelEvent );
321 * @brief Feed a key event to the adaptor.
323 * @param[in] keyEvent The key event holding the key information.
325 void FeedKeyEvent( KeyEvent& keyEvent );
328 * @copydoc Dali::Core::SceneCreated();
333 * @copydoc Dali::Application::SetViewMode();
335 void SetViewMode( ViewMode viewMode );
338 * @copydoc Dali::Application::SetStereoBase();
340 void SetStereoBase( float stereoBase );
343 * @brief Renders once more even if we're paused
344 * @note Will not work if the window is hidden.
351 * @brief The user should connect to this signal if they need to perform any
352 * special activities when the surface Dali is being rendered on is resized.
354 * @return The signal to connect to
356 AdaptorSignalType& ResizedSignal();
359 * @brief This signal is emitted when the language is changed on the device.
361 * @return The signal to connect to
363 AdaptorSignalType& LanguageChangedSignal();
368 Adaptor(const Adaptor&);
369 Adaptor& operator=(Adaptor&);
374 * @brief Create an uninitialized Adaptor.
378 Internal::Adaptor::Adaptor* mImpl; ///< Implementation object
379 friend class Internal::Adaptor::Adaptor;
384 #endif // __DALI_INTEGRATION_ADAPTOR_H__