2 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali/internal/event/render-tasks/render-task-impl.h>
22 #include <cstring> // for strcmp
25 #include <dali/public-api/common/dali-common.h>
26 #include <dali/public-api/object/type-registry.h>
27 #include <dali/internal/event/common/event-thread-services.h>
28 #include <dali/internal/event/actors/actor-impl.h>
29 #include <dali/internal/event/actors/camera-actor-impl.h>
30 #include <dali/internal/event/common/property-helper.h>
31 #include <dali/internal/event/common/stage-impl.h>
32 #include <dali/internal/event/common/projection.h>
33 #include <dali/internal/event/images/frame-buffer-image-impl.h>
34 #include <dali/internal/update/nodes/node.h>
35 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
36 #include <dali/internal/update/render-tasks/scene-graph-render-task.h>
38 #if defined(DEBUG_ENABLED)
41 Debug::Filter* gLogRender = Debug::Filter::New(Debug::Concise, false, "LOG_RENDER_TASK");
51 namespace // For internal properties
56 // Name Type writable animatable constraint-input enum for index-checking
57 DALI_PROPERTY_TABLE_BEGIN
58 DALI_PROPERTY( "viewportPosition", VECTOR2, true, true, true, Dali::RenderTask::Property::VIEWPORT_POSITION )
59 DALI_PROPERTY( "viewportSize", VECTOR2, true, true, true, Dali::RenderTask::Property::VIEWPORT_SIZE )
60 DALI_PROPERTY( "clearColor", VECTOR4, true, true, true, Dali::RenderTask::Property::CLEAR_COLOR )
61 DALI_PROPERTY( "requiresSync", BOOLEAN, true, false, false, Dali::RenderTask::Property::REQUIRES_SYNC )
62 DALI_PROPERTY_TABLE_END( DEFAULT_OBJECT_PROPERTY_START_INDEX )
66 const char* const SIGNAL_FINISHED = "finished";
68 TypeRegistration mType( typeid( Dali::RenderTask ), typeid( Dali::BaseHandle ), NULL );
70 SignalConnectorType signalConnector1( mType, SIGNAL_FINISHED, &RenderTask::DoConnectSignal );
72 } // Unnamed namespace
74 RenderTask* RenderTask::New( bool isSystemLevel )
76 RenderTask* task( new RenderTask( isSystemLevel ) );
81 void RenderTask::SetSourceActor( Actor* actor )
83 const Stage* stage = Stage::GetCurrent();
86 stage->GetRenderTaskList().SetExclusive( this, mExclusive );
88 mSourceConnector.SetActor( actor );
91 Actor* RenderTask::GetSourceActor() const
93 return mSourceConnector.mActor;
96 void RenderTask::SetExclusive( bool exclusive )
98 if ( mExclusive != exclusive )
100 mExclusive = exclusive;
102 const Stage* stage = Stage::GetCurrent();
105 stage->GetRenderTaskList().SetExclusive( this, exclusive );
110 // mSceneObject is being used in a separate thread; queue a message to set the value
111 SetExclusiveMessage( GetEventThreadServices(), *mSceneObject, mExclusive );
116 bool RenderTask::IsExclusive() const
121 void RenderTask::SetInputEnabled( bool enabled )
123 mInputEnabled = enabled;
126 bool RenderTask::GetInputEnabled() const
128 return mInputEnabled;
131 void RenderTask::SetCameraActor( CameraActor* cameraActor )
135 mCameraConnector.mCamera = cameraActor->GetCamera();
139 mCameraConnector.mCamera = NULL;
141 mCameraConnector.SetActor( cameraActor );
144 CameraActor* RenderTask::GetCameraActor() const
146 // camera connector can only point to camera actor
147 return static_cast< CameraActor* >( mCameraConnector.mActor );
150 void RenderTask::SetTargetFrameBuffer( Dali::FrameBufferImage image )
152 if ( mFrameBufferImage != image )
154 // if we have a scene object we need to track connection status and set frame buffer id as well as updating target frame buffer
157 if(mFrameBufferImage)
159 GetImplementation(mFrameBufferImage).Disconnect();
162 // update target frame buffer
163 mFrameBufferImage = image;
165 unsigned int resourceId = 0;
166 bool isNativeFBO = false;
167 if( mFrameBufferImage )
169 Dali::Internal::FrameBufferImage& impl = GetImplementation( mFrameBufferImage );
171 resourceId = impl.GetResourceId();
172 isNativeFBO = impl.IsNativeFbo();
175 // mSceneObject is being used in a separate thread; queue a message to set the value
176 SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId, isNativeFBO );
180 // update target frame buffer
181 mFrameBufferImage = image;
186 Dali::FrameBufferImage RenderTask::GetTargetFrameBuffer() const
188 return mFrameBufferImage;
191 void RenderTask::SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction )
193 mScreenToFrameBufferFunction = conversionFunction;
196 RenderTask::ScreenToFrameBufferFunction RenderTask::GetScreenToFrameBufferFunction() const
198 return mScreenToFrameBufferFunction;
201 void RenderTask::SetScreenToFrameBufferMappingActor( Actor* mappingActor )
203 mMappingConnector.SetActor( mappingActor );
206 Actor* RenderTask::GetScreenToFrameBufferMappingActor() const
208 return mMappingConnector.mActor;
211 void RenderTask::SetViewportPosition(const Vector2& value)
213 BakeViewportPositionMessage( GetEventThreadServices(), *mSceneObject, value );
216 Vector2 RenderTask::GetCurrentViewportPosition() const
218 return mSceneObject->GetViewportPosition( GetEventThreadServices().GetEventBufferIndex() );
221 void RenderTask::SetViewportSize(const Vector2& value)
223 BakeViewportSizeMessage( GetEventThreadServices(), *mSceneObject, value );
226 Vector2 RenderTask::GetCurrentViewportSize() const
228 return mSceneObject->GetViewportSize( GetEventThreadServices().GetEventBufferIndex() );
231 void RenderTask::SetViewport( const Viewport& viewport )
233 SetViewportPosition(Vector2(viewport.x, viewport.y));
234 SetViewportSize(Vector2(viewport.width, viewport.height));
237 void RenderTask::GetViewport( Viewport& viewPort ) const
239 BufferIndex bufferIndex = GetEventThreadServices().GetEventBufferIndex();
241 if(!mSceneObject->GetViewportEnabled( bufferIndex ))
243 if ( mFrameBufferImage )
245 viewPort.x = viewPort.y = 0;
246 viewPort.width = mFrameBufferImage.GetWidth();
247 viewPort.height = mFrameBufferImage.GetHeight();
251 Internal::Stage* stage = Internal::Stage::GetCurrent();
254 Vector2 size( stage->GetSize() );
255 viewPort.x = viewPort.y = 0;
256 viewPort.width = size.width;
257 viewPort.height = size.height;
263 const Vector2& position = mSceneObject->GetViewportPosition(bufferIndex);
264 const Vector2& size = mSceneObject->GetViewportSize(bufferIndex);
265 viewPort.x = position.x;
266 viewPort.y = position.y;
267 viewPort.width = size.width;
268 viewPort.height = size.height;
272 void RenderTask::SetClearColor( const Vector4& color )
274 if ( mClearColor != color )
280 // mSceneObject is being used in a separate thread; queue a message to set the value
281 BakeClearColorMessage( GetEventThreadServices(), *mSceneObject, color );
286 const Vector4& RenderTask::GetClearColor() const
288 return mSceneObject->GetClearColor( GetEventThreadServices().GetEventBufferIndex() );
291 void RenderTask::SetSyncRequired( bool requiresSync )
293 if( mRequiresSync != requiresSync )
295 mRequiresSync = requiresSync;
299 // mSceneObject is being used in a separate thread; queue a message to set the value
300 SetSyncRequiredMessage( GetEventThreadServices(), *mSceneObject, requiresSync );
305 bool RenderTask::IsSyncRequired() const
307 return mRequiresSync;
310 void RenderTask::SetClearEnabled( bool enabled )
312 if ( mClearEnabled != enabled )
314 mClearEnabled = enabled;
318 // mSceneObject is being used in a separate thread; queue a message to set the value
319 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
324 bool RenderTask::GetClearEnabled() const
326 return mClearEnabled;
329 void RenderTask::SetCullMode( bool mode )
331 if ( mCullMode != mode )
337 // mSceneObject is being used in a separate thread; queue a message to set the value
338 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
343 bool RenderTask::GetCullMode() const
348 void RenderTask::SetRefreshRate( unsigned int refreshRate )
350 DALI_LOG_TRACE_METHOD_FMT(gLogRender, "this:%p rate:%d\n", this, refreshRate);
351 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::SetRefreshRate(this:%p, %d)\n", this, refreshRate);
353 mRefreshRate = refreshRate; // cached for GetRefreshRate()
355 // Note - even when refreshRate is the same as mRefreshRate, a message should be sent
359 // mSceneObject is being used in a separate thread; queue a message to set the value
360 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, refreshRate );
364 unsigned int RenderTask::GetRefreshRate() const
369 bool RenderTask::IsHittable( Vector2& screenCoords ) const
371 // True when input is enabled, source & camera actor are valid
372 bool inputEnabled( false );
374 Actor* sourceActor = GetSourceActor();
375 CameraActor* cameraActor = GetCameraActor();
377 if ( mInputEnabled &&
378 NULL != sourceActor &&
379 sourceActor->OnStage() &&
380 NULL != cameraActor &&
381 cameraActor->OnStage() )
383 // If the actors are rendered off-screen, then the screen coordinates must be converted
384 // and the conversion function will tell us if they are inside or outside
385 if ( TranslateCoordinates( screenCoords ) )
387 // This is a suitable render-task for input handling
395 bool RenderTask::TranslateCoordinates( Vector2& screenCoords ) const
397 // return true for on-screen tasks
399 // If the actors are rendered off-screen, then the screen coordinates must be converted
400 // the function should only be called for offscreen tasks
401 if( mFrameBufferImage && mMappingConnector.mActor )
403 CameraActor* localCamera = GetCameraActor();
404 StagePtr stage = Stage::GetCurrent();
407 CameraActor& defaultCamera = stage->GetDefaultCameraActor();
411 Vector2 size( stage->GetSize() );
412 viewport.x = viewport.y = 0;
413 viewport.width = size.width;
414 viewport.height = size.height;
416 float localX, localY;
417 inside = mMappingConnector.mActor->ScreenToLocal(defaultCamera.GetViewMatrix(), defaultCamera.GetProjectionMatrix(), viewport, localX, localY, screenCoords.x, screenCoords.y);
418 Vector3 actorSize = mMappingConnector.mActor->GetCurrentSize();
419 if( inside && localX >= 0.f && localX <= actorSize.x && localY >= 0.f && localY <= actorSize.y)
421 screenCoords.x = localX;
422 screenCoords.y = localY;
435 else if ( mFrameBufferImage && mScreenToFrameBufferFunction )
437 inside = mScreenToFrameBufferFunction( screenCoords );
442 bool RenderTask::IsSystemLevel() const
444 return mIsSystemLevel;
447 bool RenderTask::WorldToViewport(const Vector3 &position, float& viewportX, float& viewportY) const
449 CameraActor* cam = GetCameraActor();
451 Vector4 pos(position);
454 Vector4 viewportPosition;
457 GetViewport( viewport );
459 bool ok = ProjectFull(pos,
460 cam->GetViewMatrix(),
461 cam->GetProjectionMatrix(),
469 viewportX = viewportPosition.x;
470 viewportY = viewportPosition.y;
476 bool RenderTask::ViewportToLocal(Actor* actor, float viewportX, float viewportY, float &localX, float &localY) const
478 return actor->ScreenToLocal( *this, localX, localY, viewportX, viewportY );
481 SceneGraph::RenderTask* RenderTask::CreateSceneObject()
483 // This should only be called once, with no existing scene-object
484 DALI_ASSERT_DEBUG( NULL == mSceneObject );
486 // Keep the raw-pointer until DiscardSceneObject is called
487 mSceneObject = SceneGraph::RenderTask::New();
489 // if we have a frame buffer we need to track connection status then send a message to set the frame buffer id in case it has changed since last time we were on stage
490 unsigned int resourceId = 0;
491 bool isNativeFBO = false;
492 if( mFrameBufferImage )
494 Dali::Internal::FrameBufferImage& impl = GetImplementation( mFrameBufferImage );
496 resourceId = impl.GetResourceId();
497 isNativeFBO = impl.IsNativeFbo();
500 // mSceneObject is being used in a separate thread; queue a message to set the value
501 SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId, isNativeFBO );
503 // Send messages to set other properties that may have changed since last time we were on stage
504 SetExclusiveMessage( GetEventThreadServices(), *mSceneObject, mExclusive );
505 SetClearColorMessage( GetEventThreadServices(), *mSceneObject, mClearColor );
506 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
507 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
508 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, mRefreshRate );
510 // Caller takes ownership
514 SceneGraph::RenderTask* RenderTask::GetRenderTaskSceneObject()
519 void RenderTask::DiscardSceneObject()
521 // mSceneObject is not owned; throw away the raw-pointer
524 // if we have a frame buffer we need to track connection status
525 if(mFrameBufferImage)
527 GetImplementation(mFrameBufferImage).Disconnect();
531 /********************************************************************************
532 ******************************** PROPERTY METHODS **************************
533 ********************************************************************************/
535 unsigned int RenderTask::GetDefaultPropertyCount() const
537 return DEFAULT_PROPERTY_COUNT;
540 void RenderTask::GetDefaultPropertyIndices( Property::IndexContainer& indices ) const
542 indices.Reserve( DEFAULT_PROPERTY_COUNT );
544 for ( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
546 indices.PushBack( i );
550 const char* RenderTask::GetDefaultPropertyName( Property::Index index ) const
552 if( index < DEFAULT_PROPERTY_COUNT )
554 return DEFAULT_PROPERTY_DETAILS[index].name;
562 Property::Index RenderTask::GetDefaultPropertyIndex(const std::string& name) const
564 Property::Index index = Property::INVALID_INDEX;
566 // Look for name in default properties
567 for( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
569 if( 0 == strcmp( name.c_str(), DEFAULT_PROPERTY_DETAILS[i].name ) ) // dont want to convert rhs to string
579 bool RenderTask::IsDefaultPropertyWritable(Property::Index index) const
581 return DEFAULT_PROPERTY_DETAILS[ index ].writable;
584 bool RenderTask::IsDefaultPropertyAnimatable(Property::Index index) const
586 return DEFAULT_PROPERTY_DETAILS[ index ].animatable;
589 bool RenderTask::IsDefaultPropertyAConstraintInput( Property::Index index ) const
591 return DEFAULT_PROPERTY_DETAILS[ index ].constraintInput;
594 Property::Type RenderTask::GetDefaultPropertyType(Property::Index index) const
596 if( index < DEFAULT_PROPERTY_COUNT )
598 return DEFAULT_PROPERTY_DETAILS[index].type;
601 // index out of range...return Property::NONE
602 return Property::NONE;
605 void RenderTask::SetDefaultProperty( Property::Index index, const Property::Value& property )
609 case Dali::RenderTask::Property::VIEWPORT_POSITION:
611 SetViewportPosition( property.Get<Vector2>() );
614 case Dali::RenderTask::Property::VIEWPORT_SIZE:
616 SetViewportSize( property.Get<Vector2>() );
619 case Dali::RenderTask::Property::CLEAR_COLOR:
621 SetClearColor( property.Get<Vector4>() );
624 case Dali::RenderTask::Property::REQUIRES_SYNC:
626 SetSyncRequired( property.Get<bool>() );
637 Property::Value RenderTask::GetDefaultProperty(Property::Index index) const
639 Property::Value value;
644 case Dali::RenderTask::Property::VIEWPORT_POSITION:
646 value = GetCurrentViewportPosition();
649 case Dali::RenderTask::Property::VIEWPORT_SIZE:
651 value = GetCurrentViewportSize();
654 case Dali::RenderTask::Property::CLEAR_COLOR:
656 value = GetClearColor();
659 case Dali::RenderTask::Property::REQUIRES_SYNC:
661 value = IsSyncRequired();
667 DALI_ASSERT_ALWAYS(false && "RenderTask property index out of range"); // should not come here
675 const SceneGraph::PropertyOwner* RenderTask::GetSceneObject() const
680 const SceneGraph::PropertyBase* RenderTask::GetSceneObjectAnimatableProperty( Property::Index index ) const
682 DALI_ASSERT_ALWAYS( IsPropertyAnimatable(index) && "Property is not animatable" );
684 const SceneGraph::PropertyBase* property( NULL );
686 // This method should only return a property which is part of the scene-graph
687 if( mSceneObject != NULL )
691 case Dali::RenderTask::Property::VIEWPORT_POSITION:
692 property = &mSceneObject->mViewportPosition;
695 case Dali::RenderTask::Property::VIEWPORT_SIZE:
696 property = &mSceneObject->mViewportSize;
699 case Dali::RenderTask::Property::CLEAR_COLOR:
700 property = &mSceneObject->mClearColor;
711 const PropertyInputImpl* RenderTask::GetSceneObjectInputProperty( Property::Index index ) const
713 const PropertyInputImpl* property( NULL );
714 if( mSceneObject != NULL )
718 case Dali::RenderTask::Property::VIEWPORT_POSITION:
719 property = &mSceneObject->mViewportPosition;
722 case Dali::RenderTask::Property::VIEWPORT_SIZE:
723 property = &mSceneObject->mViewportSize;
726 case Dali::RenderTask::Property::CLEAR_COLOR:
727 property = &mSceneObject->mClearColor;
738 bool RenderTask::HasFinished()
740 bool finished = false;
741 const unsigned int counter = mSceneObject->GetRenderedOnceCounter();
743 if( mRefreshOnceCounter < counter )
746 mRefreshOnceCounter = counter;
749 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::HasFinished()=%s SCRT:%p SC\n", finished?"T":"F", mSceneObject);
754 void RenderTask::EmitSignalFinish()
756 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::EmitSignalFinish(this:%p)\n", this);
758 if( !mSignalFinished.Empty() )
760 Dali::RenderTask handle( this );
761 mSignalFinished.Emit(handle );
765 Dali::RenderTask::RenderTaskSignalType& RenderTask::FinishedSignal()
767 return mSignalFinished;
770 bool RenderTask::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
772 bool connected( true );
773 RenderTask* renderTask = dynamic_cast<RenderTask*>(object);
775 if ( 0 == strcmp( signalName.c_str(), SIGNAL_FINISHED ) )
777 renderTask->FinishedSignal().Connect( tracker, functor );
781 // signalName does not match any signal
788 RenderTask::RenderTask( bool isSystemLevel )
789 : mSceneObject( NULL ),
790 mSourceConnector( Connector::SOURCE_CONNECTOR, *this ),
791 mCameraConnector( Connector::CAMERA_CONNECTOR, *this ),
792 mMappingConnector( Connector::MAPPING_CONNECTOR, *this ),
793 mClearColor( Dali::RenderTask::DEFAULT_CLEAR_COLOR ),
794 mRefreshRate( Dali::RenderTask::DEFAULT_REFRESH_RATE ),
795 mRefreshOnceCounter( 0u ),
796 mScreenToFrameBufferFunction( Dali::RenderTask::DEFAULT_SCREEN_TO_FRAMEBUFFER_FUNCTION ),
797 mExclusive( Dali::RenderTask::DEFAULT_EXCLUSIVE ),
798 mInputEnabled( Dali::RenderTask::DEFAULT_INPUT_ENABLED ),
799 mClearEnabled( Dali::RenderTask::DEFAULT_CLEAR_ENABLED ),
800 mCullMode( Dali::RenderTask::DEFAULT_CULL_MODE ),
801 mIsSystemLevel( isSystemLevel ),
802 mRequiresSync( false )
804 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::RenderTask(this:%p)\n", this);
807 RenderTask::~RenderTask()
809 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::~RenderTask(this:%p)\n", this);
812 // Helper class for connecting Nodes to the scene-graph RenderTask
814 RenderTask::Connector::Connector( Type type, RenderTask& renderTask )
816 mRenderTask( renderTask ),
822 RenderTask::Connector::~Connector()
827 void RenderTask::Connector::SetActor( Actor* actor )
829 if ( mActor != actor )
833 mActor->RemoveObserver( *this );
840 mActor->AddObserver( *this );
847 void RenderTask::Connector::SceneObjectAdded( Object& object )
852 void RenderTask::Connector::SceneObjectRemoved( Object& object )
857 void RenderTask::Connector::ObjectDestroyed( Object& object )
859 if ( SOURCE_CONNECTOR == mType )
861 const Stage* stage = Stage::GetCurrent();
864 stage->GetRenderTaskList().SetExclusive( &mRenderTask, false );
869 mCamera = NULL; // only meaningful for the camera connector but no simple way to distinguish
874 void RenderTask::Connector::UpdateRenderTask()
876 // Guard to allow handle destruction after Core has been destroyed
877 if( Internal::Stage::IsInstalled() &&
878 mRenderTask.mSceneObject )
880 const SceneGraph::Node* node( NULL );
882 // Check whether a Node exists in the scene-graph
883 if ( NULL != mActor )
885 const SceneGraph::PropertyOwner* object = mActor->GetSceneObject();
886 if ( NULL != object )
888 // actors only point to nodes as their scene objects
889 node = static_cast< const SceneGraph::Node* >( object );
893 //the mapping node is not used in the scene graph
894 if ( SOURCE_CONNECTOR == mType )
896 SetSourceNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
898 else if( CAMERA_CONNECTOR == mType )
900 SetCameraMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node, mCamera );
905 } // namespace Internal