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( FrameBufferImagePtr image )
152 mFrameBufferImage = image;
153 FrameBuffer* frameBufferPtr( NULL );
156 frameBufferPtr = image->GetFrameBuffer();
159 SetFrameBuffer( frameBufferPtr );
162 void RenderTask::SetFrameBuffer( FrameBufferPtr frameBuffer )
164 mFrameBuffer = frameBuffer;
165 Render::FrameBuffer* renderFrameBufferPtr( NULL );
168 renderFrameBufferPtr = mFrameBuffer->GetRenderObject();
171 SetFrameBufferMessage( GetEventThreadServices(), *mSceneObject, renderFrameBufferPtr );
174 FrameBuffer* RenderTask::GetFrameBuffer() const
176 return mFrameBuffer.Get();
179 FrameBufferImage* RenderTask::GetTargetFrameBuffer() const
181 return mFrameBufferImage.Get();
184 void RenderTask::SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction )
186 mScreenToFrameBufferFunction = conversionFunction;
189 RenderTask::ScreenToFrameBufferFunction RenderTask::GetScreenToFrameBufferFunction() const
191 return mScreenToFrameBufferFunction;
194 void RenderTask::SetScreenToFrameBufferMappingActor( Actor* mappingActor )
196 mMappingConnector.SetActor( mappingActor );
199 Actor* RenderTask::GetScreenToFrameBufferMappingActor() const
201 return mMappingConnector.mActor;
204 void RenderTask::SetViewportPosition(const Vector2& value)
206 BakeViewportPositionMessage( GetEventThreadServices(), *mSceneObject, value );
209 Vector2 RenderTask::GetCurrentViewportPosition() const
211 return mSceneObject->GetViewportPosition( GetEventThreadServices().GetEventBufferIndex() );
214 void RenderTask::SetViewportSize(const Vector2& value)
216 BakeViewportSizeMessage( GetEventThreadServices(), *mSceneObject, value );
219 Vector2 RenderTask::GetCurrentViewportSize() const
221 return mSceneObject->GetViewportSize( GetEventThreadServices().GetEventBufferIndex() );
224 void RenderTask::SetViewport( const Viewport& viewport )
226 SetViewportPosition(Vector2(viewport.x, viewport.y));
227 SetViewportSize(Vector2(viewport.width, viewport.height));
230 void RenderTask::GetViewport( Viewport& viewPort ) const
232 BufferIndex bufferIndex = GetEventThreadServices().GetEventBufferIndex();
234 if(!mSceneObject->GetViewportEnabled( bufferIndex ))
236 if ( mFrameBufferImage )
238 viewPort.x = viewPort.y = 0;
239 viewPort.width = mFrameBufferImage->GetWidth();
240 viewPort.height = mFrameBufferImage->GetHeight();
244 Internal::Stage* stage = Internal::Stage::GetCurrent();
247 Vector2 size( stage->GetSize() );
248 viewPort.x = viewPort.y = 0;
249 viewPort.width = size.width;
250 viewPort.height = size.height;
256 const Vector2& position = mSceneObject->GetViewportPosition(bufferIndex);
257 const Vector2& size = mSceneObject->GetViewportSize(bufferIndex);
258 viewPort.x = position.x;
259 viewPort.y = position.y;
260 viewPort.width = size.width;
261 viewPort.height = size.height;
265 void RenderTask::SetClearColor( const Vector4& color )
267 if ( mClearColor != color )
273 // mSceneObject is being used in a separate thread; queue a message to set the value
274 BakeClearColorMessage( GetEventThreadServices(), *mSceneObject, color );
279 const Vector4& RenderTask::GetClearColor() const
281 return mSceneObject->GetClearColor( GetEventThreadServices().GetEventBufferIndex() );
284 void RenderTask::SetSyncRequired( bool requiresSync )
286 if( mRequiresSync != requiresSync )
288 mRequiresSync = requiresSync;
292 // mSceneObject is being used in a separate thread; queue a message to set the value
293 SetSyncRequiredMessage( GetEventThreadServices(), *mSceneObject, requiresSync );
298 bool RenderTask::IsSyncRequired() const
300 return mRequiresSync;
303 void RenderTask::SetClearEnabled( bool enabled )
305 if ( mClearEnabled != enabled )
307 mClearEnabled = enabled;
311 // mSceneObject is being used in a separate thread; queue a message to set the value
312 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
317 bool RenderTask::GetClearEnabled() const
319 return mClearEnabled;
322 void RenderTask::SetCullMode( bool mode )
324 if ( mCullMode != mode )
330 // mSceneObject is being used in a separate thread; queue a message to set the value
331 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
336 bool RenderTask::GetCullMode() const
341 void RenderTask::SetRefreshRate( unsigned int refreshRate )
343 DALI_LOG_TRACE_METHOD_FMT(gLogRender, "this:%p rate:%d\n", this, refreshRate);
344 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::SetRefreshRate(this:%p, %d)\n", this, refreshRate);
346 mRefreshRate = refreshRate; // cached for GetRefreshRate()
348 // Note - even when refreshRate is the same as mRefreshRate, a message should be sent
352 // mSceneObject is being used in a separate thread; queue a message to set the value
353 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, refreshRate );
357 unsigned int RenderTask::GetRefreshRate() const
362 bool RenderTask::IsHittable( Vector2& screenCoords ) const
364 // True when input is enabled, source & camera actor are valid
365 bool inputEnabled( false );
367 Actor* sourceActor = GetSourceActor();
368 CameraActor* cameraActor = GetCameraActor();
370 if ( mInputEnabled &&
371 NULL != sourceActor &&
372 sourceActor->OnStage() &&
373 NULL != cameraActor &&
374 cameraActor->OnStage() )
376 // If the actors are rendered off-screen, then the screen coordinates must be converted
377 // and the conversion function will tell us if they are inside or outside
378 if ( TranslateCoordinates( screenCoords ) )
380 // This is a suitable render-task for input handling
388 bool RenderTask::TranslateCoordinates( Vector2& screenCoords ) const
390 // return true for on-screen tasks
392 // If the actors are rendered off-screen, then the screen coordinates must be converted
393 // the function should only be called for offscreen tasks
394 if( mFrameBufferImage && mMappingConnector.mActor )
396 CameraActor* localCamera = GetCameraActor();
397 StagePtr stage = Stage::GetCurrent();
400 CameraActor& defaultCamera = stage->GetDefaultCameraActor();
404 Vector2 size( stage->GetSize() );
405 viewport.x = viewport.y = 0;
406 viewport.width = size.width;
407 viewport.height = size.height;
409 float localX, localY;
410 inside = mMappingConnector.mActor->ScreenToLocal(defaultCamera.GetViewMatrix(), defaultCamera.GetProjectionMatrix(), viewport, localX, localY, screenCoords.x, screenCoords.y);
411 Vector3 actorSize = mMappingConnector.mActor->GetCurrentSize();
412 if( inside && localX >= 0.f && localX <= actorSize.x && localY >= 0.f && localY <= actorSize.y)
414 screenCoords.x = localX;
415 screenCoords.y = localY;
428 else if ( mFrameBufferImage && mScreenToFrameBufferFunction )
430 inside = mScreenToFrameBufferFunction( screenCoords );
435 bool RenderTask::IsSystemLevel() const
437 return mIsSystemLevel;
440 bool RenderTask::WorldToViewport(const Vector3 &position, float& viewportX, float& viewportY) const
442 CameraActor* cam = GetCameraActor();
444 Vector4 pos(position);
447 Vector4 viewportPosition;
450 GetViewport( viewport );
452 bool ok = ProjectFull(pos,
453 cam->GetViewMatrix(),
454 cam->GetProjectionMatrix(),
462 viewportX = viewportPosition.x;
463 viewportY = viewportPosition.y;
469 bool RenderTask::ViewportToLocal(Actor* actor, float viewportX, float viewportY, float &localX, float &localY) const
471 return actor->ScreenToLocal( *this, localX, localY, viewportX, viewportY );
474 SceneGraph::RenderTask* RenderTask::CreateSceneObject()
476 // This should only be called once, with no existing scene-object
477 DALI_ASSERT_DEBUG( NULL == mSceneObject );
479 // Keep the raw-pointer until DiscardSceneObject is called
480 mSceneObject = SceneGraph::RenderTask::New();
482 // Send messages to set other properties that may have changed since last time we were on stage
483 SetExclusiveMessage( GetEventThreadServices(), *mSceneObject, mExclusive );
484 SetClearColorMessage( GetEventThreadServices(), *mSceneObject, mClearColor );
485 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
486 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
487 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, mRefreshRate );
488 SetSyncRequiredMessage( GetEventThreadServices(), *mSceneObject, mRequiresSync );
489 SetFrameBuffer( mFrameBuffer );
491 // Caller takes ownership
495 SceneGraph::RenderTask* RenderTask::GetRenderTaskSceneObject()
500 void RenderTask::DiscardSceneObject()
502 // mSceneObject is not owned; throw away the raw-pointer
506 /********************************************************************************
507 ******************************** PROPERTY METHODS **************************
508 ********************************************************************************/
510 unsigned int RenderTask::GetDefaultPropertyCount() const
512 return DEFAULT_PROPERTY_COUNT;
515 void RenderTask::GetDefaultPropertyIndices( Property::IndexContainer& indices ) const
517 indices.Reserve( DEFAULT_PROPERTY_COUNT );
519 for ( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
521 indices.PushBack( i );
525 const char* RenderTask::GetDefaultPropertyName( Property::Index index ) const
527 if( index < DEFAULT_PROPERTY_COUNT )
529 return DEFAULT_PROPERTY_DETAILS[index].name;
537 Property::Index RenderTask::GetDefaultPropertyIndex(const std::string& name) const
539 Property::Index index = Property::INVALID_INDEX;
541 // Look for name in default properties
542 for( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
544 if( 0 == strcmp( name.c_str(), DEFAULT_PROPERTY_DETAILS[i].name ) ) // dont want to convert rhs to string
554 bool RenderTask::IsDefaultPropertyWritable(Property::Index index) const
556 return DEFAULT_PROPERTY_DETAILS[ index ].writable;
559 bool RenderTask::IsDefaultPropertyAnimatable(Property::Index index) const
561 return DEFAULT_PROPERTY_DETAILS[ index ].animatable;
564 bool RenderTask::IsDefaultPropertyAConstraintInput( Property::Index index ) const
566 return DEFAULT_PROPERTY_DETAILS[ index ].constraintInput;
569 Property::Type RenderTask::GetDefaultPropertyType(Property::Index index) const
571 if( index < DEFAULT_PROPERTY_COUNT )
573 return DEFAULT_PROPERTY_DETAILS[index].type;
576 // index out of range...return Property::NONE
577 return Property::NONE;
580 void RenderTask::SetDefaultProperty( Property::Index index, const Property::Value& property )
584 case Dali::RenderTask::Property::VIEWPORT_POSITION:
586 SetViewportPosition( property.Get<Vector2>() );
589 case Dali::RenderTask::Property::VIEWPORT_SIZE:
591 SetViewportSize( property.Get<Vector2>() );
594 case Dali::RenderTask::Property::CLEAR_COLOR:
596 SetClearColor( property.Get<Vector4>() );
599 case Dali::RenderTask::Property::REQUIRES_SYNC:
601 SetSyncRequired( property.Get<bool>() );
612 Property::Value RenderTask::GetDefaultProperty(Property::Index index) const
614 Property::Value value;
619 case Dali::RenderTask::Property::VIEWPORT_POSITION:
621 value = GetCurrentViewportPosition();
624 case Dali::RenderTask::Property::VIEWPORT_SIZE:
626 value = GetCurrentViewportSize();
629 case Dali::RenderTask::Property::CLEAR_COLOR:
631 value = GetClearColor();
634 case Dali::RenderTask::Property::REQUIRES_SYNC:
636 value = IsSyncRequired();
642 DALI_ASSERT_ALWAYS(false && "RenderTask property index out of range"); // should not come here
650 const SceneGraph::PropertyOwner* RenderTask::GetSceneObject() const
655 const SceneGraph::PropertyBase* RenderTask::GetSceneObjectAnimatableProperty( Property::Index index ) const
657 DALI_ASSERT_ALWAYS( IsPropertyAnimatable(index) && "Property is not animatable" );
659 const SceneGraph::PropertyBase* property( NULL );
661 // This method should only return a property which is part of the scene-graph
662 if( mSceneObject != NULL )
666 case Dali::RenderTask::Property::VIEWPORT_POSITION:
667 property = &mSceneObject->mViewportPosition;
670 case Dali::RenderTask::Property::VIEWPORT_SIZE:
671 property = &mSceneObject->mViewportSize;
674 case Dali::RenderTask::Property::CLEAR_COLOR:
675 property = &mSceneObject->mClearColor;
686 const PropertyInputImpl* RenderTask::GetSceneObjectInputProperty( Property::Index index ) const
688 const PropertyInputImpl* property( NULL );
689 if( mSceneObject != NULL )
693 case Dali::RenderTask::Property::VIEWPORT_POSITION:
694 property = &mSceneObject->mViewportPosition;
697 case Dali::RenderTask::Property::VIEWPORT_SIZE:
698 property = &mSceneObject->mViewportSize;
701 case Dali::RenderTask::Property::CLEAR_COLOR:
702 property = &mSceneObject->mClearColor;
713 bool RenderTask::HasFinished()
715 bool finished = false;
716 const unsigned int counter = mSceneObject->GetRenderedOnceCounter();
718 if( mRefreshOnceCounter < counter )
721 mRefreshOnceCounter = counter;
724 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::HasFinished()=%s SCRT:%p SC\n", finished?"T":"F", mSceneObject);
729 void RenderTask::EmitSignalFinish()
731 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::EmitSignalFinish(this:%p)\n", this);
733 if( !mSignalFinished.Empty() )
735 Dali::RenderTask handle( this );
736 mSignalFinished.Emit(handle );
740 Dali::RenderTask::RenderTaskSignalType& RenderTask::FinishedSignal()
742 return mSignalFinished;
745 bool RenderTask::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
747 bool connected( true );
748 RenderTask* renderTask = static_cast< RenderTask* >(object); // TypeRegistry guarantees that this is the correct type.
750 if ( 0 == strcmp( signalName.c_str(), SIGNAL_FINISHED ) )
752 renderTask->FinishedSignal().Connect( tracker, functor );
756 // signalName does not match any signal
763 RenderTask::RenderTask( bool isSystemLevel )
764 : mSceneObject( NULL ),
765 mSourceConnector( Connector::SOURCE_CONNECTOR, *this ),
766 mCameraConnector( Connector::CAMERA_CONNECTOR, *this ),
767 mMappingConnector( Connector::MAPPING_CONNECTOR, *this ),
768 mClearColor( Dali::RenderTask::DEFAULT_CLEAR_COLOR ),
769 mRefreshRate( Dali::RenderTask::DEFAULT_REFRESH_RATE ),
770 mRefreshOnceCounter( 0u ),
771 mScreenToFrameBufferFunction( Dali::RenderTask::DEFAULT_SCREEN_TO_FRAMEBUFFER_FUNCTION ),
772 mExclusive( Dali::RenderTask::DEFAULT_EXCLUSIVE ),
773 mInputEnabled( Dali::RenderTask::DEFAULT_INPUT_ENABLED ),
774 mClearEnabled( Dali::RenderTask::DEFAULT_CLEAR_ENABLED ),
775 mCullMode( Dali::RenderTask::DEFAULT_CULL_MODE ),
776 mIsSystemLevel( isSystemLevel ),
777 mRequiresSync( false )
779 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::RenderTask(this:%p)\n", this);
782 RenderTask::~RenderTask()
784 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::~RenderTask(this:%p)\n", this);
787 // Helper class for connecting Nodes to the scene-graph RenderTask
789 RenderTask::Connector::Connector( Type type, RenderTask& renderTask )
791 mRenderTask( renderTask ),
797 RenderTask::Connector::~Connector()
802 void RenderTask::Connector::SetActor( Actor* actor )
804 if ( mActor != actor )
808 mActor->RemoveObserver( *this );
815 mActor->AddObserver( *this );
822 void RenderTask::Connector::SceneObjectAdded( Object& object )
827 void RenderTask::Connector::SceneObjectRemoved( Object& object )
832 void RenderTask::Connector::ObjectDestroyed( Object& object )
834 if ( SOURCE_CONNECTOR == mType )
836 const Stage* stage = Stage::GetCurrent();
839 stage->GetRenderTaskList().SetExclusive( &mRenderTask, false );
844 mCamera = NULL; // only meaningful for the camera connector but no simple way to distinguish
849 void RenderTask::Connector::UpdateRenderTask()
851 // Guard to allow handle destruction after Core has been destroyed
852 if( Internal::Stage::IsInstalled() &&
853 mRenderTask.mSceneObject )
855 const SceneGraph::Node* node( NULL );
857 // Check whether a Node exists in the scene-graph
858 if ( NULL != mActor )
860 const SceneGraph::PropertyOwner* object = mActor->GetSceneObject();
861 if ( NULL != object )
863 // actors only point to nodes as their scene objects
864 node = static_cast< const SceneGraph::Node* >( object );
868 //the mapping node is not used in the scene graph
869 if ( SOURCE_CONNECTOR == mType )
871 SetSourceNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
873 else if( CAMERA_CONNECTOR == mType )
875 SetCameraMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node, mCamera );
880 } // namespace Internal