1 #ifndef __DALI_INTEGRATION_ADAPTOR_H__
2 #define __DALI_INTEGRATION_ADAPTOR_H__
5 * Copyright (c) 2014 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>
29 #include "application-configuration.h"
45 * @brief An Adaptor object is used to initialize and control how Dali runs.
47 * It provides a lifecycle interface that allows the application
48 * writer to provide their own main loop and other platform related
51 * The Adaptor class provides a means for initialising the resources required by the Dali::Core.
53 * When dealing with platform events, the application writer MUST ensure that Dali is called in a
56 * As soon as the Adaptor class is created and started, the application writer can initialise their
57 * Dali::Actor objects straight away or as required by the main loop they intend to use (there is no
58 * need to wait for an initialise signal as per the Dali::Application class).
60 * The Adaptor does emit a Resize signal which informs the user when the surface is resized.
61 * Tizen and Linux Adaptors should follow the example below:
64 * void CreateProgram(DaliAdaptor& adaptor)
66 * // Create Dali components...
67 * // Can instantiate adaptor here instead, if required
72 * // Initialise platform
75 * // Create an 800 by 1280 window positioned at (0,0).
76 * Dali::PositionSize positionSize(0, 0, 800, 1280);
77 * Dali::Window window = Dali::Window::New( positionSize, "My Application" );
79 * // Create an adaptor which uses that window for rendering
80 * Dali::Adaptor adaptor = Dali::Adaptor::New( window );
83 * CreateProgram(adaptor);
84 * // Or use this as a callback function depending on the platform initialisation sequence.
86 * // Start Main Loop of your platform
87 * MyPlatform.StartMainLoop();
93 * If required, you can also connect class member functions to a signal:
96 * MyApplication application;
97 * adaptor.ResizedSignal().Connect(&application, &MyApplication::Resize);
102 class DALI_IMPORT_API Adaptor
106 typedef Signal< void (Adaptor&) > AdaptorSignalType; ///< Generic Type for adaptor signals
110 * @brief Create a new adaptor using the window.
112 * @param[in] window The window to draw onto
113 * @return a reference to the adaptor handle
115 static Adaptor& New( Window window );
118 * @brief Create a new adaptor using the window.
120 * @param[in] window The window to draw onto
121 * @param[in] configuration The context loss configuration.
122 * @return a reference to the adaptor handle
124 static Adaptor& New( Window window, Configuration::ContextLoss configuration );
127 * @brief Create a new adaptor using render surface.
129 * @param[in] nativeWindow native window handle
130 * @param[in] surface The surface to draw onto
131 * @return a reference to the adaptor handle
133 static Adaptor& New( Any nativeWindow, const Dali::RenderSurface& surface );
136 * @brief Create a new adaptor using render surface.
138 * @param[in] nativeWindow native window handle
139 * @param[in] surface The surface to draw onto
140 * @param[in] configuration The context loss configuration.
141 * @return a reference to the adaptor handle
143 static Adaptor& New( Any nativeWindow, const Dali::RenderSurface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
146 * @brief Virtual Destructor.
153 * @brief Starts the Adaptor.
158 * @brief Pauses the Adaptor.
163 * @brief Resumes the Adaptor, if previously paused.
165 * @note If the adaptor is not paused, this does not do anything.
170 * @brief Stops the Adaptor.
175 * @brief Ensures that the function passed in is called from the main loop when it is idle.
176 * @note Function must be called from the main event thread only.
178 * A callback of the following type may be used:
183 * @param[in] callback The function to call.
184 * @return true if added successfully, false otherwise
186 * @note Ownership of the callback is passed onto this class.
188 bool AddIdle( CallbackBase* callback );
191 * @brief Replaces the rendering surface
193 * @param[in] nativeWindow native window handle
194 * @param[in] surface to use
196 void ReplaceSurface( Any nativeWindow, Dali::RenderSurface& surface );
199 * @brief Get the render surface the adaptor is using to render to.
201 * @return reference to current render surface
203 RenderSurface& GetSurface();
206 * @brief Release any locks the surface may hold.
208 * For example, after compositing an offscreen surface, use this method to allow
209 * rendering to continue.
211 void ReleaseSurfaceLock();
214 * @brief Set the number of frames per render.
216 * This enables an application to deliberately render with a reduced FPS.
217 * @param[in] numberOfVSyncsPerRender The number of vsyncs between successive renders.
218 * Suggest this is a power of two:
219 * 1 - render each vsync frame
220 * 2 - render every other vsync frame
221 * 4 - render every fourth vsync frame
222 * 8 - render every eighth vsync frame
224 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
227 * @brief Set whether the frame count per render is managed using the hardware VSync or
230 * @param[in] useHardware True if the hardware VSync should be used
232 void SetUseHardwareVSync(bool useHardware);
235 * @brief Returns a reference to the instance of the adaptor used by the current thread.
237 * @return A reference to the adaptor.
238 * @pre The adaptor has been initialised.
239 * @note This is only valid in the main thread.
241 static Adaptor& Get();
244 * @brief Checks whether the adaptor is available.
246 * @return true, if it is available, false otherwise.
248 static bool IsAvailable();
251 * @brief Call this method to notify Dali when scene is created and initialized.
253 * Notify Adaptor that the scene has been created.
255 void NotifySceneCreated();
258 * @brief Call this method to notify Dali when the system language changes.
260 * Use this only when NOT using Dali::Application, As Application created using
261 * Dali::Application will automatically receive notification of language change.
262 * When Dali::Application is not used, the application developer should
263 * use app-core to receive language change notifications and should update Dali
264 * by calling this method.
266 void NotifyLanguageChanged();
269 * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
270 * trigger a pinch gesture
272 * @param[in] distance The minimum pinch distance in pixels
274 void SetMinimumPinchDistance(float distance);
277 * @brief Feed a touch point to the adaptor.
279 * @param[in] point touch point
280 * @param[in] timeStamp time value of event
282 void FeedTouchPoint( TouchPoint& point, int timeStamp );
285 * @brief Feed a wheel event to the adaptor.
287 * @param[in] wheelEvent wheel event
289 void FeedWheelEvent( WheelEvent& wheelEvent );
292 * @brief Feed a key event to the adaptor.
294 * @param[in] keyEvent The key event holding the key information.
296 void FeedKeyEvent( KeyEvent& keyEvent );
301 * @brief The user should connect to this signal if they need to perform any
302 * special activities when the surface Dali is being rendered on is resized.
304 * @return The signal to connect to
306 AdaptorSignalType& ResizedSignal();
309 * @brief This signal is emitted when the language is changed on the device.
311 * @return The signal to connect to
313 AdaptorSignalType& LanguageChangedSignal();
318 Adaptor(const Adaptor&);
319 Adaptor& operator=(Adaptor&);
324 * @brief Create an uninitialized Adaptor.
328 Internal::Adaptor::Adaptor* mImpl; ///< Implementation object
329 friend class Internal::Adaptor::Adaptor;
334 #endif // __DALI_INTEGRATION_ADAPTOR_H__