devilhorns pushed a commit to branch master.

commit 2dc165936de16ba5e6f66045344c15fd1dec2eda
Author: Chris Michael <[email protected]>
Date:   Thu Jul 11 08:46:53 2013 +0100

    Update doxygen comments wrt constant changing of pixmap id
    
    Signed-off-by: Chris Michael <[email protected]>
---
 src/lib/ecore_evas/Ecore_Evas.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index d1fd0d7..cf88905 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -933,6 +933,10 @@ EAPI void            
ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *
  * @brief Create a new Ecore_Evas which does not contain an XWindow. It will 
  * only contain an XPixmap to render to
  * 
+ * @warning The XPixmap ID can change with every frame after it is rendered, 
+ * so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you 
+ * need the current pixmap id.
+ * 
  * @since 1.8
  */
 EAPI Ecore_Evas     *ecore_evas_software_x11_pixmap_new(const char *disp_name, 
Ecore_X_Window parent, int x, int y, int w, int h);
@@ -945,6 +949,10 @@ EAPI Ecore_Evas     
*ecore_evas_software_x11_pixmap_new(const char *disp_name, E
  * 
  * @warning Support for this depends on the underlying windowing system.
  * 
+ * @warning The XPixmap ID can change with every frame after it is rendered, 
+ * so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you 
+ * need the current pixmap id.
+ * 
  * @since 1.8
  */
 EAPI Ecore_X_Pixmap ecore_evas_software_x11_pixmap_get(const Ecore_Evas *ee);
@@ -973,6 +981,10 @@ EAPI void            
ecore_evas_gl_x11_pre_post_swap_callback_set(const Ecore_Ev
  * @brief Create a new Ecore_Evas which does not contain an XWindow. It will 
  * only contain an XPixmap to render to
  * 
+ * @warning The XPixmap ID can change with every frame after it is rendered, 
+ * so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you 
+ * need the current pixmap id.
+ * 
  * @since 1.8
  */
 EAPI Ecore_Evas     *ecore_evas_gl_x11_pixmap_new(const char *disp_name, 
Ecore_X_Window parent, int x, int y, int w, int h);
@@ -985,6 +997,10 @@ EAPI Ecore_Evas     *ecore_evas_gl_x11_pixmap_new(const 
char *disp_name, Ecore_X
  * 
  * @warning Support for this depends on the underlying windowing system.
  * 
+ * @warning The XPixmap ID can change with every frame after it is rendered, 
+ * so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you 
+ * need the current pixmap id.
+ * 
  * @since 1.8
  */
 EAPI Ecore_X_Pixmap ecore_evas_gl_x11_pixmap_get(const Ecore_Evas *ee);

-- 

------------------------------------------------------------------------------
See everything from the browser to the database with AppDynamics
Get end-to-end visibility with application monitoring from AppDynamics
Isolate bottlenecks and diagnose root cause in seconds.
Start your free trial of AppDynamics Pro today!
http://pubads.g.doubleclick.net/gampad/clk?id=48808831&iu=/4140/ostg.clktrk

Reply via email to