summaryrefslogtreecommitdiff
path: root/src/lib/ecore_evas
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-05-08 15:17:46 -0700
committerCedric BAIL <cedric@osg.samsung.com>2017-05-08 15:17:48 -0700
commit9c04a046a6c0228262d0e2efb03c10a5bda6eb86 (patch)
tree58758d19dfaec8a858b39e6fce0f0216ce0218d3 /src/lib/ecore_evas
parent7c368923a1c257f843097bc8660377f7185fb7ae (diff)
ecore_evas: doc experimental comp_sync API
Summary: (And indicate it's likely to be made private in EFL 2) Reviewers: stefan_schmidt Subscribers: stefan_schmidt, cedric, jpeg Differential Revision: https://phab.enlightenment.org/D4850 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.h44
1 files changed, 44 insertions, 0 deletions
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index 56bbcb3e56..0675f8d6c8 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -174,7 +174,25 @@ EAPI int ecore_evas_init(void);
174 */ 174 */
175EAPI int ecore_evas_shutdown(void); 175EAPI int ecore_evas_shutdown(void);
176 176
177/**
178 * @brief Sets application compositor synchronization on/off
179 *
180 * Turns on client+server synchronized rendering in X11. App comp sync
181 * is disabled by default, but can be turned on optionally.
182 *
183 * @note This is an experimental functionality and is likely to be removed.
184 *
185 * @param do_sync True to enable comp syncing, False to disable
186 */
177EAPI void ecore_evas_app_comp_sync_set(Eina_Bool do_sync); 187EAPI void ecore_evas_app_comp_sync_set(Eina_Bool do_sync);
188
189/**
190 * @brief Get the compositing synchronization state
191 *
192 * @note This is an experimental functionality and is likely to be removed.
193 *
194 * @return True if app comp sync is enabled.
195 */
178EAPI Eina_Bool ecore_evas_app_comp_sync_get(void); 196EAPI Eina_Bool ecore_evas_app_comp_sync_get(void);
179 197
180/** 198/**
@@ -2437,7 +2455,33 @@ EAPI void ecore_evas_input_event_unregister(Ecore_Evas *ee);
2437 * pipeline, thus bring its window to an up to date state. 2455 * pipeline, thus bring its window to an up to date state.
2438 */ 2456 */
2439EAPI void ecore_evas_manual_render(Ecore_Evas *ee); 2457EAPI void ecore_evas_manual_render(Ecore_Evas *ee);
2458
2459/**
2460 * @brief Sets comp syncing to enabled/disabled
2461 *
2462 * Turns on client+server synchronized rendering in X11. Comp sync is
2463 * disabled by default, but can be turned on optionally. Can also be
2464 * set via the ECORE_EVAS_COMP_NOSYNC / ECORE_EVAS_COMP_SYNC
2465 * environmental variables.
2466 *
2467 * @note This is an experimental functionality and is likely to be
2468 * removed in future versions of EFL.
2469 *
2470 * @param ee An @c Ecore_Evas handle
2471 * @param do_sync True to enable comp syncing, False to disable
2472 */
2440EAPI void ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync); 2473EAPI void ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync);
2474
2475/**
2476 * @brief Gets the comp sync state
2477 *
2478 * @note This is an experimental functionality and is likely to be
2479 * removed in future versions of EFL.
2480 *
2481 * @param ee An @c Ecore_Evas handle
2482 *
2483 * @return True if composition synchronization is enabled, False otherwise
2484 */
2441EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee); 2485EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee);
2442 2486
2443/** 2487/**