* 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
tdm_client_handle_events(tdm_client *client);
/**
+ * @brief Handle the events of the given file descriptor with millisecond timeout
+ * @details
+ * -1: infinite. 0: return immediately. Otherwise, waiting for ms_timeout milliseconds.
+ * @param[in] client A TDM client object
+ * @param[in] ms_timeout timeout value.
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see #tdm_client_get_fd
+ */
+tdm_error
+tdm_client_handle_events_timeout(tdm_client *client, int ms_timeout);
+
+/**
* @brief @b Deprecated. Wait for VBLANK.
* @deprecated
* @details After interval vblanks, a client vblank handler will be called.
tdm_client_output_get_refresh_rate(tdm_client_output *output, unsigned int *refresh);
/**
+ * @brief Get the width and height of the given client output mode
+ * @param[in] output The client output object
+ * @param[out] width The width of output mode
+ * @param[out] height The height of output mode
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_client_output_get_mode(tdm_client_output *output, unsigned int *width, unsigned int *height);
+
+/**
* @brief Get the connection status of the given client output
* @param[in] output The client output object
* @param[out] status The connection status
tdm_error
tdm_client_vblank_wait_seq(tdm_client_vblank *vblank, unsigned int sequence, tdm_client_vblank_handler func, void *user_data);
+/**
+ * @brief Check if the client vblank object is waiting a vblank event
+ * @param[in] vblank The client vblank object
+ * @return 1 if waiting. 0 if not waiting.
+ */
+unsigned int
+tdm_client_vblank_is_waiting(tdm_client_vblank *vblank);
+
+
+/**
+ * @brief Create the client voutput object which has the given name
+ * @param[in] client The TDM client object
+ * @param[in] name The name of the TDM client virtual output object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A client voutput object if success. Otherwise, NULL.
+ */
+tdm_client_voutput *
+tdm_client_create_voutput(tdm_client *client, const char *name, tdm_error *error);
+
+/**
+ * @brief Destroy the client voutput object
+ * @param[in] voutput The client voutput object
+ */
+void
+tdm_client_voutput_destroy(tdm_client_voutput *voutput);
+
+/**
+ * @brief Set the available mode info to the client voutput object
+ * @param[in] voutput The client voutput object
+ * @param[in] modes The array of available mode info
+ * @param[in] count The mode count
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_client_voutput_set_available_modes(tdm_client_voutput *voutput, const tdm_client_output_mode *modes, int count);
+
+/**
+ * @brief Set the physical size info to the client voutput object
+ * @param[in] voutput The client voutput object
+ * @param[in] mmWidth The width of voutput
+ * @param[in] mmHeight The height of voutput
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_client_voutput_set_physical_size(tdm_client_voutput *voutput, unsigned int mmWidth, unsigned int mmHeight);
+
+/**
+ * @brief Set the client voutput buffer commit handler
+ * @details The handler will be called when server send buffer.
+ * Client can get the committed buffer in the handler function.
+ * @param[in] voutput The client voutput object
+ * @param[in] func The user client voutput buffer commit handler
+ * @param[in] user_data The user_data
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_client_voutput_add_commit_handler(tdm_client_voutput *voutput, tdm_client_voutput_commit_handler func, void *user_data);
+
+/**
+ * @brief Remove the client voutput buffer commit handler
+ * @param[in] voutput The client voutput object
+ * @param[in] func The user client voutput buffer commit handler
+ * @param[in] user_data The user_data
+ */
+void
+tdm_client_voutput_remove_commit_handler(tdm_client_voutput *voutput, tdm_client_voutput_commit_handler func, void *user_data);
+
+/**
+ * @brief Send the commit done event to server
+ * @details
+ * After using the commited buffer which is get from commit handler
+ * have to send done event to server.
+ * @param[in] voutput The client voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_client_voutput_commit_done(tdm_client_voutput *voutput);
+
+/**
+ * @brief Get the client output object which was created by the given voutput object
+ * @details
+ * The client output object is made by voutput object.
+ * @param[in] voutput The client voutput object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A client output object if success. Otherwise, NULL.
+ */
+tdm_client_output *
+tdm_client_voutput_get_client_output(tdm_client_voutput *voutput, tdm_error *error);
+
+/**
+ * @brief Set the mode to the client voutput object
+ * details
+ * The client can set the mode of voutput object by send mode index.
+ * the index is the array number of available modes info.
+ * @param[in] voutput The client voutput object
+ * @param[in] modes The array of available mode info
+ * @param[in] index The index of avaliable modes
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_client_voutput_set_mode(tdm_client_voutput *voutput, int index);
+
+/**
+ * @brief Set the client voutput object connected status
+ * @detail Send availabe_modes, physical size and connect info to the server.
+ * @param[in] voutput The client voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_client_voutput_connect(tdm_client_voutput *voutput);
+
+/**
+ * @brief Set the client voutput object disconnected status
+ * @param[in] voutput The client voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+tdm_error
+tdm_client_voutput_disconnect(tdm_client_voutput *voutput);
+
#ifdef __cplusplus
}
#endif
projects / platform / core / uifw / libtdm.git / blobdiff