opentype.xml

Pango is a library for layout and rendering of text, with an emphasis on internationalization. Pang

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>properties</parameter>&nbsp;:</term>
<listitem><simpara> the glyph properties
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cluster</parameter>&nbsp;:</term>
<listitem><simpara> the cluster that this glyph belongs to
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.4
</para></refsect2>
<refsect2 id="pango-ot-buffer-set-rtl" role="function" condition="since:1.4">
<title>pango_ot_buffer_set_rtl ()</title>
<indexterm zone="pango-ot-buffer-set-rtl" role="1.4"><primary>pango_ot_buffer_set_rtl</primary></indexterm><programlisting><link linkend="void">void</link>                pango_ot_buffer_set_rtl             (<link linkend="PangoOTBuffer">PangoOTBuffer</link> *buffer,
                                                         <link linkend="gboolean">gboolean</link> rtl);</programlisting>
<para>
Sets whether glyphs will be rendered right-to-left.  This setting
is needed for proper horizontal positioning of right-to-left scripts.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoOTBuffer"><type>PangoOTBuffer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rtl</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> for right-to-left text
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.4
</para></refsect2>
<refsect2 id="pango-ot-buffer-set-zero-width-marks" role="function" condition="since:1.6">
<title>pango_ot_buffer_set_zero_width_marks ()</title>
<indexterm zone="pango-ot-buffer-set-zero-width-marks" role="1.6"><primary>pango_ot_buffer_set_zero_width_marks</primary></indexterm><programlisting><link linkend="void">void</link>                pango_ot_buffer_set_zero_width_marks
                                                        (<link linkend="PangoOTBuffer">PangoOTBuffer</link> *buffer,
                                                         <link linkend="gboolean">gboolean</link> zero_width_marks);</programlisting>
<para>
Sets whether characters with a mark class should be forced to zero width.
This setting is needed for proper positioning of Arabic accents,
but will produce incorrect results with standard OpenType Indic
fonts.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoOTBuffer"><type>PangoOTBuffer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>zero_width_marks</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if characters with a mark class should
 be forced to zero width.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.6
</para></refsect2>
<refsect2 id="pango-ot-buffer-get-glyphs" role="function" condition="since:1.4">
<title>pango_ot_buffer_get_glyphs ()</title>
<indexterm zone="pango-ot-buffer-get-glyphs" role="1.4"><primary>pango_ot_buffer_get_glyphs</primary></indexterm><programlisting><link linkend="void">void</link>                pango_ot_buffer_get_glyphs          (const <link linkend="PangoOTBuffer">PangoOTBuffer</link> *buffer,
                                                         <link linkend="PangoOTGlyph">PangoOTGlyph</link> **glyphs,
                                                         <link linkend="int">int</link> *n_glyphs);</programlisting>
<para>
Gets the glyph array contained in a <link linkend="PangoOTBuffer"><type>PangoOTBuffer</type></link>.  The glyphs are
owned by the buffer and should not be freed, and are only valid as long
as buffer is not modified.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoOTBuffer"><type>PangoOTBuffer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>glyphs</parameter>&nbsp;:</term>
<listitem><simpara> location to store the array of glyphs, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_glyphs</parameter>&nbsp;:</term>
<listitem><simpara> location to store the number of glyphs, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.4
</para></refsect2>
<refsect2 id="pango-ot-buffer-output" role="function" condition="since:1.4">
<title>pango_ot_buffer_output ()</title>
<indexterm zone="pango-ot-buffer-output" role="1.4"><primary>pango_ot_buffer_output</primary></indexterm><programlisting><link linkend="void">void</link>                pango_ot_buffer_output              (const <link linkend="PangoOTBuffer">PangoOTBuffer</link> *buffer,
                                                         <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs);</programlisting>
<para>
Exports the glyphs in a <link linkend="PangoOTBuffer"><type>PangoOTBuffer</type></link> into a <link linkend="PangoGlyphString"><type>PangoGlyphString</type></link>.  This is
typically used after the OpenType layout processing is over, to convert the
resulting glyphs into a generic Pango glyph string.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoOTBuffer"><type>PangoOTBuffer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>glyphs</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoGlyphString"><type>PangoGlyphString</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.4
</para></refsect2>
<refsect2 id="pango-ot-ruleset-get-for-description" role="function" condition="since:1.18">
<title>pango_ot_ruleset_get_for_description ()</title>
<indexterm zone="pango-ot-ruleset-get-for-description" role="1.18"><primary>pango_ot_ruleset_get_for_description</primary></indexterm><programlisting>const <link linkend="PangoOTRuleset">PangoOTRuleset</link>* pango_ot_ruleset_get_for_description
                                                        (<link linkend="PangoOTInfo">PangoOTInfo</link> *info,
                                                         const <link linkend="PangoOTRulesetDescription">PangoOTRulesetDescription</link> *desc);</programlisting>
<para>
Returns a ruleset for the given OpenType info and ruleset
description.  Rulesets are created on demand using
<link linkend="pango-ot-ruleset-new-from-description"><function>pango_ot_ruleset_new_from_description()</function></link>.
The returned ruleset should not be modified or destroyed.
</para>
<para>
The static feature map members of <parameter>desc</parameter> should be alive as
long as <parameter>info</parameter> is.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoOTInfo"><type>PangoOTInfo</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>desc</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoOTRulesetDescription"><type>PangoOTRulesetDescription</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="PangoOTRuleset"><type>PangoOTRuleset</type></link> for <parameter>desc</parameter>. This object will have
the same lifetime as <parameter>info</parameter>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.18
</para></refsect2>
<refsect2 id="pango-ot-ruleset-new" role="function">
<title>pango_ot_ruleset_new ()</title>
<indexterm zone="pango-ot-ruleset-new"><primary>pango_ot_ruleset_new</primary></indexterm><programlisting><link linkend="PangoOTRuleset">PangoOTRuleset</link>*     pango_ot_ruleset_new                (<link linkend="PangoOTInfo">PangoOTInfo</link> *info);</programlisting>
<para>
Creates a new <link linkend="PangoOTRuleset"><type>PangoOTRuleset</type></link> for the given OpenType info.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoOTInfo"><type>PangoOTInfo</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the newly allocated <link linkend="PangoOTRuleset"><type>PangoOTRuleset</type></link>, which
              should be freed with <link linkend="g-object-unref"><function>g_object_unref()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-ot-ruleset-new-for" role="function" condition="since:1.18">
<title>pango_ot_ruleset_new_for ()</title>
<indexterm zone="pango-ot-ruleset-new-for" role="1.18"><primary>pango_ot_ruleset_new_for</primary></indexterm><programlisting><link linkend="PangoOTRuleset">PangoOTRuleset</link>*     pango_ot_ruleset_new_for            (<link linkend="PangoOTInfo">PangoOTInfo</link> *info,
                                                         <link linkend="PangoScript">PangoScript</link> script,
                                                         <link linkend="PangoLanguage">PangoLanguage</link> *language);</programlisting>
<para>
Creates a new <link linkend="PangoOTRuleset"><type>PangoOTRuleset</type></link> for the given OpenType info, script, and
language.
</para>
<para>
This function is part of a convenience scheme that highly simplifies
using a <link linkend="PangoOTRuleset"><type>PangoOTRuleset</type></link> to represent features for a specific pair of script
and language.  So one can use this function passing in the script and
language of interest, and later try to add features to the ruleset by just
specifying the feature name or tag, without having to deal with finding
script, language, or feature indices manually.
</para>
<para>
In excess to what <link linkend="pango-ot-ruleset-new"><function>pango_ot_ruleset_new()</function></link> does, this function will:
<itemizedlist>
  <listitem>
  Find the <link linkend="PangoOTTag"><type>PangoOTTag</type></link> script and language tags associated with
  <parameter>script</parameter> and <parameter>language</parameter> using <link linkend="pango-ot-tag-from-script"><function>pango_ot_tag_from_script()</function></link> and
  <link linkend="pango-ot-tag-from-language"><function>pango_ot_tag_from_language()</function></link>,
  </listitem>
  <listitem>
  For each of table types <link linkend="PANGO-OT-TABLE-GSUB:CAPS"><literal>PANGO_OT_TABLE_GSUB</literal></link> and <link linkend="PANGO-OT-TABLE-GPOS:CAPS"><literal>PANGO_OT_TABLE_GPOS</literal></link>,
  find the script index of the script tag found and the language
  system index of the language tag found in that script system, using
  <link linkend="pango-ot-info-find-script"><function>pango_ot_info_find_script()</function></link> and <link linkend="pango-ot-info-find-language"><function>pango_ot_info_find_language()</function></link>,
  </listitem>
  <listitem>
  For found language-systems, if they have required feature
  index, add that feature to the ruleset using
  <link linkend="pango-ot-ruleset-add-feature"><function>pango_ot_ruleset_add_feature()</function></link>,
  </listitem>
  <listitem>
  Remember found script and language indices for both table types,
  and use them in future <link linkend="pango-ot-ruleset-maybe-add-feature"><function>pango_ot_ruleset_maybe_add_feature()</function></link> and
  <link linkend="pango-ot-ruleset-maybe-add-features"><function>pango_ot_ruleset_maybe_add_features()</function></link>.
  </listitem>
</itemizedlist>
</para>
<para>
Because of the way return values of <link linkend="pango-ot-info-find-script"><function>pango_ot_info_find_script()</function></link> and
<link linkend="pango-ot-info-find-language"><function>pango_ot_info_find_language()</function></link> are ignored, this function automatically
finds and uses the 'DFLT' script and the default language-system.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoOTInfo"><type>PangoOTInfo</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>script</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoScri