summaryrefslogtreecommitdiff
path: root/src/lib/evas
diff options
context:
space:
mode:
authorJean-Philippe Andre <jp.andre@samsung.com>2014-11-27 16:15:23 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2014-11-27 16:46:31 +0900
commitda87709dd3bd289181ce221f71877ed62040d5c4 (patch)
tree558707e30cfaac0e0acbe8e7bd5f7167843b6ad3 /src/lib/evas
parent129ba38cc75e4553934b569959f1eae86e4b5577 (diff)
Evas GL: Doc: Tell people not to read info from Evas_Native_Surface
The information set there is not meant to be read by applications and reused there. This would break the whole concept of letting Evas deal with its surfaces. Ideally Evas GL should not expose texture or fbo ID to external applications. We could even use a new (non public) surface type for that purpose.
Diffstat (limited to 'src/lib/evas')
-rw-r--r--src/lib/evas/Evas_Common.h6
-rw-r--r--src/lib/evas/Evas_GL.h4
2 files changed, 10 insertions, 0 deletions
diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h
index a09cb20cc4..ed336c23cf 100644
--- a/src/lib/evas/Evas_Common.h
+++ b/src/lib/evas/Evas_Common.h
@@ -491,6 +491,12 @@ typedef enum _Evas_Native_Surface_Type
491 * @warning Native surface types totally depend on the system. Please 491 * @warning Native surface types totally depend on the system. Please
492 * be aware that the types are supported on your system before using 492 * be aware that the types are supported on your system before using
493 * them. 493 * them.
494 *
495 * @note The information stored in an @c Evas_Native_Surface returned by
496 * @ref evas_gl_native_surface_get() is not meant to be used by
497 * applications except for passing it to
498 * @ref evas_object_image_native_surface_set().
499 *
494 * @see evas_object_image_native_surface_set() 500 * @see evas_object_image_native_surface_set()
495 */ 501 */
496struct _Evas_Native_Surface 502struct _Evas_Native_Surface
diff --git a/src/lib/evas/Evas_GL.h b/src/lib/evas/Evas_GL.h
index a06b523277..eb55d081e2 100644
--- a/src/lib/evas/Evas_GL.h
+++ b/src/lib/evas/Evas_GL.h
@@ -681,6 +681,10 @@ EAPI Evas_GL_Func evas_gl_proc_address_get (Evas_GL *evas_gl, cons
681 * @details This function can be called to later set this native surface as 681 * @details This function can be called to later set this native surface as
682 * source of an Evas Object Image. Please refer to 682 * source of an Evas Object Image. Please refer to
683 * @ref evas_object_image_native_surface_set. 683 * @ref evas_object_image_native_surface_set.
684 *
685 * @warning Applications should not rely on the information set in @p ns
686 * since its properties are internal to Evas and are not meant to be
687 * tampered with in any way or form from outside Evas.
684 */ 688 */
685EAPI Eina_Bool evas_gl_native_surface_get (Evas_GL *evas_gl, Evas_GL_Surface *surf, Evas_Native_Surface *ns) EINA_ARG_NONNULL(1,2,3); 689EAPI Eina_Bool evas_gl_native_surface_get (Evas_GL *evas_gl, Evas_GL_Surface *surf, Evas_Native_Surface *ns) EINA_ARG_NONNULL(1,2,3);
686 690