diff options
author | Nicolas Bruguier <nicolas.bruguier@supersonicimagine.fr> | 2008-11-29 14:09:58 +0100 |
---|---|---|
committer | Nicolas Bruguier <nicolas.bruguier@supersonicimagine.fr> | 2008-11-29 14:09:58 +0100 |
commit | 4b8cd59f2757a63bec982a96b7c8112d75b410b8 (patch) | |
tree | e6b1aac57203d997b975336a2d5f2ec29732327e | |
parent | 49e45fb1b8dc0f2b45254a370c62a0e36ca7be91 (diff) |
[doc] Add cgl documentation section
Add CGL documentation section.
-rw-r--r-- | doc/reference/Makefile.am | 24 | ||||
-rw-r--r-- | doc/reference/glitz-docs.xml | 1 | ||||
-rw-r--r-- | doc/reference/glitz-sections.txt | 11 | ||||
-rw-r--r-- | doc/reference/glitz-undeclared.txt | 7 | ||||
-rw-r--r-- | doc/reference/glitz-undocumented.txt | 14 | ||||
-rw-r--r-- | doc/reference/tmpl/glitz-formats.sgml | 8 | ||||
-rw-r--r-- | doc/reference/tmpl/glitz-formats.sgml.sgml | 8 | ||||
-rw-r--r-- | doc/reference/tmpl/glitz-glx.sgml | 36 | ||||
-rw-r--r-- | doc/reference/tmpl/glitz-surface.sgml | 20 | ||||
-rw-r--r-- | doc/reference/tmpl/glitz-types.sgml | 7 | ||||
-rw-r--r-- | doc/reference/tmpl/glitz-unused.sgml | 63 |
11 files changed, 111 insertions, 88 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index 1158612..42aa6f3 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -13,8 +13,26 @@ SCAN_OPTIONS= DOC_SOURCE_DIR=../../src # Used for dependencies -HFILE_GLOB=$(top_srcdir)/src/*.h $(top_srcdir)/src/glx/*.h -CFILE_GLOB=$(top_srcdir)/src/*.c $(top_srcdir)/src/*.h $(top_srcdir)/src/glx/*.c $(top_srcdir)/src/glx/*.h +HFILE_GLOB= \ + $(top_srcdir)/src/*.h \ + $(top_srcdir)/src/agl/*.h \ + $(top_srcdir)/src/cgl/*.h \ + $(top_srcdir)/src/egl/*.h \ + $(top_srcdir)/src/glx/*.h \ + $(top_srcdir)/src/wgl/*.h + +CFILE_GLOB=$(top_srcdir)/src/*.c \ + $(top_srcdir)/src/*.h \ + $(top_srcdir)/src/agl/*.c \ + $(top_srcdir)/src/agl/*.h \ + $(top_srcdir)/src/cgl/*.m \ + $(top_srcdir)/src/cgl/*.h \ + $(top_srcdir)/src/egl/*.c \ + $(top_srcdir)/src/egl/*.h \ + $(top_srcdir)/src/glx/*.c \ + $(top_srcdir)/src/glx/*.h \ + $(top_srcdir)/src/wgl/*.c \ + $(top_srcdir)/src/wgl/*.h UNSUPPORTED_HFILES= glitzint.h \ glitz_gl.h \ @@ -23,6 +41,8 @@ UNSUPPORTED_HFILES= glitzint.h \ glitz_glxint.h \ glitz_aglext.h \ glitz_aglint.h \ + glitz_cglext.h \ + glitz_cglint.h \ glitz_eglext.h \ glitz_eglint.h \ glitz_wglext.h \ diff --git a/doc/reference/glitz-docs.xml b/doc/reference/glitz-docs.xml index e8fff21..04bce6a 100644 --- a/doc/reference/glitz-docs.xml +++ b/doc/reference/glitz-docs.xml @@ -25,6 +25,7 @@ <chapter> <title>Glitz backends</title> <xi:include href="xml/glitz-agl.xml"/> + <xi:include href="xml/glitz-cgl.xml"/> <xi:include href="xml/glitz-egl.xml"/> <xi:include href="xml/glitz-glx.xml"/> <xi:include href="xml/glitz-wgl.xml"/> diff --git a/doc/reference/glitz-sections.txt b/doc/reference/glitz-sections.txt index 5f4bdd5..83c2348 100644 --- a/doc/reference/glitz-sections.txt +++ b/doc/reference/glitz-sections.txt @@ -230,6 +230,17 @@ glitz_agl_create_pbuffer_drawable </SECTION> <SECTION> +<FILE>glitz-cgl</FILE> +<TITLE>CGL Backend</TITLE> +glitz_cgl_init +glitz_cgl_fini +glitz_cgl_find_window_format +glitz_cgl_find_pbuffer_format +glitz_cgl_create_pbuffer_drawable +glitz_cgl_create_drawable_for_view +</SECTION> + +<SECTION> <FILE>glitz-egl</FILE> <TITLE>EGL Backend</TITLE> glitz_egl_init diff --git a/doc/reference/glitz-undeclared.txt b/doc/reference/glitz-undeclared.txt index e69de29..5bcdd50 100644 --- a/doc/reference/glitz-undeclared.txt +++ b/doc/reference/glitz-undeclared.txt @@ -0,0 +1,7 @@ +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 7ef258c..722ce57 100644 --- a/doc/reference/glitz-undocumented.txt +++ b/doc/reference/glitz-undocumented.txt @@ -19,7 +19,6 @@ 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 @@ -34,7 +33,6 @@ GLITZ_FORMAT_ID_MASK GLITZ_FORMAT_RED_SIZE_MASK GLITZ_FORMAT_SAMPLES_MASK GLITZ_FORMAT_STENCIL_SIZE_MASK -GLITZ_FORMAT_Y_INVERTED_MASK GLITZ_FOURCC GLITZ_FOURCC_RGB GLITZ_FOURCC_YUY2 @@ -63,6 +61,11 @@ glitz_buffer_reference glitz_buffer_set_data glitz_buffer_t glitz_buffer_unmap +glitz_cgl_create_pbuffer_drawable +glitz_cgl_find_pbuffer_format +glitz_cgl_find_window_format +glitz_cgl_fini +glitz_cgl_init glitz_color_format_t glitz_color_t glitz_composite @@ -121,16 +124,13 @@ glitz_function_pointer_t glitz_geometry_type_t glitz_get_pixels glitz_gl_string_t -glitz_glx_create_drawable_for_pixmap glitz_glx_create_drawable_for_window glitz_glx_create_pbuffer_drawable -glitz_glx_create_pixmap_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_get_xdrawable glitz_glx_init glitz_glx_set_render_type glitz_int_t @@ -162,7 +162,6 @@ 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 @@ -174,7 +173,6 @@ 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 @@ -216,6 +214,8 @@ glitz-agl:Long_Description glitz-agl:Short_Description glitz-buffer:Long_Description glitz-buffer:Short_Description +glitz-cgl:Long_Description +glitz-cgl:Short_Description glitz-context:Long_Description glitz-context:Short_Description glitz-drawable:Long_Description diff --git a/doc/reference/tmpl/glitz-formats.sgml b/doc/reference/tmpl/glitz-formats.sgml index 937c253..f3344b9 100644 --- a/doc/reference/tmpl/glitz-formats.sgml +++ b/doc/reference/tmpl/glitz-formats.sgml @@ -152,13 +152,6 @@ Formats -<!-- ##### MACRO GLITZ_FORMAT_Y_INVERTED_MASK ##### --> -<para> - -</para> - - - <!-- ##### STRUCT glitz_drawable_format_t ##### --> <para> @@ -170,7 +163,6 @@ Formats @stencil_size: @samples: @doublebuffer: -@y_inverted: <!-- ##### STRUCT glitz_format_t ##### --> <para> diff --git a/doc/reference/tmpl/glitz-formats.sgml.sgml b/doc/reference/tmpl/glitz-formats.sgml.sgml index dc5b2cb..a9fb182 100644 --- a/doc/reference/tmpl/glitz-formats.sgml.sgml +++ b/doc/reference/tmpl/glitz-formats.sgml.sgml @@ -152,13 +152,6 @@ glitz-formats.sgml -<!-- ##### MACRO GLITZ_FORMAT_Y_INVERTED_MASK ##### --> -<para> - -</para> - - - <!-- ##### STRUCT glitz_drawable_format_t ##### --> <para> @@ -170,7 +163,6 @@ glitz-formats.sgml @stencil_size: @samples: @doublebuffer: -@y_inverted: <!-- ##### STRUCT glitz_format_t ##### --> <para> diff --git a/doc/reference/tmpl/glitz-glx.sgml b/doc/reference/tmpl/glitz-glx.sgml index 2bd9294..ab115ae 100644 --- a/doc/reference/tmpl/glitz-glx.sgml +++ b/doc/reference/tmpl/glitz-glx.sgml @@ -90,15 +90,6 @@ GLX Backend @Returns: -<!-- ##### FUNCTION glitz_glx_get_xdrawable ##### --> -<para> - -</para> - -@drawable: -@Returns: - - <!-- ##### FUNCTION glitz_glx_create_drawable_for_window ##### --> <para> @@ -113,33 +104,6 @@ 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> diff --git a/doc/reference/tmpl/glitz-surface.sgml b/doc/reference/tmpl/glitz-surface.sgml index 9604c03..0a7cd7b 100644 --- a/doc/reference/tmpl/glitz-surface.sgml +++ b/doc/reference/tmpl/glitz-surface.sgml @@ -219,23 +219,3 @@ 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 e3e64ed..f9a5c27 100644 --- a/doc/reference/tmpl/glitz-types.sgml +++ b/doc/reference/tmpl/glitz-types.sgml @@ -347,10 +347,3 @@ 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 e69de29..92b00ab 100644 --- a/doc/reference/tmpl/glitz-unused.sgml +++ b/doc/reference/tmpl/glitz-unused.sgml @@ -0,0 +1,63 @@ +<!-- ##### 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> + +</para> + +@drawable: +@Returns: + +<!-- ##### FUNCTION glitz_surface_bind_tex_image ##### --> +<para> + +</para> + +@surface: +@drawable: +@Returns: + +<!-- ##### FUNCTION glitz_surface_release_tex_image ##### --> +<para> + +</para> + +@surface: +@drawable: +@Returns: + |