1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDER_LIST_H
2 #define DALI_INTERNAL_SCENE_GRAPH_RENDER_LIST_H
5 * Copyright (c) 2016 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/math/rect.h>
23 #include <dali/devel-api/common/owner-container.h>
24 #include <dali/internal/render/common/render-item.h>
29 typedef Rect<int> ClippingBox;
44 typedef OwnerContainer< RenderItem* > RenderItemContainer;
47 typedef OwnerContainer< RenderList* > RenderListContainer;
50 * The RenderList structure provides the renderer with a list of renderers.
63 mHasColorRenderItems( false )
72 // Pointer container deletes the render items
77 * Reset the render list for next frame
81 // We don't want to delete and re-create the render items every frame
89 * Reserve space in the render list
90 * @param size to reserve
92 void Reserve( RenderItemContainer::SizeType size )
95 mItems.Reserve( size );
99 * @return the capacity of the render list
101 RenderItemContainer::SizeType Capacity()
103 return mItems.Capacity();
107 * Get next free render item
108 * @return reference to the next available RenderItem
110 RenderItem& GetNextFreeItem()
112 // check if we have enough items, we can only be one behind at worst
113 if( mItems.Count() <= mNextFree )
115 mItems.PushBack( RenderItem::New() ); // Push a new empty render item
117 // get the item mNextFree points to and increase by one
118 RenderItem& item = *mItems[ mNextFree++ ];
123 * Get item at a given position in the list
125 RenderItem& GetItem( RenderItemContainer::SizeType index ) const
127 DALI_ASSERT_DEBUG( index < GetCachedItemCount() );
128 return *mItems[ index ];
132 * Get renderer from an item in the list
134 const Render::Renderer& GetRenderer( RenderItemContainer::SizeType index ) const
136 DALI_ASSERT_DEBUG( index < GetCachedItemCount() );
137 return *mItems[ index ]->mRenderer;
141 * Get the number of real items
142 * Because of caching, the actual size may be bit more
143 * @return The number of items
145 RenderItemContainer::SizeType Count() const
151 * @return the number of items cached by the list
153 RenderItemContainer::SizeType GetCachedItemCount() const
155 return mItems.Count();
159 * Tells the render list to reuse the items from the cache
161 void ReuseCachedItems()
163 mNextFree = mItems.Count();
167 * Predicate to inform if the list is empty
171 return ( mNextFree == 0 );
176 * @param clipping on/off
177 * @param box for clipping
179 void SetClipping( bool clipping, const ClippingBox& box )
184 mClippingBox = new ClippingBox( box );;
189 * @return true if clipping is on
191 bool IsClipping() const
193 return ( NULL != mClippingBox );
197 * @return the clipping box
199 const ClippingBox& GetClippingBox() const
201 return *mClippingBox;
205 * @return the container (for sorting)
207 RenderItemContainer& GetContainer()
213 * Do some housekeeping to keep memory consumption low
215 void ReleaseUnusedItems()
217 // release any non-used RenderItems
218 if( mItems.Count() > mNextFree )
220 mItems.Resize( mNextFree );
225 * @return the source layer these renderitems originate from
227 Layer* GetSourceLayer() const
233 * @param layer The layer these RenderItems originate from
235 void SetSourceLayer( Layer* layer )
237 mSourceLayer = layer;
241 * Set if the RenderList contains color RenderItems
242 * @param[in] hasColorRenderItems True if it contains color RenderItems, false otherwise
244 void SetHasColorRenderItems( bool hasColorRenderItems )
246 mHasColorRenderItems = hasColorRenderItems;
250 * Check if the RenderList contains color RenderItems
251 * @return true if the RenderList contains color RenderItems, false otherwise
253 bool HasColorRenderItems() const
255 return mHasColorRenderItems;
261 * Copy constructor and assignment operator not defined
263 RenderList( const RenderList& rhs );
264 const RenderList& operator=( const RenderList& rhs );
266 RenderItemContainer mItems; ///< Each item is a renderer and matrix pair
267 RenderItemContainer::SizeType mNextFree; ///< index for the next free item to use
269 ClippingBox* mClippingBox; ///< The clipping box, in window coordinates, when clipping is enabled
270 Layer* mSourceLayer; ///< The originating layer where the renderers are from
271 bool mHasColorRenderItems : 1; ///< True if list contains color render items
276 } // namespace SceneGraph
278 } // namespace Internal
282 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_LIST_H