dali/internal/update/common/discard-queue.h

   1 #ifndef __DALI_INTERNAL_DISCARD_QUEUE_H__
   2 #define __DALI_INTERNAL_DISCARD_QUEUE_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 // INTERNAL INCLUDES
  22 #include <dali/public-api/object/ref-object.h>
  23 #include <dali/internal/common/buffer-index.h>
  24 #include <dali/internal/common/owner-container.h>
  25 #include <dali/internal/update/nodes/node-declarations.h>
  26 #include <dali/internal/update/node-attachments/node-attachment-declarations.h>
  27 #include <dali/internal/update/geometry/scene-graph-geometry.h>
  28 #include <dali/internal/update/effects/scene-graph-material.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Internal
  34 {
  35
  36 class Texture;
  37
  38 namespace SceneGraph
  39 {
  40
  41 class Node;
  42 class RenderQueue;
  43 class Shader;
  44
  45 /**
  46  * DiscardQueue is used to cleanup nodes & resources when no longer in use.
  47  * Unwanted objects are added here during UpdateManager::Update().
  48  * When added, messages will be sent to clean-up GL resources in the next Render.
  49  * The Update for frame N+1 may occur in parallel with the rendering of frame N.
  50  * Therefore objects queued for destruction in frame N, are destroyed frame N+2.
  51  */
  52 class DiscardQueue
  53 {
  54 public:
  55
  56   typedef OwnerContainer< Shader* > ShaderQueue;
  57   typedef OwnerContainer< Geometry* > GeometryQueue;
  58   typedef OwnerContainer< Material* > MaterialQueue;
  59
  60   /**
  61    * Create a new DiscardQueue.
  62    * @param[in] renderQueue Used to send GL clean-up messages for the next Render.
  63    */
  64   DiscardQueue( RenderQueue& renderQueue );
  65
  66   /**
  67    * Non-virtual destructor; DiscardQueue is not suitable as a base class.
  68    */
  69   ~DiscardQueue();
  70
  71   /**
  72    * Adds an unwanted Node and its children to the discard queue.
  73    * If necessary, a message will be sent to clean-up GL resources in the next Render.
  74    * @pre This method is not thread-safe, and should only be called from the update-thread.
  75    * @param[in] updateBufferIndex The current update buffer index.
  76    * @param[in] node The discarded node; DiscardQueue takes ownership.
  77    */
  78   void Add( BufferIndex updateBufferIndex, Node* node );
  79
  80   /**
  81    * Adds an unwanted NodeAttachment to the discard queue.
  82    * If necessary, a message will be sent to clean-up GL resources in the next Render.
  83    * @pre This method is not thread-safe, and should only be called from the update-thread.
  84    * @param[in] updateBufferIndex The current update buffer index.
  85    * @param[in] attachment The discarded attachment; DiscardQueue takes ownership.
  86    */
  87   void Add( BufferIndex updateBufferIndex, NodeAttachment* attachment );
  88
  89   /**
  90    * Adds an unwanted geometry to the discard queue.
  91    * A message will be sent to clean up GL resources in the next Render
  92    */
  93   void Add( BufferIndex updateBufferIndex, Geometry* geometry );
  94
  95   /**
  96    * Adds an unwanted material to the discard queue.
  97    * A message will be sent to clean up GL resources in the next Render.
  98    */
  99   void Add( BufferIndex updateBufferIndex, Material* material );
 100
 101   /**
 102    * Adds an unwanted shader to the discard queue.
 103    * A message will be sent to clean-up GL resources in the next Render.
 104    * @pre This method is not thread-safe, and should only be called from the update-thread.
 105    * @param[in] bufferIndex The current update buffer index.
 106    * @param[in] shader The shader to queue; DiscardQueue takes ownership.
 107    */
 108   void Add( BufferIndex bufferIndex, Shader* shader );
 109
 110   /**
 111    * Release the nodes which were queued in the frame N-2.
 112    * @pre This method should be called (once) at the beginning of every Update.
 113    * @param[in] updateBufferIndex The current update buffer index.
 114    */
 115   void Clear( BufferIndex updateBufferIndex );
 116
 117 private:
 118
 119   // Undefined
 120   DiscardQueue( const DiscardQueue& );
 121
 122   // Undefined
 123   DiscardQueue& operator=( const DiscardQueue& rhs );
 124
 125 private:
 126
 127   RenderQueue& mRenderQueue; ///< Used to send GL clean-up messages for the next Render.
 128
 129   // Messages are queued here when the update buffer index == 0
 130   NodeOwnerContainer           mNodeQueue0;
 131   NodeAttachmentOwnerContainer mAttachmentQueue0;
 132   ShaderQueue                  mShaderQueue0;
 133   GeometryQueue                mGeometryQueue0;
 134   MaterialQueue                mMaterialQueue0;
 135
 136   // Messages are queued here when the update buffer index == 1
 137   NodeOwnerContainer           mNodeQueue1;
 138   NodeAttachmentOwnerContainer mAttachmentQueue1;
 139   ShaderQueue                  mShaderQueue1;
 140   GeometryQueue                mGeometryQueue1;
 141   MaterialQueue                mMaterialQueue1;
 142 };
 143
 144 } // namespace SceneGraph
 145
 146 } // namespace Internal
 147
 148 } // namespace Dali
 149
 150 #endif // __DALI_INTERNAL_RESOURCE_DISCARD_QUEUE_H__