summaryrefslogtreecommitdiff
path: root/src/lib/ecore_evas
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-06-19 11:47:16 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-06-19 15:14:20 +0900
commit08f04b1496479f2ff8d5d8cea2cff5f8f01d7952 (patch)
tree7c83923bc7c3554f4f61a8e9e2e8e9b7feee499e /src/lib/ecore_evas
parent864e854fa94305d449eecfdc20606935a9809b8c (diff)
ecore_evas: Document remaining new/get calls for misc. backends
Summary: This completes the documentation for Ecore_Evas for all (non-deprecated) APIs. Note that ecore_evas_software_16_ddraw_new, ecore_evas_direct3d_new, ecore_evas_gl_glew_new, and ecore_evas_sdl16_new are left undocumented because while they're not declared as deprecated their implementations are either missing or marked as obsolete or legacy. I suspect a few of the remaining routines are likely also obsolete but I added documentation anyway. Reviewers: cedric Subscribers: jpeg Differential Revision: https://phab.enlightenment.org/D4972
Diffstat (limited to 'src/lib/ecore_evas')
-rw-r--r--src/lib/ecore_evas/Ecore_Evas.h125
1 files changed, 122 insertions, 3 deletions
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index 3041877d7a..7c863a195e 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -47,7 +47,6 @@
47 * to do soon: 47 * to do soon:
48 * - iconfication api needs to work 48 * - iconfication api needs to work
49 * - maximization api needs to work 49 * - maximization api needs to work
50 * - document all calls
51 * 50 *
52 * later: 51 * later:
53 * - buffer back-end that renders to an evas_image_object ??? 52 * - buffer back-end that renders to an evas_image_object ???
@@ -1573,9 +1572,45 @@ EAPI void ecore_evas_wayland_pointer_set(Ecore_Evas *ee, int hot_x, i
1573 */ 1572 */
1574EAPI void ecore_evas_wayland_type_set(Ecore_Evas *ee, int type); 1573EAPI void ecore_evas_wayland_type_set(Ecore_Evas *ee, int type);
1575 1574
1575/**
1576 * @brief Gets the window from Ecore_Evas using the wayland backend.
1577 *
1578 * @param ee The Ecore_Evas from which to get the window.
1579 * @return The window of type Ecore_X_Window.
1580 *
1581 * @note If ecore is not compiled with support for wayland or if @p ee
1582 * was not created with ecore_evas_wayland_shm_new() or
1583 * ecore_evas_wayland_egl_new() then nothing is done and NULL is returned.
1584 */
1576EAPI Ecore_Wl_Window *ecore_evas_wayland_window_get(const Ecore_Evas *ee); 1585EAPI 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 */ 1586
1578EAPI Ecore_Cocoa_Window *ecore_evas_cocoa_window_get(const Ecore_Evas *ee); /** @since 1.17 */ 1587/**
1588 * @brief Gets the window from Ecore_Evas using the wayland2 backend.
1589 *
1590 * @param ee The Ecore_Evas from which to get the window.
1591 * @return The window of type Ecore_X_Window.
1592 *
1593 * @note If ecore is not compiled with support for wayland or if @p ee
1594 * was not created with ecore_evas_wayland_shm_new() or
1595 * ecore_evas_wayland_egl_new() then nothing is done and NULL is returned.
1596 *
1597 * @since 1.17
1598 */
1599EAPI Ecore_Wl2_Window *ecore_evas_wayland2_window_get(const Ecore_Evas *ee);
1600
1601/**
1602 * @brief Gets the window from Ecore_Evas using the opengl_cocoa backend.
1603 *
1604 * @param ee The Ecore_Evas from which to get the window.
1605 * @return The window of type Ecore_X_Window.
1606 *
1607 * @note If ecore is not compiled with support for opengl_cocoa or if @p
1608 * ee was not created with ecore_evas_cocoa_new() then nothing is done
1609 * and NULL is returned.
1610 *
1611 * @since 1.17
1612 */
1613EAPI Ecore_Cocoa_Window *ecore_evas_cocoa_window_get(const Ecore_Evas *ee);
1579 1614
1580/** 1615/**
1581 * @brief Create an Ecore_Evas window using the drm engine. 1616 * @brief Create an Ecore_Evas window using the drm engine.
@@ -1827,12 +1862,44 @@ EAPI Ecore_Evas *ecore_evas_object_ecore_evas_get(Evas_Object *obj);
1827 */ 1862 */
1828EAPI Evas *ecore_evas_object_evas_get(Evas_Object *obj); 1863EAPI Evas *ecore_evas_object_evas_get(Evas_Object *obj);
1829 1864
1865/**
1866 * @brief Creates a new @c Ecore_Evas canvas bound to the Evas
1867 * @b gdi (software) engine.
1868 *
1869 * @param parent ID of the parent window this Ecore_Evas window belongs
1870 * to, or 0 if this is a top-level window.
1871 * @param x Horizontal position of window, in pixels.
1872 * @param y Vertical position of window, in pixels.
1873 * @param width The width of the canvas, in pixels.
1874 * @param height The height of the canvas, in pixels.
1875 * @return A new @c Ecore_Evas instance, or @c NULL on failure.
1876 *
1877 * The Graphics Device Interface (GDI) is a display API for Microsoft
1878 * Win32 similar in concept to Xlib or Quartz, providing an
1879 * abstraction layer for performing advanced drawing functionalities
1880 * using software rendering.
1881 */
1830EAPI Ecore_Evas *ecore_evas_software_gdi_new(Ecore_Win32_Window *parent, 1882EAPI Ecore_Evas *ecore_evas_software_gdi_new(Ecore_Win32_Window *parent,
1831 int x, 1883 int x,
1832 int y, 1884 int y,
1833 int width, 1885 int width,
1834 int height); 1886 int height);
1835 1887
1888/**
1889 * @brief Creates a new @c Ecore_Evas canvas bound to the Evas
1890 * @b DirectDraw (software) engine.
1891 *
1892 * @param parent ID of the parent window this Ecore_Evas window belongs
1893 * to, or 0 if this is a top-level window.
1894 * @param x Horizontal position of window, in pixels
1895 * @param y Vertical position of window, in pixels
1896 * @param width The width of the canvas, in pixels
1897 * @param height The height of the canvas, in pixels
1898 * @return A new @c Ecore_Evas instance or @c NULL on failure
1899 *
1900 * DirectDraw is an old Microsoft Win32 API for graphics rendering.
1901 * This API uses the unaccelerated software-based rendering.
1902 */
1836EAPI Ecore_Evas *ecore_evas_software_ddraw_new(Ecore_Win32_Window *parent, 1903EAPI Ecore_Evas *ecore_evas_software_ddraw_new(Ecore_Win32_Window *parent,
1837 int x, 1904 int x,
1838 int y, 1905 int y,
@@ -1859,8 +1926,34 @@ EAPI Ecore_Evas *ecore_evas_gl_glew_new(Ecore_Win32_Window *parent,
1859 1926
1860EAPI Ecore_Win32_Window *ecore_evas_win32_window_get(const Ecore_Evas *ee); 1927EAPI Ecore_Win32_Window *ecore_evas_win32_window_get(const Ecore_Evas *ee);
1861 1928
1929/**
1930 * @brief Creates a new @c Ecore_Evas canvas bound to the Evas
1931 * @b SDL engine.
1932 *
1933 * @param name Device target name, defaults to "EFL SDL" if NULL.
1934 * @param w Width of the canvas, in pixels.
1935 * @param h Height of the canvas, in pixels.
1936 * @param fullscreen Set the fullscreen property for the window.
1937 * @param hwsurface Set the hardware surface property for the window.
1938 * @param noframe Set the noframe flag on the einfo.
1939 * @param alpha Set alpha for the Ecore_Evas window.
1940 * @return A new @c Ecore_Evas instance, or @c NULL on failure.
1941 */
1862EAPI Ecore_Evas *ecore_evas_sdl_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha); 1942EAPI Ecore_Evas *ecore_evas_sdl_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha);
1943
1863EAPI Ecore_Evas *ecore_evas_sdl16_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha); 1944EAPI Ecore_Evas *ecore_evas_sdl16_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha);
1945
1946/**
1947 * @brief Creates a new @c Ecore_Evas canvas bound to the Evas
1948 * @b SDL + gl engine.
1949 *
1950 * @param name Device target name, defaults to "EFL SDL" if NULL.
1951 * @param w Width of the canvas, in pixels.
1952 * @param h Height of the canvas, in pixels.
1953 * @param fullscreen Set the fullscreen property for the window.
1954 * @param noframe Set the noframe flag on the einfo.
1955 * @return A new @c Ecore_Evas instance or @c NULL on failure
1956 */
1864EAPI Ecore_Evas *ecore_evas_gl_sdl_new(const char* name, int w, int h, int fullscreen, int noframe); 1957EAPI Ecore_Evas *ecore_evas_gl_sdl_new(const char* name, int w, int h, int fullscreen, int noframe);
1865 1958
1866EAPI Ecore_Evas *ecore_evas_software_wince_new(Ecore_WinCE_Window *parent, 1959EAPI Ecore_Evas *ecore_evas_software_wince_new(Ecore_WinCE_Window *parent,
@@ -1895,12 +1988,38 @@ EAPI Ecore_Evas *ecore_evas_software_wince_gdi_new(Ecore_WinCE_Window *paren
1895 1988
1896EAPI Ecore_WinCE_Window *ecore_evas_software_wince_window_get(const Ecore_Evas *ee) EINA_DEPRECATED; 1989EAPI Ecore_WinCE_Window *ecore_evas_software_wince_window_get(const Ecore_Evas *ee) EINA_DEPRECATED;
1897 1990
1991/**
1992 * @brief Creates a new @c Ecore_Evas canvas bound to the Evas
1993 * @b Cocoa engine.
1994 *
1995 * @param parent ID of the parent window this Ecore_Evas window belongs
1996 * to, or 0 if this is a top-level window.
1997 * @param x Horizontal position of window, in pixels
1998 * @param y Vertical position of window, in pixels
1999 * @param w Width of the canvas, in pixels.
2000 * @param h Height of the canvas, in pixels.
2001 *
2002 * The cocoa backend is used for MacOS based systems.
2003 */
1898EAPI Ecore_Evas *ecore_evas_cocoa_new(Ecore_Cocoa_Window *parent, 2004EAPI Ecore_Evas *ecore_evas_cocoa_new(Ecore_Cocoa_Window *parent,
1899 int x, 2005 int x,
1900 int y, 2006 int y,
1901 int w, 2007 int w,
1902 int h); 2008 int h);
1903 2009
2010/**
2011 * @brief Creates a new @c Ecore_Evas canvas bound to the Evas
2012 * @b psl1ght engine.
2013 *
2014 * @param parent ID of the parent window this Ecore_Evas window belongs
2015 * to, or 0 if this is a top-level window.
2016 * @param x Horizontal position of window, in pixels
2017 * @param y Vertical position of window, in pixels
2018 * @param w Width of the canvas, in pixels.
2019 * @param h Height of the canvas, in pixels.
2020 *
2021 * The psl1ght backend is used for the PS3 GameOS.
2022 */
1904EAPI Ecore_Evas *ecore_evas_psl1ght_new(const char* name, int w, int h); 2023EAPI Ecore_Evas *ecore_evas_psl1ght_new(const char* name, int w, int h);
1905 2024
1906 2025