summaryrefslogtreecommitdiff
path: root/src/lib/ecore_evas
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-06-15 10:09:30 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-06-15 10:09:30 +0900
commit79e8444c916c472090d91ee63c848ab564f54648 (patch)
tree2ea16afea33bac0d474c4753067b6c4f59e8ffa9 /src/lib/ecore_evas
parent4eb13031eef17f3359fa27eed3dd3c27ca439f95 (diff)
ecore_evas: Document the drm and gl drm window constructors
Reviewers: cedric Subscribers: jpeg Differential Revision: https://phab.enlightenment.org/D4965
Diffstat (limited to 'src/lib/ecore_evas')
-rw-r--r--src/lib/ecore_evas/Ecore_Evas.h36
1 files changed, 36 insertions, 0 deletions
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index 8481ccc203..3041877d7a 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -1577,7 +1577,43 @@ EAPI Ecore_Wl_Window *ecore_evas_wayland_window_get(const Ecore_Evas *ee);
1577EAPI Ecore_Wl2_Window *ecore_evas_wayland2_window_get(const Ecore_Evas *ee); /** @since 1.17 */ 1577EAPI Ecore_Wl2_Window *ecore_evas_wayland2_window_get(const Ecore_Evas *ee); /** @since 1.17 */
1578EAPI Ecore_Cocoa_Window *ecore_evas_cocoa_window_get(const Ecore_Evas *ee); /** @since 1.17 */ 1578EAPI Ecore_Cocoa_Window *ecore_evas_cocoa_window_get(const Ecore_Evas *ee); /** @since 1.17 */
1579 1579
1580/**
1581 * @brief Create an Ecore_Evas window using the drm engine.
1582 *
1583 * @param disp_name Name of the Wayland display to connect to.
1584 * @param parent (Unused)
1585 * @param x Horizontal position of the Ecore_Evas window.
1586 * @param y Vertical position of the Ecore_Evas window.
1587 * @param w Width of the Ecore_Evas window to be created.
1588 * @param h Height of the Ecore_Evas window to be created.
1589 * @return Ecore_Evas instance or @c NULL if creation failed.
1590 *
1591 * Creates an Ecore_Evas window using the Direct Rendering Manager (DRM)
1592 * backend. DRM is a kernel-level module providing direct graphic
1593 * hardware access, bypassing the GL stack entirely.
1594 *
1595 * @see ecore_evas_new()
1596 * @see ecore_evas_gl_drm_new()
1597 */
1580EAPI Ecore_Evas *ecore_evas_drm_new(const char *device, unsigned int parent, int x, int y, int w, int h); 1598EAPI Ecore_Evas *ecore_evas_drm_new(const char *device, unsigned int parent, int x, int y, int w, int h);
1599
1600/**
1601 * @brief Create an Ecore_Evas window using the drm engine with GL support.
1602 *
1603 * @param disp_name Name of the Wayland display to connect to.
1604 * @param parent (Unused)
1605 * @param x Horizontal position of the Ecore_Evas window.
1606 * @param y Vertical position of the Ecore_Evas window.
1607 * @param w Width of the Ecore_Evas window to be created.
1608 * @param h Height of the Ecore_Evas window to be created.
1609 * @return Ecore_Evas instance or @c NULL if creation failed.
1610 *
1611 * This creates a drm backend backed Ecore_Evas window, that also includes
1612 * gl support using libglapi.
1613 *
1614 * @see ecore_evas_new()
1615 * @see ecore_evas_drm_new()
1616 */
1581EAPI Ecore_Evas *ecore_evas_gl_drm_new(const char *device, unsigned int parent, int x, int y, int w, int h); /** @since 1.12 */ 1617EAPI Ecore_Evas *ecore_evas_gl_drm_new(const char *device, unsigned int parent, int x, int y, int w, int h); /** @since 1.12 */
1582 1618
1583/** 1619/**