2 * Copyright (c) 2015 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 )
133 mCameraConnector.SetActor( cameraActor );
136 CameraActor* RenderTask::GetCameraActor() const
138 // camera connector can only point to camera actor
139 return static_cast< CameraActor* >( mCameraConnector.mActor );
142 void RenderTask::SetTargetFrameBuffer( Dali::FrameBufferImage image )
144 if ( mFrameBufferImage != image )
146 // if we have a scene object we need to track connection status and set frame buffer id as well as updating target frame buffer
149 if(mFrameBufferImage)
151 GetImplementation(mFrameBufferImage).Disconnect();
154 // update target frame buffer
155 mFrameBufferImage = image;
157 unsigned int resourceId = 0;
158 bool isNativeFBO = false;
159 if( mFrameBufferImage )
161 Dali::Internal::FrameBufferImage& impl = GetImplementation( mFrameBufferImage );
163 resourceId = impl.GetResourceId();
164 isNativeFBO = impl.IsNativeFbo();
167 // mSceneObject is being used in a separate thread; queue a message to set the value
168 SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId, isNativeFBO );
172 // update target frame buffer
173 mFrameBufferImage = image;
178 Dali::FrameBufferImage RenderTask::GetTargetFrameBuffer() const
180 return mFrameBufferImage;
183 void RenderTask::SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction )
185 mScreenToFrameBufferFunction = conversionFunction;
188 RenderTask::ScreenToFrameBufferFunction RenderTask::GetScreenToFrameBufferFunction() const
190 return mScreenToFrameBufferFunction;
193 void RenderTask::SetScreenToFrameBufferMappingActor( Actor* mappingActor )
195 mMappingConnector.SetActor( mappingActor );
198 Actor* RenderTask::GetScreenToFrameBufferMappingActor() const
200 return mMappingConnector.mActor;
203 void RenderTask::SetViewportPosition(const Vector2& value)
205 BakeViewportPositionMessage( GetEventThreadServices(), *mSceneObject, value );
208 Vector2 RenderTask::GetCurrentViewportPosition() const
210 return mSceneObject->GetViewportPosition( GetEventThreadServices().GetEventBufferIndex() );
213 void RenderTask::SetViewportSize(const Vector2& value)
215 BakeViewportSizeMessage( GetEventThreadServices(), *mSceneObject, value );
218 Vector2 RenderTask::GetCurrentViewportSize() const
220 return mSceneObject->GetViewportSize( GetEventThreadServices().GetEventBufferIndex() );
223 void RenderTask::SetViewport( const Viewport& viewport )
225 SetViewportPosition(Vector2(viewport.x, viewport.y));
226 SetViewportSize(Vector2(viewport.width, viewport.height));
229 void RenderTask::GetViewport( Viewport& viewPort ) const
231 BufferIndex bufferIndex = GetEventThreadServices().GetEventBufferIndex();
233 if(!mSceneObject->GetViewportEnabled( bufferIndex ))
235 if ( mFrameBufferImage )
237 viewPort.x = viewPort.y = 0;
238 viewPort.width = mFrameBufferImage.GetWidth();
239 viewPort.height = mFrameBufferImage.GetHeight();
243 Internal::Stage* stage = Internal::Stage::GetCurrent();
246 Vector2 size( stage->GetSize() );
247 viewPort.x = viewPort.y = 0;
248 viewPort.width = size.width;
249 viewPort.height = size.height;
255 const Vector2& position = mSceneObject->GetViewportPosition(bufferIndex);
256 const Vector2& size = mSceneObject->GetViewportSize(bufferIndex);
257 viewPort.x = position.x;
258 viewPort.y = position.y;
259 viewPort.width = size.width;
260 viewPort.height = size.height;
264 void RenderTask::SetClearColor( const Vector4& color )
266 if ( mClearColor != color )
272 // mSceneObject is being used in a separate thread; queue a message to set the value
273 BakeClearColorMessage( GetEventThreadServices(), *mSceneObject, color );
278 const Vector4& RenderTask::GetClearColor() const
280 return mSceneObject->GetClearColor( GetEventThreadServices().GetEventBufferIndex() );
283 void RenderTask::SetSyncRequired( bool requiresSync )
285 if( mRequiresSync != requiresSync )
287 mRequiresSync = requiresSync;
291 // mSceneObject is being used in a separate thread; queue a message to set the value
292 SetSyncRequiredMessage( GetEventThreadServices(), *mSceneObject, requiresSync );
297 bool RenderTask::IsSyncRequired() const
299 return mRequiresSync;
302 void RenderTask::SetClearEnabled( bool enabled )
304 if ( mClearEnabled != enabled )
306 mClearEnabled = enabled;
310 // mSceneObject is being used in a separate thread; queue a message to set the value
311 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
316 bool RenderTask::GetClearEnabled() const
318 return mClearEnabled;
321 void RenderTask::SetCullMode( bool mode )
323 if ( mCullMode != mode )
329 // mSceneObject is being used in a separate thread; queue a message to set the value
330 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
335 bool RenderTask::GetCullMode() const
340 void RenderTask::SetRefreshRate( unsigned int refreshRate )
342 DALI_LOG_TRACE_METHOD_FMT(gLogRender, "this:%p rate:%d\n", this, refreshRate);
343 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::SetRefreshRate(this:%p, %d)\n", this, refreshRate);
345 mRefreshRate = refreshRate; // cached for GetRefreshRate()
347 // Note - even when refreshRate is the same as mRefreshRate, a message should be sent
351 // mSceneObject is being used in a separate thread; queue a message to set the value
352 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, refreshRate );
356 unsigned int RenderTask::GetRefreshRate() const
361 bool RenderTask::IsHittable( Vector2& screenCoords ) const
363 // True when input is enabled, source & camera actor are valid
364 bool inputEnabled( false );
366 Actor* sourceActor = GetSourceActor();
367 CameraActor* cameraActor = GetCameraActor();
369 if ( mInputEnabled &&
370 NULL != sourceActor &&
371 sourceActor->OnStage() &&
372 NULL != cameraActor &&
373 cameraActor->OnStage() )
375 // If the actors are rendered off-screen, then the screen coordinates must be converted
376 // and the conversion function will tell us if they are inside or outside
377 if ( TranslateCoordinates( screenCoords ) )
379 // This is a suitable render-task for input handling
387 bool RenderTask::TranslateCoordinates( Vector2& screenCoords ) const
389 // return true for on-screen tasks
391 // If the actors are rendered off-screen, then the screen coordinates must be converted
392 // the function should only be called for offscreen tasks
393 if( mFrameBufferImage && mMappingConnector.mActor )
395 CameraActor* localCamera = GetCameraActor();
396 StagePtr stage = Stage::GetCurrent();
399 CameraActor& defaultCamera = stage->GetDefaultCameraActor();
403 Vector2 size( stage->GetSize() );
404 viewport.x = viewport.y = 0;
405 viewport.width = size.width;
406 viewport.height = size.height;
408 float localX, localY;
409 inside = mMappingConnector.mActor->ScreenToLocal(defaultCamera.GetViewMatrix(), defaultCamera.GetProjectionMatrix(), viewport, localX, localY, screenCoords.x, screenCoords.y);
410 Vector3 actorSize = mMappingConnector.mActor->GetCurrentSize();
411 if( inside && localX >= 0.f && localX <= actorSize.x && localY >= 0.f && localY <= actorSize.y)
413 screenCoords.x = localX;
414 screenCoords.y = localY;
427 else if ( mFrameBufferImage && mScreenToFrameBufferFunction )
429 inside = mScreenToFrameBufferFunction( screenCoords );
434 bool RenderTask::IsSystemLevel() const
436 return mIsSystemLevel;
439 bool RenderTask::WorldToViewport(const Vector3 &position, float& viewportX, float& viewportY) const
441 CameraActor* cam = GetCameraActor();
443 Vector4 pos(position);
446 Vector4 viewportPosition;
449 GetViewport( viewport );
451 bool ok = ProjectFull(pos,
452 cam->GetViewMatrix(),
453 cam->GetProjectionMatrix(),
461 viewportX = viewportPosition.x;
462 viewportY = viewportPosition.y;
468 bool RenderTask::ViewportToLocal(Actor* actor, float viewportX, float viewportY, float &localX, float &localY) const
470 return actor->ScreenToLocal( *this, localX, localY, viewportX, viewportY );
473 SceneGraph::RenderTask* RenderTask::CreateSceneObject()
475 // This should only be called once, with no existing scene-object
476 DALI_ASSERT_DEBUG( NULL == mSceneObject );
478 // Keep the raw-pointer until DiscardSceneObject is called
479 mSceneObject = SceneGraph::RenderTask::New();
481 // 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
482 unsigned int resourceId = 0;
483 bool isNativeFBO = false;
484 if( mFrameBufferImage )
486 Dali::Internal::FrameBufferImage& impl = GetImplementation( mFrameBufferImage );
488 resourceId = impl.GetResourceId();
489 isNativeFBO = impl.IsNativeFbo();
492 // mSceneObject is being used in a separate thread; queue a message to set the value
493 SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId, isNativeFBO );
495 // Send messages to set other properties that may have changed since last time we were on stage
496 SetExclusiveMessage( GetEventThreadServices(), *mSceneObject, mExclusive );
497 SetClearColorMessage( GetEventThreadServices(), *mSceneObject, mClearColor );
498 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
499 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
500 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, mRefreshRate );
502 // Caller takes ownership
506 SceneGraph::RenderTask* RenderTask::GetRenderTaskSceneObject()
511 void RenderTask::DiscardSceneObject()
513 // mSceneObject is not owned; throw away the raw-pointer
516 // if we have a frame buffer we need to track connection status
517 if(mFrameBufferImage)
519 GetImplementation(mFrameBufferImage).Disconnect();
523 /********************************************************************************
524 ******************************** PROPERTY METHODS **************************
525 ********************************************************************************/
527 unsigned int RenderTask::GetDefaultPropertyCount() const
529 return DEFAULT_PROPERTY_COUNT;
532 void RenderTask::GetDefaultPropertyIndices( Property::IndexContainer& indices ) const
534 indices.Reserve( DEFAULT_PROPERTY_COUNT );
536 for ( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
538 indices.PushBack( i );
542 const char* RenderTask::GetDefaultPropertyName( Property::Index index ) const
544 if( index < DEFAULT_PROPERTY_COUNT )
546 return DEFAULT_PROPERTY_DETAILS[index].name;
554 Property::Index RenderTask::GetDefaultPropertyIndex(const std::string& name) const
556 Property::Index index = Property::INVALID_INDEX;
558 // Look for name in default properties
559 for( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
561 if( 0 == strcmp( name.c_str(), DEFAULT_PROPERTY_DETAILS[i].name ) ) // dont want to convert rhs to string
571 bool RenderTask::IsDefaultPropertyWritable(Property::Index index) const
573 return DEFAULT_PROPERTY_DETAILS[ index ].writable;
576 bool RenderTask::IsDefaultPropertyAnimatable(Property::Index index) const
578 return DEFAULT_PROPERTY_DETAILS[ index ].animatable;
581 bool RenderTask::IsDefaultPropertyAConstraintInput( Property::Index index ) const
583 return DEFAULT_PROPERTY_DETAILS[ index ].constraintInput;
586 Property::Type RenderTask::GetDefaultPropertyType(Property::Index index) const
588 if( index < DEFAULT_PROPERTY_COUNT )
590 return DEFAULT_PROPERTY_DETAILS[index].type;
593 // index out of range...return Property::NONE
594 return Property::NONE;
597 void RenderTask::SetDefaultProperty( Property::Index index, const Property::Value& property )
601 case Dali::RenderTask::Property::VIEWPORT_POSITION:
603 SetViewportPosition( property.Get<Vector2>() );
606 case Dali::RenderTask::Property::VIEWPORT_SIZE:
608 SetViewportSize( property.Get<Vector2>() );
611 case Dali::RenderTask::Property::CLEAR_COLOR:
613 SetClearColor( property.Get<Vector4>() );
616 case Dali::RenderTask::Property::REQUIRES_SYNC:
618 SetSyncRequired( property.Get<bool>() );
629 Property::Value RenderTask::GetDefaultProperty(Property::Index index) const
631 Property::Value value;
636 case Dali::RenderTask::Property::VIEWPORT_POSITION:
638 value = GetCurrentViewportPosition();
641 case Dali::RenderTask::Property::VIEWPORT_SIZE:
643 value = GetCurrentViewportSize();
646 case Dali::RenderTask::Property::CLEAR_COLOR:
648 value = GetClearColor();
651 case Dali::RenderTask::Property::REQUIRES_SYNC:
653 value = IsSyncRequired();
659 DALI_ASSERT_ALWAYS(false && "RenderTask property index out of range"); // should not come here
667 const SceneGraph::PropertyOwner* RenderTask::GetSceneObject() const
672 const SceneGraph::PropertyBase* RenderTask::GetSceneObjectAnimatableProperty( Property::Index index ) const
674 DALI_ASSERT_ALWAYS( IsPropertyAnimatable(index) && "Property is not animatable" );
676 const SceneGraph::PropertyBase* property( NULL );
678 // This method should only return a property which is part of the scene-graph
679 if( mSceneObject != NULL )
683 case Dali::RenderTask::Property::VIEWPORT_POSITION:
684 property = &mSceneObject->mViewportPosition;
687 case Dali::RenderTask::Property::VIEWPORT_SIZE:
688 property = &mSceneObject->mViewportSize;
691 case Dali::RenderTask::Property::CLEAR_COLOR:
692 property = &mSceneObject->mClearColor;
703 const PropertyInputImpl* RenderTask::GetSceneObjectInputProperty( Property::Index index ) const
705 const PropertyInputImpl* property( NULL );
706 if( mSceneObject != NULL )
710 case Dali::RenderTask::Property::VIEWPORT_POSITION:
711 property = &mSceneObject->mViewportPosition;
714 case Dali::RenderTask::Property::VIEWPORT_SIZE:
715 property = &mSceneObject->mViewportSize;
718 case Dali::RenderTask::Property::CLEAR_COLOR:
719 property = &mSceneObject->mClearColor;
730 bool RenderTask::HasFinished()
732 bool finished = false;
733 const unsigned int counter = mSceneObject->GetRenderedOnceCounter();
735 if( mRefreshOnceCounter < counter )
738 mRefreshOnceCounter = counter;
741 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::HasFinished()=%s SCRT:%p SC\n", finished?"T":"F", mSceneObject);
746 void RenderTask::EmitSignalFinish()
748 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::EmitSignalFinish(this:%p)\n", this);
750 if( !mSignalFinished.Empty() )
752 Dali::RenderTask handle( this );
753 mSignalFinished.Emit(handle );
757 Dali::RenderTask::RenderTaskSignalType& RenderTask::FinishedSignal()
759 return mSignalFinished;
762 bool RenderTask::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
764 bool connected( true );
765 RenderTask* renderTask = dynamic_cast<RenderTask*>(object);
767 if ( 0 == strcmp( signalName.c_str(), SIGNAL_FINISHED ) )
769 renderTask->FinishedSignal().Connect( tracker, functor );
773 // signalName does not match any signal
780 RenderTask::RenderTask( bool isSystemLevel )
781 : mSceneObject( NULL ),
782 mSourceConnector( Connector::SOURCE_CONNECTOR, *this ),
783 mCameraConnector( Connector::CAMERA_CONNECTOR, *this ),
784 mMappingConnector( Connector::MAPPING_CONNECTOR, *this ),
785 mClearColor( Dali::RenderTask::DEFAULT_CLEAR_COLOR ),
786 mRefreshRate( Dali::RenderTask::DEFAULT_REFRESH_RATE ),
787 mRefreshOnceCounter( 0u ),
788 mScreenToFrameBufferFunction( Dali::RenderTask::DEFAULT_SCREEN_TO_FRAMEBUFFER_FUNCTION ),
789 mExclusive( Dali::RenderTask::DEFAULT_EXCLUSIVE ),
790 mInputEnabled( Dali::RenderTask::DEFAULT_INPUT_ENABLED ),
791 mClearEnabled( Dali::RenderTask::DEFAULT_CLEAR_ENABLED ),
792 mCullMode( Dali::RenderTask::DEFAULT_CULL_MODE ),
793 mIsSystemLevel( isSystemLevel ),
794 mRequiresSync( false )
796 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::RenderTask(this:%p)\n", this);
799 RenderTask::~RenderTask()
801 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::~RenderTask(this:%p)\n", this);
804 // Helper class for connecting Nodes to the scene-graph RenderTask
806 RenderTask::Connector::Connector( Type type, RenderTask& renderTask )
808 mRenderTask( renderTask ),
813 RenderTask::Connector::~Connector()
818 void RenderTask::Connector::SetActor( Actor* actor )
820 if ( mActor != actor )
824 mActor->RemoveObserver( *this );
831 mActor->AddObserver( *this );
838 void RenderTask::Connector::SceneObjectAdded( Object& object )
843 void RenderTask::Connector::SceneObjectRemoved( Object& object )
848 void RenderTask::Connector::ObjectDestroyed( Object& object )
850 if ( SOURCE_CONNECTOR == mType )
852 const Stage* stage = Stage::GetCurrent();
855 stage->GetRenderTaskList().SetExclusive( &mRenderTask, false );
864 void RenderTask::Connector::UpdateRenderTask()
866 // Guard to allow handle destruction after Core has been destroyed
867 if( Internal::Stage::IsInstalled() &&
868 mRenderTask.mSceneObject )
870 const SceneGraph::Node* node( NULL );
872 // Check whether a Node exists in the scene-graph
873 if ( NULL != mActor )
875 const SceneGraph::PropertyOwner* object = mActor->GetSceneObject();
876 if ( NULL != object )
878 // actors only point to nodes as their scene objects
879 node = static_cast< const SceneGraph::Node* >( object );
883 //the mapping node is not used in the scene graph
884 if ( SOURCE_CONNECTOR == mType )
886 SetSourceNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
888 else if( CAMERA_CONNECTOR == mType )
890 SetCameraNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
895 } // namespace Internal