summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_glview.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_glview.h')
-rw-r--r--src/lib/elementary/elm_glview.h38
1 files changed, 38 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_glview.h b/src/lib/elementary/elm_glview.h
new file mode 100644
index 0000000000..d1c6672d3b
--- /dev/null
+++ b/src/lib/elementary/elm_glview.h
@@ -0,0 +1,38 @@
+/**
+ * @defgroup Elm_GLView GLView
+ * @ingroup Elementary
+ *
+ * @image html glview_inheritance_tree.png
+ * @image latex glview_inheritance_tree.eps
+ *
+ * A GLView widget allows for simple GL rendering in elementary environment.
+ * GLView hides all the complicated evas_gl details so that the user only
+ * has to deal with registering a few callback functions for rendering
+ * to a surface using OpenGL APIs.
+ *
+ * This widget emits the following signals, besides the ones sent from
+ * @ref GLView:
+ * - @c "focused" - when glview has received focus.
+ * - @c "unfocused" - when glview has lost focus.
+ * - @c "language,changed" - the program's language changed
+ *
+ * Below is an illustrative example of how to use GLView and and OpenGL
+ * to render in elementary environment.
+ * @ref glview_example_01_page
+ *
+ */
+
+/**
+ * @ingroup Elm_GLView
+ */
+
+#include "elm_glview_common.h"
+#ifdef EFL_EO_API_SUPPORT
+#include "elm_glview_eo.h"
+#endif
+#ifndef EFL_NOLEGACY_API_SUPPORT
+#include "elm_glview_legacy.h"
+#endif
+/**
+ * @}
+ */