X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Finternal%2Fupdate%2Frender-tasks%2Fscene-graph-render-task.h;h=15c0e4f91ae280ce5181ab49817ad10cb122701c;hb=79881246746f65474b24ea4fe14151ccef8df3f4;hp=6b9e162fd7877d71948229df728429d80e0c1fb5;hpb=f5e7e4ee5e26ba8584d9f568abbc1de36aa59f57;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/internal/update/render-tasks/scene-graph-render-task.h b/dali/internal/update/render-tasks/scene-graph-render-task.h index 6b9e162..15c0e4f 100644 --- a/dali/internal/update/render-tasks/scene-graph-render-task.h +++ b/dali/internal/update/render-tasks/scene-graph-render-task.h @@ -1,8 +1,8 @@ -#ifndef __DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_H__ -#define __DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_H__ +#ifndef DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_H +#define DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_H /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -22,33 +22,39 @@ #include #include #include -#include #include -#include +#include #include #include +#include +#include namespace Dali { namespace Internal { -class FrameBufferTexture; -class CompleteStatusManager; + +namespace Render +{ +class RenderTracker; +} namespace SceneGraph { class Node; -class CameraAttachment; +class Camera; class RenderInstruction; +class RenderMessageDispatcher; /** * RenderTasks describe how the Dali scene should be rendered. */ -class RenderTask : public PropertyOwner +class RenderTask : public PropertyOwner, public PropertyOwner::Observer { public: - enum State + + enum State : uint8_t { RENDER_CONTINUOUSLY, ///< mRefreshRate > 0 RENDER_ONCE_WAITING_FOR_RESOURCES, ///< mRefreshRate = REFRESH_ONCE @@ -67,6 +73,12 @@ public: virtual ~RenderTask(); /** + * Initialize the render task. Called in update thread + * @param[in] renderMessageDispatcher to send messages to render thread + */ + void Initialize( RenderMessageDispatcher& renderMessageDispatcher ); + + /** * Set the nodes to be rendered. * @param[in] node This node and its children will be rendered. */ @@ -91,31 +103,26 @@ public: bool IsExclusive() const; /** - * Set the node from which the scene is viewed. - * @param[in] node The scene is viewed from the perspective of this node. + * Set the camera from which the scene is viewed. + * @param[in] cameraNode that camera is connected with + * @param[in] camera to use. */ - void SetCameraNode( Node* node ); - - /** - * Retrieve the camera node. - * @return The scene is viewed from the perspective of this node. - */ - Node* GetCameraNode() const; + void SetCamera( Node* cameraNode, Camera* camera ); /** * Set the frame-buffer used as a render target. - * @param[in] resourceId The resource ID of the frame-buffer, or zero if not rendering off-screen. + * @param[in] frameBuffer The framebuffer */ - void SetFrameBufferId( unsigned int resourceId ); + void SetFrameBuffer( Render::FrameBuffer* frameBuffer ); /** * Retrieve the resource ID of the frame-buffer. * @return The resource ID, or zero if not rendering off-screen. */ - unsigned int GetFrameBufferId() const; + Render::FrameBuffer* GetFrameBuffer(); /** - * Set the value of property viewport-position + * Set the value of property viewportPosition * This value will persist only for the current frame. * @param[in] updateBufferIndex The current update buffer index. * @param[in] value The value of the property @@ -123,7 +130,7 @@ public: void SetViewportPosition( BufferIndex updateBufferIndex, const Vector2& value ); /** - * Get the value of property viewport-position + * Get the value of property viewportPosition * @warning Should only be called from the Update thread * @param[in] bufferIndex The buffer to read from. * @return the value of the property. @@ -131,7 +138,7 @@ public: const Vector2& GetViewportPosition( BufferIndex bufferIndex ) const; /** - * Bake the value of the property viewport-position + * Bake the value of the property viewportPosition * This will also set the base value * @param[in] updateBufferIndex The current update buffer index. * @param[in] value The new value for property. @@ -139,7 +146,7 @@ public: void BakeViewportPosition( BufferIndex updateBufferIndex, const Vector2& value ); /** - * Set the value of property viewport-size + * Set the value of property viewportSize * This value will persist only for the current frame. * @param[in] updateBufferIndex The current update buffer index. * @param[in] value The value of the property @@ -147,7 +154,7 @@ public: void SetViewportSize( BufferIndex updateBufferIndex, const Vector2& value ); /** - * Get the value of property viewport-size + * Get the value of property viewportSize * @warning Should only be called from the Update thread * @param[in] bufferIndex The buffer to read from. * @return the value of the property. @@ -155,7 +162,7 @@ public: const Vector2& GetViewportSize( BufferIndex bufferIndex ) const; /** - * Bake the value of the property viewport-size + * Bake the value of the property viewportSize * This will also set the base value * @param[in] updateBufferIndex The current update buffer index. * @param[in] value The new value for property. @@ -163,7 +170,7 @@ public: void BakeViewportSize( BufferIndex updateBufferIndex, const Vector2& value ); /** - * Get the value of property viewport-enabled + * Get the value of property viewportEnabled * @warning Should only be called from the Update thread * @param[in] bufferIndex The buffer to read from. * @return the value of the property. @@ -179,7 +186,7 @@ public: bool QueryViewport( BufferIndex bufferIndex, Viewport& viewport ) const; /** - * Set the value of property clear-color + * Set the value of property clearColor * This value will persist only for the current frame. * @param[in] updateBufferIndex The current update buffer index. * @param[in] value The value of the property @@ -187,7 +194,7 @@ public: void SetClearColor( BufferIndex updateBufferIndex, const Vector4& value ); /** - * Get the value of property clear-color + * Get the value of property clearColor * @warning Should only be called from the Update thread * @param[in] bufferIndex The buffer to read from. * @return the value of the property. @@ -195,7 +202,7 @@ public: const Vector4& GetClearColor( BufferIndex bufferIndex ) const; /** - * Bake the value of the property clear-color + * Bake the value of the property clearColor * This will also set the base value * @param[in] updateBufferIndex The current update buffer index. * @param[in] value The new value for property. @@ -226,13 +233,13 @@ public: * Set the refresh-rate of the RenderTask. * @param[in] refreshRate The new refresh rate. */ - void SetRefreshRate( unsigned int refreshRate ); + void SetRefreshRate( uint32_t refreshRate ); /** * Retrieve the refresh-rate of the RenderTask. * @return The refresh rate. */ - unsigned int GetRefreshRate() const; + uint32_t GetRefreshRate() const; /** * Check if the render task is ready for rendering. @@ -251,9 +258,8 @@ public: /** * Process a frame. This method is called each frame for every ready render task, regardless * of whether it needs to render (so that the frame counter can be updated). - * @param[in] resourcesComplete true if the resources of the source tree are completely loaded. */ - void UpdateState( bool resourcesComplete ); + void UpdateState(); /** * Return true only if currently waiting for the render task to @@ -272,19 +278,27 @@ public: /** * @return The number of times we have transited from RENDERED_ONCE to RENDERED_ONCE_AND_NOTIFIED state. */ - unsigned int GetRenderedOnceCounter() const; + uint32_t GetRenderedOnceCounter() const; /** * Retrieve the view-matrix; this is double buffered for input handling. - * @pre GetCameraNode() returns a node with valid CameraAttachment. + * @pre GetCameraNode() returns a node with valid Camera. * @param[in] bufferIndex The buffer to read from. * @return The view-matrix. */ const Matrix& GetViewMatrix( BufferIndex bufferIndex ) const; /** + * @brief Retrieve the camera. + * @pre GetCameraNode() returns a node with valid Camera. + * + * @return The camera. + */ + SceneGraph::Camera& GetCamera() const; + + /** * Retrieve the projection-matrix; this is double buffered for input handling. - * @pre GetCameraNode() returns a node with valid CameraAttachment. + * @pre GetCameraNode() returns a node with valid Camera. * @param[in] bufferIndex The buffer to read from. * @return The projection-matrix. */ @@ -292,10 +306,15 @@ public: /** * Prepares the render-instruction buffer to be populated with instructions. - * @param[out] instruction to prepare + * + * If the render task is a render-once framebuffer backed by a native image, + * then this method will ensure that a GL sync object is created to track + * when the rendering has finished. + * * @param[in] updateBufferIndex The current update buffer index. + * @return instruction to prepare */ - void PrepareRenderInstruction( RenderInstruction& instruction, BufferIndex updateBufferIndex ); + RenderInstruction& PrepareRenderInstruction( BufferIndex updateBufferIndex ); /** * @return true if the view matrix has been updated during this or last frame @@ -303,126 +322,150 @@ public: bool ViewMatrixUpdated(); /** - * Set the complete status tracker. - * @param[in] completeStatusManager The complete status Tracker (not owned) + * Indicate whether GL sync is required for native render target. + * @param[in] requiresSync whether GL sync is required for native render target */ - void SetCompleteStatusManager( CompleteStatusManager* completeStatusManager ); + void SetSyncRequired( bool requiresSync ); -private: + /** + * Retrieve the render instruction. + * @param[in] updateBufferIndex The current update buffer index. + * @return The render instruction + */ + RenderInstruction& GetRenderInstruction( BufferIndex updateBufferIndex ) + { + return mRenderInstruction[updateBufferIndex]; + } + +private: // from PropertyOwner::Observer /** - * Protected constructor. + * @copydoc PropertyOwner::Observer::PropertyOwnerConnected( PropertyOwner& owner ) */ - RenderTask(); + void PropertyOwnerConnected( PropertyOwner& owner ); - // Undefined - RenderTask(const RenderTask&); + /** + * @copydoc PropertyOwner::Observer::PropertyOwnerDisconnected( BufferIndex updateBufferIndex, PropertyOwner& owner ) + */ + void PropertyOwnerDisconnected( BufferIndex updateBufferIndex, PropertyOwner& owner ); - // Undefined - RenderTask& operator=(const RenderTask&); + /** + * @copydoc PropertyOwner::Observer::PropertyOwnerDestroyed( PropertyOwner& owner ) + */ + void PropertyOwnerDestroyed( PropertyOwner& owner ); + +private: -private: // PropertyOwner + void SetActiveStatus(); - virtual void ResetDefaultProperties( BufferIndex currentBufferIndex ); + /** + * Constructor. + */ + RenderTask(); + + // Undefined + RenderTask(const RenderTask&) = delete; + RenderTask& operator=(const RenderTask&) = delete; public: // Animatable Properties - AnimatableProperty< Vector2 > mViewportPosition; ///< viewport-position - AnimatableProperty< Vector2 > mViewportSize; ///< viewport-size - AnimatableProperty< Vector4 > mClearColor; ///< clear-color + AnimatableProperty< Vector2 > mViewportPosition; ///< viewportPosition + AnimatableProperty< Vector2 > mViewportSize; ///< viewportSize + AnimatableProperty< Vector4 > mClearColor; ///< clearColor private: - CompleteStatusManager* mCompleteStatusManager; + RenderMessageDispatcher* mRenderMessageDispatcher; + Render::RenderTracker* mRenderSyncTracker; Node* mSourceNode; Node* mCameraNode; - CameraAttachment* mCameraAttachment; - unsigned int mFrameBufferResourceId; + SceneGraph::Camera* mCamera; + Render::FrameBuffer* mFrameBuffer; - bool mWaitingToRender:1; ///< True when an render once to FBO is waiting - bool mNotifyTrigger:1; ///< True if a render once render task has finished renderering - bool mExclusive: 1; ///< Whether the render task has exclusive access to the source actor (node in the scene graph implementation). - bool mClearEnabled: 1; ///< Whether previous results are cleared. - bool mCullMode: 1; ///< Whether renderers should be frustum culled + RenderInstruction mRenderInstruction[2]; ///< Owned double buffered render instruction. (Double buffered because this owns render commands for the currently drawn frame) - FrameBufferTexture* mRenderTarget; - Viewport mViewport; + uint32_t mRefreshRate; ///< REFRESH_ONCE, REFRESH_ALWAYS or render every N frames + uint32_t mFrameCounter; ///< counter for rendering every N frames + uint32_t mRenderedOnceCounter;///< Incremented whenever state changes to RENDERED_ONCE_AND_NOTIFIED - State mState; ///< Render state. - unsigned int mRefreshRate; ///< REFRESH_ONCE, REFRESH_ALWAYS or render every N frames - unsigned int mFrameCounter; ///< counter for rendering every N frames + State mState; ///< Render state. - unsigned int mRenderedOnceCounter; ///< Incremented whenever state changes to RENDERED_ONCE_AND_NOTIFIED + bool mRequiresSync:1; ///< Whether sync is needed to track the render + bool mActive:1; ///< True when the task is active, i.e. has valid source and camera + bool mWaitingToRender:1;///< True when an render once to FBO is waiting + bool mNotifyTrigger:1; ///< True if a render once render task has finished renderering + bool mExclusive:1; ///< Whether the render task has exclusive access to the source actor (node in the scene graph). + bool mClearEnabled:1; ///< Whether previous results are cleared. + bool mCullMode:1; ///< Whether renderers should be frustum culled }; // Messages for RenderTask - -inline void SetFrameBufferIdMessage( EventToUpdate& eventToUpdate, RenderTask& task, unsigned int resourceId ) +inline void SetFrameBufferMessage( EventThreadServices& eventThreadServices, const RenderTask& task, Render::FrameBuffer* frameBuffer ) { - typedef MessageValue1< RenderTask, unsigned int > LocalType; + typedef MessageValue1< RenderTask, Render::FrameBuffer*> LocalType; // Reserve some memory inside the message queue - unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) ); + uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) ); // Construct message in the message queue memory; note that delete should not be called on the return value - new (slot) LocalType( &task, &RenderTask::SetFrameBufferId, resourceId ); + new (slot) LocalType( &task, &RenderTask::SetFrameBuffer, frameBuffer ); } -inline void SetClearColorMessage( EventToUpdate& eventToUpdate, RenderTask& task, const Vector4& value ) +inline void SetClearColorMessage( EventThreadServices& eventThreadServices, const RenderTask& task, const Vector4& value ) { typedef MessageDoubleBuffered1< RenderTask, Vector4 > LocalType; // Reserve some memory inside the message queue - unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) ); + uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) ); // Construct message in the message queue memory; note that delete should not be called on the return value new (slot) LocalType( &task, &RenderTask::SetClearColor, value ); } -inline void BakeClearColorMessage( EventToUpdate& eventToUpdate, const RenderTask& task, const Vector4& value ) +inline void BakeClearColorMessage( EventThreadServices& eventThreadServices, const RenderTask& task, const Vector4& value ) { typedef MessageDoubleBuffered1< RenderTask, Vector4 > LocalType; // Reserve some memory inside the message queue - unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) ); + uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) ); // Construct message in the message queue memory; note that delete should not be called on the return value new (slot) LocalType( &task, &RenderTask::BakeClearColor, value ); } -inline void SetClearEnabledMessage( EventToUpdate& eventToUpdate, RenderTask& task, bool enabled ) +inline void SetClearEnabledMessage( EventThreadServices& eventThreadServices, const RenderTask& task, bool enabled ) { typedef MessageValue1< RenderTask, bool > LocalType; // Reserve some memory inside the message queue - unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) ); + uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) ); // Construct message in the message queue memory; note that delete should not be called on the return value new (slot) LocalType( &task, &RenderTask::SetClearEnabled, enabled ); } -inline void SetCullModeMessage( EventToUpdate& eventToUpdate, RenderTask& task, bool mode ) +inline void SetCullModeMessage( EventThreadServices& eventThreadServices, const RenderTask& task, bool mode ) { typedef MessageValue1< RenderTask, bool > LocalType; // Reserve some memory inside the message queue - unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) ); + uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) ); // Construct message in the message queue memory; note that delete should not be called on the return value new (slot) LocalType( &task, &RenderTask::SetCullMode, mode ); } -inline void SetRefreshRateMessage( EventToUpdate& eventToUpdate, RenderTask& task, unsigned int refreshRate ) +inline void SetRefreshRateMessage( EventThreadServices& eventThreadServices, const RenderTask& task, uint32_t refreshRate ) { - typedef MessageValue1< RenderTask, unsigned int > LocalType; + typedef MessageValue1< RenderTask, uint32_t > LocalType; // Reserve some memory inside the message queue - unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) ); + uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) ); // Construct message in the message queue memory; note that delete should not be called on the return value new (slot) LocalType( &task, &RenderTask::SetRefreshRate, refreshRate ); } -inline void SetSourceNodeMessage( EventToUpdate& eventToUpdate, RenderTask& task, const Node* constNode ) +inline void SetSourceNodeMessage( EventThreadServices& eventThreadServices, const RenderTask& task, const Node* constNode ) { // Scene graph thread can destroy this object. Node* node = const_cast< Node* >( constNode ); @@ -430,54 +473,64 @@ inline void SetSourceNodeMessage( EventToUpdate& eventToUpdate, RenderTask& task typedef MessageValue1< RenderTask, Node* > LocalType; // Reserve some memory inside the message queue - unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) ); + uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) ); // Construct message in the message queue memory; note that delete should not be called on the return value new (slot) LocalType( &task, &RenderTask::SetSourceNode, node ); } -inline void SetCameraNodeMessage( EventToUpdate& eventToUpdate, RenderTask& task, const Node* constNode ) +inline void SetCameraMessage( EventThreadServices& eventThreadServices, const RenderTask& task, const Node* constNode, const Camera* constCamera ) { - // Scene graph thread can destroy this object. + typedef MessageValue2< RenderTask, Node*, Camera* > LocalType; + Node* node = const_cast< Node* >( constNode ); + Camera* camera = const_cast< Camera* >( constCamera ); + // Reserve memory inside the message queue + uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) ); - typedef MessageValue1< RenderTask, Node* > LocalType; + // Construct message in the message queue memory; note that delete should not be called on the return value + new (slot) LocalType( &task, &RenderTask::SetCamera, node, camera ); +} + +inline void SetExclusiveMessage( EventThreadServices& eventThreadServices, const RenderTask& task, bool exclusive ) +{ + typedef MessageValue1< RenderTask, bool > LocalType; // Reserve some memory inside the message queue - unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) ); + uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) ); // Construct message in the message queue memory; note that delete should not be called on the return value - new (slot) LocalType( &task, &RenderTask::SetCameraNode, node ); + new (slot) LocalType( &task, &RenderTask::SetExclusive, exclusive ); } -inline void SetExclusiveMessage( EventToUpdate& eventToUpdate, RenderTask& task, bool exclusive ) +inline void SetSyncRequiredMessage(EventThreadServices& eventThreadServices, const RenderTask& task, bool requiresSync ) { typedef MessageValue1< RenderTask, bool > LocalType; // Reserve some memory inside the message queue - unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) ); + uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) ); // Construct message in the message queue memory; note that delete should not be called on the return value - new (slot) LocalType( &task, &RenderTask::SetExclusive, exclusive ); + new (slot) LocalType( &task, &RenderTask::SetSyncRequired, requiresSync ); } -inline void BakeViewportPositionMessage( EventToUpdate& eventToUpdate, const RenderTask& task, const Vector2& value ) +inline void BakeViewportPositionMessage( EventThreadServices& eventThreadServices, const RenderTask& task, const Vector2& value ) { typedef MessageDoubleBuffered1< RenderTask, Vector2 > LocalType; // Reserve some memory inside the message queue - unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) ); + uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) ); // Construct message in the message queue memory; note that delete should not be called on the return value new (slot) LocalType( &task, &RenderTask::BakeViewportPosition, value ); } -inline void BakeViewportSizeMessage( EventToUpdate& eventToUpdate, const RenderTask& task, const Vector2& value ) +inline void BakeViewportSizeMessage( EventThreadServices& eventThreadServices, const RenderTask& task, const Vector2& value ) { typedef MessageDoubleBuffered1< RenderTask, Vector2 > LocalType; // Reserve some memory inside the message queue - unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) ); + uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) ); // Construct message in the message queue memory; note that delete should not be called on the return value new (slot) LocalType( &task, &RenderTask::BakeViewportSize, value ); @@ -489,4 +542,4 @@ inline void BakeViewportSizeMessage( EventToUpdate& eventToUpdate, const RenderT } // namespace Dali -#endif // __DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_H__ +#endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_H