int zpos;
unsigned int format_count; /**< The count of available formats */
- tbm_format
- *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
+ tbm_format *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
unsigned int prop_count; /**< The count of available properties */
tdm_prop *props; /**< The @b newly-allocated array of properties. will be freed in frontend. */
*/
tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error);
- void (*reserved1)(void);
+ /**
+ * @brief Create a virtual output object of a backend module
+ * @param[in] bdata The backend module data
+ * @param[in] name The output name
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A tdm_voutput object
+ * @see voutput_destroy() function
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_voutput *(*display_voutput_create)(tdm_backend_data *bdata, const char *name, tdm_error *error);
+
void (*reserved2)(void);
void (*reserved3)(void);
void (*reserved4)(void);
* #output_set_dpms_handler, a backend module needs to call the output dpms handler
* to let the TDM frontend know the output DPMS change indeed.
* @param[in] dpms_value DPMS value
+ * @param[out] sync A flag for sync call
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
* @see #output_set_dpms_handler, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
* @since 1.7.0
*/
- tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value);
+ tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value, int *sync);
/**
* @brief Get a hwc object of a output object
*/
tdm_hwc *(*output_get_hwc)(tdm_output *output, tdm_error *error);
+ /**
+ * @brief Set the mirror image of the src_output to the output
+ * @details This function set the mirro image of the src_output to the output.
+ * If there is the hardware or the implementation to display the mirror image
+ * of the src_output to the output, the backend does it in this function.
+ * If the backend output gets the ability of the mirror displaying, it has to
+ * set the TDM_OUTPUT_CAPABILITY_MIRROR on the output capability.
+ * @param[in] output A output object to display the src_output image
+ * @param[in] src_output A src output object of which image is displayed on the output
+ * @param[in] transform A transform value
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see #output_set_mirror, #TDM_OUTPUT_CAPABILITY_MIRROR
+ */
+ tdm_error (*output_set_mirror)(tdm_output *output,
+ tdm_output *src_output,
+ tdm_transform transform);
+ /**
+ * @brief Unset the mirror image
+ * @details This function unset the mirro image of the output.
+ * @param[in] output A output object to display the src_output image
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see #output_set_mirror, #TDM_OUTPUT_CAPABILITY_MIRROR
+ */
+ tdm_error (*output_unset_mirror)(tdm_output *output);
+
+ void (*reserved4)(void);
void (*reserved5)(void);
void (*reserved6)(void);
void (*reserved7)(void);
void (*reserved8)(void);
} tdm_func_output;
+typedef struct _tdm_func_voutput {
+ /**
+ * @brief Destroy a virtual output object of a backend module
+ * @param[in] voutput The voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see display_voutput_create() function
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_error (*voutput_destroy)(tdm_voutput *voutput);
+
+ /**
+ * @brief Set available modes of a virtual output object
+ * @param[in] voutput A voutput object
+ * @param[in] modes Modes of voutput
+ * @param[in] count A count of modes
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_error (*voutput_set_available_mode)(tdm_voutput *voutput, const tdm_output_mode *modes, int count);
+
+ /**
+ * @brief Set physical size(mm) of a virtual output object
+ * @param[in] voutput A voutput object
+ * @param[in] mmwidth Width of voutput
+ * @param[in] mmheight Height of voutput
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_error (*voutput_set_physical_size)(tdm_voutput *voutput, unsigned int mmwidth, unsigned int mmheight);
+
+ /**
+ * @brief Set connect status of a virtual output object
+ * @param[in] voutput A voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_error (*voutput_connect)(tdm_voutput *voutput);
+
+ /**
+ * @brief Set disconnect status of a virtual output object
+ * @param[in] voutput A voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_error (*voutput_disconnect)(tdm_voutput *voutput);
+
+ /**
+ * @brief Get output object from virtual output object
+ * @param[in] voutput A voutput object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A tdm_output object
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_output *(*voutput_get_output)(tdm_voutput *voutput, tdm_error *error);
+
+ /**
+ * @brief Set a user commit function
+ * @param[in] voutput A voutput object
+ * @param[in] func A user voutput commit function
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ * If virtual output's output_commit is executed, call this voutput commit func.
+ */
+ tdm_error (*voutput_set_commit_func)(tdm_voutput *voutput, tdm_voutput_commit_handler commit_func);
+
+ /**
+ * @brief Notify commit done to backend
+ * @param[in] voutput A voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @remark
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+ tdm_error (*voutput_commit_done)(tdm_voutput *voutput);
+
+ void (*reserved1)(void);
+ void (*reserved2)(void);
+ void (*reserved3)(void);
+ void (*reserved4)(void);
+ void (*reserved5)(void);
+ void (*reserved6)(void);
+} tdm_func_voutput;
/**
* @brief The layer functions for a backend module.
*/
tdm_error (*hwc_get_video_supported_formats)(tdm_hwc *hwc, const tbm_format **formats,
int *count);
/**
- * @brief Get the hwc video capability
+ * @brief Get the available video property array of a hwc object.
+ * @param[in] hwc A hwc object
+ * @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 (*hwc_get_video_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
+ int *count);
+
+ /**
+ * @brief Get the hwc capabilities
* @param[in] hwc A hwc object
- * @param[out] video_capability A hwc hwc video capability
+ * @param[out] capabilities A hwc hwc capability
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
- tdm_error (*hwc_get_video_capability)(tdm_hwc *hwc,
- tdm_hwc_video_capability *video_capability);
+ tdm_error (*hwc_get_capabilities)(tdm_hwc *hwc, tdm_hwc_capability *capabilities);
/**
* @brief Get the available property array of a hwc object.
* @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_COMPOSITION_CLIENT.
+ * tdm_hwc_windows which marked as TDM_HWC_WIN_COMPOSITION_CLIENT.
* @param[in] hwc A hwc object
* @param[in] target_buffer The new target buffer
* @param[in] damage The buffer damage region
* @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_changes, or will set new types and attempt to validate the
+ * 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
tdm_hwc_window **hwc_window,
tdm_hwc_window_composition *composition_types);
/**
- * @brief Accepts the changes required by the backend
- * @details Accepts the changes required by the backend from the previous
+ * @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 (*hwc_accept_changes)(tdm_hwc *hwc);
+ tdm_error (*hwc_accept_validation)(tdm_hwc *hwc);
/**
* @brief Commit changes for a hwc object
* @return #TDM_ERROR_NONE if success. Otherwise, error value.
*/
tdm_error (*hwc_set_commit_handler)(tdm_hwc *hwc, tdm_hwc_commit_handler func);
+
+ /**
+ * @brief Set the property which has a given id on the hwc object.
+ * @param[in] hwc A hwc 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 (*hwc_set_property)(tdm_hwc *hwc, uint32_t id, tdm_value value);
+
+ /**
+ * @brief Get the property which has a given id on the hwc object.
+ * @param[in] hwc A hwc 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 (*hwc_get_property)(tdm_hwc *hwc, uint32_t id, tdm_value *value);
} tdm_func_hwc;
/**
*/
tdm_error (*hwc_window_get_constraints)(tdm_hwc_window *hwc_window,
int *constraints);
+
+ /**
+ * @brief Set the name of hwc_window
+ * @param[in] hwc_window A hwc window object
+ * @param[in] name of the hwc_window
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*hwc_window_set_name)(tdm_hwc_window *hwc_window,
+ const char *name);
+
+ /**
+ * @brief Get buffer flags of cursor hwc_window
+ * @param[in] hwc_window A hwc window object
+ * @param[in] width of the cursor image
+ * @param[in] height of the cursor image
+ * @param[in] stride of the cursor image
+ * @param[in] virtual address of the cursor image
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
+ tdm_error (*hwc_window_set_cursor_image)(tdm_hwc_window *hwc_window,
+ int width, int height, int stride, void *ptr);
} tdm_func_hwc_window;
/**
tdm_func_output *func_output);
/**
+ * @brief Register the backend voutput functions to a display
+ * @param[in] dpy A display object
+ * @param[in] func_voutput voutput functions
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see tdm_backend_register_func_display, tdm_backend_register_func_output
+ * @remarks
+ * A backend module doesn't need to implement this function if doesn't support virtual output.
+ */
+tdm_error
+tdm_backend_register_func_voutput(tdm_display *dpy, tdm_func_voutput *func_voutput);
+
+/**
* @brief Register the backend layer functions to a display
* @param[in] dpy A display object
* @param[in] func_layer layer functions
tdm_func_capture *func_capture);
/**
+ * @brief Register the backend output to a display
+ * @param[in] dpy A display object
+ * @param[in] output A backend output object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see tdm_backend_unregister_output
+ */
+tdm_error
+tdm_backend_register_output(tdm_display *dpy, tdm_output *output);
+
+/**
+ * @brief Unregister the backend output to a display
+ * @param[in] dpy A display object
+ * @param[in] output A backend output object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @see tdm_backend_register_output
+ */
+void
+tdm_backend_unregister_output(tdm_display *dpy, tdm_output *output);
+
+/**
* @brief Increase the ref_count of a TDM buffer
* @details
* TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer