summaryrefslogtreecommitdiff
path: root/src/modules/ecore_evas
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-06-05 11:06:36 -0700
committerCedric BAIL <cedric@osg.samsung.com>2017-06-05 12:07:56 -0700
commit2f025184f775dcb2ba43f1b871ff2f7c7adfd23a (patch)
tree229990252a76af76197170319bd27bc98d323a9e /src/modules/ecore_evas
parentaa9bda8b83b1c766ab90ef967dc5ec2947beb444 (diff)
evas: document the wayland ecore_evas constructors
Reviewers: cedric Subscribers: jpeg Differential Revision: https://phab.enlightenment.org/D4896 Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
Diffstat (limited to 'src/modules/ecore_evas')
-rw-r--r--src/modules/ecore_evas/engines/wayland/ecore_evas_wayland_private.h31
1 files changed, 30 insertions, 1 deletions
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 @@
33 33
34typedef struct _Ecore_Evas_Engine_Wl_Data Ecore_Evas_Engine_Wl_Data; 34typedef struct _Ecore_Evas_Engine_Wl_Data Ecore_Evas_Engine_Wl_Data;
35 35
36struct _Ecore_Evas_Engine_Wl_Data 36struct _Ecore_Evas_Engine_Wl_Data
37{ 37{
38 Ecore_Wl2_Display *display; 38 Ecore_Wl2_Display *display;
39 Eina_List *regen_objs; 39 Eina_List *regen_objs;
@@ -53,6 +53,35 @@ struct _Ecore_Evas_Engine_Wl_Data
53 Eina_Bool activated : 1; 53 Eina_Bool activated : 1;
54}; 54};
55 55
56/**
57 * @brief Create an Ecore_Evas window using a Wayland-based engine.
58 *
59 * @param disp_name Name of the Wayland display to connect to.
60 * @param parent ID of the parent window this Ecore_Evas window belongs
61 * to, or 0 if this is a top-level window.
62 * @param x Horizontal position of the Ecore_Evas window.
63 * @param y Vertical position of the Ecore_Evas window.
64 * @param w Width of the Ecore_Evas window to be created.
65 * @param h Height of the Ecore_Evas window to be created.
66 * @param frame Deprecated. (Just pass EINA_FALSE.)
67 * @param engine_name Wayland engine to use for rendering.
68 * @return Ecore_Evas instance or @c NULL if creation failed.
69 *
70 * Like Evas' other window creation routines, this constructs an
71 * Ecore_Evas window object using an engine name and various common
72 * parameters. However, this connects to the display using a Wayland
73 * protocol for client-server communication rather than the X11
74 * protocol.
75 *
76 * Also, Wayland uses a direct rendering model that permits clients to
77 * do their own rendering and share it using one of a range of buffer
78 * sharing alternatives. The caller of this routine must specify which
79 * @p engine_name to use (e.g. @c "wayland_egl" or @c "wayland_shm").
80 *
81 * @see ecore_evas_new()
82 * @see ecore_evas_wayland_shm_new()
83 * @see ecore_evas_wayland_egl_new()
84 */
56Ecore_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); 85Ecore_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);
57 86
58#endif /* _ECORE_EVAS_WAYLAND_PRIVATE_H_ */ 87#endif /* _ECORE_EVAS_WAYLAND_PRIVATE_H_ */