[dali_2.3.33] Merge branch 'devel/master'

[platform/core/uifw/dali-core.git] / dali / public-api / render-tasks / render-task.h

diff --git a/dali/public-api/render-tasks/render-task.h b/dali/public-api/render-tasks/render-task.h
index 683a97e..e00eea8 100644 (file)
--- a/dali/public-api/render-tasks/render-task.h
+++ b/dali/public-api/render-tasks/render-task.h
@@ -257,6 +257,13 @@ public:
   Actor GetSourceActor() const;
 
   /**
+   * @brief Retrives stopper actor.
+   * @SINCE_2_3.23
+   * @return The actor that marks where to stop rendering.
+   */
+  Actor GetStopperActor() const;
+
+  /**
    * @brief Sets whether the RenderTask has exclusive access to the source actors; the default is false.
    * @SINCE_1_0.0
    * @param[in] exclusive True if the source actors will only be rendered by this render-task
@@ -535,6 +542,57 @@ public:
    */
   bool ViewportToLocal(Actor actor, float viewportX, float viewportY, float& localX, float& localY) const;
 
+  /**
+   * Sets Render Pass key for this RenderTask.
+   * Shader code that matches this render pass is used for rendering.
+   * If no matching shader is found, the code with a render pass of 0 is used.
+   * In other cases, operation is not guaranteed.
+   * @param[in] renderPassTag RenderPassTag value for this render task.
+   * @note RenderPassTag of default RenderTask is 0u.
+   */
+  void SetRenderPassTag(uint32_t renderPassTag);
+
+  /**
+   * Gets Render Pass key for this RenderTask.
+   * @return RenderPassTag value for this render task.
+   */
+  uint32_t GetRenderPassTag() const;
+
+  /**
+   * Sets Order Index to define rendering order for this RenderTask.
+   * In the DALi, offscreen renderTasks are rendered earlier than onscreen renderTask.
+   * In each category of OffScreen RenderTask and OnScreen RenderTask,
+   * a RenderTask with a smaller orderIndex is rendered first.
+   * The RenderTasks in RenderTaskList is always sorted as acending order of the OrderIndex.
+   * The OrderIndex value is needed to be set between [-1000, 1000].
+   * Default orderIndex is 0.
+   * @param[in] orderIndex the order index for this render task.
+   * @note The order among RenderTasks whose OrderIndex has not changed follows the order in which they were created.
+   * @note Rendering order among RenderTasks those have same OrderIndex cannot be guaranteed after the OrderIndex is changed
+   */
+  void SetOrderIndex(int32_t orderIndex);
+
+  /**
+   * Gets Order Index for this RenderTask.
+   * @return OrderIndex value for this render task.
+   */
+  int32_t GetOrderIndex() const;
+
+  /**
+   * @brief Get the unique id of RenderTask. It could be 0 given render task is invalid.
+   *
+   * @SINCE_2_3.10
+   * @return The unique id of RenderTask, or 0 if invalid.
+   */
+  uint32_t GetRenderTaskId() const;
+
+  /**
+   * @brief Stop rendering from given actor. The actor is not included.
+   * @SINCE_2_3.23
+   * @param[in] stopperActor A marker to stop rendering.
+   */
+  void RenderUntil(Actor stopperActor);
+
 public: // Signals
   /**
    * @brief If the refresh rate is REFRESH_ONCE, connect to this signal to be notified when a RenderTask has finished.