summaryrefslogtreecommitdiff
path: root/src/lib/ecore_evas
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-04-26 13:34:52 -0400
committerChris Michael <cp.michael@samsung.com>2017-04-26 13:34:52 -0400
commit70cbb29477dce72b3ae2e22ca2840db7d722bd98 (patch)
tree493d8090778ce2f07c8346437b4b50a1ee282f56 /src/lib/ecore_evas
parent6af85271177f41a07d59b14759236c9f4a5bd1de (diff)
ecore_evas: Add doxygen for ecore_evas_gl_x11_options_new()
Reviewers: devilhorns Subscribers: cedric, jpeg Differential Revision: https://phab.enlightenment.org/D4828
Diffstat (limited to 'src/lib/ecore_evas')
-rw-r--r--src/lib/ecore_evas/Ecore_Evas.h30
1 files changed, 30 insertions, 0 deletions
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index a800f2757b..56bbcb3e56 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -1221,16 +1221,46 @@ EAPI Ecore_X_Pixmap ecore_evas_software_x11_pixmap_get(const Ecore_Evas *ee);
1221 1221
1222/** 1222/**
1223 * @brief Creates Ecore_Evas using opengl x11. 1223 * @brief Creates Ecore_Evas using opengl x11.
1224 *
1224 * @note If ecore is not compiled with support for x11 then nothing is done and NULL is returned. 1225 * @note If ecore is not compiled with support for x11 then nothing is done and NULL is returned.
1226 *
1225 * @param disp_name The name of the display of the Ecore_Evas to be created. 1227 * @param disp_name The name of the display of the Ecore_Evas to be created.
1226 * @param parent The parent of the Ecore_Evas to be created. 1228 * @param parent The parent of the Ecore_Evas to be created.
1227 * @param x The X coordinate to be used. 1229 * @param x The X coordinate to be used.
1228 * @param y The Y coordinate to be used. 1230 * @param y The Y coordinate to be used.
1229 * @param w The width of the Ecore_Evas to be created. 1231 * @param w The width of the Ecore_Evas to be created.
1230 * @param h The height of the Ecore_Evas to be created. 1232 * @param h The height of the Ecore_Evas to be created.
1233 *
1231 * @return The new Ecore_Evas. 1234 * @return The new Ecore_Evas.
1232 */ 1235 */
1233EAPI Ecore_Evas *ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); 1236EAPI Ecore_Evas *ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
1237
1238/**
1239 * @brief Create Ecore_Evas using OpenGL X11, with options
1240 *
1241 * Allows creation of an Ecore_Evas, similar to ecore_evas_gl_x11_new,
1242 * except it permits passing in @p opt, a NULL-terminated C array of
1243 * key/value pairs for various settings, as follows:
1244 *
1245 * ECORE_EVAS_GL_X11_OPT_INDIRECT: Use indirect rendering [0,1]
1246 * ECORE_EVAS_GL_X11_OPT_VSYNC: Use vsync [0,1]
1247 * ECORE_EVAS_GL_X11_OPT_SWAP_MODE: Swap mode to assume (see Evas_Engine_Info_Gl_Swap_Mode)
1248 * ECORE_EVAS_GL_X11_OPT_GL_DEPTH: depth_bits
1249 * ECORE_EVAS_GL_X11_OPT_GL_STENCIL: stencil_bits
1250 * ECORE_EVAS_GL_X11_OPT_GL_MSAA: msaa_bits
1251 *
1252 * @note If ecore is not compiled with support for x11 then nothing is done and NULL is returned.
1253 *
1254 * @param disp_name The name of the display of the Ecore_Evas to be created.
1255 * @param parent The parent of the Ecore_Evas to be created.
1256 * @param x The X coordinate to be used.
1257 * @param y The Y coordinate to be used.
1258 * @param w The width of the Ecore_Evas to be created.
1259 * @param h The height of the Ecore_Evas to be created.
1260 * @param opt The options array (see above)
1261 *
1262 * @return The new Ecore_Evas.
1263 */
1234EAPI Ecore_Evas *ecore_evas_gl_x11_options_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h, const int *opt); 1264EAPI Ecore_Evas *ecore_evas_gl_x11_options_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h, const int *opt);
1235 1265
1236/** 1266/**