correct email address
[platform/core/uifw/libtdm.git] / include / tdm.h
index 9ae31a3..0f9bf5d 100644 (file)
@@ -9,7 +9,7 @@
  *          Taeheon Kim <th908.kim@samsung.com>,
  *          YoungJun Cho <yj44.cho@samsung.com>,
  *          SooChan Lim <sc1.lim@samsung.com>,
- *          Boram Park <sc1.lim@samsung.com>
+ *          Boram Park <boram1288.park@samsung.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the
@@ -96,6 +96,13 @@ tdm_error
 tdm_display_handle_events(tdm_display *dpy);
 
 /**
+ * @brief Flush the all events to clients
+ * @param[in] dpy A display object
+ */
+void
+tdm_display_flush(tdm_display *dpy);
+
+/**
  * @brief Get the capabilities of a display object.
  * @details A frontend user can get whether TDM supports pp/capture functionality with this function.
  * @param[in] dpy A display object
@@ -200,6 +207,16 @@ tdm_output *
 tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error);
 
 /**
+ * @brief Find a output object which has the given name.
+ * @param[in] dpy A display object
+ * @param[in] name The name of a output object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A output object if success. Otherwise, NULL.
+ */
+tdm_output *
+tdm_display_find_output(tdm_display *dpy, const char *name, tdm_error *error);
+
+/**
  * @brief Create a pp object.
  * @param[in] dpy A display object
  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
@@ -211,24 +228,24 @@ tdm_display_create_pp(tdm_display *dpy, tdm_error *error);
 
 /**
  * @brief Get the information of the TDM backend module.
- * @param[in] backend A backend object
+ * @param[in] module A backend module object
  * @param[out] name The name of the TDM backend module
  * @param[out] vendor The vendor of the TDM backend module
  * @param[out] version The version of the TDM backend module
  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
  */
 tdm_error
-tdm_backend_get_info(tdm_backend *backend, const char **name,
-                                        const char **vendor, int *major, int *minor);
+tdm_module_get_info(tdm_module *module, const char **name,
+                                       const char **vendor, int *major, int *minor);
 
 /**
- * @brief Get a backend object of the given output.
+ * @brief Get a backend module object of the given output.
  * @param[in] output A output object
  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
  * @return A backend object if success. Otherwise, NULL.
  */
-tdm_backend *
-tdm_output_get_backend(tdm_output *output, tdm_error *error);
+tdm_module *
+tdm_output_get_backend_module(tdm_output *output, tdm_error *error);
 
 /**
  * @brief Get the capabilities of a output object.
@@ -531,6 +548,15 @@ tdm_error
 tdm_output_get_dpms(tdm_output *output, tdm_output_dpms *dpms_value);
 
 /**
+ * @brief Check if a output object has the capture capability
+ * @param[in] output A output object
+ * @param[out] has_capability 1: has the capability, 0: not has the capability
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_output_has_capture_capability(tdm_output *output, unsigned int *has_capability);
+
+/**
  * @brief Create a capture object of a output object
  * @param[in] output A output object
  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
@@ -745,6 +771,15 @@ tdm_output*
 tdm_layer_get_output(tdm_layer *layer, tdm_error *error);
 
 /**
+ * @brief Get the index of a layer object.
+ * @param[in] layer A layer object
+ * @param[out] index The index of a layer object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_layer_get_index(tdm_layer *layer, int *index);
+
+/**
  * @brief Get the capabilities of a layer object.
  * @param[in] layer A layer object
  * @param[out] capabilities The capabilities of a layer object