1 #ifndef DALI_OFFSCREEN_WINDOW_H
2 #define DALI_OFFSCREEN_WINDOW_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/actors/actor.h>
23 #include <dali/public-api/math/uint-16-pair.h>
24 #include <dali/public-api/object/any.h>
25 #include <dali/public-api/signals/dali-signal.h>
28 #include <dali/public-api/dali-adaptor-common.h>
33 * @addtogroup dali_adaptor_framework
41 class OffscreenWindow;
44 class DALI_ADAPTOR_API OffscreenWindow : public Dali::BaseHandle
47 using WindowSize = Uint16Pair;
48 using PostRenderSignalType = Signal<void(OffscreenWindow, Any)>;
52 * @brief Creates an initialized handle to a new OffscreenWindow
53 * @note You should hold the returned handle. If you missed the handle, the OffscreenWindow will be released
55 * @param[in] width The initial width of the OffscreenWindow
56 * @param[in] height The initial height of the OffscreenWindow
57 * @param[in] isTranslucent Whether the OffscreenWindow is translucent or not
59 static OffscreenWindow New(uint16_t width, uint16_t height, bool isTranslucent);
62 * @brief Creates an initialized handle to a new OffscreenWindow
63 * @note You should hold the returned handle. If you missed the handle, the OffscreenWindow will be released
65 * @param[in] surface The native surface handle of your platform
67 static OffscreenWindow New(Any surface);
70 * @brief Constructs an empty handle
75 * @brief Copy constructor
77 * @param [in] window A reference to the copied handle
79 OffscreenWindow(const OffscreenWindow& window);
82 * @brief Assignment operator
84 * @param [in] window A reference to the copied handle
85 * @return A reference to this
87 OffscreenWindow& operator=(const OffscreenWindow& window);
96 * @brief Adds a child Actor to the OffscreenWindow.
98 * The child will be referenced.
100 * @param[in] actor The child
101 * @pre The actor has been initialized.
102 * @pre The actor does not have a parent.
104 void Add(Actor actor);
107 * @brief Removes a child Actor from the OffscreenWindow.
109 * The child will be unreferenced.
111 * @param[in] actor The child
112 * @pre The actor has been added to the OffscreenWindow.
114 void Remove(Actor actor);
117 * @brief Sets the background color of the OffscreenWindow.
119 * @param[in] color The new background color
121 void SetBackgroundColor(const Vector4& color);
124 * @brief Gets the background color of the OffscreenWindow.
126 * @return The background color
128 Vector4 GetBackgroundColor() const;
131 * @brief Returns the root Layer of the OffscreenWindow.
133 * @return The root layer
135 Layer GetRootLayer() const;
138 * @brief Queries the number of on-scene layers.
140 * Note that a default layer is always provided (count >= 1).
142 * @return The number of layers
144 uint32_t GetLayerCount() const;
147 * @brief Retrieves the layer at a specified depth in the OffscreenWindow.
149 * @param[in] depth The depth
150 * @return The layer found at the given depth
151 * @pre Depth is less than layer count; see GetLayerCount().
153 Layer GetLayer(uint32_t depth) const;
156 * @brief Returns the size of the OffscreenWindow in pixels as a Vector.
158 * The x component will be the width of the OffscreenWindow in pixels.
159 * The y component will be the height of the OffscreenWindow in pixels.
161 * @return The size of the OffscreenWindow as a Vector
163 WindowSize GetSize() const;
166 * @brief Gets the native handle.
167 * @note When users call this function, it wraps the actual type used by the underlying system.
168 * @return The native handle or an empty handle
170 Any GetNativeHandle() const;
173 * @brief Retrieves the DPI of the window.
175 * @return The DPI of the window
177 Uint16Pair GetDpi() const;
181 * @brief This signal is emitted when the OffscreenWindow is rendered.
185 PostRenderSignalType& PostRenderSignal();
187 public: // Not intended for application developers
189 * @brief Internal constructor
191 explicit DALI_INTERNAL OffscreenWindow(Internal::OffscreenWindow* window);
200 #endif // DALI_OFFSCREEN_WINDOW_H