summaryrefslogtreecommitdiff
path: root/src/lib/evas/Evas_Common.h
diff options
context:
space:
mode:
authorChunEon Park <hermet@hermet.pe.kr>2014-09-11 12:17:56 +0900
committerChunEon Park <hermet@hermet.pe.kr>2014-09-11 12:17:56 +0900
commit17f75c962798170b31f40341baac2205fbbc3ae7 (patch)
treecfcc91ab5a7b6ec3701ee33057e0d2a9fafcb22e /src/lib/evas/Evas_Common.h
parent2219c0329d7ee5ea177e12a6bf736f0b084f7fbb (diff)
evas: updated native surface documentation.
Diffstat (limited to 'src/lib/evas/Evas_Common.h')
-rw-r--r--src/lib/evas/Evas_Common.h33
1 files changed, 28 insertions, 5 deletions
diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h
index adafbdd570..3fc0da5857 100644
--- a/src/lib/evas/Evas_Common.h
+++ b/src/lib/evas/Evas_Common.h
@@ -419,17 +419,40 @@ struct _Evas_Pixel_Import_Source
419/* magic version number to know what the native surf struct looks like */ 419/* magic version number to know what the native surf struct looks like */
420#define EVAS_NATIVE_SURFACE_VERSION 2 420#define EVAS_NATIVE_SURFACE_VERSION 2
421 421
422/**
423 * Native surface types that image object supports
424 *
425 * @see Evas_Native_Surface
426 * @see evas_object_image_native_surface_set()
427 */
422typedef enum _Evas_Native_Surface_Type 428typedef enum _Evas_Native_Surface_Type
423{ 429{
424 EVAS_NATIVE_SURFACE_NONE, 430 EVAS_NATIVE_SURFACE_NONE, /**< No surface type */
425 EVAS_NATIVE_SURFACE_X11, 431 EVAS_NATIVE_SURFACE_X11, /**< X Window system based type. pixmap id or visual of the pixmap */
426 EVAS_NATIVE_SURFACE_OPENGL 432 EVAS_NATIVE_SURFACE_OPENGL /**< OpenGL system based type. texture or framebuffer id*/
427} Evas_Native_Surface_Type; 433} Evas_Native_Surface_Type;
428 434
435/**
436 * @brief A generic datatype for engine specific native surface information.
437 *
438 * Please fill up Evas_Native_Surface fields that regarded with current surface
439 * type. If you want to set the native surface type to
440 * EVAS_NATIVE_SURFACE_X11, you need to set union data with x11.visual or
441 * x11.pixmap. If you need to set the native surface as
442 * EVAS_NATIVE_SURFACE_OPENGL, on the other hand, you need to set union data
443 * with opengl.texture_id or opengl.framebuffer_id and so on. The version field
444 * should be set with EVAS_NATIVE_SURFACE_VERSION in order to check abi
445 * break in your application on the different efl library versions.
446 *
447 * @warning Native surface types totally depend on the system. Please
448 * be aware that the types are supported on your system before using
449 * them.
450 * @see evas_object_image_native_surface_set()
451 */
429struct _Evas_Native_Surface 452struct _Evas_Native_Surface
430{ 453{
431 int version; 454 int version; /**< Current Native Surface Version. Use EVAS_NATIVE_SURFACE_VERSION */
432 Evas_Native_Surface_Type type; 455 Evas_Native_Surface_Type type; /**< Surface type. @see Evas_Native_Surface_Type */
433 union { 456 union {
434 struct 457 struct
435 { 458 {