1 #ifndef __DALI_INTERNAL_RENDER_TASK_H__
2 #define __DALI_INTERNAL_RENDER_TASK_H__
5 * Copyright (c) 2016 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;
43 class RenderTask : public Object
47 typedef Dali::RenderTask::ScreenToFrameBufferFunction ScreenToFrameBufferFunction;
50 * Creates a new RenderTask.
51 * @param[in] isSystemLevel Whether the render-task is on the system level task list.
53 static RenderTask* New( bool isSystemLevel );
56 * @copydoc Dali::RenderTask::SetSourceActor()
58 void SetSourceActor( Actor* actor );
61 * @copydoc Dali::RenderTask::GetSourceActor()
63 Actor* GetSourceActor() const;
66 * @copydoc Dali::RenderTask::SetExclusive()
68 void SetExclusive( bool exclusive );
71 * @copydoc Dali::RenderTask::IsExclusive()
73 bool IsExclusive() const;
76 * @copydoc Dali::RenderTask::SetInputEnabled()
78 void SetInputEnabled( bool enabled );
81 * @copydoc Dali::RenderTask::GetInputEnabled()
83 bool GetInputEnabled() const;
86 * @copydoc Dali::RenderTask::SetCameraActor()
88 void SetCameraActor( CameraActor* cameraActor );
91 * @copydoc Dali::RenderTask::GetCameraActor()
93 CameraActor* GetCameraActor() const;
96 * @copydoc Dali::RenderTask::SetTargetFrameBuffer()
98 void SetTargetFrameBuffer( Dali::FrameBufferImage frameBuffer );
101 * @copydoc Dali::RenderTask::GetTargetFrameBuffer
103 Dali::FrameBufferImage GetTargetFrameBuffer() const;
106 * @copydoc Dali::RenderTask::SetScreenToFrameBufferFunction
108 void SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction );
111 * @copydoc Dali::RenderTask::GetScreenToFrameBufferFunction
113 ScreenToFrameBufferFunction GetScreenToFrameBufferFunction() const;
116 * copydoc Dali::RenderTask::SetScreenToFrameBufferMappingActor
118 void SetScreenToFrameBufferMappingActor( Actor* mappingActor );
121 * copydoc Dali::RenderTask::GetScreenToFrameBufferMAppingActor
123 Actor* GetScreenToFrameBufferMappingActor() const;
126 * @copydoc Dali::RenderTask::SetViewportPosition
128 void SetViewportPosition(const Vector2& value);
131 * @copydoc Dali::RenderTask::GetCurrentViewportPosition
133 Vector2 GetCurrentViewportPosition() const;
136 * @copydoc Dali::RenderTask::SetViewportSize
138 void SetViewportSize(const Vector2& value);
141 * @copydoc Dali::RenderTask::GetCurrentViewportSize
143 Vector2 GetCurrentViewportSize() const;
146 * @copydoc Dali::RenderTask::SetViewport()
148 void SetViewport( const Viewport& viewport );
151 * @param[out] viewPort instance to copy the values into
153 void GetViewport( Viewport& viewPort ) const;
156 * @copydoc Dali::RenderTask::SetClearColor()
158 void SetClearColor( const Vector4& color );
161 * @copydoc Dali::RenderTask::GetClearColor()
163 const Vector4& GetClearColor() const;
166 * Indicate whether GL sync is required for native render target.
167 * @param[in] requiresSync whether GL sync is required.
169 void SetSyncRequired( bool requiresSync );
172 * Query whether the sync object is required for native render target.
173 * @return True if the sync object is required, false otherwise.
175 bool IsSyncRequired() const;
178 * @copydoc Dali::RenderTask::SetClearEnabled()
180 void SetClearEnabled( bool enabled );
183 * @copydoc Dali::RenderTask::GetClearEnabled()
185 bool GetClearEnabled() const;
188 * @copydoc Dali::RenderTask::SetCullMode()
190 void SetCullMode( bool mode );
193 * @copydoc Dali::RenderTask::GetCullMode()
195 bool GetCullMode() const;
198 * @copydoc Dali::RenderTask::SetRefreshRate()
200 void SetRefreshRate( unsigned int refreshRate );
203 * @copydoc Dali::RenderTask::GetRefreshRate()
205 unsigned int GetRefreshRate() const;
208 * Check if the render-task is hittable. If render task is offscreen, the screen coordinates may be translated.
209 * @param[in,out] screenCoords The screen coordinate, which may be converted (for hit-testing actors which are rendered off-screen).
210 * @return True the render-task can be used for input-handling; otherwise the output parameters are not valid.
212 bool IsHittable( Vector2& screenCoords ) const;
215 * Translates screen coordinates to render task coordinates for offscreen render tasks
216 * @param[in,out] screenCoords The screen coordinates, which may be converted (for off-screen).
217 * @return false if the conversion function decides the coordinates are not inside. returns true if there is no conversion function
219 bool TranslateCoordinates( Vector2& screenCoords ) const;
222 * Query whether the RenderTask is on the system level render-task list.
223 * @return true, if on the system level task list, false otherwise.
225 bool IsSystemLevel() const;
228 * @copydoc Dali::RenderTask::WorldToViewport()
230 bool WorldToViewport(const Vector3 &position, float& viewportX, float& viewportY) const;
233 * @copydoc Dali::RenderTask::ViewportToLocal()
235 bool ViewportToLocal(Actor* actor, float viewportX, float viewportY, float &localX, float &localY) const;
237 public: // Used by RenderTaskList, which owns the SceneGraph::RenderTasks
240 * Create the scene-graph RenderTask object.
241 * @pre CreateSceneObject has not already been called.
242 * @return A newly allocated scene-graph object; the caller takes ownership.
244 SceneGraph::RenderTask* CreateSceneObject();
247 * Retrieve the scene-graph RenderTask object.
248 * @return The scene-graph object, or NULL if this has been discarded.
250 SceneGraph::RenderTask* GetRenderTaskSceneObject();
253 * Discard the scene-graph RenderTask object.
255 void DiscardSceneObject();
257 public: // Implementation of Object
260 * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
262 virtual unsigned int GetDefaultPropertyCount() const;
265 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
267 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
270 * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
272 virtual const char* GetDefaultPropertyName(Property::Index index) const;
275 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
277 virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
280 * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
282 virtual bool IsDefaultPropertyWritable(Property::Index index) const;
285 * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
287 virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
290 * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
292 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
295 * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
297 virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
300 * @copydoc Dali::Internal::Object::SetDefaultProperty()
302 virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
305 * @copydoc Dali::Internal::Object::GetDefaultProperty()
307 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
310 * @copydoc Dali::Internal::Object::GetSceneObject()
312 virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
315 * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
317 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
320 * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
322 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
327 * Query whether a Finished signal should be emitted for this render-task.
328 * This should only be called by NotificationManager, before signals are emitted.
329 * @pre The refresh rate must be REFRESH_ONCE.
330 * @post HasFinished() will return false on subsequent calls, until the render-task is processed again.
331 * @return \e true if the refresh once render task has finished. Otherwise it returns \e false.
336 * Emit the Finished signal
338 void EmitSignalFinish();
341 * @copydoc Dali::RenderTask::FinishedSignal()
343 Dali::RenderTask::RenderTaskSignalType& FinishedSignal();
346 * Connects a callback function with the object's signals.
347 * @param[in] object The object providing the signal.
348 * @param[in] tracker Used to disconnect the signal.
349 * @param[in] signalName The signal to connect to.
350 * @param[in] functor A newly allocated FunctorDelegate.
351 * @return True if the signal was connected.
352 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
354 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
359 * Construct a new RenderTask.
360 * @param[in] isSystemLevel Whether the RenderTask is on the system level task list.
362 RenderTask( bool isSystemLevel );
365 * A reference counted object may only be deleted by calling Unreference()
367 virtual ~RenderTask();
370 * Helper class for connecting Nodes to the scene-graph RenderTask
372 class Connector : public Object::Observer
384 * Create the helper class
386 Connector( Type type, RenderTask& renderTask );
389 * Non-virtual destructor; not suitable as a base object.
394 * Set the actor to be observed.
395 * @param[in] actor The actor to be observed.
397 void SetActor( Actor* actor );
400 * Update the scene-graph RenderTask with a new source/camera Node.
402 void UpdateRenderTask();
404 public: // From Object::Observer
407 * @copydoc Dali::Internal::Object::Observer::SceneObjectAdded
409 virtual void SceneObjectAdded( Object& object );
412 * @copydoc Dali::Internal::Object::Observer::SceneObjectAdded
414 virtual void SceneObjectRemoved( Object& object );
417 * @copydoc Dali::Internal::Object::Observer::ObjectDestroyed
419 virtual void ObjectDestroyed( Object& object );
424 Connector(const Connector&);
427 Connector& operator=(const Connector& rhs);
433 RenderTask& mRenderTask;
435 Actor* mActor; ///< Raw-pointer to the actor; not owned.
436 const SceneGraph::Camera* mCamera; ///< Raw-pointer to camera scene-graph object; not owned.
441 SceneGraph::RenderTask* mSceneObject; ///< Raw-pointer to the scene-graph object; not owned.
443 Connector mSourceConnector; ///< Responsible for connecting/disconnecting source Nodes
444 Connector mCameraConnector; ///< Responsible for connecting/disconnecting camera Nodes
445 Connector mMappingConnector; /// Responsible for connecting/disconnecting actor node, which used to mapping screen to frame buffer coordinate
447 Vector4 mClearColor; ///< Optional clear color
449 unsigned int mRefreshRate; ///< Determines how often the task is processed.
451 unsigned int mRefreshOnceCounter;
453 Dali::FrameBufferImage mFrameBufferImage; ///< Optional off-screen render target.
455 Dali::RenderTask::ScreenToFrameBufferFunction mScreenToFrameBufferFunction; ///< Used to convert screen to frame-buffer coordinates
457 bool mExclusive : 1; ///< True if the render-task has exclusive access to the source Nodes.
458 bool mInputEnabled : 1; ///< True if the render-task should be considered for input handling.
459 bool mClearEnabled : 1; ///< True if the render-task should be clear the color buffer.
460 bool mCullMode : 1; ///< True if the render-task's actors should be culled
461 bool mIsSystemLevel : 1; ///< True if the render-task is on the system level task list.
462 bool mRequiresSync : 1; ///< True if the GL sync is required to track the render of.
465 Dali::RenderTask::RenderTaskSignalType mSignalFinished; ///< Signal emmited when the render task has been processed.
468 } // namespace Internal
470 // Helpers for public-api forwarding methods
472 inline Internal::RenderTask& GetImplementation(Dali::RenderTask& task)
474 DALI_ASSERT_ALWAYS(task && "RenderTask handle is empty");
476 BaseObject& handle = task.GetBaseObject();
478 return static_cast<Internal::RenderTask&>(handle);
481 inline const Internal::RenderTask& GetImplementation(const Dali::RenderTask& task)
483 DALI_ASSERT_ALWAYS(task && "RenderTask handle is empty");
485 const BaseObject& handle = task.GetBaseObject();
487 return static_cast<const Internal::RenderTask&>(handle);
492 #endif //__DALI_INTERNAL_RENDER_TASK_H__