Document GisOpenGL

[grits] / src / gis-opengl.c

diff --git a/src/gis-opengl.c b/src/gis-opengl.c
index ad0b5f4a2cabb56a13745356a3c2b56c648d689a..bb2095113d9830d2bc1ad874396b62a946136dea 100644 (file)
--- a/src/gis-opengl.c
+++ b/src/gis-opengl.c
@@ -15,9 +15,17 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/* Tessellation, "finding intersecting triangles" */
-/* http://research.microsoft.com/pubs/70307/tr-2006-81.pdf */
-/* http://www.opengl.org/wiki/Alpha_Blending */
+/**
+ * SECTION:gis-opengl
+ * @short_description: OpenGL based virtual globe
+ *
+ * #GisOpenGL is the core rendering engine used by libgis. Theoretically other
+ * renderers could be writte, but they have not been. GisOpenGL uses the ROAM
+ * algorithm for updating surface mesh the planet. The only thing GisOpenGL can
+ * actually render on it's own is a wireframe of a sphere.
+ *
+ * GisOpenGL relies on #GtkGlExt and requires (at least) OpenGL 2.0.
+ */
 
 #include <config.h>
 #include <math.h>
@@ -466,6 +474,15 @@ static gboolean on_idle(GisOpenGL *opengl)
 /*********************
  * GisViewer methods *
  *********************/
+/**
+ * gis_opengl_new:
+ * @plugins: the plugins store to use
+ * @prefs:   the preferences object to use
+ *
+ * Create a new OpenGL renderer.
+ *
+ * Returns: the new #GisOpenGL
+ */
 GisViewer *gis_opengl_new(GisPlugins *plugins, GisPrefs *prefs)
 {
        g_debug("GisOpenGL: new");