1 #ifndef __DALI_INTERNAL_RENDER_TASK_H__
2 #define __DALI_INTERNAL_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/object/base-object.h>
23 #include <dali/public-api/render-tasks/render-task.h>
24 #include <dali/public-api/images/frame-buffer-image.h>
25 #include <dali/internal/event/common/object-impl.h>
35 class EventThreadServices;
42 class RenderTask : public Object
46 typedef Dali::RenderTask::ScreenToFrameBufferFunction ScreenToFrameBufferFunction;
49 * Creates a new RenderTask.
50 * @param[in] isSystemLevel Whether the render-task is on the system level task list.
52 static RenderTask* New( bool isSystemLevel );
55 * @copydoc Dali::RenderTask::SetSourceActor()
57 void SetSourceActor( Actor* actor );
60 * @copydoc Dali::RenderTask::GetSourceActor()
62 Actor* GetSourceActor() const;
65 * @copydoc Dali::RenderTask::SetExclusive()
67 void SetExclusive( bool exclusive );
70 * @copydoc Dali::RenderTask::IsExclusive()
72 bool IsExclusive() const;
75 * @copydoc Dali::RenderTask::SetInputEnabled()
77 void SetInputEnabled( bool enabled );
80 * @copydoc Dali::RenderTask::GetInputEnabled()
82 bool GetInputEnabled() const;
85 * @copydoc Dali::RenderTask::SetCameraActor()
87 void SetCameraActor( CameraActor* cameraActor );
90 * @copydoc Dali::RenderTask::GetCameraActor()
92 CameraActor* GetCameraActor() const;
95 * @copydoc Dali::RenderTask::SetTargetFrameBuffer()
97 void SetTargetFrameBuffer( Dali::FrameBufferImage frameBuffer );
100 * @copydoc Dali::RenderTask::GetTargetFrameBuffer
102 Dali::FrameBufferImage GetTargetFrameBuffer() const;
105 * @copydoc Dali::RenderTask::SetScreenToFrameBufferFunction
107 void SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction );
110 * @copydoc Dali::RenderTask::GetScreenToFrameBufferFunction
112 ScreenToFrameBufferFunction GetScreenToFrameBufferFunction() const;
115 * copydoc Dali::RenderTask::SetScreenToFrameBufferMappingActor
117 void SetScreenToFrameBufferMappingActor( Actor* mappingActor );
120 * copydoc Dali::RenderTask::GetScreenToFrameBufferMAppingActor
122 Actor* GetScreenToFrameBufferMappingActor() const;
125 * @copydoc Dali::RenderTask::SetViewportPosition
127 void SetViewportPosition(const Vector2& value);
130 * @copydoc Dali::RenderTask::GetCurrentViewportPosition
132 Vector2 GetCurrentViewportPosition() const;
135 * @copydoc Dali::RenderTask::SetViewportSize
137 void SetViewportSize(const Vector2& value);
140 * @copydoc Dali::RenderTask::GetCurrentViewportSize
142 Vector2 GetCurrentViewportSize() const;
145 * @copydoc Dali::RenderTask::SetViewport()
147 void SetViewport( const Viewport& viewport );
150 * @param[out] viewPort instance to copy the values into
152 void GetViewport( Viewport& viewPort ) const;
155 * @copydoc Dali::RenderTask::SetClearColor()
157 void SetClearColor( const Vector4& color );
160 * @copydoc Dali::RenderTask::GetClearColor()
162 const Vector4& GetClearColor() const;
165 * Set whether whether GL sync is required for native render target.
166 * @param[in] requiresSync whether whether GL sync is required.
168 void SetSyncRequired( bool requiresSync );
171 * Query whether the sync object is required for native render target.
172 * @return True if the sync object is required, false otherwise.
174 bool IsSyncRequired() const;
177 * @copydoc Dali::RenderTask::SetClearEnabled()
179 void SetClearEnabled( bool enabled );
182 * @copydoc Dali::RenderTask::GetClearEnabled()
184 bool GetClearEnabled() const;
187 * @copydoc Dali::RenderTask::SetCullMode()
189 void SetCullMode( bool mode );
192 * @copydoc Dali::RenderTask::GetCullMode()
194 bool GetCullMode() const;
197 * @copydoc Dali::RenderTask::SetRefreshRate()
199 void SetRefreshRate( unsigned int refreshRate );
202 * @copydoc Dali::RenderTask::GetRefreshRate()
204 unsigned int GetRefreshRate() const;
207 * Check if the render-task is hittable. If render task is offscreen, the screen coordinates may be translated.
208 * @param[in,out] screenCoords The screen coordinate, which may be converted (for hit-testing actors which are rendered off-screen).
209 * @return True the render-task can be used for input-handling; otherwise the output parameters are not valid.
211 bool IsHittable( Vector2& screenCoords ) const;
214 * Translates screen coordinates to render task coordinates for offscreen render tasks
215 * @param[in,out] screenCoords The screen coordinates, which may be converted (for off-screen).
216 * @return false if the conversion function decides the coordinates are not inside. returns true if there is no conversion function
218 bool TranslateCoordinates( Vector2& screenCoords ) const;
221 * Query whether the RenderTask is on the system level render-task list.
222 * @return true, if on the system level task list, false otherwise.
224 bool IsSystemLevel() const;
227 * @copydoc Dali::RenderTask::WorldToViewport()
229 bool WorldToViewport(const Vector3 &position, float& viewportX, float& viewportY) const;
232 * @copydoc Dali::RenderTask::ViewportToLocal()
234 bool ViewportToLocal(Actor* actor, float viewportX, float viewportY, float &localX, float &localY) const;
236 public: // Used by RenderTaskList, which owns the SceneGraph::RenderTasks
239 * Create the scene-graph RenderTask object.
240 * @pre CreateSceneObject has not already been called.
241 * @return A newly allocated scene-graph object; the caller takes ownership.
243 SceneGraph::RenderTask* CreateSceneObject();
246 * Retrieve the scene-graph RenderTask object.
247 * @return The scene-graph object, or NULL if this has been discarded.
249 SceneGraph::RenderTask* GetRenderTaskSceneObject();
252 * Discard the scene-graph RenderTask object.
254 void DiscardSceneObject();
256 public: // Implementation of Object
259 * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
261 virtual unsigned int GetDefaultPropertyCount() const;
264 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
266 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
269 * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
271 virtual const char* GetDefaultPropertyName(Property::Index index) const;
274 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
276 virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
279 * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
281 virtual bool IsDefaultPropertyWritable(Property::Index index) const;
284 * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
286 virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
289 * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
291 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
294 * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
296 virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
299 * @copydoc Dali::Internal::Object::SetDefaultProperty()
301 virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
304 * @copydoc Dali::Internal::Object::GetDefaultProperty()
306 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
309 * @copydoc Dali::Internal::Object::GetSceneObject()
311 virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
314 * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
316 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
319 * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
321 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
326 * Query whether a Finished signal should be emitted for this render-task.
327 * This should only be called by NotificationManager, before signals are emitted.
328 * @pre The refresh rate must be REFRESH_ONCE.
329 * @post HasFinished() will return false on subsequent calls, until the render-task is processed again.
330 * @return \e true if the refresh once render task has finished. Otherwise it returns \e false.
335 * Emit the Finished signal
337 void EmitSignalFinish();
340 * @copydoc Dali::RenderTask::FinishedSignal()
342 Dali::RenderTask::RenderTaskSignalType& FinishedSignal();
345 * Connects a callback function with the object's signals.
346 * @param[in] object The object providing the signal.
347 * @param[in] tracker Used to disconnect the signal.
348 * @param[in] signalName The signal to connect to.
349 * @param[in] functor A newly allocated FunctorDelegate.
350 * @return True if the signal was connected.
351 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
353 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
358 * Construct a new RenderTask.
359 * @param[in] isSystemLevel Whether the RenderTask is on the system level task list.
361 RenderTask( bool isSystemLevel );
364 * A reference counted object may only be deleted by calling Unreference()
366 virtual ~RenderTask();
369 * Helper class for connecting Nodes to the scene-graph RenderTask
371 class Connector : public Object::Observer
383 * Create the helper class
385 Connector( Type type, RenderTask& renderTask );
388 * Non-virtual destructor; not suitable as a base object.
393 * Set the actor to be observed.
394 * @param[in] actor The actor to be observed.
396 void SetActor( Actor* actor );
399 * Update the scene-graph RenderTask with a new source/camera Node.
401 void UpdateRenderTask();
403 public: // From Object::Observer
406 * @copydoc Dali::Internal::Object::Observer::SceneObjectAdded
408 virtual void SceneObjectAdded( Object& object );
411 * @copydoc Dali::Internal::Object::Observer::SceneObjectAdded
413 virtual void SceneObjectRemoved( Object& object );
416 * @copydoc Dali::Internal::Object::Observer::ObjectDestroyed
418 virtual void ObjectDestroyed( Object& object );
423 Connector(const Connector&);
426 Connector& operator=(const Connector& rhs);
432 RenderTask& mRenderTask;
434 Actor* mActor; ///< Raw-pointer to the actor; not owned.
439 SceneGraph::RenderTask* mSceneObject; ///< Raw-pointer to the scene-graph object; not owned.
441 Connector mSourceConnector; ///< Responsible for connecting/disconnecting source Nodes
442 Connector mCameraConnector; ///< Responsible for connecting/disconnecting camera Nodes
443 Connector mMappingConnector; /// Responsible for connecting/disconnection actor node, which used to mapping screen to frame buffer coordinate
445 Vector4 mClearColor; ///< Optional clear color
447 unsigned int mRefreshRate; ///< Determines how often the task is processed.
449 unsigned int mRefreshOnceCounter;
451 Dali::FrameBufferImage mFrameBufferImage; ///< Optional off-screen render target.
453 Dali::RenderTask::ScreenToFrameBufferFunction mScreenToFrameBufferFunction; ///< Used to convert screen to frame-buffer coordinates
455 bool mExclusive : 1; ///< True if the render-task has exclusive access to the source Nodes.
456 bool mInputEnabled : 1; ///< True if the render-task should be considered for input handling.
457 bool mClearEnabled : 1; ///< True if the render-task should be clear the color buffer.
458 bool mCullMode : 1; ///< True if the render-task's actors should be culled
459 bool mIsSystemLevel : 1; ///< True if the render-task is on the system level task list.
460 bool mRequiresSync : 1; ///< True if the GL sync is required to track the render of
463 Dali::RenderTask::RenderTaskSignalType mSignalFinished; ///< Signal emmited when the render task has been processed.
466 } // namespace Internal
468 // Helpers for public-api forwarding methods
470 inline Internal::RenderTask& GetImplementation(Dali::RenderTask& task)
472 DALI_ASSERT_ALWAYS(task && "RenderTask handle is empty");
474 BaseObject& handle = task.GetBaseObject();
476 return static_cast<Internal::RenderTask&>(handle);
479 inline const Internal::RenderTask& GetImplementation(const Dali::RenderTask& task)
481 DALI_ASSERT_ALWAYS(task && "RenderTask handle is empty");
483 const BaseObject& handle = task.GetBaseObject();
485 return static_cast<const Internal::RenderTask&>(handle);
490 #endif //__DALI_INTERNAL_RENDER_TASK_H__