1 #ifndef DALI_OFFSCREEN_APPLICATION_H
2 #define DALI_OFFSCREEN_APPLICATION_H
5 * Copyright (c) 2020 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/object/any.h>
23 #include <dali/public-api/object/base-handle.h>
24 #include <dali/public-api/signals/dali-signal.h>
27 #include <dali/public-api/dali-adaptor-common.h>
32 * @addtogroup dali_adaptor_framework
36 class OffscreenWindow;
40 class OffscreenApplication;
44 * @brief Appliations can draw UI on offscreen surface with the OffscreenApplication.
45 * When you use a OffscreenApplication, you don't have to create a Window.
47 class DALI_ADAPTOR_API OffscreenApplication : public Dali::BaseHandle
50 using OffscreenApplicationSignalType = Signal<void(void)>;
53 * @brief Enumeration for the render mode
57 AUTO, // Scene is rendered automatically
58 MANUAL // Scene is rendered by RenderOnce()
63 * @brief This is the constructor of OffscreenApplication
65 * @param[in] width The initial width of the default OffscreenWindow
66 * @param[in] height The initial height of the default OffscreenWindow
67 * @param[in] isTranslucent Whether the OffscreenWindow is translucent or not
68 * @param[in] renderMode The RenderMode of the OffscreenApplication
70 static OffscreenApplication New(uint16_t width, uint16_t height, bool isTranslucent, RenderMode renderMode = RenderMode::AUTO);
73 * @brief This is the constructor of OffscreenApplication
75 * @param[in] surface The native surface handle to create the OffscreenWindow
76 * @param[in] renderMode The RenderMode of the OffscreenApplication
78 static OffscreenApplication New(Dali::Any surface, RenderMode renderMode = RenderMode::AUTO);
81 * @brief Constructs an empty handle
83 OffscreenApplication();
86 * @brief Copy constructor
88 * @param [in] offscreenApplication A reference to the copied handle
90 OffscreenApplication(const OffscreenApplication& offscreenApplication);
93 * @brief Assignment operator
95 * @param [in] offscreenApplication A reference to the copied handle
96 * @return A reference to this
98 OffscreenApplication& operator=(const OffscreenApplication& offscreenApplication);
103 ~OffscreenApplication();
107 * @brief Starts the OffscreenApplication (rendering, event handling, etc)
112 * @brief Stops the OffscreenApplication
117 * @brief Get the default OffscreenWindow handle
118 * @return The default OffscreenWindow
120 OffscreenWindow GetWindow();
123 * @brief Renders once more even if we're paused
129 * @brief Signal to notify the client when the application is ready to be initialized
131 * @note OffscreenApplication::Start() should be called to be initialized
135 OffscreenApplicationSignalType& InitSignal();
138 * @brief Signal to notify the user when the application is about to be terminated
142 OffscreenApplicationSignalType& TerminateSignal();
144 public: // Not intended for application developers
146 * @brief Internal constructor
148 explicit DALI_INTERNAL OffscreenApplication(Internal::OffscreenApplication* offscreenApplication);
157 #endif // DALI_OFFSCREEN_APPLICATION_H