Update doxygen comments wrt constant changing of pixmap id

Signed-off-by: Chris Michael <cp.michael@samsung.com>
This commit is contained in:
Chris Michael 2013-07-11 08:46:53 +01:00
parent fa9f891bce
commit 2dc165936d
1 changed files with 16 additions and 0 deletions

View File

@ -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);