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 Stage::GetRenderTaskList() method 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   /**
  92    * @brief Enumeration for instances of properties belonging to the RenderTask class.
  93    * @SINCE_1_0.0
  94    */
  95   struct Property
  96   {
  97     /**
  98      * @brief Enumeration for instances of properties belonging to the RenderTask class.
  99      * @SINCE_1_0.0
 100      */
 101     enum
 102     {
 103       /**
 104        * @brief name "viewportPosition", type Vector2
 105        * @SINCE_1_0.0
 106        */
 107       VIEWPORT_POSITION = DEFAULT_OBJECT_PROPERTY_START_INDEX,
 108       /**
 109        * @brief name "viewportSize", type Vector2
 110        * @SINCE_1_0.0
 111        */
 112       VIEWPORT_SIZE,
 113       /**
 114        * @brief name "clearColor", type Vector4
 115        * @SINCE_1_0.0
 116        */
 117       CLEAR_COLOR,
 118       /**
 119        * @brief name "requiresSync", type BOOLEAN
 120        * @details By default, the sync object is not created.
 121        *  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.
 122        *  Thus the RENDER_ONCE finished signal can be emit at the correct timing.
 123        * @SINCE_1_1.29
 124        * @note The use of GL sync might cause deadlock with multiple access to the single pixmap happening in the same time.
 125        */
 126       REQUIRES_SYNC,
 127     };
 128   };
 129
 130   /**
 131    * @brief Typedef for signals sent by this class.
 132    * @SINCE_1_0.0
 133    */
 134   typedef Signal< void (RenderTask& source) > RenderTaskSignalType;
 135
 136   /**
 137    * @brief A pointer to a function for converting screen to frame-buffer coordinates.
 138    * @SINCE_1_0.0
 139    * @param[in,out] coordinates The screen coordinates to convert where (0,0) is the top-left of the screen
 140    * @return True if the conversion was successful, otherwise coordinates should be unmodified
 141    */
 142   typedef bool (* ScreenToFrameBufferFunction)( Vector2& coordinates );
 143
 144   /**
 145    * @brief A pointer to a function for converting screen to frame-buffer coordinates.
 146    * @SINCE_1_0.0
 147    * @param[in,out] coordinates The screen coordinates to convert where (0,0) is the top-left of the screen
 148    * @return True if the conversion was successful, otherwise coordinates should be unmodified
 149    */
 150   typedef bool (* const ConstScreenToFrameBufferFunction)( Vector2& coordinates );
 151
 152   /**
 153    * @brief The default conversion function returns false for any screen coordinates.
 154    *
 155    * This effectively disables hit-testing for RenderTasks rendering to a frame buffer.
 156    * See also FULLSCREEN_FRAMEBUFFER_FUNCTION below.
 157    */
 158   static ConstScreenToFrameBufferFunction DEFAULT_SCREEN_TO_FRAMEBUFFER_FUNCTION;
 159
 160   /**
 161    * @brief This conversion function outputs the (unmodified) screen coordinates as frame-buffer coordinates.
 162    *
 163    * Therefore the contents of an off-screen image is expected to be rendered "full screen".
 164    */
 165   static ConstScreenToFrameBufferFunction FULLSCREEN_FRAMEBUFFER_FUNCTION;
 166
 167   /**
 168    * @brief Enumeration for the refresh-rate of the RenderTask.
 169    * @SINCE_1_0.0
 170    */
 171   enum RefreshRate
 172   {
 173     REFRESH_ONCE   = 0, ///< Process once only e.g. take a snap-shot of the scene. @SINCE_1_0.0
 174     REFRESH_ALWAYS = 1  ///< Process every frame. @SINCE_1_0.0
 175   };
 176
 177   static const bool     DEFAULT_EXCLUSIVE;     ///< false
 178   static const bool     DEFAULT_INPUT_ENABLED; ///< true
 179   static const Vector4  DEFAULT_CLEAR_COLOR;   ///< Color::BLACK
 180   static const bool     DEFAULT_CLEAR_ENABLED; ///< false
 181   static const bool     DEFAULT_CULL_MODE;     ///< true
 182   static const uint32_t DEFAULT_REFRESH_RATE;  ///< REFRESH_ALWAYS
 183
 184   /**
 185    * @brief Creates an empty RenderTask handle.
 186    *
 187    * This can be initialised with RenderTaskList::CreateRenderTask().
 188    * @SINCE_1_0.0
 189    */
 190   RenderTask();
 191
 192   /**
 193    * @brief Downcasts a handle to RenderTask handle.
 194    *
 195    * If handle points to a RenderTask, the
 196    * downcast produces valid handle. If not, the returned handle is left uninitialized.
 197    * @SINCE_1_0.0
 198    * @param[in] handle A handle to an object
 199    * @return A handle to a RenderTask or an uninitialized handle
 200    */
 201   static RenderTask DownCast( BaseHandle handle );
 202
 203   /**
 204    * @brief Destructor.
 205    *
 206    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 207    * @SINCE_1_0.0
 208    */
 209   ~RenderTask();
 210
 211   /**
 212    * @brief This copy constructor is required for (smart) pointer semantics.
 213    *
 214    * @SINCE_1_0.0
 215    * @param[in] handle A reference to the copied handle
 216    */
 217   RenderTask(const RenderTask& handle);
 218
 219   /**
 220    * @brief This assignment operator is required for (smart) pointer semantics.
 221    *
 222    * @SINCE_1_0.0
 223    * @param[in] rhs A reference to the copied handle
 224    * @return A reference to this
 225    */
 226   RenderTask& operator=(const RenderTask& rhs);
 227
 228   /**
 229    * @brief Sets the actors to be rendered.
 230    * @SINCE_1_0.0
 231    * @param[in] actor This actor and its children will be rendered.
 232    * If actor is an empty handle, then nothing will be rendered
 233    */
 234   void SetSourceActor( Actor actor );
 235
 236   /**
 237    * @brief Retrieves the actors to be rendered.
 238    * @SINCE_1_0.0
 239    * @return This actor and its children will be rendered
 240    */
 241   Actor GetSourceActor() const;
 242
 243   /**
 244    * @brief Sets whether the RenderTask has exclusive access to the source actors; the default is false.
 245    * @SINCE_1_0.0
 246    * @param[in] exclusive True if the source actors will only be rendered by this render-task
 247    */
 248   void SetExclusive( bool exclusive );
 249
 250   /**
 251    * @brief Queries whether the RenderTask has exclusive access to the source actors.
 252    * @SINCE_1_0.0
 253    * @return True if the source actors will only be rendered by this render-task
 254    */
 255   bool IsExclusive() const;
 256
 257   /**
 258    * @brief Sets whether the render-task should be considered for input handling; the default is true.
 259    *
 260    * The task used for input handling will be last task in the RenderTaskList which has input enabled,
 261    * and has a valid source & camera actor.
 262    * A RenderTask targetting a frame-buffer can still be hit-tested, provided that the screen->frame-buffer
 263    * coordinate conversion is successful; see also SetScreenToFrameBufferFunction().
 264    * @SINCE_1_0.0
 265    * @param[in] enabled True if the render-task should be considered for input handling
 266    */
 267   void SetInputEnabled( bool enabled );
 268
 269   /**
 270    * @brief Queries whether the render-task should be considered for input handling.
 271    * @SINCE_1_0.0
 272    * @return True if the render-task should be considered for input handling
 273    */
 274   bool GetInputEnabled() const;
 275
 276   /**
 277    * @brief Sets the actor from which the scene is viewed.
 278    * @SINCE_1_0.0
 279    * @param[in] cameraActor The scene is viewed from the perspective of this actor
 280    */
 281   void SetCameraActor( CameraActor cameraActor );
 282
 283   /**
 284    * @brief Retrieves the actor from which the scene is viewed.
 285    * @SINCE_1_0.0
 286    * @return The scene is viewed from the perspective of this actor
 287    */
 288   CameraActor GetCameraActor() const;
 289
 290   /**
 291    * @brief Sets the frame-buffer used as a render target.
 292    * @SINCE_1_1.38
 293    * @param[in] frameBuffer A valid FrameBuffer handle to enable off-screen rendering, or an uninitialized handle to disable it
 294    */
 295   void SetFrameBuffer( FrameBuffer frameBuffer );
 296
 297   /**
 298    * @brief Retrieves the frame-buffer used as a render target.
 299    * @SINCE_1_1.38
 300    * @return The framebuffer
 301    */
 302   FrameBuffer GetFrameBuffer() const;
 303
 304   /**
 305    * @brief Sets the function used to convert screen coordinates to frame-buffer coordinates.
 306    *
 307    * This is useful for hit-testing actors which are rendered off-screen.
 308    * @SINCE_1_0.0
 309    * @param[in] conversionFunction The conversion function
 310    */
 311   void SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction );
 312
 313   /**
 314    * @brief Retrieves the function used to convert screen coordinates to frame-buffer coordinates.
 315    * @SINCE_1_0.0
 316    * @return The conversion function
 317    */
 318   ScreenToFrameBufferFunction GetScreenToFrameBufferFunction() const;
 319
 320   /**
 321    * @brief Sets the actor used to convert screen coordinates to frame-buffer coordinates.
 322    *
 323    * The local coordinates of the actor are mapped as frame-buffer coordinates.
 324    * This is useful for hit-testing actors which are rendered off-screen.
 325    * @SINCE_1_0.0
 326    * @param[in] mappingActor The actor used for conversion
 327    * @note The mapping actor needs to be rendered by the default render task to make the mapping work properly.
 328    */
 329   void SetScreenToFrameBufferMappingActor( Actor mappingActor );
 330
 331   /**
 332    * @brief Retrieves the actor used to convert screen coordinates to frame-buffer coordinates.
 333    * @SINCE_1_0.0
 334    * @return The actor used for conversion
 335    */
 336   Actor GetScreenToFrameBufferMappingActor() const;
 337
 338   /**
 339    * @brief Sets the GL viewport position used when rendering.
 340    *
 341    * This specifies the transformation between normalized device coordinates and target window (or frame-buffer) coordinates.
 342    * By default this will match the target window or frame-buffer size.
 343    * @SINCE_1_0.0
 344    * @param[in] position The viewports position (x,y)
 345    * @note Unlike the glViewport method, the x & y coordinates refer to the top-left of the viewport rectangle.
 346    */
 347   void SetViewportPosition( Vector2 position );
 348
 349   /**
 350    * @brief Retrieves the GL viewport position used when rendering.
 351    * @SINCE_1_0.0
 352    * @return The viewport
 353    */
 354   Vector2 GetCurrentViewportPosition() const;
 355
 356   /**
 357    * @brief Sets the GL viewport size used when rendering.
 358    *
 359    * This specifies the transformation between normalized device coordinates and target window (or frame-buffer) coordinates.
 360    * By default this will match the target window or frame-buffer size.
 361    * @SINCE_1_0.0
 362    * @param[in] size The viewports size (width,height)
 363    */
 364   void SetViewportSize( Vector2 size );
 365
 366   /**
 367    * @brief Retrieves the GL viewport size used when rendering.
 368    * @SINCE_1_0.0
 369    * @return The viewport
 370    */
 371   Vector2 GetCurrentViewportSize() const;
 372
 373   /**
 374    * @brief Sets the GL viewport used when rendering.
 375    *
 376    * This specifies the transformation between normalized device coordinates and target window (or frame-buffer) coordinates.
 377    * By default this will match the target window or frame-buffer size.
 378    * @SINCE_1_0.0
 379    * @param[in] viewport The new viewport
 380    * @note Unlike the glViewport method, the x & y coordinates refer to the top-left of the viewport rectangle.
 381    */
 382   void SetViewport( Viewport viewport );
 383
 384   /**
 385    * @brief Retrieves the GL viewport used when rendering.
 386    * @SINCE_1_0.0
 387    * @return The viewport
 388    */
 389   Viewport GetViewport() const;
 390
 391   /**
 392    * @brief Sets the clear color used when SetClearEnabled(true) is used.
 393    * @SINCE_1_0.0
 394    * @param[in] color The new clear color
 395    */
 396   void SetClearColor( const Vector4& color );
 397
 398   /**
 399    * @brief Retrieves the clear color used when SetClearEnabled(true) is used.
 400    * @SINCE_1_0.0
 401    * @return The clear color
 402    * @note This property can be animated; the return value may not match the value written with SetClearColor().
 403    */
 404   Vector4 GetClearColor() const;
 405
 406   /**
 407    * @brief Sets whether the render-task will clear the results of previous render-tasks.
 408    *
 409    * The default is false.
 410    *
 411    * @SINCE_1_0.0
 412    * @param[in] enabled True if the render-task should clear
 413    * @note The default GL surface is cleared automatically at the
 414    * beginning of each frame; this setting is only useful when 2+
 415    * render-tasks are used, and the result of the first task needs to
 416    * be (partially) cleared before rendering the second.
 417    *
 418    */
 419   void SetClearEnabled( bool enabled );
 420
 421   /**
 422    * @brief Queries whether the render-task will clear the results of previous render-tasks.
 423    * @SINCE_1_0.0
 424    * @return True if the render-task should clear
 425    */
 426   bool GetClearEnabled() const;
 427
 428   /**
 429    * @brief Sets whether the render task will cull the actors to the camera's view frustum.
 430    *
 431    * @SINCE_1_0.0
 432    * @param[in] cullMode True if the renderers should be culled
 433    * @note The default mode is to cull actors.
 434    * @note If the shader uses @ref Shader::Hint::MODIFIES_GEOMETRY then culling optimizations are disabled.
 435    * @see Shader::Hint
 436    */
 437   void SetCullMode( bool cullMode );
 438
 439   /**
 440    * @brief Gets the cull mode.
 441    *
 442    * @SINCE_1_0.0
 443    * @return True if the render task should cull the actors to the camera's view frustum
 444    */
 445   bool GetCullMode() const;
 446
 447   /**
 448    * @brief Sets the refresh-rate of the RenderTask.
 449    *
 450    * The default is REFRESH_ALWAYS (1), meaning that the RenderTask
 451    * will be processed every frame if the scene graph is changing.  It
 452    * may be desirable to process less frequently. For example,
 453    * SetRefreshRate(3) will process once every 3 frames if the scene
 454    * graph is changing. If the scene graph is not changing, then the
 455    * render task will not be rendered, regardless of this value.
 456    *
 457    * The REFRESH_ONCE value means that the RenderTask will be
 458    * processed once only, to take a snap-shot of the scene.
 459    * Repeatedly calling SetRefreshRate(REFRESH_ONCE) will cause more
 460    * snap-shots to be taken.
 461    *
 462    * @SINCE_1_0.0
 463    * @param[in] refreshRate The new refresh rate
 464    */
 465   void SetRefreshRate( uint32_t refreshRate );
 466
 467   /**
 468    * @brief Queries the refresh-rate of the RenderTask.
 469    * @SINCE_1_0.0
 470    * @return The refresh-rate
 471    */
 472   uint32_t GetRefreshRate() const;
 473
 474   /**
 475    * @brief Gets viewport coordinates for given world position.
 476    *
 477    * @SINCE_1_1.13
 478    * @param[in] position The world position
 479    * @param[out] viewportX The viewport x position
 480    * @param[out] viewportY The viewport y position
 481    * @return true if the position has a screen coordinate
 482    */
 483   bool WorldToViewport(const Vector3 &position, float& viewportX, float& viewportY) const;
 484
 485   /**
 486    * @brief Gets actor local coordinates for given viewport coordinates.
 487    *
 488    * @SINCE_1_1.13
 489    * @param[in] actor The actor describing local coordinate system
 490    * @param[in] viewportX The viewport x position
 491    * @param[in] viewportY The viewport y position
 492    * @param[out] localX The local x position
 493    * @param[out] localY The local y position
 494    * @return true if the screen position has a local coordinate
 495    */
 496   bool ViewportToLocal(Actor actor, float viewportX, float viewportY, float &localX, float &localY) const;
 497
 498 public: // Signals
 499
 500   /**
 501    * @brief If the refresh rate is REFRESH_ONCE, connect to this signal to be notified when a RenderTask has finished.
 502    * @SINCE_1_0.0
 503    * @return The signal to connect to
 504    */
 505   RenderTaskSignalType& FinishedSignal();
 506
 507 public: // Not intended for application developers
 508
 509   /// @cond internal
 510   /**
 511    * @brief This constructor is used by Dali New() methods.
 512    * @SINCE_1_0.0
 513    * @param[in] renderTask A pointer to a newly allocated render-task
 514    */
 515   explicit DALI_INTERNAL RenderTask( Internal::RenderTask* renderTask );
 516   /// @endcond
 517 };
 518
 519 /**
 520  * @}
 521  */
 522 } // namespace Dali
 523
 524 #endif //DALI_RENDER_TASK_H