1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_H__
2 #define __DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_H__
5 * Copyright (c) 2014 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/viewport.h>
23 #include <dali/public-api/render-tasks/render-task.h>
24 #include <dali/internal/common/buffer-index.h>
25 #include <dali/internal/common/message.h>
26 #include <dali/internal/event/common/event-thread-services.h>
27 #include <dali/internal/update/common/property-owner.h>
28 #include <dali/internal/update/common/animatable-property.h>
35 class FrameBufferTexture;
36 class CompleteStatusManager;
41 class CameraAttachment;
42 class RenderInstruction;
45 * RenderTasks describe how the Dali scene should be rendered.
47 class RenderTask : public PropertyOwner
52 RENDER_CONTINUOUSLY, ///< mRefreshRate > 0
53 RENDER_ONCE_WAITING_FOR_RESOURCES, ///< mRefreshRate = REFRESH_ONCE
54 RENDERED_ONCE, ///< mRefreshRate = REFRESH_ONCE & rendered
55 RENDERED_ONCE_AND_NOTIFIED ///< mRefreshRate = REFRESH_ONCE & rendered & notified
59 * Create a new RenderTask
61 static RenderTask* New();
66 virtual ~RenderTask();
69 * Set the nodes to be rendered.
70 * @param[in] node This node and its children will be rendered.
72 void SetSourceNode( Node* node );
75 * Retrieve the source node.
76 * @return This node and its children will be rendered.
78 Node* GetSourceNode() const;
81 * Set whether the RenderTask has exclusive access to the source nodes.
82 * @param[in] exclusive True if the source nodes will only be rendered by this render-task.
84 void SetExclusive( bool exclusive );
87 * Query whether the RenderTask has exclusive access to the source actors.
88 * @return True if the source actors will only be rendered by this render-task.
90 bool IsExclusive() const;
93 * Set the node from which the scene is viewed.
94 * @param[in] node The scene is viewed from the perspective of this node.
96 void SetCameraNode( Node* node );
99 * Set the frame-buffer used as a render target.
100 * @param[in] resourceId The resource ID of the frame-buffer, or zero if not rendering off-screen.
102 void SetFrameBufferId( unsigned int resourceId );
105 * Retrieve the resource ID of the frame-buffer.
106 * @return The resource ID, or zero if not rendering off-screen.
108 unsigned int GetFrameBufferId() const;
111 * Set the value of property viewport-position
112 * This value will persist only for the current frame.
113 * @param[in] updateBufferIndex The current update buffer index.
114 * @param[in] value The value of the property
116 void SetViewportPosition( BufferIndex updateBufferIndex, const Vector2& value );
119 * Get the value of property viewport-position
120 * @warning Should only be called from the Update thread
121 * @param[in] bufferIndex The buffer to read from.
122 * @return the value of the property.
124 const Vector2& GetViewportPosition( BufferIndex bufferIndex ) const;
127 * Bake the value of the property viewport-position
128 * This will also set the base value
129 * @param[in] updateBufferIndex The current update buffer index.
130 * @param[in] value The new value for property.
132 void BakeViewportPosition( BufferIndex updateBufferIndex, const Vector2& value );
135 * Set the value of property viewport-size
136 * This value will persist only for the current frame.
137 * @param[in] updateBufferIndex The current update buffer index.
138 * @param[in] value The value of the property
140 void SetViewportSize( BufferIndex updateBufferIndex, const Vector2& value );
143 * Get the value of property viewport-size
144 * @warning Should only be called from the Update thread
145 * @param[in] bufferIndex The buffer to read from.
146 * @return the value of the property.
148 const Vector2& GetViewportSize( BufferIndex bufferIndex ) const;
151 * Bake the value of the property viewport-size
152 * This will also set the base value
153 * @param[in] updateBufferIndex The current update buffer index.
154 * @param[in] value The new value for property.
156 void BakeViewportSize( BufferIndex updateBufferIndex, const Vector2& value );
159 * Get the value of property viewport-enabled
160 * @warning Should only be called from the Update thread
161 * @param[in] bufferIndex The buffer to read from.
162 * @return the value of the property.
164 bool GetViewportEnabled( BufferIndex bufferIndex ) const;
167 * Query whether the optional viewport is set.
168 * @param[in] bufferIndex The buffer to read from.
169 * @param[out] viewport The viewport position and size is populated.
170 * @return true if the viewport has been set
172 bool QueryViewport( BufferIndex bufferIndex, Viewport& viewport ) const;
175 * Set the value of property clear-color
176 * This value will persist only for the current frame.
177 * @param[in] updateBufferIndex The current update buffer index.
178 * @param[in] value The value of the property
180 void SetClearColor( BufferIndex updateBufferIndex, const Vector4& value );
183 * Get the value of property clear-color
184 * @warning Should only be called from the Update thread
185 * @param[in] bufferIndex The buffer to read from.
186 * @return the value of the property.
188 const Vector4& GetClearColor( BufferIndex bufferIndex ) const;
191 * Bake the value of the property clear-color
192 * This will also set the base value
193 * @param[in] updateBufferIndex The current update buffer index.
194 * @param[in] value The new value for property.
196 void BakeClearColor( BufferIndex updateBufferIndex, const Vector4& value );
199 * @copydoc Dali::RenderTask::SetClearEnabled()
201 void SetClearEnabled( bool enabled );
204 * @copydoc Dali::RenderTask::GetClearEnabled()
206 bool GetClearEnabled() const;
209 * @copydoc Dali::RenderTask::SetCullMode()
211 void SetCullMode( bool mode );
214 * @copydoc Dali::RenderTask::GetCullMode()
216 bool GetCullMode() const;
219 * Set the refresh-rate of the RenderTask.
220 * @param[in] refreshRate The new refresh rate.
222 void SetRefreshRate( unsigned int refreshRate );
225 * Retrieve the refresh-rate of the RenderTask.
226 * @return The refresh rate.
228 unsigned int GetRefreshRate() const;
231 * Check if the render task is ready for rendering.
232 * @param[in] updateBufferIndex The current update buffer index.
233 * @return True if the render-task is ready for rendering.
235 bool ReadyToRender( BufferIndex updateBufferIndex );
238 * True if a render is required. If the current state is RENDER_CONTINUOUSLY, then
239 * this returns true if the frame count is zero. If the current state is RENDER_ONCE_WAITING_FOR_RESOURCES, then it always returns true. In all other states, it returns false.
240 * @return true if a render is required
242 bool IsRenderRequired();
245 * Set whether all resources were available when the render-task was processed
246 * @param[in] resourcesComplete True if the resources of the source tree are completely loaded.
248 void SetResourcesFinished( bool resourcesFinished );
251 * Process a frame. This method is called each frame for every ready render task, regardless
252 * of whether it needs to render (so that the frame counter can be updated).
257 * Return true only if currently waiting for the render task to
258 * finish rendering and the update thread should be kept alive.
259 * @return true if waiting to be rendered
261 bool IsWaitingToRender();
264 * Return true when the render task has finished rendering and a notification
265 * needs sending. (Only one notification is sent per render once request)
266 * @return true if notification is required.
271 * @return The number of times we have transited from RENDERED_ONCE to RENDERED_ONCE_AND_NOTIFIED state.
273 unsigned int GetRenderedOnceCounter() const;
276 * Retrieve the view-matrix; this is double buffered for input handling.
277 * @pre GetCameraNode() returns a node with valid CameraAttachment.
278 * @param[in] bufferIndex The buffer to read from.
279 * @return The view-matrix.
281 const Matrix& GetViewMatrix( BufferIndex bufferIndex ) const;
284 * Retrieve the projection-matrix; this is double buffered for input handling.
285 * @pre GetCameraNode() returns a node with valid CameraAttachment.
286 * @param[in] bufferIndex The buffer to read from.
287 * @return The projection-matrix.
289 const Matrix& GetProjectionMatrix( BufferIndex bufferIndex ) const;
292 * Prepares the render-instruction buffer to be populated with instructions.
293 * @param[out] instruction to prepare
294 * @param[in] updateBufferIndex The current update buffer index.
296 void PrepareRenderInstruction( RenderInstruction& instruction, BufferIndex updateBufferIndex );
299 * @return true if the view matrix has been updated during this or last frame
301 bool ViewMatrixUpdated();
304 * Set the complete status tracker.
305 * @param[in] completeStatusManager The complete status Tracker (not owned)
307 void SetCompleteStatusManager( CompleteStatusManager* completeStatusManager );
310 * @return A pointer to the camera used by the RenderTask
312 Node* GetCamera() const;
317 * Protected constructor.
322 RenderTask(const RenderTask&);
325 RenderTask& operator=(const RenderTask&);
327 private: // PropertyOwner
329 virtual void ResetDefaultProperties( BufferIndex currentBufferIndex );
331 public: // Animatable Properties
332 AnimatableProperty< Vector2 > mViewportPosition; ///< viewport-position
333 AnimatableProperty< Vector2 > mViewportSize; ///< viewport-size
334 AnimatableProperty< Vector4 > mClearColor; ///< clear-color
337 CompleteStatusManager* mCompleteStatusManager;
340 CameraAttachment* mCameraAttachment;
341 unsigned int mFrameBufferResourceId;
343 bool mResourcesFinished:1; ///< True if all resources were available when the render-task was processed
344 bool mWaitingToRender:1; ///< True when an render once to FBO is waiting
345 bool mNotifyTrigger:1; ///< True if a render once render task has finished renderering
346 bool mExclusive: 1; ///< Whether the render task has exclusive access to the source actor (node in the scene graph implementation).
347 bool mClearEnabled: 1; ///< Whether previous results are cleared.
348 bool mCullMode: 1; ///< Whether renderers should be frustum culled
350 FrameBufferTexture* mRenderTarget;
353 State mState; ///< Render state.
354 unsigned int mRefreshRate; ///< REFRESH_ONCE, REFRESH_ALWAYS or render every N frames
355 unsigned int mFrameCounter; ///< counter for rendering every N frames
357 unsigned int mRenderedOnceCounter; ///< Incremented whenever state changes to RENDERED_ONCE_AND_NOTIFIED
361 // Messages for RenderTask
363 inline void SetFrameBufferIdMessage( EventThreadServices& eventThreadServices, RenderTask& task, unsigned int resourceId )
365 typedef MessageValue1< RenderTask, unsigned int > LocalType;
367 // Reserve some memory inside the message queue
368 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
370 // Construct message in the message queue memory; note that delete should not be called on the return value
371 new (slot) LocalType( &task, &RenderTask::SetFrameBufferId, resourceId );
374 inline void SetClearColorMessage( EventThreadServices& eventThreadServices, RenderTask& task, const Vector4& value )
376 typedef MessageDoubleBuffered1< RenderTask, Vector4 > LocalType;
378 // Reserve some memory inside the message queue
379 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
381 // Construct message in the message queue memory; note that delete should not be called on the return value
382 new (slot) LocalType( &task, &RenderTask::SetClearColor, value );
385 inline void BakeClearColorMessage( EventThreadServices& eventThreadServices, const RenderTask& task, const Vector4& value )
387 typedef MessageDoubleBuffered1< RenderTask, Vector4 > LocalType;
389 // Reserve some memory inside the message queue
390 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
392 // Construct message in the message queue memory; note that delete should not be called on the return value
393 new (slot) LocalType( &task, &RenderTask::BakeClearColor, value );
396 inline void SetClearEnabledMessage( EventThreadServices& eventThreadServices, RenderTask& task, bool enabled )
398 typedef MessageValue1< RenderTask, bool > LocalType;
400 // Reserve some memory inside the message queue
401 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
403 // Construct message in the message queue memory; note that delete should not be called on the return value
404 new (slot) LocalType( &task, &RenderTask::SetClearEnabled, enabled );
407 inline void SetCullModeMessage( EventThreadServices& eventThreadServices, RenderTask& task, bool mode )
409 typedef MessageValue1< RenderTask, bool > LocalType;
411 // Reserve some memory inside the message queue
412 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
414 // Construct message in the message queue memory; note that delete should not be called on the return value
415 new (slot) LocalType( &task, &RenderTask::SetCullMode, mode );
418 inline void SetRefreshRateMessage( EventThreadServices& eventThreadServices, RenderTask& task, unsigned int refreshRate )
420 typedef MessageValue1< RenderTask, unsigned int > LocalType;
422 // Reserve some memory inside the message queue
423 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
425 // Construct message in the message queue memory; note that delete should not be called on the return value
426 new (slot) LocalType( &task, &RenderTask::SetRefreshRate, refreshRate );
429 inline void SetSourceNodeMessage( EventThreadServices& eventThreadServices, RenderTask& task, const Node* constNode )
431 // Scene graph thread can destroy this object.
432 Node* node = const_cast< Node* >( constNode );
434 typedef MessageValue1< RenderTask, Node* > LocalType;
436 // Reserve some memory inside the message queue
437 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
439 // Construct message in the message queue memory; note that delete should not be called on the return value
440 new (slot) LocalType( &task, &RenderTask::SetSourceNode, node );
443 inline void SetCameraNodeMessage( EventThreadServices& eventThreadServices, RenderTask& task, const Node* constNode )
445 // Scene graph thread can destroy this object.
446 Node* node = const_cast< Node* >( constNode );
448 typedef MessageValue1< RenderTask, Node* > LocalType;
450 // Reserve some memory inside the message queue
451 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
453 // Construct message in the message queue memory; note that delete should not be called on the return value
454 new (slot) LocalType( &task, &RenderTask::SetCameraNode, node );
457 inline void SetExclusiveMessage( EventThreadServices& eventThreadServices, RenderTask& task, bool exclusive )
459 typedef MessageValue1< RenderTask, bool > LocalType;
461 // Reserve some memory inside the message queue
462 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
464 // Construct message in the message queue memory; note that delete should not be called on the return value
465 new (slot) LocalType( &task, &RenderTask::SetExclusive, exclusive );
468 inline void BakeViewportPositionMessage( EventThreadServices& eventThreadServices, const RenderTask& task, const Vector2& value )
470 typedef MessageDoubleBuffered1< RenderTask, Vector2 > LocalType;
472 // Reserve some memory inside the message queue
473 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
475 // Construct message in the message queue memory; note that delete should not be called on the return value
476 new (slot) LocalType( &task, &RenderTask::BakeViewportPosition, value );
479 inline void BakeViewportSizeMessage( EventThreadServices& eventThreadServices, const RenderTask& task, const Vector2& value )
481 typedef MessageDoubleBuffered1< RenderTask, Vector2 > LocalType;
483 // Reserve some memory inside the message queue
484 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
486 // Construct message in the message queue memory; note that delete should not be called on the return value
487 new (slot) LocalType( &task, &RenderTask::BakeViewportSize, value );
490 } // namespace SceneGraph
492 } // namespace Internal
496 #endif // __DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_H__