1 #ifndef DALI_INTERNAL_SCENE_GRAPH_LAYER_H
2 #define DALI_INTERNAL_SCENE_GRAPH_LAYER_H
5 * Copyright (c) 2018 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/layer.h>
23 #include <dali/internal/event/common/event-thread-services.h>
24 #include <dali/internal/update/nodes/node.h>
32 // value types used by messages
33 template <> struct ParameterType< Dali::Layer::SortFunctionType >
34 : public BasicType< Dali::Layer::SortFunctionType > {};
35 template <> struct ParameterType< Dali::Layer::Behavior >
36 : public BasicType< Dali::Layer::Behavior > {};
43 * Pair of node-renderer
52 Renderable( Node* node, Renderer* renderer )
61 typedef Dali::Vector< Renderable > RenderableContainer;
64 * Layers have a "depth" relative to all other layers in the scene-graph.
65 * Non-layer child nodes are considered part of the layer.
67 * Layers are rendered separately, and by default the depth buffer is cleared before each layer is rendered.
68 * Objects in higher layers, are rendered after (in front of) objects in lower layers.
70 class Layer : public Node
74 typedef Dali::Layer::SortFunctionType SortFunctionType;
79 * Construct a new Layer.
80 * @return A smart-pointer to a newly allocated Node
82 static SceneGraph::Layer* New();
90 * From Node, to convert a node to a layer.
93 virtual Layer* GetLayer()
99 * Sets the sort-function of a layer.
100 * @param [in] function The new sort-function.
102 void SetSortFunction( Dali::Layer::SortFunctionType function );
105 * Retrieve the function used to sort semi-transparent geometry in this layer.
106 * @return The sort function.
108 Dali::Layer::SortFunctionType GetSortFunction() const
110 return mSortFunction;
114 * Sets whether clipping is enabled for a layer.
115 * @param [in] enabled True if clipping is enabled.
117 void SetClipping( bool enabled );
120 * Query whether clipping is enabled for a layer.
121 * @return True if clipping is enabled.
123 bool IsClipping() const
129 * Sets the clipping box of a layer, in window coordinates.
130 * The contents of the layer will not be visible outside this box, when clipping is
131 * enabled. The default clipping box is empty (0,0,0,0).
132 * @param [in] box The clipping box
134 void SetClippingBox( const ClippingBox& box );
137 * Retrieves the clipping box of a layer, in window coordinates.
138 * @return The clipping box
140 const ClippingBox& GetClippingBox() const
146 * Sets the behavior of the layer
147 * @param [in] behavior The behavior of the layer
149 void SetBehavior( Dali::Layer::Behavior behavior );
152 * Retrieves the behavior of the layer.
153 * @return The behavior
155 Dali::Layer::Behavior GetBehavior() const
161 * @copydoc Dali::Layer::SetDepthTestDisabled()
163 void SetDepthTestDisabled( bool disable );
166 * @copydoc Dali::Layer::IsDepthTestDisabled()
168 bool IsDepthTestDisabled() const;
171 * Enables the reuse of the model view matrices of all renderers for this layer
172 * @param[in] updateBufferIndex The current update buffer index.
173 * @param value to set
175 void SetReuseRenderers( BufferIndex updateBufferIndex, bool value )
177 mAllChildTransformsClean[ updateBufferIndex ] = value;
181 * Checks if it is ok to reuse renderers. Renderers can be reused if ModelView transform for all the renderers
182 * has not changed from previous use.
183 * @param[in] camera A pointer to the camera that we want to use to render the list.
184 * @return True if all children transforms have been clean for two consecutive frames and the camera we are going
185 * to use is the same than the one used before ( Otherwise View transform will be different )
188 bool CanReuseRenderers( Camera* camera )
190 bool bReturn( mAllChildTransformsClean[ 0 ] && mAllChildTransformsClean[ 1 ] && camera == mLastCamera );
191 mLastCamera = camera;
197 * @return True if default sort function is used
199 bool UsesDefaultSortFunction()
201 return mIsDefaultSortFunction;
205 * Clears all the renderable lists
207 void ClearRenderables();
212 * Private constructor.
213 * See also Layer::New()
221 Layer& operator=(const Layer& rhs);
223 public: // For update-algorithms
225 RenderableContainer colorRenderables;
226 RenderableContainer overlayRenderables;
230 SortFunctionType mSortFunction; ///< Used to sort semi-transparent geometry
232 ClippingBox mClippingBox; ///< The clipping box, in window coordinates
233 Camera* mLastCamera; ///< Pointer to the last camera that has rendered the layer
235 Dali::Layer::Behavior mBehavior; ///< The behavior of the layer
237 bool mAllChildTransformsClean[ 2 ]; ///< True if all child nodes transforms are clean,
238 /// double buffered as we need two clean frames before we can reuse N-1 for N+1
239 /// this allows us to cache render items when layer is "static"
240 bool mIsClipping:1; ///< True when clipping is enabled
241 bool mDepthTestDisabled:1; ///< Whether depth test is disabled.
242 bool mIsDefaultSortFunction:1; ///< whether the default depth sort function is used
246 // Messages for Layer
249 * Create a message to set the sort-function of a layer
250 * @param[in] layer The layer
251 * @param[in] function The new sort-function.
253 inline void SetSortFunctionMessage( EventThreadServices& eventThreadServices, const Layer& layer, Dali::Layer::SortFunctionType function )
255 typedef MessageValue1< Layer, Dali::Layer::SortFunctionType > LocalType;
257 // Reserve some memory inside the message queue
258 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
260 // Construct message in the message queue memory; note that delete should not be called on the return value
261 new (slot) LocalType( &layer, &Layer::SetSortFunction, function );
265 * Create a message for enabling/disabling layer clipping
266 * @param[in] layer The layer
267 * @param[in] enabled True if clipping is enabled
269 inline void SetClippingMessage( EventThreadServices& eventThreadServices, const Layer& layer, bool enabled )
271 typedef MessageValue1< Layer, bool > LocalType;
273 // Reserve some memory inside the message queue
274 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
276 // Construct message in the message queue memory; note that delete should not be called on the return value
277 new (slot) LocalType( &layer, &Layer::SetClipping, enabled );
281 * Create a message to set the clipping box of a layer
282 * @param[in] layer The layer
283 * @param[in] clippingbox The clipping box
285 inline void SetClippingBoxMessage( EventThreadServices& eventThreadServices, const Layer& layer, const Dali::ClippingBox& clippingbox )
287 typedef MessageValue1< Layer, Dali::ClippingBox > LocalType;
289 // Reserve some memory inside the message queue
290 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
292 // Construct message in the message queue memory; note that delete should not be called on the return value
293 new (slot) LocalType( &layer, &Layer::SetClippingBox, clippingbox );
297 * Create a message to set the behavior of a layer
298 * @param[in] layer The layer
299 * @param[in] behavior The behavior
301 inline void SetBehaviorMessage( EventThreadServices& eventThreadServices,
303 Dali::Layer::Behavior behavior )
305 typedef MessageValue1< Layer, Dali::Layer::Behavior > LocalType;
307 // Reserve some memory inside the message queue
308 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
310 // Construct message in the message queue memory; note that delete should not be called on the return value
311 new (slot) LocalType( &layer, &Layer::SetBehavior, behavior );
315 * Create a message for disabling/enabling depth test.
317 * @see Dali::Layer::SetDepthTestDisabled().
319 * @param[in] layer The layer
320 * @param[in] disable \e true disables depth test. \e false sets the default behavior.
322 inline void SetDepthTestDisabledMessage( EventThreadServices& eventThreadServices, const Layer& layer, bool disable )
324 typedef MessageValue1< Layer, bool > LocalType;
326 // Reserve some memory inside the message queue
327 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
329 // Construct message in the message queue memory; note that delete should not be called on the return value
330 new (slot) LocalType( &layer, &Layer::SetDepthTestDisabled, disable );
333 } // namespace SceneGraph
335 // Template specialisation for OwnerPointer<Layer>, because delete is protected
337 inline void OwnerPointer<Dali::Internal::SceneGraph::Layer>::Reset()
341 Dali::Internal::SceneGraph::Node::Delete(mObject);
345 } // namespace Internal
349 #endif // DALI_INTERNAL_SCENE_GRAPH_LAYER_H