X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Ftdm.h;h=ab9197cff9043c0621ef5b796ec2e9a4619b2fc1;hb=5aa022f9020fbf011e177946ff5b63b402125a22;hp=91cabef9690e69c610423a77451dcd82bcbba400;hpb=9595289e9edc0cac2662282a5cf3dac8eac9fd36;p=platform%2Fcore%2Fuifw%2Flibtdm.git diff --git a/include/tdm.h b/include/tdm.h index 91cabef..ab9197c 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 @@ -37,11 +37,13 @@ #define _TDM_H_ #include +#include #include #include #include #include "tdm_types.h" +#include "tdm_deprecated.h" #ifdef __cplusplus extern "C" { @@ -57,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 @@ -92,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 @@ -123,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. @@ -199,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); /** @@ -218,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 @@ -249,6 +207,40 @@ tdm_output * tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error); /** + * @brief Add a output create handler + * @param[in] output A output object + * @param[in] func A output create handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_display_add_output_create_handler(tdm_display *dpy, + tdm_output_create_handler func, + void *user_data); + +/** + * @brief Remove a output create handler + * @param[in] output A output object + * @param[in] func A output create handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +void +tdm_display_remove_output_create_handler(tdm_display *dpy, + tdm_output_create_handler func, + void *user_data); + +/** + * @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. @@ -259,6 +251,51 @@ 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 Add a output destroy handler + * @param[in] output A output object + * @param[in] func A output destroy handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_output_add_destroy_handler(tdm_output *output, + tdm_output_destroy_handler func, + void *user_data); + +/** + * @brief Remove a output destroy handler + * @param[in] output A output object + * @param[in] func A output destroy handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +void +tdm_output_remove_destroy_handler(tdm_output *output, + tdm_output_destroy_handler func, + void *user_data); + +/** + * @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 @@ -316,6 +353,30 @@ tdm_output_remove_change_handler(tdm_output *output, void *user_data); /** + * @brief Add a output mode change handler + * @param[in] output A output object + * @param[in] func A output mode change handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_output_add_mode_change_request_handler(tdm_output *output, + tdm_output_mode_change_request_handler func, + void *user_data); + +/** + * @brief Remove a output mode change handler + * @param[in] output A output object + * @param[in] func A output mode change handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_output_remove_mode_change_request_handler(tdm_output *output, + tdm_output_mode_change_request_handler func, + void *user_data); + +/** * @brief Get the connection type of a output object. * @param[in] output A output object * @param[out] type The connection type. @@ -486,6 +547,26 @@ tdm_output_commit(tdm_output *output, int sync, tdm_output_commit_handler func, void *user_data); /** + * @brief Remove the user vblank handler + * @param[in] output A output object + * @param[in] func A user vblank handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_output_remove_vblank_handler(tdm_output *output, tdm_output_vblank_handler func, void *user_data); + +/** + * @brief Remove the user commit handler + * @param[in] output A output 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_remove_commit_handler(tdm_output *output, tdm_output_commit_handler func, void *user_data); + +/** * @brief Set one of available modes of a output object * @param[in] output A output object * @param[in] mode A output mode @@ -504,15 +585,32 @@ tdm_error tdm_output_get_mode(tdm_output *output, const tdm_output_mode **mode); /** - * @brief Set DPMS of a output object + * @brief Set DPMS of a output object synchronously * @param[in] output A output object * @param[in] dpms_value DPMS value * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @see tdm_output_set_dpms_async */ tdm_error tdm_output_set_dpms(tdm_output *output, tdm_output_dpms dpms_value); /** + * @brief Set DPMS of a output object asynchronously + * @details This function can be used when a output supports the asynchronous DPMS + * control. The output has #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS flags which + * #tdm_output_get_capabilities returns. If an output change handler is added with + * #tdm_output_add_change_handler, the output change handler will be called when + * the DPMS status is changed indeed. + * @param[in] output A output object + * @param[in] dpms_value DPMS value + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @see tdm_output_add_change_handler, tdm_output_set_dpms, + * tdm_output_get_capabilities, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS. + */ +tdm_error +tdm_output_set_dpms_async(tdm_output *output, tdm_output_dpms dpms_value); + +/** * @brief Get DPMS of a output object * @param[in] output A output object * @param[out] dpms_value DPMS value @@ -522,6 +620,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. @@ -532,6 +639,34 @@ tdm_capture * tdm_output_create_capture(tdm_output *output, tdm_error *error); /** + * @brief Get a hwc associated with a output object. + * @param[in] output A output object + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. + * @return A hwc object + * @since 2.0.0 + */ +tdm_hwc * +tdm_output_get_hwc(tdm_output *output, tdm_error *error); + +/** + * @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 @@ -666,10 +801,21 @@ tdm_error tdm_layer_is_committing(tdm_layer *layer, unsigned int *committing); /** + * @brief Remove the user commit handler + * @param[in] layer A layer 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_layer_remove_commit_handler(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data); + +/** * @brief Get a displaying TDM buffer from a layer object * @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 @@ -741,6 +887,272 @@ tdm_error tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags); /** + * @brief Creates a new window on the given hwc. + * @param[in] hwc A hwc object + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. + * @return A created window object + * @since 2.0.0 + */ +tdm_hwc_window * +tdm_hwc_create_window(tdm_hwc *hwc, tdm_error *error); + +/** + * @brief Get the video supported format array for hwc windows of a output object. + * @param[in] hwc A hwc object + * @param[out] formats The available format array + * @param[out] count The count of formats + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_hwc_get_video_supported_formats(tdm_hwc *hwc, const tbm_format **formats, + int *count); +/** + * @brief Get the available video property array of a hwc object. + * @param[in] hwc A hwc + * @param[out] props The available video property array + * @param[out] count The count of video properties + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_hwc_get_video_available_properties(tdm_hwc *hwc, const tdm_prop **props, int *count); + +/** + * @brief Get the hwc video capability + * @param[in] hwc A hwc object + * @param[out] video_capability A hwc video capability + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_hwc_get_video_capability(tdm_hwc *hwc, tdm_hwc_video_capability *video_capability); + +/** + * @brief Get the available property array of a hwc object. + * @param[in] hwc A hwc + * @param[out] props The available property array + * @param[out] count The count of properties + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_hwc_get_available_properties(tdm_hwc *hwc, const tdm_prop **props, int *count); + +/** + * @brief Get a target buffer queue + * @details The client composites the tdm_hwd_windows which have + * TDM_COMPOSITE_CLIENT types on the buffer from this target buffer queue. + * Then, the client set the buffer by calling tdm_hwc_set_client_target_buffer. + * @param[in] output A output object + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. + * @return A buffer queue + * @since 2.0.0 + */ +tbm_surface_queue_h +tdm_hwc_get_client_target_buffer_queue(tdm_hwc *hwc, tdm_error *error); + +/** + * @brief Set the client(relative to the TDM) target buffer + * @details This function lets the backend know the target buffer. + * The target buffer contains the result of the gl composition with the + * tdm_hwc_windows which marked as TDM_HWC_WIN_COMPOSITION_CLIENT. + * @param[in] hwc A output hwc + * @param[in] target_buffer The new target buffer + * @param[in] damage The buffer damage region + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @since 2.0.0 + */ +tdm_error +tdm_hwc_set_client_target_buffer(tdm_hwc *hwc, tbm_surface_h target_buffer, tdm_region damage); + +/** + * @brief Validate the output + * @details Instructs the backend to inspect all of the hw layer state and + * determine if there are any composition type changes necessary before + * presenting the hwc. + * @param[in] hwc A hwc object + * @param[in] composited_wnds the hwc window list which is visible. + * @param[in] num_wnds the number of the visible windows in the composited_wnds + * @param[out] num_types The number of composition type changes + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @remark + * The backend has to return the num_types when the assgined comopsite types of + * the tdm_hwc_windows in the composited_wnds. If the num_types is greater than + * 0, the cleint must get the changed composite types of the tdm_hwc_windows + * and change the comopsite types + * @since 2.0.0 + */ +tdm_error +tdm_hwc_validate(tdm_hwc *hwc, tdm_hwc_window **composited_wnds, uint32_t num_wnds, + uint32_t *num_types); + +/** + * @brief Get changed composition types + * @details Retrieves the windows for which the backend requires a different + * composition types that had been set prior to the last call to tdm_hwc_validate(). + * The client will either update its state with these types and call + * tdm_hwc_accept_validation, or will set new types and attempt to validate the + * display again. The number of elements returned must be the same as the + * value returned in num_types from the last call to tdm_hwc_validate(). + * @param[in] hwc A hwc object + * @param[out] num_elements the number of hwc_windows + * @param[out] windows An array of windows + * @param[out] composition_types An array of composition types, each corresponding + * to an element of windows + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @remark + * @since 2.0.0 + */ +tdm_error +tdm_hwc_get_changed_composition_types(tdm_hwc *hwc, uint32_t *num_elements, + tdm_hwc_window **hwc_window, + tdm_hwc_window_composition *composition_types); + +/** + * @brief Accepts the validation required by the backend + * @details Accepts the validation required by the backend from the previous + * tdm_hwc_validate() and tdm_hwc_get_chaged_composition_types(). + * @param[in] hwc A hwc object + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @since 2.0.0 + */ +tdm_error +tdm_hwc_accept_validation(tdm_hwc *hwc); + +/* temporary prototype to avoid build break */ +tdm_error tdm_hwc_accept_changes(tdm_hwc *hwc); + +/** + * @brief Commit changes for a hwc + * @details After all change of a window object are applied, a user commit handler + * will be called. + * @param[in] hwc A hwc object + * @param[in] sync 0: asynchronous, 1:synchronous + * @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_commit(tdm_hwc *hwc, int sync, tdm_hwc_commit_handler func, void *user_data); + +/** + * @brief Destroys the given window. + * @param[in] window the pointer of the window to destroy + * @since 2.0.0 + */ +void +tdm_hwc_window_destroy(tdm_hwc_window *hwc_window); + +/** + * @brief Acquire a buffer queue for the window object + * @details These buffers are used to composite by hardware a client content in + * the nocomp mode. + * @param[in] hwc_window A window object + * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value. + * @return A tbm buffer queue + * @since 2.0.0 + */ +tbm_surface_queue_h +tdm_hwc_window_acquire_buffer_queue(tdm_hwc_window *hwc_window, tdm_error *error); + +/** + * @brief Release a buffer queue for the window object + * @details Release buffer queue when the client no longer uses buferrs of queue. + * @param[in] hwc_window A window object + * @param[in] A tbm buffer queue + * @since 2.0.0 + */ +void +tdm_hwc_window_release_buffer_queue(tdm_hwc_window *hwc_window, tbm_surface_queue_h queue); + +/** + * @brief Sets the desired composition type of the given window. + * @details During tdm_hwc_validate(), the backend may request changes to + * the composition types of any of the layers as described in the definition + * of tdm_hwc_window_composition_t above. + * @param[in] hwc_window A window object + * @param[in] composition_type The new composition type + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @since 2.0.0 + */ +tdm_error +tdm_hwc_window_set_composition_type(tdm_hwc_window *hwc_window, + tdm_hwc_window_composition composition_type); + +/** + * @brief Set the buffer damage + * @details Provides the region of the source buffer which has been modified + * since the last frame. This region does not need to be validated before + * calling tdm_output_commit(). + * Once set through this function, the damage region remains the same until a + * subsequent call to this function. + * If damage.num_rects > 0, then it may be assumed that any portion of the source + * buffer not covered by one of the rects has not been modified this frame. If + * damage.num_rects == 0, then the whole source buffer must be treated as if it + * has been modified. + * If the layer's contents are not modified relative to the prior frame, damage + * will contain exactly one empty rect([0, 0, 0, 0]). + * The damage rects are relative to the pre-transformed buffer, and their origin + * is the top-left corner. They will not exceed the dimensions of the latched + * buffer. + * @param[in] hwc_window A window object + * @param[in] damage The new buffer damage region + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @since 2.0.0 + */ +tdm_error +tdm_hwc_window_set_buffer_damage(tdm_hwc_window *hwc_window, tdm_region damage); + +/** + * @brief Set the information to a window object + * @details The information will be applied when the hwc object is committed. + * @param[in] hwc_window A window object + * @param[in] info The information + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @since 2.0.0 + */ +tdm_error +tdm_hwc_window_set_info(tdm_hwc_window *hwc_window, tdm_hwc_window_info *info); + +/** + * @brief Set 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 + * @param[in] buffer A TBM buffer + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + * @since 2.0.0 + */ +tdm_error +tdm_hwc_window_set_buffer(tdm_hwc_window *hwc_window, tbm_surface_h buffer); + +/** + * @brief Set the property which has a given id. + * @param[in] hwc_window A hwc window object + * @param[in] id The property id + * @param[in] value The value of the propery id + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_hwc_window_set_property(tdm_hwc_window *hwc_window, uint32_t id, tdm_value value); + +/** + * @brief Get the property which has a given id. + * @param[in] hwc_window A hwc window object + * @param[in] id The property id + * @param[out] value The value of the propery id + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_hwc_window_get_property(tdm_hwc_window *hwc_window, uint32_t id, tdm_value *value); + +/** + * @brief Get the constraints of hwc_window + * @param[in] hwc_window A hwc window object + * @param[out] constraints The tdm_hwc_window_constraint types + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_hwc_window_get_constraints(tdm_hwc_window *hwc_window, int *constraints); + +/** * @brief Destroy a pp object * @param[in] pp A pp object * @see tdm_display_create_pp @@ -894,6 +1306,52 @@ tdm_error tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps); /** + * @brief Set the ignore global fps for the given PID and name. + * @param[in] pid The process ID + * @param[in] name The client vblank name + * @param[in] ignore 1: ignore 0:not ignore(default) + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_set_client_ignore_global_fps(unsigned int pid, const char *name, unsigned int ignore); + +/** + * @brief Set the vblank global fps for the entire system. + * @param[in] enable 1:enable, 0:disable + * @param[in] fps The vblank global fps + * @details + * This global fps will be applied to all client's vblanks for all outputs. + * If the client's vblank fps is less than this, the global fps will be ignored + * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore + * the global fps, it will be ignored also. + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_enable_global_fps(unsigned int enable, unsigned int fps); + +/** + * @brief Add the vblank create handler. + * @param[in] dpy A display object + * @param[in] func The user vblank create handler + * @param[in] user_data The user data + * @details + * The user vblank create handler will be called when new vblank object created. + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_add_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data); + +/** + * @brief Remove the vblank create handler. + * @param[in] dpy A display object + * @param[in] func The user vblank create handler + * @param[in] user_data The user data + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +void +tdm_vblank_remove_create_handler(tdm_display *dpy, tdm_vblank_create_handler func, void *user_data); + +/** * @brief Create a vblank object * @param[in] dpy A display object * @param[in] output A output object @@ -913,6 +1371,25 @@ 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 + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_get_client_pid(tdm_vblank *vblank, pid_t *pid); + +/** * @brief Set the name to a vblank object * @details The default name is "unknown" * @param[in] vblank A vblank object @@ -935,6 +1412,7 @@ tdm_vblank_get_name(tdm_vblank *vblank, const char **name); /** * @brief Set the fps to a vblank object * @details Default is the @b vertical @b refresh @b rate of the given output. + * It could be ignored when the fixed fps is set by #tdm_vblank_set_fixed_fps * @param[in] vblank A vblank object * @param[in] fps over 0 * @return #TDM_ERROR_NONE if success. Otherwise, error value. @@ -952,6 +1430,31 @@ tdm_error tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps); /** + * @brief Set the fixed fps to a vblank object + * @details + * It could be ignored when the global fps is set by #tdm_vblank_enable_global_fps + * @param[in] vblank A vblank object + * @param[in] fps over 0 + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_set_fixed_fps(tdm_vblank *vblank, unsigned int fps); + +/** + * @brief Ignore the vblank global fps + * @details + * The global fps will be applied to all client's vblanks for all outputs. + * If the client's vblank fps is less than this, the global fps will be ignored + * for that client. And if a client calls #tdm_vblank_ignore_global_fps to ignore + * the global fps, it will be ignored also. + * @param[in] vblank A vblank object + * @param[in] ignore 1: ignore 0:not ignore(default) + * @return #TDM_ERROR_NONE if success. Otherwise, error value. + */ +tdm_error +tdm_vblank_ignore_global_fps(tdm_vblank *vblank, unsigned int ignore); + +/** * @brief Set the offset(milli-second) to a vblank object * @details Default is @b 0. * @param[in] vblank A vblank object