From 2f025184f775dcb2ba43f1b871ff2f7c7adfd23a Mon Sep 17 00:00:00 2001 From: Bryce Harrington Date: Mon, 5 Jun 2017 11:06:36 -0700 Subject: [PATCH] evas: document the wayland ecore_evas constructors Reviewers: cedric Subscribers: jpeg Differential Revision: https://phab.enlightenment.org/D4896 Signed-off-by: Cedric BAIL --- src/lib/ecore_evas/Ecore_Evas.h | 50 +++++++++++++++++++++- .../engines/wayland/ecore_evas_wayland_private.h | 31 +++++++++++++- 2 files changed, 79 insertions(+), 2 deletions(-) diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h index 186481e..538abce 100644 --- a/src/lib/ecore_evas/Ecore_Evas.h +++ b/src/lib/ecore_evas/Ecore_Evas.h @@ -1478,9 +1478,57 @@ EAPI Ecore_Evas *ecore_evas_fb_new(const char *disp_name, int rotation, int EAPI Ecore_Evas *ecore_evas_directfb_new(const char *disp_name, int windowed, int x, int y, int w, int h) EINA_DEPRECATED; EAPI Ecore_DirectFB_Window *ecore_evas_directfb_window_get(const Ecore_Evas *ee) EINA_DEPRECATED; - +/** + * @brief Create an Ecore_Evas window using the wayland-shm engine. + * + * @param disp_name Name of the Wayland display to connect to. + * @param parent ID of the parent window this Ecore_Evas window belongs + * to, or 0 if this is a top-level window. + * @param x Horizontal position of the Ecore_Evas window. + * @param y Vertical position of the Ecore_Evas window. + * @param w Width of the Ecore_Evas window to be created. + * @param h Height of the Ecore_Evas window to be created. + * @param frame Deprecated. (Just pass EINA_FALSE.) + * @return Ecore_Evas instance or @c NULL if creation failed. + * + * Wayland's Shared Memory (SHM) rendering model stores client-drawn + * data in system memory buffers for communication with the display + * server. The server then copies the buffer from system memory to the + * video output as appropriate. This routine constructs an Ecore_Evas + * window object that uses SHM buffers for communication using the + * Wayland protocol. + * + * @see ecore_evas_new() + * @see ecore_evas_wayland_egl_new() + */ EAPI Ecore_Evas *ecore_evas_wayland_shm_new(const char *disp_name, unsigned int parent, int x, int y, int w, int h, Eina_Bool frame); + +/** + * @brief Create an Ecore_Evas window using the wayland-egl engine. + * + * @param disp_name Name of the Wayland display to connect to. + * @param parent ID of the parent window this Ecore_Evas window belongs + * to, or 0 if this is a top-level window. + * @param x Horizontal position of the Ecore_Evas window. + * @param y Vertical position of the Ecore_Evas window. + * @param w Width of the Ecore_Evas window to be created. + * @param h Height of the Ecore_Evas window to be created. + * @param frame Deprecated. (Just pass EINA_FALSE.) + * @return Ecore_Evas instance or @c NULL if creation failed. + * + * Under Wayland, clients can also set up rendering directly to graphics + * hardware memory via various rendering APIs such as OpenGL, OpenGL ES, + * etc.) thus skipping the need for server-side copying of graphics data + * to the display device, thus providing higher performance than SHM. + * This routine constructs an Ecore_Evas window object using the + * Embedded-system Graphics Library (EGL) interface for handling the + * context management and rendering synchronization. + * + * @see ecore_evas_new() + * @see ecore_evas_wayland_shm_new() + */ EAPI Ecore_Evas *ecore_evas_wayland_egl_new(const char *disp_name, unsigned int parent, int x, int y, int w, int h, Eina_Bool frame); + EAPI void ecore_evas_wayland_resize(Ecore_Evas *ee, int location); EAPI void ecore_evas_wayland_move(Ecore_Evas *ee, int x, int y); diff --git a/src/modules/ecore_evas/engines/wayland/ecore_evas_wayland_private.h b/src/modules/ecore_evas/engines/wayland/ecore_evas_wayland_private.h index 4dfebf8..aed693b 100644 --- a/src/modules/ecore_evas/engines/wayland/ecore_evas_wayland_private.h +++ b/src/modules/ecore_evas/engines/wayland/ecore_evas_wayland_private.h @@ -33,7 +33,7 @@ typedef struct _Ecore_Evas_Engine_Wl_Data Ecore_Evas_Engine_Wl_Data; -struct _Ecore_Evas_Engine_Wl_Data +struct _Ecore_Evas_Engine_Wl_Data { Ecore_Wl2_Display *display; Eina_List *regen_objs; @@ -53,6 +53,35 @@ struct _Ecore_Evas_Engine_Wl_Data Eina_Bool activated : 1; }; +/** + * @brief Create an Ecore_Evas window using a Wayland-based engine. + * + * @param disp_name Name of the Wayland display to connect to. + * @param parent ID of the parent window this Ecore_Evas window belongs + * to, or 0 if this is a top-level window. + * @param x Horizontal position of the Ecore_Evas window. + * @param y Vertical position of the Ecore_Evas window. + * @param w Width of the Ecore_Evas window to be created. + * @param h Height of the Ecore_Evas window to be created. + * @param frame Deprecated. (Just pass EINA_FALSE.) + * @param engine_name Wayland engine to use for rendering. + * @return Ecore_Evas instance or @c NULL if creation failed. + * + * Like Evas' other window creation routines, this constructs an + * Ecore_Evas window object using an engine name and various common + * parameters. However, this connects to the display using a Wayland + * protocol for client-server communication rather than the X11 + * protocol. + * + * Also, Wayland uses a direct rendering model that permits clients to + * do their own rendering and share it using one of a range of buffer + * sharing alternatives. The caller of this routine must specify which + * @p engine_name to use (e.g. @c "wayland_egl" or @c "wayland_shm"). + * + * @see ecore_evas_new() + * @see ecore_evas_wayland_shm_new() + * @see ecore_evas_wayland_egl_new() + */ Ecore_Evas *_ecore_evas_wl_common_new_internal(const char *disp_name, unsigned int parent, int x, int y, int w, int h, Eina_Bool frame, const char *engine_name); #endif /* _ECORE_EVAS_WAYLAND_PRIVATE_H_ */ -- 2.7.4