X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Ftdm.h;h=0f9bf5df6446451e34f1e63774197f6308c066a9;hb=e6035c2be184ee7fc40a7425a70b8f4d583246d0;hp=7aee6b8959991c0323ac6f39c6a635baf8197e1d;hpb=4f27d4f31e3281c07f131d9a089ab5a7d6c01a97;p=platform%2Fcore%2Fuifw%2Flibtdm.git diff --git a/include/tdm.h b/include/tdm.h index 7aee6b8..0f9bf5d 100644 --- a/include/tdm.h +++ b/include/tdm.h @@ -9,7 +9,7 @@ * Taeheon Kim , * YoungJun Cho , * SooChan Lim , - * Boram Park + * Boram Park * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the @@ -43,6 +43,7 @@ #include #include "tdm_types.h" +#include "tdm_deprecated.h" #ifdef __cplusplus extern "C" { @@ -58,24 +59,6 @@ extern "C" { */ /** - * @brief The display capability enumeration - */ -typedef enum { - TDM_DISPLAY_CAPABILITY_PP = (1 << 0), /**< if hardware supports pp operation */ - TDM_DISPLAY_CAPABILITY_CAPTURE = (1 << 1), /**< if hardware supports capture operation */ -} tdm_display_capability; - -/** - * @brief The output change handler - * @details This handler will be called when the status of a output object is - * changed in runtime. - */ -typedef void (*tdm_output_change_handler)(tdm_output *output, - tdm_output_change_type type, - tdm_value value, - void *user_data); - -/** * @brief Initialize a display object * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. * @return A display object @@ -93,17 +76,6 @@ void tdm_display_deinit(tdm_display *dpy); /** - * @brief Update a display object - * @details - * When new output is connected, a frontend user need to call this function. - * And a frontend user can the new output information with tdm_output_get_xxx functions. - * @param[in] dpy A display object - * @return #TDM_ERROR_NONE if success. Otherwise, error value. - */ -tdm_error -tdm_display_update(tdm_display *dpy); - -/** * @brief Get the file descriptor * @details TDM handles the events of fd with #tdm_display_handle_events. * @param[in] dpy A display object @@ -124,16 +96,11 @@ tdm_error tdm_display_handle_events(tdm_display *dpy); /** - * @brief Get the information of the TDM backend module. + * @brief Flush the all events to clients * @param[in] dpy A display 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_display_get_backend_info(tdm_display *dpy, const char **name, - const char **vendor, int *major, int *minor); +void +tdm_display_flush(tdm_display *dpy); /** * @brief Get the capabilities of a display object. @@ -200,7 +167,7 @@ tdm_display_get_capture_capabilities(tdm_display *dpy, * @return #TDM_ERROR_NONE if success. Otherwise, error value. */ tdm_error -tdm_display_get_catpure_available_formats(tdm_display *dpy, +tdm_display_get_capture_available_formats(tdm_display *dpy, const tbm_format **formats, int *count); /** @@ -219,16 +186,6 @@ tdm_display_get_capture_available_size(tdm_display *dpy, int *min_w, int *min_h, int *max_w, int *max_h, int *preferred_align); /** - * @brief Get the max layer counts which a display object can show on screen. - * @details -1 means that a TDM backend module doesn't define the value. - * @param[in] dpy A display object - * @param[out] count The max count of layers - * @return #TDM_ERROR_NONE if success. Otherwise, error value. - */ -tdm_error -tdm_display_get_max_layer_count(tdm_display *dpy, int *max_count); - -/** * @brief Get the output counts which a display object has. * @param[in] dpy A display object * @param[out] count The count of outputs @@ -250,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. @@ -260,6 +227,27 @@ tdm_pp * tdm_display_create_pp(tdm_display *dpy, tdm_error *error); /** + * @brief Get the information of the TDM backend module. + * @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_module_get_info(tdm_module *module, const char **name, + const char **vendor, int *major, int *minor); + +/** + * @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_module * +tdm_output_get_backend_module(tdm_output *output, tdm_error *error); + +/** * @brief Get the capabilities of a output object. * @param[in] output A output object * @param[out] capabilities The capabilities of a output object @@ -560,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. @@ -635,6 +632,28 @@ tdm_error tdm_output_hwc_set_client_target_buffer(tdm_output *output, tbm_surface_h target_buffer, tdm_hwc_region damage); /** + * @brief Unset the client(relative to the TDM) target buffer + * @details TODO + * @param[in] output A output object + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @since 2.0.0 + */ +tdm_error +tdm_output_hwc_unset_client_target_buffer(tdm_output *output); + +/** + * @brief Commit changes for a target_window + * @details After all change of a window object are applied, a user commit handler + * will be called. + * @param[in] hwc_window A window object + * @param[in] func A user commit handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_output_hwc_commit_client_target_buffer(tdm_output *output, tdm_output_hwc_target_buffer_commit_handler func, void *user_data); + +/** * @brief Validate the output * @details Instructs the device to inspect all of the layer state and * determine if there are any composition type changes necessary before @@ -743,6 +762,24 @@ tdm_output_hwc_get_video_supported_formats(tdm_layer *layer, const tbm_format ** int *count); /** + * @brief Get a output object of a layer object + * @param[in] layer A layer object + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. + * @return A TDM output object if success. Otherwise, NULL. + */ +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 @@ -891,6 +928,7 @@ tdm_layer_remove_commit_handler(tdm_layer *layer, tdm_layer_commit_handler func, * @details A displaying TDM buffer is a current showing buffer on screen * that is set to layer object and applied output object of a layer object. * @param[in] layer A layer object + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. * @return A TDM buffer if success. Otherwise, NULL. */ tbm_surface_h @@ -974,17 +1012,6 @@ tbm_surface_queue_h tdm_hwc_window_get_tbm_buffer_queue(tdm_hwc_window *hwc_window, tdm_error *error); /** - * @brief Sets the desired Z order of the given window. A window with - * a greater Z value occludes a window with a lesser Z value. - * @param[in] hwc_window A window object - * @param[in] z the new Z order - * @return #TDM_ERROR_NONE if success. Otherwise, error value. - * @since 2.0.0 - */ -tdm_error -tdm_hwc_window_set_zpos(tdm_hwc_window *hwc_window, int32_t zpos); - -/** * @brief Sets the desired composition type of the given window. * @details During tdm_output_hwc_validate(), the device may request changes to * the composition types of any of the layers as described in the definition @@ -1050,6 +1077,20 @@ tdm_error tdm_hwc_window_set_buffer(tdm_hwc_window *hwc_window, tbm_surface_h buffer); /** + * @brief Unset a TBM buffer to a window object + * @details A TBM buffer will be applied when the output object of a layer + * object is committed. + * @param[in] hwc_window A window object + * @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 +tdm_hwc_window_unset_buffer(tdm_hwc_window *hwc_window); + +/** * @brief Set a flags to a window object * @param[in] hwc_window A window object * @param[in] flags A hwc_window flags @@ -1070,6 +1111,18 @@ tdm_error tdm_hwc_window_unset_flags(tdm_hwc_window *hwc_window, tdm_hwc_window_flag flags); /** + * @brief Commit changes for a window object + * @details After all change of a window object are applied, a user commit handler + * will be called. + * @param[in] hwc_window A window object + * @param[in] func A user commit handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_hwc_window_commit(tdm_hwc_window *hwc_window, tdm_hwc_window_commit_handler func, void *user_data); + +/** * @brief Get the available property array of a video hwc window object. * @param[in] hwc window A video hwc window object * @param[out] props The available property array @@ -1332,6 +1385,16 @@ void tdm_vblank_destroy(tdm_vblank *vblank); /** + * @brief Get a output object of a vblank object + * @param[in] vblank A vblank object + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. + * @return A TDM output object if success. Otherwise, NULL. + * @see #tdm_vblank_create + */ +tdm_output * +tdm_vblank_get_output(tdm_vblank *vblank, tdm_error *error); + +/** * @brief Get the client PID for a vblank object * @param[in] vblank A vblank object * @param[out] pid PID of vblank's client