summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Bruguier <nicolas.bruguier@supersonicimagine.fr>2008-11-30 18:17:03 +0100
committerNicolas Bruguier <nicolas.bruguier@supersonicimagine.fr>2008-11-30 18:17:03 +0100
commitbb178adfdf8075dfd992b999e855cb947634672e (patch)
treea1854e242c861ea83119addfa3a85fd7cc7512ec
parent68492bd15c925e9d954e0879ab7f407006ad343f (diff)
[doc] Update glx docsHEADmaster
Remove obsolete functions and add offscreen pixmaps methods in glx section.
-rw-r--r--doc/reference/glitz-sections.txt7
-rw-r--r--doc/reference/glitz-undeclared.txt7
-rw-r--r--doc/reference/glitz-undocumented.txt21
-rw-r--r--doc/reference/tmpl/glitz-formats.sgml16
-rw-r--r--doc/reference/tmpl/glitz-formats.sgml.sgml16
-rw-r--r--doc/reference/tmpl/glitz-glx.sgml54
-rw-r--r--doc/reference/tmpl/glitz-surface.sgml20
-rw-r--r--doc/reference/tmpl/glitz-types.sgml7
-rw-r--r--doc/reference/tmpl/glitz-unused.sgml49
9 files changed, 127 insertions, 70 deletions
diff --git a/doc/reference/glitz-sections.txt b/doc/reference/glitz-sections.txt
index 83c2348..ac8a738 100644
--- a/doc/reference/glitz-sections.txt
+++ b/doc/reference/glitz-sections.txt
@@ -67,7 +67,8 @@ GLITZ_FORMAT_DEPTH_SIZE_MASK
GLITZ_FORMAT_STENCIL_SIZE_MASK
GLITZ_FORMAT_DOUBLEBUFFER_MASK
GLITZ_FORMAT_SAMPLES_MASK
-GLITZ_FORMAT_Y_INVERTED_MASK
+GLITZ_FORMAT_SCANLINE_ORDER_MASK
+GLITZ_FORMAT_DEPTH_MASK
glitz_drawable_format_t
glitz_format_t
glitz_find_standard_format
@@ -261,11 +262,13 @@ glitz_glx_find_window_format
glitz_glx_find_pbuffer_format
glitz_glx_find_drawable_format_for_visual
glitz_glx_get_visual_info_from_format
-glitz_glx_get_xdrawable
glitz_glx_create_drawable_for_window
glitz_glx_create_drawable_for_pixmap
glitz_glx_create_pixmap_drawable
glitz_glx_create_pbuffer_drawable
+glitz_glx_get_display_from_drawable
+glitz_glx_get_screen_from_drawable
+glitz_glx_get_drawable_from_drawable
</SECTION>
<SECTION>
diff --git a/doc/reference/glitz-undeclared.txt b/doc/reference/glitz-undeclared.txt
index 5bcdd50..e69de29 100644
--- a/doc/reference/glitz-undeclared.txt
+++ b/doc/reference/glitz-undeclared.txt
@@ -1,7 +0,0 @@
-GLITZ_FEATURE_TEXTURE_FROM_PIXMAP_MASK
-GLITZ_FORMAT_Y_INVERTED_MASK
-glitz_glx_create_drawable_for_pixmap
-glitz_glx_create_pixmap_drawable
-glitz_glx_get_xdrawable
-glitz_surface_bind_tex_image
-glitz_surface_release_tex_image
diff --git a/doc/reference/glitz-undocumented.txt b/doc/reference/glitz-undocumented.txt
index 722ce57..755924d 100644
--- a/doc/reference/glitz-undocumented.txt
+++ b/doc/reference/glitz-undocumented.txt
@@ -1,7 +1,7 @@
-0% symbol docs coverage.
-1 symbols documented.
+6% symbol docs coverage.
+15 symbols documented.
0 symbols incomplete.
-231 not documented.
+228 not documented.
GLITZ_FEATURE_BLEND_COLOR_MASK
@@ -19,12 +19,14 @@ GLITZ_FEATURE_PIXEL_BUFFER_OBJECT_MASK
GLITZ_FEATURE_TEXTURE_BORDER_CLAMP_MASK
GLITZ_FEATURE_TEXTURE_ENV_COMBINE_MASK
GLITZ_FEATURE_TEXTURE_ENV_DOT3_MASK
+GLITZ_FEATURE_TEXTURE_FROM_PIXMAP_MASK
GLITZ_FEATURE_TEXTURE_MIRRORED_REPEAT_MASK
GLITZ_FEATURE_TEXTURE_NON_POWER_OF_TWO_MASK
GLITZ_FEATURE_TEXTURE_RECTANGLE_MASK
GLITZ_FEATURE_VERTEX_BUFFER_OBJECT_MASK
GLITZ_FORMAT_ALPHA_SIZE_MASK
GLITZ_FORMAT_BLUE_SIZE_MASK
+GLITZ_FORMAT_DEPTH_MASK
GLITZ_FORMAT_DEPTH_SIZE_MASK
GLITZ_FORMAT_DOUBLEBUFFER_MASK
GLITZ_FORMAT_FOURCC_MASK
@@ -32,6 +34,7 @@ GLITZ_FORMAT_GREEN_SIZE_MASK
GLITZ_FORMAT_ID_MASK
GLITZ_FORMAT_RED_SIZE_MASK
GLITZ_FORMAT_SAMPLES_MASK
+GLITZ_FORMAT_SCANLINE_ORDER_MASK
GLITZ_FORMAT_STENCIL_SIZE_MASK
GLITZ_FOURCC
GLITZ_FOURCC_RGB
@@ -61,6 +64,7 @@ glitz_buffer_reference
glitz_buffer_set_data
glitz_buffer_t
glitz_buffer_unmap
+glitz_cgl_create_drawable_for_view
glitz_cgl_create_pbuffer_drawable
glitz_cgl_find_pbuffer_format
glitz_cgl_find_window_format
@@ -124,15 +128,6 @@ glitz_function_pointer_t
glitz_geometry_type_t
glitz_get_pixels
glitz_gl_string_t
-glitz_glx_create_drawable_for_window
-glitz_glx_create_pbuffer_drawable
-glitz_glx_find_drawable_format_for_visual
-glitz_glx_find_pbuffer_format
-glitz_glx_find_window_format
-glitz_glx_fini
-glitz_glx_get_visual_info_from_format
-glitz_glx_init
-glitz_glx_set_render_type
glitz_int_t
glitz_line_fixed_t
glitz_lose_current_function_t
@@ -162,6 +157,7 @@ glitz_status_string
glitz_status_t
glitz_surface_attach
glitz_surface_attributes_t
+glitz_surface_bind_tex_image
glitz_surface_create
glitz_surface_destroy
glitz_surface_detach
@@ -173,6 +169,7 @@ glitz_surface_get_height
glitz_surface_get_status
glitz_surface_get_width
glitz_surface_reference
+glitz_surface_release_tex_image
glitz_surface_set_clip_region
glitz_surface_set_component_alpha
glitz_surface_set_dither
diff --git a/doc/reference/tmpl/glitz-formats.sgml b/doc/reference/tmpl/glitz-formats.sgml
index f3344b9..3dca15d 100644
--- a/doc/reference/tmpl/glitz-formats.sgml
+++ b/doc/reference/tmpl/glitz-formats.sgml
@@ -152,6 +152,20 @@ Formats
+<!-- ##### MACRO GLITZ_FORMAT_SCANLINE_ORDER_MASK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GLITZ_FORMAT_DEPTH_MASK ##### -->
+<para>
+
+</para>
+
+
+
<!-- ##### STRUCT glitz_drawable_format_t ##### -->
<para>
@@ -159,10 +173,12 @@ Formats
@id:
@color:
+@depth:
@depth_size:
@stencil_size:
@samples:
@doublebuffer:
+@scanline_order:
<!-- ##### STRUCT glitz_format_t ##### -->
<para>
diff --git a/doc/reference/tmpl/glitz-formats.sgml.sgml b/doc/reference/tmpl/glitz-formats.sgml.sgml
index a9fb182..74b4ada 100644
--- a/doc/reference/tmpl/glitz-formats.sgml.sgml
+++ b/doc/reference/tmpl/glitz-formats.sgml.sgml
@@ -152,6 +152,20 @@ glitz-formats.sgml
+<!-- ##### MACRO GLITZ_FORMAT_SCANLINE_ORDER_MASK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GLITZ_FORMAT_DEPTH_MASK ##### -->
+<para>
+
+</para>
+
+
+
<!-- ##### STRUCT glitz_drawable_format_t ##### -->
<para>
@@ -159,10 +173,12 @@ glitz-formats.sgml
@id:
@color:
+@depth:
@depth_size:
@stencil_size:
@samples:
@doublebuffer:
+@scanline_order:
<!-- ##### STRUCT glitz_format_t ##### -->
<para>
diff --git a/doc/reference/tmpl/glitz-glx.sgml b/doc/reference/tmpl/glitz-glx.sgml
index ab115ae..7a7d408 100644
--- a/doc/reference/tmpl/glitz-glx.sgml
+++ b/doc/reference/tmpl/glitz-glx.sgml
@@ -104,6 +104,33 @@ GLX Backend
@Returns:
+<!-- ##### FUNCTION glitz_glx_create_drawable_for_pixmap ##### -->
+<para>
+
+</para>
+
+@display:
+@screen:
+@format:
+@pixmap:
+@width:
+@height:
+@Returns:
+
+
+<!-- ##### FUNCTION glitz_glx_create_pixmap_drawable ##### -->
+<para>
+
+</para>
+
+@display:
+@screen:
+@format:
+@width:
+@height:
+@Returns:
+
+
<!-- ##### FUNCTION glitz_glx_create_pbuffer_drawable ##### -->
<para>
@@ -117,3 +144,30 @@ GLX Backend
@Returns:
+<!-- ##### FUNCTION glitz_glx_get_display_from_drawable ##### -->
+<para>
+
+</para>
+
+@drawable:
+@Returns:
+
+
+<!-- ##### FUNCTION glitz_glx_get_screen_from_drawable ##### -->
+<para>
+
+</para>
+
+@drawable:
+@Returns:
+
+
+<!-- ##### FUNCTION glitz_glx_get_drawable_from_drawable ##### -->
+<para>
+
+</para>
+
+@drawable:
+@Returns:
+
+
diff --git a/doc/reference/tmpl/glitz-surface.sgml b/doc/reference/tmpl/glitz-surface.sgml
index 0a7cd7b..9604c03 100644
--- a/doc/reference/tmpl/glitz-surface.sgml
+++ b/doc/reference/tmpl/glitz-surface.sgml
@@ -219,3 +219,23 @@ Surface
@Returns:
+<!-- ##### FUNCTION glitz_surface_bind_tex_image ##### -->
+<para>
+
+</para>
+
+@surface:
+@drawable:
+@Returns:
+
+
+<!-- ##### FUNCTION glitz_surface_release_tex_image ##### -->
+<para>
+
+</para>
+
+@surface:
+@drawable:
+@Returns:
+
+
diff --git a/doc/reference/tmpl/glitz-types.sgml b/doc/reference/tmpl/glitz-types.sgml
index f9a5c27..e3e64ed 100644
--- a/doc/reference/tmpl/glitz-types.sgml
+++ b/doc/reference/tmpl/glitz-types.sgml
@@ -347,3 +347,10 @@ Types
+<!-- ##### MACRO GLITZ_FEATURE_TEXTURE_FROM_PIXMAP_MASK ##### -->
+<para>
+
+</para>
+
+
+
diff --git a/doc/reference/tmpl/glitz-unused.sgml b/doc/reference/tmpl/glitz-unused.sgml
index 92b00ab..d341629 100644
--- a/doc/reference/tmpl/glitz-unused.sgml
+++ b/doc/reference/tmpl/glitz-unused.sgml
@@ -1,40 +1,9 @@
-<!-- ##### MACRO GLITZ_FEATURE_TEXTURE_FROM_PIXMAP_MASK ##### -->
-<para>
-
-</para>
-
-
<!-- ##### MACRO GLITZ_FORMAT_Y_INVERTED_MASK ##### -->
<para>
</para>
-<!-- ##### FUNCTION glitz_glx_create_drawable_for_pixmap ##### -->
-<para>
-
-</para>
-
-@display:
-@screen:
-@format:
-@pixmap:
-@width:
-@height:
-@Returns:
-
-<!-- ##### FUNCTION glitz_glx_create_pixmap_drawable ##### -->
-<para>
-
-</para>
-
-@display:
-@screen:
-@format:
-@width:
-@height:
-@Returns:
-
<!-- ##### FUNCTION glitz_glx_get_xdrawable ##### -->
<para>
@@ -43,21 +12,3 @@
@drawable:
@Returns:
-<!-- ##### FUNCTION glitz_surface_bind_tex_image ##### -->
-<para>
-
-</para>
-
-@surface:
-@drawable:
-@Returns:
-
-<!-- ##### FUNCTION glitz_surface_release_tex_image ##### -->
-<para>
-
-</para>
-
-@surface:
-@drawable:
-@Returns:
-