1 #ifndef __DALI_ADAPTOR_H__
2 #define __DALI_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 <boost/function.hpp>
24 #include "application-configuration.h"
25 #include "tts-player.h"
26 #include <dali/public-api/signals/dali-signal.h>
27 #include <dali/public-api/math/rect.h>
28 #include <dali/public-api/events/touch-event.h>
30 namespace Dali DALI_INTERNAL
36 namespace Internal DALI_INTERNAL
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);
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 * @note The default base layout DeviceLayout::DEFAULT_BASE_LAYOUT will be used.
114 * @return a reference to the adaptor handle
116 static Adaptor& New( Window window );
119 * @brief Create a new adaptor using the window.
121 * @param[in] window The window to draw onto
122 * @param[in] baseLayout The base layout that the application has been written for
123 * @param[in] configuration The context loss configuration.
124 * @return a reference to the adaptor handle
126 static Adaptor& New( Window window, const DeviceLayout& baseLayout, Configuration::ContextLoss configuration );
129 * @brief Virtual Destructor.
136 * @brief Starts the Adaptor.
141 * @brief Pauses the Adaptor.
146 * @brief Resumes the Adaptor, if previously paused.
148 * @note If the adaptor is not paused, this does not do anything.
153 * @brief Stops the Adaptor.
158 * @brief Ensures that the function passed in is called from the main loop when it is idle.
160 * A callback of the following type may be used:
165 * @param[in] callBack The function to call.
166 * @return true if added successfully, false otherwise
168 bool AddIdle( boost::function<void(void)> callBack );
171 * @brief Get the render surface the adaptor is using to render to.
173 * @return reference to current render surface
175 RenderSurface& GetSurface();
178 * @brief Release any locks the surface may hold.
180 * For example, after compositing an offscreen surface, use this method to allow
181 * rendering to continue.
183 void ReleaseSurfaceLock();
186 * @brief Set the number of frames per render.
188 * This enables an application to deliberately render with a reduced FPS.
189 * @param[in] numberOfVSyncsPerRender The number of vsyncs between successive renders.
190 * Suggest this is a power of two:
191 * 1 - render each vsync frame
192 * 2 - render every other vsync frame
193 * 4 - render every fourth vsync frame
194 * 8 - render every eighth vsync frame
196 void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
199 * @brief Set whether the frame count per render is managed using the hardware VSync or
202 * @param[in] useHardware True if the hardware VSync should be used
204 void SetUseHardwareVSync(bool useHardware);
207 * @brief Returns a reference to the instance of the adaptor used by the current thread.
209 * @return A reference to the adaptor.
210 * @pre The adaptor has been initialised.
211 * @note This is only valid in the main thread.
213 static Adaptor& Get();
216 * @brief Checks whether the adaptor is available.
218 * @return true, if it is available, false otherwise.
220 static bool IsAvailable();
223 * @brief Call this method to notify Dali when the system language changes.
225 * Use this only when NOT using Dali::Application, As Application created using
226 * Dali::Application will automatically receive notification of language change.
227 * When Dali::Application is not used, the application developer should
228 * use app-core to receive language change notifications and should update Dali
229 * by calling this method.
231 void NotifyLanguageChanged();
234 * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
235 * trigger a pinch gesture
237 * @param[in] distance The minimum pinch distance in pixels
239 void SetMinimumPinchDistance(float distance);
244 * @brief The user should connect to this signal if they need to perform any
245 * special activities when the surface Dali is being rendered on is resized.
247 * @return The signal to connect to
249 AdaptorSignalType& ResizedSignal();
252 * @brief This signal is emitted when the language is changed on the device.
254 * @return The signal to connect to
256 AdaptorSignalType& LanguageChangedSignal();
261 Adaptor(const Adaptor&);
262 Adaptor& operator=(Adaptor&);
267 * @brief Create an uninitialized Adaptor.
271 Internal::Adaptor::Adaptor* mImpl; ///< Implementation object
272 friend class Internal::Adaptor::Adaptor;
277 #endif // __DALI_ADAPTOR_H__