From: Sergey Sizonov <s.sizonov@samsung.com>
Date: Thu, 14 Dec 2017 12:48:19 +0000 (+0300)
Subject: add some comments
X-Git-Tag: accepted/tizen/unified/20171219.072724~2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=78f4a6d03360c3cb776a0532db76b75a34ef4421;p=platform%2Fcore%2Fuifw%2Flibtdm.git

add some comments

Change-Id: I14ad80d9ded4cd81b43d94f21fcc479963182c7a
Signed-off-by: Sergey Sizonov <s.sizonov@samsung.com>
---

diff --git a/include/tdm.h b/include/tdm.h
index ededcb1..2c0ba6a 100644
--- a/include/tdm.h
+++ b/include/tdm.h
@@ -614,13 +614,19 @@ tdm_output_hwc_destroy_window(tdm_output *output, tdm_hwc_window *hwc_window);
  * The damage parameter describes a buffer damage region as defined in the
  * description of tdm_hwc_window_set_buffer_damage().
  *
- * Will be called before tdm_output_commit() if any of the layers are marked as
+ * List of composited hwc_windows (hwc_windows which buffers are presented on #target_buffer)
+ * should be passed along with #target_buffer to allow tdm to make the smooth transition
+ * from a DEVICE type to a CLIENT type.
+ *
+ * Should be called before tdm_output_commit() if any of the layers are marked as
  * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
  * so marked, then it is not necessary to call this function. It is not necessary
  * to call tdm_output_hwc_validate() after changing the target through this function.
  * @param[in] output A output object
- * @param[in] target The new target buffer
+ * @param[in] target_buffer The new target buffer
  * @param[in] damage The buffer damage region
+ * @param[in] composited_wnds The array of composited hwc_wnds
+ * @param[in] num_wnds The size of #composited_wnds array
  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
  * @since 2.0.0
  */
@@ -1035,6 +1041,9 @@ tdm_hwc_window_set_info(tdm_hwc_window *hwc_window, tdm_hwc_window_info *info);
  * @param[in] hwc_window A window object
  * @param[in] buffer A TDM buffer
  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return #TDM_ERROR_BUSY if #hwc_window can't be updated right now, this
+ * can happen if #hwc_window is involved in the smooth transition from
+ * DEVICE to CLIENT, this shouldn't be interpreted like some critical error.
  * @since 2.0.0
  */
 tdm_error
diff --git a/include/tdm_backend.h b/include/tdm_backend.h
index 3910184..99eff29 100644
--- a/include/tdm_backend.h
+++ b/include/tdm_backend.h
@@ -576,6 +576,10 @@ typedef struct _tdm_func_output {
 	 * The damage parameter describes a buffer damage region as defined in the
 	 * description of hwc_window_set_buffer_damage().
 	 *
+	 * List of composited hwc_windows (hwc_windows which buffers are presented on #target_buffer)
+	 * will be passed along with #target_buffer to allow tdm to make the smooth transition
+	 * from a DEVICE type to a CLIENT type.
+	 *
 	 * Will be called before output_commit() if any of the layers are marked as
 	 * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
 	 * so marked, then it is not necessary to call this function. It is not necessary
@@ -583,6 +587,8 @@ typedef struct _tdm_func_output {
 	 * @param[in] output A output object
 	 * @param[in] target The new target buffer
 	 * @param[in] damage The buffer damage region
+	 * @param[in] composited_wnds The array of composited hwc_wnds
+	 * @param[in] num_wnds The size of #composited_wnds array
 	 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 	 * @since 2.0.0
 	 */
@@ -891,6 +897,10 @@ typedef struct _tdm_func_window {
 	 * @param[in] hwc_window A window object
 	 * @param[in] buffer A TDM buffer
 	 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+	 *
+	 * Implementation should return #TDM_ERROR_BUSY if #hwc_window can't
+	 * be updated right now, this won't be interpreted like some critical
+	 * error.
 	 */
 	tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
 									   tbm_surface_h buffer);