Initial revision

1 files changed, 180 insertions, 0 deletions

diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml
new file mode 100644
index 00000000..a764f2ef
--- /dev/null
+++ b/docs/tmpl/glyphs.sgml
@@ -0,0 +1,180 @@
+<!-- ##### SECTION Title ##### -->
+Glyph Storage
+
+<!-- ##### SECTION Short_Description ##### -->
+Structures for storing information about glyphs.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+pango_shape() produces a string of glyphs which
+can be measured or drawn to the screen. The following
+structures are used to store information about
+glyphs.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT PangoGlyph ##### -->
+<para>
+The #PangoGlyph structure represents a single glyph in the output
+form of a string. It contains the following fields.
+
+<informaltable pgwide=1 frame="none" role="struct">
+<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
+<tbody>
+
+<row>
+<entry>#PangoGlyphIndex glyph;</entry>
+<entry>the index of the glyph into the font. (Rendering system
+       dependent).</entry>
+</row>
+
+<row>
+<entry>#PangoCFont *font;</entry>
+<entry>the rendering-system-specific font information for this glyph.</entry>
+</row>
+
+</tbody></tgroup></informaltable>
+</para>
+
+
+<!-- ##### TYPEDEF PangoGlyphIndex ##### -->
+<para>
+The #PangoGlyphIndex type is an integral type used to store glyph
+indices.
+</para>
+
+
+<!-- ##### STRUCT PangoGlyphGeometry ##### -->
+<para>
+The #PangoGlyphGeometry structure contains width and positioning
+information for a single glyph. Distances are in
+1/64ths of a point.
+
+<informaltable pgwide=1 frame="none" role="struct">
+<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
+<tbody>
+
+<row>
+<entry>#PangoGlyphUnit width;</entry>
+<entry>the logical width to use for the the character.</entry>
+</row>
+
+<row>
+<entry>#PangoCFont *x_offset;</entry>
+<entry>horizontal offset from nominal character position.</entry>
+</row>
+
+<row>
+<entry>#PangoCFont *y_offset;</entry>
+<entry>vertical offset from nominal character position.</entry>
+</row>
+
+</tbody></tgroup></informaltable>
+</para>
+
+
+<!-- ##### TYPEDEF PangoGlyphUnit ##### -->
+<para>
+The #PangoGlyphUnit type is used to store dimensions within
+Pango. Dimensions are stored in 1/64ths of a point.
+</para>
+
+
+<!-- ##### STRUCT PangoGlyphVisAttr ##### -->
+<para>
+The PangoGlyphVisAttr is used to communicate information between
+the shaping phase and the rendering phase. It's contents
+are still evolving.
+
+<informaltable pgwide=1 frame="none" role="struct">
+<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
+<tbody>
+
+<row>
+<entry>#guint is_cluster_start : 1;</entry>
+<entry>set for the first logical glyph in each cluster. (Clusters
+       are stored in visual order, within the cluster, glyphs
+       are always ordered in logical order, since visual
+       order is meaningless; that is, in Arabic text, accent glyphs
+       follow the glyphs for the base character.)
+</entry>
+</row>
+
+</tbody></tgroup></informaltable>
+</para>
+
+
+<!-- ##### STRUCT PangoGlyphString ##### -->
+<para>
+The #PangoGlyphString structure is used to store strings
+of glyphs with geometry and visual attribute information.
+The storage for the glyph information is owned
+by the structure which simplifies memory management.
+</para>
+<para>
+#PangoGlyphString contains the following publically
+accessible fields
+
+<informaltable pgwide=1 frame="none" role="struct">
+<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
+<tbody>
+
+<row>
+<entry>gint #num_glyphs;</entry>
+<entry>the number of glyphs in the string.</entry>
+</row>
+
+<row>
+<entry>PangoGlyph *#glyphs;</entry>
+<entry>an array of glyphs of length <structfield>num_glyphs</structfield>.</entry>
+</row>
+
+<row>
+<entry>PangoGlyphGeometry *#geometry;</entry>
+<entry>an array of #PangoGlyphGeometry structures corresponding to <structfield>glyphs</structfield>.</entry>
+</row>
+
+<row>
+<entry>PangoGlyphVisAttr *#attrs;</entry>
+<entry>an array of #PangoGlyphVisAttr structures corresponding to <structfield>glyphs</structfield>.</entry>
+</row>
+
+<row>
+<entry>gint *#log_clusters;</entry>
+<entry>for each glyph, the character index (should this be byte
+       index?) of the starting character for the cluster.</entry>
+</row>
+
+</tbody></tgroup></informaltable>
+</para>
+
+
+<!-- ##### FUNCTION g_glyph_string_new ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION g_glyph_string_set_size ##### -->
+<para>
+
+</para>
+
+@string: 
+@new_len: 
+
+
+<!-- ##### FUNCTION g_glyph_string_free ##### -->
+<para>
+
+</para>
+
+@string: 
+
+