1 #ifndef DALI_INTERNAL_RENDER_TASK_H
2 #define DALI_INTERNAL_RENDER_TASK_H
5 * Copyright (c) 2020 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/object/weak-handle.h>
24 #include <dali/public-api/render-tasks/render-task.h>
25 #include <dali/internal/event/common/object-impl.h>
26 #include <dali/internal/event/rendering/frame-buffer-impl.h>
27 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
28 #include <dali/internal/event/events/actor-observer.h>
38 class EventThreadServices;
48 using RenderTaskPtr = IntrusivePtr<RenderTask>;
50 class RenderTask : public Object
54 using ScreenToFrameBufferFunction = Dali::RenderTask::ScreenToFrameBufferFunction;
57 * Creates a new RenderTask.
59 * @param[in] sourceActor The source actor.
60 * @param[in] cameraActor The camera actor.
61 * @param[in] renderTaskList The render task list.
62 * @return The created render task
64 static RenderTaskPtr New( Actor* sourceActor, CameraActor* cameraActor, RenderTaskList& renderTaskList );
67 * @copydoc Dali::RenderTask::SetSourceActor()
69 void SetSourceActor( Actor* actor );
72 * @copydoc Dali::RenderTask::GetSourceActor()
74 Actor* GetSourceActor() const;
77 * @copydoc Dali::RenderTask::SetExclusive()
79 void SetExclusive( bool exclusive );
82 * @copydoc Dali::RenderTask::IsExclusive()
84 bool IsExclusive() const;
87 * @copydoc Dali::RenderTask::SetInputEnabled()
89 void SetInputEnabled( bool enabled );
92 * @copydoc Dali::RenderTask::GetInputEnabled()
94 bool GetInputEnabled() const;
97 * @copydoc Dali::RenderTask::SetCameraActor()
99 void SetCameraActor( CameraActor* cameraActor );
102 * @copydoc Dali::RenderTask::GetCameraActor()
104 CameraActor* GetCameraActor() const;
107 * @copydoc Dali::RenderTask::SetFrameBuffer()
109 void SetFrameBuffer( FrameBufferPtr frameBuffer );
112 * @copydoc Dali::RenderTask::GetFrameBuffer
114 FrameBuffer* GetFrameBuffer() const;
117 * @copydoc Dali::RenderTask::SetScreenToFrameBufferFunction
119 void SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction );
122 * @copydoc Dali::RenderTask::GetScreenToFrameBufferFunction
124 ScreenToFrameBufferFunction GetScreenToFrameBufferFunction() const;
127 * copydoc Dali::RenderTask::SetScreenToFrameBufferMappingActor
129 void SetScreenToFrameBufferMappingActor( Dali::Actor& mappingActor );
132 * copydoc Dali::RenderTask::GetScreenToFrameBufferMAppingActor
134 Dali::Actor GetScreenToFrameBufferMappingActor() const;
137 * @copydoc Dali::RenderTask::SetViewportPosition
139 void SetViewportPosition(const Vector2& value);
142 * @copydoc Dali::RenderTask::GetCurrentViewportPosition
144 Vector2 GetCurrentViewportPosition() const;
147 * @copydoc Dali::RenderTask::SetViewportSize
149 void SetViewportSize(const Vector2& value);
152 * @copydoc Dali::RenderTask::GetCurrentViewportSize
154 Vector2 GetCurrentViewportSize() const;
157 * @copydoc Dali::RenderTask::SetViewport()
159 void SetViewport( const Viewport& viewport );
162 * @param[out] viewPort instance to copy the values into
164 void GetViewport( Viewport& viewPort ) const;
167 * @copydoc Dali::RenderTask::SetClearColor()
169 void SetClearColor( const Vector4& color );
172 * @copydoc Dali::RenderTask::GetClearColor()
174 const Vector4& GetClearColor() const;
177 * Indicate whether GL sync is required for native render target.
178 * @param[in] requiresSync whether GL sync is required.
180 void SetSyncRequired( bool requiresSync );
183 * Query whether the sync object is required for native render target.
184 * @return True if the sync object is required, false otherwise.
186 bool IsSyncRequired() const;
189 * @copydoc Dali::RenderTask::SetClearEnabled()
191 void SetClearEnabled( bool enabled );
194 * @copydoc Dali::RenderTask::GetClearEnabled()
196 bool GetClearEnabled() const;
199 * @copydoc Dali::RenderTask::SetCullMode()
201 void SetCullMode( bool mode );
204 * @copydoc Dali::RenderTask::GetCullMode()
206 bool GetCullMode() const;
209 * @copydoc Dali::RenderTask::SetRefreshRate()
211 void SetRefreshRate( uint32_t refreshRate );
214 * @copydoc Dali::RenderTask::GetRefreshRate()
216 uint32_t GetRefreshRate() const;
219 * Check if the render-task is hittable. If render task is offscreen, the screen coordinates may be translated.
220 * @param[in,out] screenCoords The screen coordinate, which may be converted (for hit-testing actors which are rendered off-screen).
221 * @return True the render-task can be used for input-handling; otherwise the output parameters are not valid.
223 bool IsHittable( Vector2& screenCoords ) const;
226 * Translates screen coordinates to render task coordinates for offscreen render tasks
227 * @param[in,out] screenCoords The screen coordinates, which may be converted (for off-screen).
228 * @return false if the conversion function decides the coordinates are not inside. returns true if there is no conversion function
230 bool TranslateCoordinates( Vector2& screenCoords ) const;
233 * @copydoc Dali::RenderTask::WorldToViewport()
235 bool WorldToViewport(const Vector3 &position, float& viewportX, float& viewportY) const;
238 * @copydoc Dali::RenderTask::ViewportToLocal()
240 bool ViewportToLocal(Actor* actor, float viewportX, float viewportY, float &localX, float &localY) const;
242 public: // Used by RenderTaskList, which owns the SceneGraph::RenderTasks
245 * Retrieve the scene-graph RenderTask object.
246 * @return The scene-graph object
248 const SceneGraph::RenderTask& GetRenderTaskSceneObject() const;
251 * Retrieve the render task list RenderTask object belongs to.
252 * @return The render task list
254 RenderTaskList& GetRenderTaskList() const;
256 public: // Implementation of Object
259 * @copydoc Dali::Internal::Object::SetDefaultProperty()
261 void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue) override;
264 * @copydoc Dali::Internal::Object::GetDefaultProperty()
266 Property::Value GetDefaultProperty( Property::Index index ) const override;
269 * @copydoc Dali::Internal::Object::GetDefaultPropertyCurrentValue()
271 Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const override;
274 * @copydoc Dali::Internal::Object::OnNotifyDefaultPropertyAnimation()
276 void OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType ) override;
279 * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
281 const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const override;
284 * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
286 const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const override;
291 * Query whether a Finished signal should be emitted for this render-task.
292 * This should only be called by NotificationManager, before signals are emitted.
293 * @pre The refresh rate must be REFRESH_ONCE.
294 * @post HasFinished() will return false on subsequent calls, until the render-task is processed again.
295 * @return \e true if the refresh once render task has finished. Otherwise it returns \e false.
300 * Emit the Finished signal
302 void EmitSignalFinish();
305 * @copydoc Dali::RenderTask::FinishedSignal()
307 Dali::RenderTask::RenderTaskSignalType& FinishedSignal();
310 * Connects a callback function with the object's signals.
311 * @param[in] object The object providing the signal.
312 * @param[in] tracker Used to disconnect the signal.
313 * @param[in] signalName The signal to connect to.
314 * @param[in] functor A newly allocated FunctorDelegate.
315 * @return True if the signal was connected.
316 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
318 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
325 * @param[in] sceneObject The scene graph object
326 * @param[in] renderTaskList The render task list
328 RenderTask( const SceneGraph::RenderTask* sceneObject, RenderTaskList& renderTaskList );
331 * A reference counted object may only be deleted by calling Unreference()
333 ~RenderTask() override;
335 private: // not copyable
337 RenderTask() = delete;
338 RenderTask( const RenderTask& ) = delete;
339 RenderTask& operator=( const RenderTask& ) = delete;
343 ActorObserver mSourceActor; ///< Source actor
344 ActorObserver mCameraActor; ///< Camera actor
345 WeakHandle<Dali::Actor> mInputMappingActor; /// used to mapping screen to frame buffer coordinate, not kept alive by rendertask
346 RenderTaskList& mRenderTaskList; ///< The render task list
348 Vector4 mClearColor; ///< Optional clear color
350 Vector2 mViewportPosition; ///< The cached viewport position
351 Vector2 mViewportSize; ///< The cached viewport size
353 uint32_t mRefreshRate; ///< Determines how often the task is processed.
355 uint32_t mRefreshOnceCounter;
357 FrameBufferPtr mFrameBuffer;
360 Dali::RenderTask::ScreenToFrameBufferFunction mScreenToFrameBufferFunction; ///< Used to convert screen to frame-buffer coordinates
362 bool mExclusive : 1; ///< True if the render-task has exclusive access to the source Nodes.
363 bool mInputEnabled : 1; ///< True if the render-task should be considered for input handling.
364 bool mClearEnabled : 1; ///< True if the render-task should be clear the color buffer.
365 bool mCullMode : 1; ///< True if the render-task's actors should be culled
366 bool mRequiresSync : 1; ///< True if the GL sync is required to track the render of.
369 Dali::RenderTask::RenderTaskSignalType mSignalFinished; ///< Signal emmited when the render task has been processed.
372 } // namespace Internal
374 // Helpers for public-api forwarding methods
376 inline Internal::RenderTask& GetImplementation(Dali::RenderTask& task)
378 DALI_ASSERT_ALWAYS(task && "RenderTask handle is empty");
380 BaseObject& handle = task.GetBaseObject();
382 return static_cast<Internal::RenderTask&>(handle);
385 inline const Internal::RenderTask& GetImplementation(const Dali::RenderTask& task)
387 DALI_ASSERT_ALWAYS(task && "RenderTask handle is empty");
389 const BaseObject& handle = task.GetBaseObject();
391 return static_cast<const Internal::RenderTask&>(handle);
396 #endif // DALI_INTERNAL_RENDER_TASK_H