1 #ifndef __DALI_INTERNAL_DISCARD_QUEUE_H__
2 #define __DALI_INTERNAL_DISCARD_QUEUE_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/object/ref-object.h>
23 #include <dali/devel-api/common/owner-container.h>
24 #include <dali/internal/common/buffer-index.h>
25 #include <dali/internal/update/nodes/node-declarations.h>
26 #include <dali/internal/update/rendering/scene-graph-texture-set.h>
27 #include <dali/internal/update/rendering/scene-graph-renderer.h>
44 * DiscardQueue is used to cleanup nodes & resources when no longer in use.
45 * Unwanted objects are added here during UpdateManager::Update().
46 * When added, messages will be sent to clean-up GL resources in the next Render.
47 * The Update for frame N+1 may occur in parallel with the rendering of frame N.
48 * Therefore objects queued for destruction in frame N, are destroyed frame N+2.
54 typedef OwnerContainer< Shader* > ShaderQueue;
55 typedef OwnerContainer< Renderer* > RendererQueue;
56 typedef OwnerContainer< Camera* > CameraQueue;
59 * Create a new DiscardQueue.
60 * @param[in] renderQueue Used to send GL clean-up messages for the next Render.
62 DiscardQueue( RenderQueue& renderQueue );
65 * Non-virtual destructor; DiscardQueue is not suitable as a base class.
70 * Adds an unwanted Node and its children to the discard queue.
71 * If necessary, a message will be sent to clean-up GL resources in the next Render.
72 * @pre This method is not thread-safe, and should only be called from the update-thread.
73 * @param[in] updateBufferIndex The current update buffer index.
74 * @param[in] node The discarded node; DiscardQueue takes ownership.
76 void Add( BufferIndex updateBufferIndex, Node* node );
79 * Adds an unwanted shader to the discard queue.
80 * A message will be sent to clean-up GL resources in the next Render.
81 * @pre This method is not thread-safe, and should only be called from the update-thread.
82 * @param[in] bufferIndex The current update buffer index.
83 * @param[in] shader The shader to queue; DiscardQueue takes ownership.
85 void Add( BufferIndex bufferIndex, Shader* shader );
88 * Adds an unwanted Renderer to the discard queue.
89 * A message will be sent to clean up GL resources in the next Render.
90 * @param[in] updateBufferIndex The current update buffer index.
91 * @param[in] renderer The discarded renderer; DiscardQueue takes ownership.
93 void Add( BufferIndex updateBufferIndex, Renderer* renderer );
96 * Adds an unwanted Camera to the discard queue.
97 * This is done because Render thread may use Matrices from the camera
98 * @param[in] updateBufferIndex The current update buffer index.
99 * @param[in] camera The discarded renderer; DiscardQueue takes ownership.
101 void Add( BufferIndex updateBufferIndex, Camera* camera );
104 * Release the nodes which were queued in the frame N-2.
105 * @pre This method should be called (once) at the beginning of every Update.
106 * @param[in] updateBufferIndex The current update buffer index.
108 void Clear( BufferIndex updateBufferIndex );
113 DiscardQueue( const DiscardQueue& );
116 DiscardQueue& operator=( const DiscardQueue& rhs );
120 RenderQueue& mRenderQueue; ///< Used to send GL clean-up messages for the next Render.
122 // Messages are queued here following the current update buffer number
123 NodeOwnerContainer mNodeQueue[2];
124 ShaderQueue mShaderQueue[2];
125 RendererQueue mRendererQueue[2];
126 CameraQueue mCameraQueue[2];
129 } // namespace SceneGraph
131 } // namespace Internal
135 #endif // __DALI_INTERNAL_RESOURCE_DISCARD_QUEUE_H__