[cogl] docs: Adds various missing 2.0 sections and symbols



commit e0344468d80d655520733494de5ae4c043d5705e
Author: Robert Bragg <robert linux intel com>
Date:   Fri Oct 28 18:31:05 2011 +0100

    docs: Adds various missing 2.0 sections and symbols
    
    This adds a number of missing sections and symbols to the experimental
    2.0 reference manual.

 cogl/winsys/cogl-texture-pixmap-x11.h              |   10 +++++
 doc/reference/cogl-2.0-experimental/Makefile.am    |    7 ++-
 .../cogl-2.0-experimental-docs.xml.in              |   10 +++++
 .../cogl-2.0-experimental-sections.txt             |   43 +++++++++++++++-----
 4 files changed, 56 insertions(+), 14 deletions(-)
---
diff --git a/cogl/winsys/cogl-texture-pixmap-x11.h b/cogl/winsys/cogl-texture-pixmap-x11.h
index b2a4ae0..48911a0 100644
--- a/cogl/winsys/cogl-texture-pixmap-x11.h
+++ b/cogl/winsys/cogl-texture-pixmap-x11.h
@@ -28,6 +28,16 @@
 
 #ifdef COGL_ENABLE_EXPERIMENTAL_API
 
+/**
+ * SECTION:cogl-texture-pixmap-x11
+ * @short_description: Functions for creating and manipulating 2D meta
+ *                     textures derived from X11 pixmaps.
+ *
+ * These functions allow high-level meta textures (See the
+ * #CoglMetaTexture interface) that derive their contents from an X11
+ * pixmap.
+ */
+
 /* All of the cogl-texture-pixmap-x11 API is currently experimental so
  * we suffix the actual symbols with _EXP so if somone is monitoring
  * for ABI changes it will hopefully be clearer to them what's going
diff --git a/doc/reference/cogl-2.0-experimental/Makefile.am b/doc/reference/cogl-2.0-experimental/Makefile.am
index 417deb3..0e9cf2e 100644
--- a/doc/reference/cogl-2.0-experimental/Makefile.am
+++ b/doc/reference/cogl-2.0-experimental/Makefile.am
@@ -46,7 +46,9 @@ FIXXREF_OPTIONS=\
 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
 HFILE_GLOB=\
 	$(top_srcdir)/cogl/*.h \
-	$(top_builddir)/cogl/*.h
+	$(top_builddir)/cogl/*.h \
+	$(top_srcdir)/cogl/winsys/*.h \
+	$(top_builddir)/cogl/winsys/*.h
 CFILE_GLOB=$(top_srcdir)/cogl/*.c
 
 # Header files to ignore when scanning.
@@ -111,8 +113,7 @@ IGNORE_HFILES=\
 	cogl-profile.h				\
 	cogl-util.h 				\
 	driver 					\
-	tesselator				\
-	winsys
+	tesselator
 
 EXTRA_HFILES=
 
diff --git a/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml.in b/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml.in
index d8d676c..6c4d533 100644
--- a/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml.in
+++ b/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml.in
@@ -97,7 +97,17 @@
     <section id="cogl-textures">
       <title>Textures</title>
       <xi:include href="xml/cogl-texture.xml"/>
+      <xi:include href="xml/cogl-texture-2d.xml"/>
       <xi:include href="xml/cogl-texture-3d.xml"/>
+      <xi:include href="xml/cogl-texture-rectangle.xml"/>
+    </section>
+
+    <section id="cogl-meta-textures">
+      <title>Meta Textures</title>
+      <xi:include href="xml/cogl-meta-texture.xml"/>
+      <xi:include href="xml/cogl-sub-texture.xml"/>
+      <xi:include href="xml/cogl-texture-2d-sliced.xml"/>
+      <xi:include href="xml/cogl-texture-pixmap-x11.xml"/>
     </section>
 
     <xi:include href="xml/cogl-clipping.xml"/>
diff --git a/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt b/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt
index 12888ae..f8a1185 100644
--- a/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt
+++ b/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt
@@ -173,6 +173,7 @@ cogl_clip_push_rectangle
 cogl_clip_push_window_rectangle
 cogl_clip_push_from_path
 cogl_clip_push_from_path_preserve
+cogl_clip_push_primitive
 cogl_clip_pop
 </SECTION>
 
@@ -279,24 +280,14 @@ cogl_draw_indexed_vertex_attributes_array
 <SECTION>
 <FILE>cogl-texture</FILE>
 <TITLE>The Texture Interface</TITLE>
-CoglTextureVertex
-CoglTextureFlags
-cogl_texture_new_with_size
-cogl_texture_new_from_file
-cogl_texture_new_from_data
-cogl_texture_new_from_foreign
-cogl_texture_new_from_bitmap
-cogl_texture_new_from_sub_texture
+CoglTexture
 cogl_is_texture
 
 <SUBSECTION>
 cogl_texture_get_width
 cogl_texture_get_height
 cogl_texture_get_format
-cogl_texture_get_rowstride
-cogl_texture_get_max_waste
 cogl_texture_is_sliced
-cogl_texture_get_gl_texture
 cogl_texture_get_data
 cogl_texture_set_region
 
@@ -307,6 +298,7 @@ COGL_TEXTURE_MAX_WASTE
 <SECTION>
 <FILE>cogl-texture-2d</FILE>
 <TITLE>2D textures</TITLE>
+CoglTexture2D
 cogl_texture_2d_new_with_size
 cogl_texture_2d_new_from_data
 cogl_texture_2d_new_from_foreign
@@ -316,6 +308,7 @@ cogl_is_texture_rectangle
 <SECTION>
 <FILE>cogl-texture-rectangle</FILE>
 <TITLE>Rectangle textures (non-normalized coordinates)</TITLE>
+CoglTextureRectangle
 cogl_texture_rectangle_new_with_size
 cogl_is_texture_rectangle
 </SECTION>
@@ -323,19 +316,47 @@ cogl_is_texture_rectangle
 <SECTION>
 <FILE>cogl-texture-3d</FILE>
 <TITLE>3D textures</TITLE>
+CoglTexture3D
 cogl_texture_3d_new_with_size
 cogl_texture_3d_new_from_data
 cogl_is_texture_3d
 </SECTION>
 
 <SECTION>
+<FILE>cogl-meta-texture</FILE>
+<TITLE>High Level Meta Textures</TITLE>
+CoglMetaTexture
+CoglMetaTextureCallback
+cogl_meta_texture_foreach_in_region
+</SECTION>
+
+<SECTION>
 <FILE>cogl-sub-texture</FILE>
 <TITLE>Sub Textures</TITLE>
+CoglSubTexture
 cogl_sub_texture_new
 cogl_is_sub_texture
 </SECTION>
 
 <SECTION>
+<FILE>cogl-texture-2d-sliced</FILE>
+<TITLE>Sliced Textures</TITLE>
+CoglTexture2DSliced
+cogl_texture_2d_sliced_new_with_size
+cogl_is_texture_2d_sliced
+</SECTION>
+
+<SECTION>
+<FILE>cogl-texture-pixmap-x11</FILE>
+<TITLE>X11 Texture From Pixmap</TITLE>
+cogl_texture_pixmap_x11_new
+cogl_texture_pixmap_x11_update_area
+cogl_texture_pixmap_x11_is_using_tfp_extension
+cogl_texture_pixmap_x11_set_damage_object
+cogl_is_texture_pixmap_x11
+</SECTION>
+
+<SECTION>
 <FILE>cogl-framebuffer</FILE>
 <TITLE>CoglFramebuffer: The Framebuffer Interface</TITLE>
 CoglFramebuffer



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]