dali/public-api/render-tasks/render-task.h

   1 #ifndef DALI_RENDER_TASK_H
   2 #define DALI_RENDER_TASK_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <cstdint> // uint32_t
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/math/viewport.h>
  26 #include <dali/public-api/object/handle.h>
  27 #include <dali/public-api/object/property-index-ranges.h>
  28 #include <dali/public-api/signals/dali-signal.h>
  29
  30 namespace Dali
  31 {
  32 /**
  33  * @addtogroup dali_core_rendering_effects
  34  * @{
  35  */
  36
  37 class Actor;
  38 class CameraActor;
  39 class FrameBufferImage;
  40 class FrameBuffer;
  41 struct Vector4;
  42
  43 namespace Internal DALI_INTERNAL
  44 {
  45 class RenderTask;
  46 }
  47
  48 /**
  49  * @brief RenderTasks describe how the Dali scene should be rendered.
  50  *
  51  * The Scene provides access to an ordered list of render-tasks.
  52  *
  53  * Each RenderTask must specify the source actors to be rendered, and a camera actor from
  54  * which the scene is viewed.
  55  *
  56  * RenderTasks may optionally target a frame-buffer, otherwise the default GL surface is used;
  57  * typically this is a window provided by the native system.
  58  *
  59  * By default Dali provides a single RenderTask, which renders the entire actor hierarchy using
  60  * a default camera actor and GL surface. If stereoscopic rendering is enabled, Dali will create
  61  * two additional render tasks, on for each eye. Each render task will have its own camera parented
  62  * to the default camera actor.
  63  *
  64  * The first RenderTask used for input handling will be the last one rendered, which also has input enabled,
  65  * and has a valid source & camera actor; see SetInputEnabled().
  66  *
  67  * If none of the actors are hit in the last RenderTask rendered, then input handling will continue
  68  * with the second last RenderTask rendered, and so on.
  69  *
  70  * All RenderTasks which target a frame-buffer (i.e. off screen) will be rendered before all RenderTasks
  71  * which target the default GL surface. This allows the user to render intermediate targets which are used
  72  * later when targeting the screen.
  73  *
  74  * A RenderTask targeting a frame-buffer can still be hit-tested, provided that the
  75  * screen->frame-buffer coordinate conversion is successful; see SetScreenToFrameBufferFunction().
  76  *
  77  * If the refresh rate id REFRESH_ONCE and a "Finish" signal is connected, it will be emitted when the RenderTask is completed.
  78  * Note that all connected signals must be disconnected before the object is destroyed. This is typically done in the
  79  * object destructor, and requires either the Dali::Connection object or Dali::RenderTask handle to be stored.
  80  *
  81  * Signals
  82  * | %Signal Name | Method                |
  83  * |--------------|-----------------------|
  84  * | finished     | @ref FinishedSignal() |
  85  * @SINCE_1_0.0
  86  */
  87 class DALI_CORE_API RenderTask : public Handle
  88 {
  89 public:
  90   /**
  91    * @brief Enumeration for instances of properties belonging to the RenderTask class.
  92    * @SINCE_1_0.0
  93    */
  94   struct Property
  95   {
  96     /**
  97      * @brief Enumeration for instances of properties belonging to the RenderTask class.
  98      * @SINCE_1_0.0
  99      */
 100     enum
 101     {
 102       /**
 103        * @brief name "viewportPosition", type Vector2
 104        * @SINCE_1_0.0
 105        */
 106       VIEWPORT_POSITION = DEFAULT_OBJECT_PROPERTY_START_INDEX,
 107       /**
 108        * @brief name "viewportSize", type Vector2
 109        * @SINCE_1_0.0
 110        */
 111       VIEWPORT_SIZE,
 112       /**
 113        * @brief name "clearColor", type Vector4
 114        * @SINCE_1_0.0
 115        */
 116       CLEAR_COLOR,
 117       /**
 118        * @brief name "requiresSync", type BOOLEAN
 119        * @details By default, the sync object is not created.
 120        *  When native image source is used as render target, in order to track when the render to pixmap is completed, the GL sync should be enabled.
 121        *  Thus the RENDER_ONCE finished signal can be emit at the correct timing.
 122        * @SINCE_1_1.29
 123        * @note The use of GL sync might cause deadlock with multiple access to the single pixmap happening in the same time.
 124        */
 125       REQUIRES_SYNC,
 126     };
 127   };
 128
 129   /**
 130    * @brief Typedef for signals sent by this class.
 131    * @SINCE_1_0.0
 132    */
 133   using RenderTaskSignalType = Signal<void(RenderTask&)>;
 134
 135   /**
 136    * @brief A pointer to a function for converting screen to frame-buffer coordinates.
 137    * @SINCE_1_0.0
 138    * @param[in,out] coordinates The screen coordinates to convert where (0,0) is the top-left of the screen
 139    * @return True if the conversion was successful, otherwise coordinates should be unmodified
 140    */
 141   using ScreenToFrameBufferFunction = bool (*)(Vector2&);
 142
 143   /**
 144    * @brief A pointer to a function for converting screen to frame-buffer coordinates.
 145    * @SINCE_1_0.0
 146    * @param[in,out] coordinates The screen coordinates to convert where (0,0) is the top-left of the screen
 147    * @return True if the conversion was successful, otherwise coordinates should be unmodified
 148    */
 149   using ConstScreenToFrameBufferFunction = bool (*const)(Vector2&);
 150
 151   /**
 152    * @brief The default conversion function returns false for any screen coordinates.
 153    *
 154    * This effectively disables hit-testing for RenderTasks rendering to a frame buffer.
 155    * See also FULLSCREEN_FRAMEBUFFER_FUNCTION below.
 156    */
 157   static ConstScreenToFrameBufferFunction DEFAULT_SCREEN_TO_FRAMEBUFFER_FUNCTION;
 158
 159   /**
 160    * @brief This conversion function outputs the (unmodified) screen coordinates as frame-buffer coordinates.
 161    *
 162    * Therefore the contents of an off-screen image is expected to be rendered "full screen".
 163    */
 164   static ConstScreenToFrameBufferFunction FULLSCREEN_FRAMEBUFFER_FUNCTION;
 165
 166   /**
 167    * @brief Enumeration for the refresh-rate of the RenderTask.
 168    * @SINCE_1_0.0
 169    */
 170   enum RefreshRate
 171   {
 172     REFRESH_ONCE   = 0, ///< Process once only e.g. take a snap-shot of the scene. @SINCE_1_0.0
 173     REFRESH_ALWAYS = 1  ///< Process every frame. @SINCE_1_0.0
 174   };
 175
 176   static const bool     DEFAULT_EXCLUSIVE;     ///< false
 177   static const bool     DEFAULT_INPUT_ENABLED; ///< true
 178   static const Vector4  DEFAULT_CLEAR_COLOR;   ///< Color::BLACK
 179   static const bool     DEFAULT_CLEAR_ENABLED; ///< false
 180   static const bool     DEFAULT_CULL_MODE;     ///< true
 181   static const uint32_t DEFAULT_REFRESH_RATE;  ///< REFRESH_ALWAYS
 182
 183   /**
 184    * @brief Creates an empty RenderTask handle.
 185    *
 186    * This can be initialised with RenderTaskList::CreateRenderTask().
 187    * @SINCE_1_0.0
 188    */
 189   RenderTask();
 190
 191   /**
 192    * @brief Downcasts a handle to RenderTask handle.
 193    *
 194    * If handle points to a RenderTask, the
 195    * downcast produces valid handle. If not, the returned handle is left uninitialized.
 196    * @SINCE_1_0.0
 197    * @param[in] handle A handle to an object
 198    * @return A handle to a RenderTask or an uninitialized handle
 199    */
 200   static RenderTask DownCast(BaseHandle handle);
 201
 202   /**
 203    * @brief Destructor.
 204    *
 205    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 206    * @SINCE_1_0.0
 207    */
 208   ~RenderTask();
 209
 210   /**
 211    * @brief This copy constructor is required for (smart) pointer semantics.
 212    *
 213    * @SINCE_1_0.0
 214    * @param[in] handle A reference to the copied handle
 215    */
 216   RenderTask(const RenderTask& handle);
 217
 218   /**
 219    * @brief This assignment operator is required for (smart) pointer semantics.
 220    *
 221    * @SINCE_1_0.0
 222    * @param[in] rhs A reference to the copied handle
 223    * @return A reference to this
 224    */
 225   RenderTask& operator=(const RenderTask& rhs);
 226
 227   /**
 228    * @brief Move constructor.
 229    *
 230    * @SINCE_1_9.22
 231    * @param[in] rhs A reference to the moved handle
 232    */
 233   RenderTask(RenderTask&& rhs) noexcept;
 234
 235   /**
 236    * @brief Move assignment operator.
 237    *
 238    * @SINCE_1_9.22
 239    * @param[in] rhs A reference to the moved handle
 240    * @return A reference to this
 241    */
 242   RenderTask& operator=(RenderTask&& rhs) noexcept;
 243
 244   /**
 245    * @brief Sets the actors to be rendered.
 246    * @SINCE_1_0.0
 247    * @param[in] actor This actor and its children will be rendered.
 248    * If actor is an empty handle, then nothing will be rendered
 249    */
 250   void SetSourceActor(Actor actor);
 251
 252   /**
 253    * @brief Retrieves the actors to be rendered.
 254    * @SINCE_1_0.0
 255    * @return This actor and its children will be rendered
 256    */
 257   Actor GetSourceActor() const;
 258
 259   /**
 260    * @brief Retrives stopper actor.
 261    * @SINCE_2_3.23
 262    * @return The actor that marks where to stop rendering.
 263    */
 264   Actor GetStopperActor() const;
 265
 266   /**
 267    * @brief Sets whether the RenderTask has exclusive access to the source actors; the default is false.
 268    * @SINCE_1_0.0
 269    * @param[in] exclusive True if the source actors will only be rendered by this render-task
 270    */
 271   void SetExclusive(bool exclusive);
 272
 273   /**
 274    * @brief Queries whether the RenderTask has exclusive access to the source actors.
 275    * @SINCE_1_0.0
 276    * @return True if the source actors will only be rendered by this render-task
 277    */
 278   bool IsExclusive() const;
 279
 280   /**
 281    * @brief Sets whether the render-task should be considered for input handling; the default is true.
 282    *
 283    * The task used for input handling will be last task in the RenderTaskList which has input enabled,
 284    * and has a valid source & camera actor.
 285    * A RenderTask targetting a frame-buffer can still be hit-tested, provided that the screen->frame-buffer
 286    * coordinate conversion is successful; see also SetScreenToFrameBufferFunction().
 287    * @SINCE_1_0.0
 288    * @param[in] enabled True if the render-task should be considered for input handling
 289    */
 290   void SetInputEnabled(bool enabled);
 291
 292   /**
 293    * @brief Queries whether the render-task should be considered for input handling.
 294    * @SINCE_1_0.0
 295    * @return True if the render-task should be considered for input handling
 296    */
 297   bool GetInputEnabled() const;
 298
 299   /**
 300    * @brief Sets the actor from which the scene is viewed.
 301    * @SINCE_1_0.0
 302    * @param[in] cameraActor The scene is viewed from the perspective of this actor
 303    */
 304   void SetCameraActor(CameraActor cameraActor);
 305
 306   /**
 307    * @brief Retrieves the actor from which the scene is viewed.
 308    * @SINCE_1_0.0
 309    * @return The scene is viewed from the perspective of this actor
 310    */
 311   CameraActor GetCameraActor() const;
 312
 313   /**
 314    * @brief Sets the frame-buffer used as a render target.
 315    * @SINCE_1_1.38
 316    * @param[in] frameBuffer A valid FrameBuffer handle to enable off-screen rendering, or an uninitialized handle to disable it
 317    */
 318   void SetFrameBuffer(FrameBuffer frameBuffer);
 319
 320   /**
 321    * @brief Retrieves the frame-buffer used as a render target.
 322    * @SINCE_1_1.38
 323    * @return The framebuffer
 324    */
 325   FrameBuffer GetFrameBuffer() const;
 326
 327   /**
 328    * @brief Sets the function used to convert screen coordinates to frame-buffer coordinates.
 329    *
 330    * This is useful for hit-testing actors which are rendered off-screen.
 331    * @SINCE_1_0.0
 332    * @param[in] conversionFunction The conversion function
 333    */
 334   void SetScreenToFrameBufferFunction(ScreenToFrameBufferFunction conversionFunction);
 335
 336   /**
 337    * @brief Retrieves the function used to convert screen coordinates to frame-buffer coordinates.
 338    * @SINCE_1_0.0
 339    * @return The conversion function
 340    */
 341   ScreenToFrameBufferFunction GetScreenToFrameBufferFunction() const;
 342
 343   /**
 344    * @brief Sets the actor used to convert screen coordinates to frame-buffer coordinates.
 345    *
 346    * The local coordinates of the actor are mapped as frame-buffer coordinates.
 347    * This is useful for hit-testing actors which are rendered off-screen.
 348    * @SINCE_1_0.0
 349    * @param[in] mappingActor The actor used for conversion
 350    * @note The mapping actor needs to be rendered by the default render task to make the mapping work properly.
 351    */
 352   void SetScreenToFrameBufferMappingActor(Actor mappingActor);
 353
 354   /**
 355    * @brief Retrieves the actor used to convert screen coordinates to frame-buffer coordinates.
 356    * @SINCE_1_0.0
 357    * @return The actor used for conversion
 358    */
 359   Actor GetScreenToFrameBufferMappingActor() const;
 360
 361   /**
 362    * @brief Sets the actor to compute viewport of this render task.
 363    * Actor should be added on Scene.
 364    * @SINCE_2_1.36
 365    * @param[in] actor This actor is used to compute viewport of the render task.
 366    * @note If window default camera is rotated and the actor is no longer a rectangle on the screen, Viewport may be computed incorrectly.
 367    * The Viewport properties VIEWPORT_POSITION and VIEWPORT_SIZE is kept during using ViewportGuideActor, but only current value is changed.
 368    */
 369   void SetViewportGuideActor(Actor actor);
 370
 371   /**
 372    * @brief Retrieves the actor to compute viewport of this render task.
 373    * @SINCE_2_1.36
 374    * @return This actor is used to compute viewport of the render task.
 375    */
 376   Actor GetViewportGuideActor() const;
 377
 378   /**
 379    * @brief Resets the actor to compute viewport of this render task.
 380    * @SINCE_2_1.36
 381    * @note The Viewport properties VIEWPORT_POSITION and VIEWPORT_SIZE is still kept.
 382    */
 383   void ResetViewportGuideActor();
 384
 385   /**
 386    * @brief Sets the GL viewport position used when rendering.
 387    *
 388    * This specifies the transformation between normalized device coordinates and target window (or frame-buffer) coordinates.
 389    * By default this will match the target window or frame-buffer size.
 390    * @SINCE_1_0.0
 391    * @param[in] position The viewports position (x,y)
 392    * @note Unlike the glViewport method, the x & y coordinates refer to the top-left of the viewport rectangle.
 393    */
 394   void SetViewportPosition(Vector2 position);
 395
 396   /**
 397    * @brief Retrieves the GL viewport position used when rendering.
 398    * @SINCE_1_0.0
 399    * @return The viewport
 400    */
 401   Vector2 GetCurrentViewportPosition() const;
 402
 403   /**
 404    * @brief Sets the GL viewport size used when rendering.
 405    *
 406    * This specifies the transformation between normalized device coordinates and target window (or frame-buffer) coordinates.
 407    * By default this will match the target window or frame-buffer size.
 408    * @SINCE_1_0.0
 409    * @param[in] size The viewports size (width,height)
 410    */
 411   void SetViewportSize(Vector2 size);
 412
 413   /**
 414    * @brief Retrieves the GL viewport size used when rendering.
 415    * @SINCE_1_0.0
 416    * @return The viewport
 417    */
 418   Vector2 GetCurrentViewportSize() const;
 419
 420   /**
 421    * @brief Sets the GL viewport used when rendering.
 422    *
 423    * This specifies the transformation between normalized device coordinates and target window (or frame-buffer) coordinates.
 424    * By default this will match the target window or frame-buffer size.
 425    * @SINCE_1_0.0
 426    * @param[in] viewport The new viewport
 427    * @note Unlike the glViewport method, the x & y coordinates refer to the top-left of the viewport rectangle.
 428    */
 429   void SetViewport(Viewport viewport);
 430
 431   /**
 432    * @brief Retrieves the GL viewport used when rendering.
 433    * @SINCE_1_0.0
 434    * @return The viewport
 435    */
 436   Viewport GetViewport() const;
 437
 438   /**
 439    * @brief Sets the clear color used when SetClearEnabled(true) is used.
 440    * @SINCE_1_0.0
 441    * @param[in] color The new clear color
 442    */
 443   void SetClearColor(const Vector4& color);
 444
 445   /**
 446    * @brief Retrieves the clear color used when SetClearEnabled(true) is used.
 447    * @SINCE_1_0.0
 448    * @return The clear color
 449    * @note This property can be animated; the return value may not match the value written with SetClearColor().
 450    */
 451   Vector4 GetClearColor() const;
 452
 453   /**
 454    * @brief Sets whether the render-task will clear the results of previous render-tasks.
 455    *
 456    * The default is false.
 457    *
 458    * @SINCE_1_0.0
 459    * @param[in] enabled True if the render-task should clear
 460    * @note The default GL surface is cleared automatically at the
 461    * beginning of each frame; this setting is only useful when 2+
 462    * render-tasks are used, and the result of the first task needs to
 463    * be (partially) cleared before rendering the second.
 464    *
 465    */
 466   void SetClearEnabled(bool enabled);
 467
 468   /**
 469    * @brief Queries whether the render-task will clear the results of previous render-tasks.
 470    * @SINCE_1_0.0
 471    * @return True if the render-task should clear
 472    */
 473   bool GetClearEnabled() const;
 474
 475   /**
 476    * @brief Sets whether the render task will cull the actors to the camera's view frustum.
 477    *
 478    * @SINCE_1_0.0
 479    * @param[in] cullMode True if the renderers should be culled
 480    * @note The default mode is to cull actors.
 481    * @note If the shader uses @ref Shader::Hint::MODIFIES_GEOMETRY then culling optimizations are disabled.
 482    * @see Shader::Hint
 483    */
 484   void SetCullMode(bool cullMode);
 485
 486   /**
 487    * @brief Gets the cull mode.
 488    *
 489    * @SINCE_1_0.0
 490    * @return True if the render task should cull the actors to the camera's view frustum
 491    */
 492   bool GetCullMode() const;
 493
 494   /**
 495    * @brief Sets the refresh-rate of the RenderTask.
 496    *
 497    * The default is REFRESH_ALWAYS (1), meaning that the RenderTask
 498    * will be processed every frame if the scene graph is changing.  It
 499    * may be desirable to process less frequently. For example,
 500    * SetRefreshRate(3) will process once every 3 frames if the scene
 501    * graph is changing. If the scene graph is not changing, then the
 502    * render task will not be rendered, regardless of this value.
 503    *
 504    * The REFRESH_ONCE value means that the RenderTask will be
 505    * processed once only, to take a snap-shot of the scene.
 506    * Repeatedly calling SetRefreshRate(REFRESH_ONCE) will cause more
 507    * snap-shots to be taken.
 508    *
 509    * @SINCE_1_0.0
 510    * @param[in] refreshRate The new refresh rate
 511    */
 512   void SetRefreshRate(uint32_t refreshRate);
 513
 514   /**
 515    * @brief Queries the refresh-rate of the RenderTask.
 516    * @SINCE_1_0.0
 517    * @return The refresh-rate
 518    */
 519   uint32_t GetRefreshRate() const;
 520
 521   /**
 522    * @brief Gets viewport coordinates for given world position.
 523    *
 524    * @SINCE_1_1.13
 525    * @param[in] position The world position
 526    * @param[out] viewportX The viewport x position
 527    * @param[out] viewportY The viewport y position
 528    * @return true if the position has a screen coordinate
 529    */
 530   bool WorldToViewport(const Vector3& position, float& viewportX, float& viewportY) const;
 531
 532   /**
 533    * @brief Gets actor local coordinates for given viewport coordinates.
 534    *
 535    * @SINCE_1_1.13
 536    * @param[in] actor The actor describing local coordinate system
 537    * @param[in] viewportX The viewport x position
 538    * @param[in] viewportY The viewport y position
 539    * @param[out] localX The local x position
 540    * @param[out] localY The local y position
 541    * @return true if the screen position has a local coordinate
 542    */
 543   bool ViewportToLocal(Actor actor, float viewportX, float viewportY, float& localX, float& localY) const;
 544
 545   /**
 546    * Sets Render Pass key for this RenderTask.
 547    * Shader code that matches this render pass is used for rendering.
 548    * If no matching shader is found, the code with a render pass of 0 is used.
 549    * In other cases, operation is not guaranteed.
 550    * @param[in] renderPassTag RenderPassTag value for this render task.
 551    * @note RenderPassTag of default RenderTask is 0u.
 552    */
 553   void SetRenderPassTag(uint32_t renderPassTag);
 554
 555   /**
 556    * Gets Render Pass key for this RenderTask.
 557    * @return RenderPassTag value for this render task.
 558    */
 559   uint32_t GetRenderPassTag() const;
 560
 561   /**
 562    * Sets Order Index to define rendering order for this RenderTask.
 563    * In the DALi, offscreen renderTasks are rendered earlier than onscreen renderTask.
 564    * In each category of OffScreen RenderTask and OnScreen RenderTask,
 565    * a RenderTask with a smaller orderIndex is rendered first.
 566    * The RenderTasks in RenderTaskList is always sorted as acending order of the OrderIndex.
 567    * The OrderIndex value is needed to be set between [-1000, 1000].
 568    * Default orderIndex is 0.
 569    * @param[in] orderIndex the order index for this render task.
 570    * @note The order among RenderTasks whose OrderIndex has not changed follows the order in which they were created.
 571    * @note Rendering order among RenderTasks those have same OrderIndex cannot be guaranteed after the OrderIndex is changed
 572    */
 573   void SetOrderIndex(int32_t orderIndex);
 574
 575   /**
 576    * Gets Order Index for this RenderTask.
 577    * @return OrderIndex value for this render task.
 578    */
 579   int32_t GetOrderIndex() const;
 580
 581   /**
 582    * @brief Get the unique id of RenderTask. It could be 0 given render task is invalid.
 583    *
 584    * @SINCE_2_3.10
 585    * @return The unique id of RenderTask, or 0 if invalid.
 586    */
 587   uint32_t GetRenderTaskId() const;
 588
 589   /**
 590    * @brief Stop rendering from given actor. The actor is not included.
 591    * @SINCE_2_3.23
 592    * @param[in] stopperActor A marker to stop rendering.
 593    */
 594   void RenderUntil(Actor stopperActor);
 595
 596 public: // Signals
 597   /**
 598    * @brief If the refresh rate is REFRESH_ONCE, connect to this signal to be notified when a RenderTask has finished.
 599    * @SINCE_1_0.0
 600    * @return The signal to connect to
 601    */
 602   RenderTaskSignalType& FinishedSignal();
 603
 604 public: // Not intended for application developers
 605   /// @cond internal
 606   /**
 607    * @brief This constructor is used by Dali New() methods.
 608    * @SINCE_1_0.0
 609    * @param[in] renderTask A pointer to a newly allocated render-task
 610    */
 611   explicit DALI_INTERNAL RenderTask(Internal::RenderTask* renderTask);
 612   /// @endcond
 613 };
 614
 615 /**
 616  * @}
 617  */
 618 } // namespace Dali
 619
 620 #endif //DALI_RENDER_TASK_H