summaryrefslogtreecommitdiff
path: root/src/lib/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/lib/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/lib/ecore_evas')
-rw-r--r--src/lib/ecore_evas/Ecore_Evas.h50
1 files changed, 49 insertions, 1 deletions
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index 186481ee91..538abcedb2 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
1478EAPI Ecore_Evas *ecore_evas_directfb_new(const char *disp_name, int windowed, int x, int y, int w, int h) EINA_DEPRECATED; 1478EAPI Ecore_Evas *ecore_evas_directfb_new(const char *disp_name, int windowed, int x, int y, int w, int h) EINA_DEPRECATED;
1479EAPI Ecore_DirectFB_Window *ecore_evas_directfb_window_get(const Ecore_Evas *ee) EINA_DEPRECATED; 1479EAPI Ecore_DirectFB_Window *ecore_evas_directfb_window_get(const Ecore_Evas *ee) EINA_DEPRECATED;
1480 1480
1481 1481/**
1482 * @brief Create an Ecore_Evas window using the wayland-shm engine.
1483 *
1484 * @param disp_name Name of the Wayland display to connect to.
1485 * @param parent ID of the parent window this Ecore_Evas window belongs
1486 * to, or 0 if this is a top-level window.
1487 * @param x Horizontal position of the Ecore_Evas window.
1488 * @param y Vertical position of the Ecore_Evas window.
1489 * @param w Width of the Ecore_Evas window to be created.
1490 * @param h Height of the Ecore_Evas window to be created.
1491 * @param frame Deprecated. (Just pass EINA_FALSE.)
1492 * @return Ecore_Evas instance or @c NULL if creation failed.
1493 *
1494 * Wayland's Shared Memory (SHM) rendering model stores client-drawn
1495 * data in system memory buffers for communication with the display
1496 * server. The server then copies the buffer from system memory to the
1497 * video output as appropriate. This routine constructs an Ecore_Evas
1498 * window object that uses SHM buffers for communication using the
1499 * Wayland protocol.
1500 *
1501 * @see ecore_evas_new()
1502 * @see ecore_evas_wayland_egl_new()
1503 */
1482EAPI 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); 1504EAPI 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);
1505
1506/**
1507 * @brief Create an Ecore_Evas window using the wayland-egl engine.
1508 *
1509 * @param disp_name Name of the Wayland display to connect to.
1510 * @param parent ID of the parent window this Ecore_Evas window belongs
1511 * to, or 0 if this is a top-level window.
1512 * @param x Horizontal position of the Ecore_Evas window.
1513 * @param y Vertical position of the Ecore_Evas window.
1514 * @param w Width of the Ecore_Evas window to be created.
1515 * @param h Height of the Ecore_Evas window to be created.
1516 * @param frame Deprecated. (Just pass EINA_FALSE.)
1517 * @return Ecore_Evas instance or @c NULL if creation failed.
1518 *
1519 * Under Wayland, clients can also set up rendering directly to graphics
1520 * hardware memory via various rendering APIs such as OpenGL, OpenGL ES,
1521 * etc.) thus skipping the need for server-side copying of graphics data
1522 * to the display device, thus providing higher performance than SHM.
1523 * This routine constructs an Ecore_Evas window object using the
1524 * Embedded-system Graphics Library (EGL) interface for handling the
1525 * context management and rendering synchronization.
1526 *
1527 * @see ecore_evas_new()
1528 * @see ecore_evas_wayland_shm_new()
1529 */
1483EAPI 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); 1530EAPI 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);
1531
1484EAPI void ecore_evas_wayland_resize(Ecore_Evas *ee, int location); 1532EAPI void ecore_evas_wayland_resize(Ecore_Evas *ee, int location);
1485EAPI void ecore_evas_wayland_move(Ecore_Evas *ee, int x, int y); 1533EAPI void ecore_evas_wayland_move(Ecore_Evas *ee, int x, int y);
1486 1534