diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/pango-sections.txt | 6 | ||||
| -rw-r--r-- | docs/tmpl/glyphs.sgml | 1 | ||||
| -rw-r--r-- | docs/tmpl/opentype.sgml | 78 |
3 files changed, 82 insertions, 3 deletions
diff --git a/docs/pango-sections.txt b/docs/pango-sections.txt index e016407e..75906ed3 100644 --- a/docs/pango-sections.txt +++ b/docs/pango-sections.txt @@ -940,6 +940,7 @@ PangoOTInfo PangoOTBuffer PangoOTGlyph PangoOTRuleset +PangoOTRulesetDescription PangoOTTableType PangoOTFeatureMap PANGO_OT_ALL_GLYPHS @@ -963,6 +964,7 @@ pango_ot_buffer_set_rtl pango_ot_buffer_set_zero_width_marks pango_ot_buffer_get_glyphs pango_ot_buffer_output +pango_ot_ruleset_get_for pango_ot_ruleset_new pango_ot_ruleset_new_for pango_ot_ruleset_add_feature @@ -970,6 +972,10 @@ pango_ot_ruleset_maybe_add_feature pango_ot_ruleset_maybe_add_features pango_ot_ruleset_substitute pango_ot_ruleset_position +pango_ot_ruleset_description_copy +pango_ot_ruleset_description_equal +pango_ot_ruleset_description_free +pango_ot_ruleset_description_hash pango_ot_tag_from_language pango_ot_tag_from_script pango_ot_tag_to_language diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml index 2191d7a7..44dff0db 100644 --- a/docs/tmpl/glyphs.sgml +++ b/docs/tmpl/glyphs.sgml @@ -68,7 +68,6 @@ Converts a dimension to device units by ceiling. <para> Rounds a dimension to whole device units, but does not convert it to device units. - </para> @d: a dimension in Pango units. diff --git a/docs/tmpl/opentype.sgml b/docs/tmpl/opentype.sgml index 6c4f7be0..f5a61930 100644 --- a/docs/tmpl/opentype.sgml +++ b/docs/tmpl/opentype.sgml @@ -65,17 +65,38 @@ It contains the following fields. <!-- ##### STRUCT PangoOTRuleset ##### --> <para> -The #PangoOTRuleSet structure holds a +The #PangoOTRuleset structure holds a set of features selected from the tables in an OpenType font. (A feature is an operation such as adjusting glyph positioning that should be applied to a text feature such as a certain -type of accent.) A #PangoOTRuleSet +type of accent.) A #PangoOTRuleset is created with pango_ot_ruleset_new(), features are added to it with pango_ot_ruleset_add_feature(), then it is applied to a #PangoGlyphString with pango_ot_ruleset_shape(). </para> +<!-- ##### STRUCT PangoOTRulesetDescription ##### --> +<para> +The #PangoOTRuleset structure holds all the information needed +to build a complete #PangoOTRuleset from an OpenType font. +The main use of this struct is to act as the key for a per-font +hash of rulesets. The user populates a ruleset description and +gets the ruleset using pango_ot_ruleset_get_for(). +</para> + +@script: a #PangoScript. +@language: a #PangoLanguage. +@static_gsub_features: static map of GSUB features, or %NULL. +@n_static_gsub_features: length of @static_gsub_features, or 0. +@static_gpos_features: static map of GPOS features, or %NULL. +@n_static_gpos_features: length of @static_gpos_features, or 0. +@other_features: map of extra features to add to both GSUB and GPOS, or %NULL. + Unlike the static maps, this pointer need not live beyond + the life of function calls taking this struct. +@n_other_features: length of @other_features, or 0. +@Since: 1.18 + <!-- ##### ENUM PangoOTTableType ##### --> <para> The <type>PangoOTTableType</type> enumeration values are used to @@ -96,6 +117,7 @@ represented as a char array instead of a #PangoOTTag for convenience. @feature_name: feature tag in represented as four-letter ASCII string. @property_bit: the property bit to use for this feature. See pango_ot_ruleset_add_feature() for details. +@Since: 1.18 <!-- ##### MACRO PANGO_OT_ALL_GLYPHS ##### --> <para> @@ -103,6 +125,7 @@ This is used as the property bit in pango_ot_ruleset_add_feature() when a feature should be applied to all glyphs. </para> +@Since: 1.16 <!-- ##### MACRO PANGO_OT_NO_FEATURE ##### --> @@ -114,6 +137,7 @@ automatically skips this value, so no special handling is required by the user. </para> +@Since: 1.18 <!-- ##### MACRO PANGO_OT_NO_SCRIPT ##### --> @@ -126,6 +150,7 @@ taking a script index essentially return if the input script index is this value, so no special handling is required by the user. </para> +@Since: 1.18 <!-- ##### MACRO PANGO_OT_DEFAULT_LANGUAGE ##### --> @@ -141,6 +166,7 @@ pango_ot_info_find_feature() without having to worry about falling back to default language system explicitly. </para> +@Since: 1.16 <!-- ##### MACRO PANGO_OT_TAG_DEFAULT_LANGUAGE ##### --> @@ -152,6 +178,7 @@ pango_ot_info_find_language() as that function falls back to returning default language-system if the requested language tag is not found. </para> +@Since: 1.18 <!-- ##### MACRO PANGO_OT_TAG_DEFAULT_SCRIPT ##### --> @@ -161,6 +188,7 @@ returned as script tag by pango_ot_tag_from_script() if the requested script is not found. </para> +@Since: 1.18 <!-- ##### FUNCTION pango_ot_info_get ##### --> @@ -320,6 +348,16 @@ is not found. @glyphs: +<!-- ##### FUNCTION pango_ot_ruleset_get_for ##### --> +<para> + +</para> + +@info: +@desc: +@Returns: + + <!-- ##### FUNCTION pango_ot_ruleset_new ##### --> <para> @@ -393,6 +431,42 @@ is not found. @buffer: +<!-- ##### FUNCTION pango_ot_ruleset_description_copy ##### --> +<para> + +</para> + +@desc: +@Returns: + + +<!-- ##### FUNCTION pango_ot_ruleset_description_equal ##### --> +<para> + +</para> + +@desc1: +@desc2: +@Returns: + + +<!-- ##### FUNCTION pango_ot_ruleset_description_free ##### --> +<para> + +</para> + +@desc: + + +<!-- ##### FUNCTION pango_ot_ruleset_description_hash ##### --> +<para> + +</para> + +@desc: +@Returns: + + <!-- ##### FUNCTION pango_ot_tag_from_language ##### --> <para> |