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>
47 * @brief An Adaptor object is used to initialize and control how Dali runs.
49 * It provides a lifecycle interface that allows the application
50 * writer to provide their own main loop and other platform related
53 * The Adaptor class provides a means for initialising the resources required by the Dali::Core.
55 * When dealing with platform events, the application writer MUST ensure that Dali is called in a
58 * As soon as the Adaptor class is created and started, the application writer can initialise their
59 * Dali::Actor objects straight away or as required by the main loop they intend to use (there is no
60 * need to wait for an initialise signal as per the Dali::Application class).
62 * The Adaptor does emit a Resize signal which informs the user when the surface is resized.
63 * Tizen and Linux Adaptors should follow the example below:
66 * void CreateProgram(DaliAdaptor& adaptor)
68 * // Create Dali components...
69 * // Can instantiate adaptor here instead, if required
74 * // Initialise platform
77 * // Create an 800 by 1280 window positioned at (0,0).
78 * Dali::PositionSize positionSize(0, 0, 800, 1280);
79 * Dali::Window window = Dali::Window::New( positionSize, "My Application" );
81 * // Create an adaptor which uses that window for rendering
82 * Dali::Adaptor adaptor = Dali::Adaptor::New( window );
85 * CreateProgram(adaptor);
86 * // Or use this as a callback function depending on the platform initialisation sequence.
88 * // Start Main Loop of your platform
89 * MyPlatform.StartMainLoop();
95 * If required, you can also connect class member functions to a signal:
98 * MyApplication application;
99 * adaptor.ResizedSignal().Connect(&application, &MyApplication::Resize);
104 class DALI_IMPORT_API Adaptor
108 typedef Signal< void (Adaptor&) > AdaptorSignalType; ///< Generic Type for adaptor signals
112 * @brief Create a new adaptor using the window.
114 * @param[in] window The window to draw onto
115 * @return a reference to the adaptor handle
117 static Adaptor& New( Window window );
120 * @brief Create a new adaptor using the window.
122 * @param[in] window The window to draw onto
123 * @param[in] configuration The context loss configuration.
124 * @return a reference to the adaptor handle
126 static Adaptor& New( Window window, Configuration::ContextLoss configuration );
129 * @brief Create a new adaptor using render surface.
131 * @param[in] nativeWindow native window handle
132 * @param[in] surface The surface to draw onto
133 * @return a reference to the adaptor handle
135 static Adaptor& New( Any nativeWindow, const Dali::RenderSurface& surface );
138 * @brief Create a new adaptor using render surface.
140 * @param[in] nativeWindow native window handle
141 * @param[in] surface The surface to draw onto
142 * @param[in] configuration The context loss configuration.
143 * @return a reference to the adaptor handle
145 static Adaptor& New( Any nativeWindow, const Dali::RenderSurface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
148 * @brief Virtual Destructor.
155 * @brief Starts the Adaptor.
160 * @brief Pauses the Adaptor.
165 * @brief Resumes the Adaptor, if previously paused.
167 * @note If the adaptor is not paused, this does not do anything.
172 * @brief Stops the Adaptor.
177 * @brief Ensures that the function passed in is called from the main loop when it is idle.
178 * @note Function must be called from the main event thread only.
180 * A callback of the following type may be used:
185 * @param[in] callback The function to call.
186 * @return true if added successfully, false otherwise
188 * @note Ownership of the callback is passed onto this class.
190 bool AddIdle( CallbackBase* callback );
193 * @brief Removes a previously added @p callback.
194 * @note Function must be called from the main event thread only.
196 * Does nothing if the @p callback doesn't exist.
198 * @param[in] callback The callback to be removed.
200 void RemoveIdle( CallbackBase* callback );
203 * @brief Replaces the rendering surface
205 * @param[in] nativeWindow native window handle
206 * @param[in] surface to use
208 void ReplaceSurface( Any nativeWindow, Dali::RenderSurface& surface );
211 * @brief Get the render surface the adaptor is using to render to.
213 * @return reference to current render surface
215 RenderSurface& GetSurface();
218 * @brief Gets native window handle
220 * @return Native window handle
222 Any GetNativeWindowHandle();
225 * @brief Release any locks the surface may hold.
227 * For example, after compositing an offscreen surface, use this method to allow
228 * rendering to continue.
230 void ReleaseSurfaceLock();
233 * @brief Set the number of frames per render.
235 * This enables an application to deliberately render with a reduced FPS.
236 * @param[in] numberOfVSyncsPerRender The number of vsyncs between successive renders.
237 * Suggest this is a power of two:
238 * 1 - render each vsync frame
239 * 2 - render every other vsync frame
240 * 4 - render every fourth vsync frame
241 * 8 - render every eighth vsync frame
243 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
246 * @brief Set whether the frame count per render is managed using the hardware VSync or
249 * @param[in] useHardware True if the hardware VSync should be used
251 void SetUseHardwareVSync(bool useHardware);
254 * @brief Returns a reference to the instance of the adaptor used by the current thread.
256 * @return A reference to the adaptor.
257 * @pre The adaptor has been initialised.
258 * @note This is only valid in the main thread.
260 static Adaptor& Get();
263 * @brief Checks whether the adaptor is available.
265 * @return true, if it is available, false otherwise.
267 static bool IsAvailable();
270 * @brief Call this method to notify Dali when scene is created and initialized.
272 * Notify Adaptor that the scene has been created.
274 void NotifySceneCreated();
277 * @brief Call this method to notify Dali when the system language changes.
279 * Use this only when NOT using Dali::Application, As Application created using
280 * Dali::Application will automatically receive notification of language change.
281 * When Dali::Application is not used, the application developer should
282 * use app-core to receive language change notifications and should update Dali
283 * by calling this method.
285 void NotifyLanguageChanged();
288 * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
289 * trigger a pinch gesture
291 * @param[in] distance The minimum pinch distance in pixels
293 void SetMinimumPinchDistance(float distance);
296 * @brief Feed a touch point to the adaptor.
298 * @param[in] point touch point
299 * @param[in] timeStamp time value of event
301 void FeedTouchPoint( TouchPoint& point, int timeStamp );
304 * @brief Feed a wheel event to the adaptor.
306 * @param[in] wheelEvent wheel event
308 void FeedWheelEvent( WheelEvent& wheelEvent );
311 * @brief Feed a key event to the adaptor.
313 * @param[in] keyEvent The key event holding the key information.
315 void FeedKeyEvent( KeyEvent& keyEvent );
318 * @copydoc Dali::Core::SceneCreated();
323 * @copydoc Dali::Application::SetViewMode();
325 void SetViewMode( ViewMode viewMode );
328 * @copydoc Dali::Application::SetStereoBase();
330 void SetStereoBase( float stereoBase );
333 * @brief Renders once more even if we're paused
334 * @note Will not work if the window is hidden.
341 * @brief The user should connect to this signal if they need to perform any
342 * special activities when the surface Dali is being rendered on is resized.
344 * @return The signal to connect to
346 AdaptorSignalType& ResizedSignal();
349 * @brief This signal is emitted when the language is changed on the device.
351 * @return The signal to connect to
353 AdaptorSignalType& LanguageChangedSignal();
358 Adaptor(const Adaptor&);
359 Adaptor& operator=(Adaptor&);
364 * @brief Create an uninitialized Adaptor.
368 Internal::Adaptor::Adaptor* mImpl; ///< Implementation object
369 friend class Internal::Adaptor::Adaptor;
374 #endif // __DALI_INTEGRATION_ADAPTOR_H__