dali/internal/render/common/render-list.h

   1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDER_LIST_H
   2 #define DALI_INTERNAL_SCENE_GRAPH_RENDER_LIST_H
   3
   4 /*
   5  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <cstdint>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/math/rect.h>
  26 #include <dali/devel-api/common/owner-container.h>
  27 #include <dali/internal/render/common/render-item.h>
  28
  29 namespace Dali
  30 {
  31
  32 typedef Rect<int> ClippingBox;
  33
  34 namespace Internal
  35 {
  36
  37 namespace Render
  38 {
  39 class Renderer;
  40 }
  41
  42 namespace SceneGraph
  43 {
  44
  45 class Layer;
  46
  47 typedef OwnerContainer< RenderItem* > RenderItemContainer;
  48
  49 struct RenderList;
  50 typedef OwnerContainer< RenderList* > RenderListContainer;
  51
  52 /**
  53  * The RenderList structure provides the renderer with a list of renderers.
  54  */
  55 struct RenderList
  56 {
  57 public:
  58
  59   /**
  60    * Constructor
  61    */
  62   RenderList()
  63   : mNextFree( 0 ),
  64     mClippingBox( NULL ),
  65     mSourceLayer( NULL ),
  66     mHasColorRenderItems( false )
  67   {
  68   }
  69
  70   /**
  71    * Destructor
  72    */
  73   ~RenderList()
  74   {
  75     // Pointer container deletes the render items
  76     delete mClippingBox;
  77   }
  78
  79   /**
  80    * Reset the render list for next frame
  81    */
  82   void Reset()
  83   {
  84     // We don't want to delete and re-create the render items every frame
  85     mNextFree = 0;
  86
  87     delete mClippingBox;
  88     mClippingBox = NULL;
  89   }
  90
  91   /**
  92    * Reserve space in the render list
  93    * @param size to reserve
  94    */
  95   void Reserve( RenderItemContainer::SizeType size )
  96   {
  97     mNextFree = 0;
  98     mItems.Reserve( size );
  99   }
 100
 101   /**
 102    * @return the capacity of the render list
 103    */
 104   RenderItemContainer::SizeType Capacity()
 105   {
 106     return mItems.Capacity();
 107   }
 108
 109   /**
 110    * Get next free render item
 111    * @return reference to the next available RenderItem
 112    */
 113   RenderItem& GetNextFreeItem()
 114   {
 115     // check if we have enough items, we can only be one behind at worst
 116     if( mItems.Count() <= mNextFree )
 117     {
 118       mItems.PushBack( RenderItem::New() ); // Push a new empty render item
 119     }
 120     // get the item mNextFree points to and increase by one
 121     RenderItem& item = *mItems[ mNextFree++ ];
 122     return item;
 123   }
 124
 125   /**
 126    * Get item at a given position in the list
 127    */
 128   RenderItem& GetItem( uint32_t index ) const
 129   {
 130     DALI_ASSERT_DEBUG( index < GetCachedItemCount() );
 131     return *mItems[ index ];
 132   }
 133
 134   /**
 135    * Get renderer from an item in the list
 136    */
 137   const Render::Renderer& GetRenderer( uint32_t index ) const
 138   {
 139     DALI_ASSERT_DEBUG( index < GetCachedItemCount() );
 140     return *mItems[ index ]->mRenderer;
 141   }
 142
 143   /**
 144    * Get the number of real items
 145    * Because of caching, the actual size may be bit more
 146    * @return The number of items
 147    */
 148   uint32_t Count() const
 149   {
 150     return mNextFree;
 151   }
 152
 153   /**
 154    * @return the number of items cached by the list
 155    */
 156   uint32_t GetCachedItemCount() const
 157   {
 158     return static_cast<uint32_t>( mItems.Count() );
 159   }
 160
 161   /**
 162    * Tells the render list to reuse the items from the cache
 163    */
 164   void ReuseCachedItems()
 165   {
 166     mNextFree = static_cast<uint32_t>( mItems.Count() );
 167   }
 168
 169   /**
 170    * Predicate to inform if the list is empty
 171    */
 172   bool IsEmpty() const
 173   {
 174     return ( mNextFree == 0 );
 175   }
 176
 177   /**
 178    * Set clipping
 179    * @param clipping on/off
 180    * @param box for clipping
 181    */
 182   void SetClipping( bool clipping, const ClippingBox& box )
 183   {
 184     if( clipping )
 185     {
 186       delete mClippingBox;
 187       mClippingBox = new ClippingBox( box );;
 188     }
 189   }
 190
 191   /**
 192    * @return true if clipping is on
 193    */
 194   bool IsClipping() const
 195   {
 196     return ( NULL != mClippingBox );
 197   }
 198
 199   /**
 200    * @return the clipping box
 201    */
 202   const ClippingBox& GetClippingBox() const
 203   {
 204     return *mClippingBox;
 205   }
 206
 207   /**
 208    * @return the container (for sorting)
 209    */
 210   RenderItemContainer& GetContainer()
 211   {
 212     return mItems;
 213   }
 214
 215   /**
 216    * Do some housekeeping to keep memory consumption low
 217    */
 218   void ReleaseUnusedItems()
 219   {
 220     // release any non-used RenderItems
 221     if( mItems.Count() > mNextFree )
 222     {
 223       mItems.Resize( mNextFree );
 224     }
 225   }
 226
 227   /**
 228    * @return the source layer these renderitems originate from
 229    */
 230   Layer* GetSourceLayer() const
 231   {
 232     return mSourceLayer;
 233   }
 234
 235   /**
 236    * @param layer The layer these RenderItems originate from
 237    */
 238   void SetSourceLayer( Layer* layer )
 239   {
 240     mSourceLayer = layer;
 241   }
 242
 243   /**
 244    * Set if the RenderList contains color RenderItems
 245    * @param[in] hasColorRenderItems True if it contains color RenderItems, false otherwise
 246    */
 247   void SetHasColorRenderItems( bool hasColorRenderItems )
 248   {
 249     mHasColorRenderItems = hasColorRenderItems;
 250   }
 251
 252   /**
 253    * Check if the RenderList contains color RenderItems
 254    * @return true if the RenderList contains color RenderItems, false otherwise
 255    */
 256   bool HasColorRenderItems() const
 257   {
 258     return mHasColorRenderItems;
 259   }
 260
 261 private:
 262
 263   /*
 264    * Copy constructor and assignment operator not defined
 265    */
 266   RenderList( const RenderList& rhs );
 267   const RenderList& operator=( const RenderList& rhs );
 268
 269   RenderItemContainer mItems; ///< Each item is a renderer and matrix pair
 270   uint32_t mNextFree;         ///< index for the next free item to use
 271
 272   ClippingBox* mClippingBox;               ///< The clipping box, in window coordinates, when clipping is enabled
 273   Layer*       mSourceLayer;              ///< The originating layer where the renderers are from
 274   bool         mHasColorRenderItems : 1;  ///< True if list contains color render items
 275
 276 };
 277
 278
 279 } // namespace SceneGraph
 280
 281 } // namespace Internal
 282
 283 } // namespace Dali
 284
 285 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_LIST_H