vblank: return TDM_ERROR_TIMEOUT when timeout occurs

[platform/core/uifw/libtdm.git] / include / tdm_helper.h

diff --git a/include/tdm_helper.h b/include/tdm_helper.h
index 459b1b1..8bae8fa 100644 (file)
--- a/include/tdm_helper.h
+++ b/include/tdm_helper.h
@@ -76,6 +76,28 @@ void
 tdm_helper_dump_buffer(tbm_surface_h buffer, const char *file);
 
 /**
+ * @brief fill a buffer with 0 for given pos.
+ * @details
+ * This function supports only if a buffer has below formats.
+ * - TBM_FORMAT_ARGB8888
+ * - TBM_FORMAT_XRGB8888
+ * @param[in] buffer A TDM buffer
+ */
+void
+tdm_helper_clear_buffer_pos(tbm_surface_h buffer, tdm_pos *pos);
+
+/**
+ * @brief fill a buffer with 0 for given pos.
+ * @details
+ * This function supports only if a buffer has below formats.
+ * - TBM_FORMAT_ARGB8888
+ * - TBM_FORMAT_XRGB8888
+ * @param[in] buffer A TDM buffer
+ */
+void
+tdm_helper_clear_buffer_color(tbm_surface_h buffer, tdm_pos *pos, unsigned int color);
+
+/**
  * @brief fill a buffer with 0.
  * @details
  * This function supports only if a buffer has below formats.
@@ -93,14 +115,35 @@ void
 tdm_helper_clear_buffer(tbm_surface_h buffer);
 
 /**
+ * @brief Get the buffer full size.
+ * @details
+ * In some hardware, the buffer width or height is aligned with the fixed size.
+ * eg. 8, 16, etc. In this case, the real size of buffer could be bigger than
+ * the buffer size of tbm_surface_info_s.
+ * @param[in] buffer A TDM buffer
+ */
+void
+tdm_helper_get_buffer_full_size(tbm_surface_h buffer, int *buffer_w, int *buffer_h);
+
+/**
+ * @brief convert the source buffer to the destination buffer with given rectangles
+ * trannsform
+ * @details
+ * This function supports only if buffers have below formats.
+ * - TBM_FORMAT_ARGB8888
+ * - TBM_FORMAT_XRGB8888
+ * @param[in] buffer A TDM buffer
+ */
+tdm_error
+tdm_helper_convert_buffer(tbm_surface_h srcbuf, tbm_surface_h dstbuf,
+                                                 tdm_pos *srcpos, tdm_pos *dstpos,
+                                                 tdm_transform transform, int over);
+
+/**
  * @brief Get a fd from the given enviroment variable.
  * @details
  * This function will dup the fd of the given enviroment variable. The Caller
  * @b SHOULD close the fd.
- * \n
- * In DRM system, a drm-master-fd @b SHOULD be shared between TDM backend and
- * TBM backend in display server side by using "TDM_DRM_MASTER_FD"
- * and "TBM_DRM_MASTER_FD".
  * @param[in] env The given enviroment variable
  * @return fd if success. Otherwise, -1.
  * @see #tdm_helper_set_fd()
@@ -109,10 +152,6 @@ int tdm_helper_get_fd(const char *env);
 
 /**
  * @brief Set the given fd to the give enviroment variable.
- * @details
- * In DRM system, a drm-master-fd @b SHOULD be shared between TDM backend and
- * TBM backend in display server side by using "TDM_DRM_MASTER_FD"
- * and "TBM_DRM_MASTER_FD".
  * @param[in] env The given enviroment variable
  * @param[in] fd The given fd
  * @see #tdm_helper_get_fd()
@@ -178,6 +217,24 @@ tdm_helper_capture_output(tdm_output *output, tbm_surface_h dst_buffer,
 void
 tdm_helper_get_display_information(tdm_display *dpy, char *reply, int *len);
 
+/**
+ * @brief Get whether the commit-per-vblank functionality is enabled or not.
+ * @param[in] dpy A display object
+ * @return 1 if enabled. Otherwise, 0.
+ *
+ * @deprecated use @c tdm_helper_output_commit_per_vblank_enabled instead
+ */
+int
+tdm_helper_commit_per_vblank_enabled(tdm_display *dpy);
+
+/**
+ * @brief Get whether the commit-per-vblank functionality is enabled or not for the output.
+ * @param[in] output An output the functionality has to be checked for
+ * @return -1 if error occurred, 1 if enabled, 0 if disabled.
+ */
+int
+tdm_helper_output_commit_per_vblank_enabled(tdm_output *output);
+
 #ifdef __cplusplus
 }
 #endif