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/signals/dali-signal.h>
23 #include <dali/public-api/object/any.h>
24 #include <dali/public-api/object/base-handle.h>
30 * @addtogroup dali_adaptor_framework
34 class OffscreenWindow;
38 class OffscreenApplication;
42 * @brief Appliations can draw UI on offscreen surface with the OffscreenApplication.
43 * When you use a OffscreenApplication, you don't have to create a Window.
45 class DALI_IMPORT_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()
64 * @brief This is the constructor of OffscreenApplication
66 * @param[in] width The initial width of the default OffscreenWindow
67 * @param[in] height The initial height of the default OffscreenWindow
68 * @param[in] isTranslucent Whether the OffscreenWindow is translucent or not
69 * @param[in] renderMode The RenderMode of the OffscreenApplication
71 static OffscreenApplication New( uint16_t width, uint16_t height, bool isTranslucent,
72 RenderMode renderMode = RenderMode::AUTO );
75 * @brief This is the constructor of OffscreenApplication
77 * @param[in] surface The native surface handle to create the OffscreenWindow
78 * @param[in] isTranslucent Whether the OffscreenWindow is translucent or not
79 * @param[in] renderMode The RenderMode of the OffscreenApplication
81 static OffscreenApplication New( Dali::Any surface, bool isTranslucent, RenderMode renderMode = RenderMode::AUTO );
84 * @brief Constructs an empty handle
86 OffscreenApplication();
89 * @brief Copy constructor
91 * @param [in] offscreenApplication A reference to the copied handle
93 OffscreenApplication( const OffscreenApplication& offscreenApplication );
96 * @brief Assignment operator
98 * @param [in] offscreenApplication A reference to the copied handle
99 * @return A reference to this
101 OffscreenApplication& operator=( const OffscreenApplication& offscreenApplication );
106 ~OffscreenApplication();
111 * @brief Starts the OffscreenApplication (rendering, event handling, etc)
116 * @brief Stops the OffscreenApplication
122 * @brief Get the default OffscreenWindow handle
123 * @return The default OffscreenWindow
125 OffscreenWindow GetWindow();
128 * @brief Renders once more even if we're paused
135 * @brief Signal to notify the client when the application is ready to be initialized
137 * @note OffscreenApplication::Start() should be called to be initialized
141 OffscreenApplicationSignalType& InitSignal();
144 * @brief Signal to notify the user when the application is about to be terminated
148 OffscreenApplicationSignalType& TerminateSignal();
150 public: // Not intended for application developers
152 * @brief Internal constructor
154 explicit DALI_INTERNAL OffscreenApplication( Internal::OffscreenApplication* offscreenApplication );
164 #endif // DALI_OFFSCREEN_APPLICATION_H