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>
29 #include <dali/public-api/adaptor-framework/window.h>
30 #include <dali/public-api/adaptor-framework/application-configuration.h>
32 #ifdef DALI_ADAPTOR_COMPILATION
33 #include <dali/integration-api/log-factory-interface.h>
35 #include <dali/integration-api/adaptors/log-factory-interface.h>
53 * @brief An Adaptor object is used to initialize and control how Dali runs.
55 * It provides a lifecycle interface that allows the application
56 * writer to provide their own main loop and other platform related
59 * The Adaptor class provides a means for initialising the resources required by the Dali::Core.
61 * When dealing with platform events, the application writer MUST ensure that Dali is called in a
64 * As soon as the Adaptor class is created and started, the application writer can initialise their
65 * Dali::Actor objects straight away or as required by the main loop they intend to use (there is no
66 * need to wait for an initialise signal as per the Dali::Application class).
68 * The Adaptor does emit a Resize signal which informs the user when the surface is resized.
69 * Tizen and Linux Adaptors should follow the example below:
72 * void CreateProgram(DaliAdaptor& adaptor)
74 * // Create Dali components...
75 * // Can instantiate adaptor here instead, if required
80 * // Initialise platform
83 * // Create an 800 by 1280 window positioned at (0,0).
84 * Dali::PositionSize positionSize(0, 0, 800, 1280);
85 * Dali::Window window = Dali::Window::New( positionSize, "My Application" );
87 * // Create an adaptor which uses that window for rendering
88 * Dali::Adaptor adaptor = Dali::Adaptor::New( window );
91 * CreateProgram(adaptor);
92 * // Or use this as a callback function depending on the platform initialisation sequence.
94 * // Start Main Loop of your platform
95 * MyPlatform.StartMainLoop();
101 * If required, you can also connect class member functions to a signal:
104 * MyApplication application;
105 * adaptor.ResizedSignal().Connect(&application, &MyApplication::Resize);
110 class DALI_IMPORT_API Adaptor
114 typedef Signal< void (Adaptor&) > AdaptorSignalType; ///< Generic Type for adaptor signals
118 * @brief Create a new adaptor using the window.
120 * @param[in] window The window to draw onto
121 * @return a reference to the adaptor handle
123 static Adaptor& New( Window window );
126 * @brief Create a new adaptor using the window.
128 * @param[in] window The window to draw onto
129 * @param[in] configuration The context loss configuration.
130 * @return a reference to the adaptor handle
132 static Adaptor& New( Window window, Configuration::ContextLoss configuration );
135 * @brief Create a new adaptor using render surface.
137 * @param[in] nativeWindow native window handle
138 * @param[in] surface The surface to draw onto
139 * @return a reference to the adaptor handle
141 static Adaptor& New( Any nativeWindow, const Dali::RenderSurface& surface );
144 * @brief Create a new adaptor using render surface.
146 * @param[in] nativeWindow native window handle
147 * @param[in] surface The surface to draw onto
148 * @param[in] configuration The context loss configuration.
149 * @return a reference to the adaptor handle
151 static Adaptor& New( Any nativeWindow, const Dali::RenderSurface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
154 * @brief Virtual Destructor.
161 * @brief Starts the Adaptor.
166 * @brief Pauses the Adaptor.
171 * @brief Resumes the Adaptor, if previously paused.
173 * @note If the adaptor is not paused, this does not do anything.
178 * @brief Stops the Adaptor.
183 * @brief Ensures that the function passed in is called from the main loop when it is idle.
184 * @note Function must be called from the main event thread only.
186 * A callback of the following type may be used:
191 * @param[in] callback The function to call.
192 * @return true if added successfully, false otherwise
194 * @note Ownership of the callback is passed onto this class.
196 bool AddIdle( CallbackBase* callback );
199 * @brief Removes a previously added @p callback.
200 * @note Function must be called from the main event thread only.
202 * Does nothing if the @p callback doesn't exist.
204 * @param[in] callback The callback to be removed.
206 void RemoveIdle( CallbackBase* callback );
209 * @brief Replaces the rendering surface
211 * @param[in] nativeWindow native window handle
212 * @param[in] surface to use
214 void ReplaceSurface( Any nativeWindow, Dali::RenderSurface& surface );
217 * @brief Get the render surface the adaptor is using to render to.
219 * @return reference to current render surface
221 RenderSurface& GetSurface();
224 * @brief Gets native window handle
226 * @return Native window handle
228 Any GetNativeWindowHandle();
231 * @brief Release any locks the surface may hold.
233 * For example, after compositing an offscreen surface, use this method to allow
234 * rendering to continue.
236 void ReleaseSurfaceLock();
239 * @brief Set the number of frames per render.
241 * This enables an application to deliberately render with a reduced FPS.
242 * @param[in] numberOfVSyncsPerRender The number of vsyncs between successive renders.
243 * Suggest this is a power of two:
244 * 1 - render each vsync frame
245 * 2 - render every other vsync frame
246 * 4 - render every fourth vsync frame
247 * 8 - render every eighth vsync frame
249 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
252 * @brief Set whether the frame count per render is managed using the hardware VSync or
255 * @param[in] useHardware True if the hardware VSync should be used
257 void SetUseHardwareVSync(bool useHardware);
260 * @brief Returns a reference to the instance of the adaptor used by the current thread.
262 * @return A reference to the adaptor.
263 * @pre The adaptor has been initialised.
264 * @note This is only valid in the main thread.
266 static Adaptor& Get();
269 * @brief Checks whether the adaptor is available.
271 * @return true, if it is available, false otherwise.
273 static bool IsAvailable();
276 * @brief Call this method to notify Dali when scene is created and initialized.
278 * Notify Adaptor that the scene has been created.
280 void NotifySceneCreated();
283 * @brief Call this method to notify Dali when the system language changes.
285 * Use this only when NOT using Dali::Application, As Application created using
286 * Dali::Application will automatically receive notification of language change.
287 * When Dali::Application is not used, the application developer should
288 * use app-core to receive language change notifications and should update Dali
289 * by calling this method.
291 void NotifyLanguageChanged();
294 * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
295 * trigger a pinch gesture
297 * @param[in] distance The minimum pinch distance in pixels
299 void SetMinimumPinchDistance(float distance);
302 * @brief Feed a touch point to the adaptor.
304 * @param[in] point touch point
305 * @param[in] timeStamp time value of event
307 void FeedTouchPoint( TouchPoint& point, int timeStamp );
310 * @brief Feed a wheel event to the adaptor.
312 * @param[in] wheelEvent wheel event
314 void FeedWheelEvent( WheelEvent& wheelEvent );
317 * @brief Feed a key event to the adaptor.
319 * @param[in] keyEvent The key event holding the key information.
321 void FeedKeyEvent( KeyEvent& keyEvent );
324 * @copydoc Dali::Core::SceneCreated();
329 * @copydoc Dali::Application::SetViewMode();
331 void SetViewMode( ViewMode viewMode );
334 * @copydoc Dali::Application::SetStereoBase();
336 void SetStereoBase( float stereoBase );
339 * @brief Renders once more even if we're paused
340 * @note Will not work if the window is hidden.
345 * @brief The log factory allows installation of a logger function in worker threads.
346 * @return An interface to a logging factory
348 const LogFactoryInterface& GetLogFactory();
353 * @brief The user should connect to this signal if they need to perform any
354 * special activities when the surface Dali is being rendered on is resized.
356 * @return The signal to connect to
358 AdaptorSignalType& ResizedSignal();
361 * @brief This signal is emitted when the language is changed on the device.
363 * @return The signal to connect to
365 AdaptorSignalType& LanguageChangedSignal();
370 Adaptor(const Adaptor&);
371 Adaptor& operator=(Adaptor&);
376 * @brief Create an uninitialized Adaptor.
380 Internal::Adaptor::Adaptor* mImpl; ///< Implementation object
381 friend class Internal::Adaptor::Adaptor;
386 #endif // __DALI_INTEGRATION_ADAPTOR_H__