From e0344468d80d655520733494de5ae4c043d5705e Mon Sep 17 00:00:00 2001 From: Robert Bragg Date: Fri, 28 Oct 2011 18:31:05 +0100 Subject: [PATCH] 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 +++++ .../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 b2a4ae057..48911a034 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 417deb332..0e9cf2ef6 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 d8d676c9d..6c4d53350 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 @@
Textures + + +
+ +
+ Meta Textures + + + +
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 12888aeb7..f8a1185aa 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 @@ -279,24 +280,14 @@ cogl_draw_indexed_vertex_attributes_array
cogl-texture The Texture Interface -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 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
cogl-texture-2d 2D textures +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
cogl-texture-rectangle Rectangle textures (non-normalized coordinates) +CoglTextureRectangle cogl_texture_rectangle_new_with_size cogl_is_texture_rectangle
@@ -323,18 +316,46 @@ cogl_is_texture_rectangle
cogl-texture-3d 3D textures +CoglTexture3D cogl_texture_3d_new_with_size cogl_texture_3d_new_from_data cogl_is_texture_3d
+
+cogl-meta-texture +High Level Meta Textures +CoglMetaTexture +CoglMetaTextureCallback +cogl_meta_texture_foreach_in_region +
+
cogl-sub-texture Sub Textures +CoglSubTexture cogl_sub_texture_new cogl_is_sub_texture
+
+cogl-texture-2d-sliced +Sliced Textures +CoglTexture2DSliced +cogl_texture_2d_sliced_new_with_size +cogl_is_texture_2d_sliced +
+ +
+cogl-texture-pixmap-x11 +X11 Texture From Pixmap +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 +
+
cogl-framebuffer CoglFramebuffer: The Framebuffer Interface