Optionalproperties: Partial<{}>Determines if the style attributes of new_match are a closer match
for desc than those of old_match are, or if old_match is null,
determines if new_match is a match at all.
Approximate matching is done for weight and style; other style attributes must match exactly. Style attributes are all attributes other than family and size-related attributes. Approximate matching for style considers Pango.Style.OBLIQUE and Pango.Style.ITALIC as matches, but not as good a match as when the styles are equal.
Note that old_match must match desc.
a Pango.FontDescription, or null
true if new_match is a better match
Make a copy of a Pango.FontDescription.
the newly allocated Pango.FontDescription, which should be freed with Pango.FontDescription.free, or null if desc was null.
Make a copy of a Pango.FontDescription, but don't duplicate allocated fields.
This is like Pango.FontDescription.copy, but only a shallow
copy is made of the family name and other allocated fields. The result
can only be used until desc is modified or freed. This is meant
to be used when the copy is only needed temporarily.
the newly allocated Pango.FontDescription, which should be freed with Pango.FontDescription.free, or null if desc was null.
Compares two font descriptions for equality.
Two font descriptions are considered equal if the fonts they describe
are provably identical. This means that their masks do not have to match,
as long as other fields are all the same. (Two font descriptions may
result in identical fonts being loaded, but still compare false.)
another Pango.FontDescription
true if the two font descriptions are identical, false otherwise.
Frees a font description.
Gets the family name field of a font description.
the family name field for the font description, or null if not previously set. This has the same life-time as the font description itself and should not be freed.
Gets the features field of a font description.
the features field for the font description, or null if not previously set. This has the same life-time as the font description itself and should not be freed.
Gets the gravity field of a font description.
the gravity field for the font description. Use Pango.FontDescription.get_set_fields to find out if the field was explicitly set or not.
Gets the size field of a font description.
the size field for the font description in points or device units. You must call Pango.FontDescription.get_size_is_absolute to find out which is the case. Returns 0 if the size field has not previously been set or it has been set to 0 explicitly. Use Pango.FontDescription.get_set_fields to find out if the field was explicitly set or not.
Determines whether the size of the font is in points (not absolute) or device units (absolute).
See Pango.FontDescription.set_size and Pango.FontDescription.set_absolute_size.
whether the size for the font description is in points or device units. Use Pango.FontDescription.get_set_fields to find out if the size field of the font description was explicitly set or not.
Gets the stretch field of a font description.
the stretch field for the font description. Use Pango.FontDescription.get_set_fields to find out if the field was explicitly set or not.
Gets the style field of a Pango.FontDescription.
the style field for the font description. Use Pango.FontDescription.get_set_fields to find out if the field was explicitly set or not.
Gets the variant field of a Pango.FontDescription.
the variant field for the font description. Use Pango.FontDescription.get_set_fields to find out if the field was explicitly set or not.
Gets the variations field of a font description.
the variations field for the font description, or null if not previously set. This has the same life-time as the font description itself and should not be freed.
Gets the weight field of a font description.
the weight field for the font description. Use Pango.FontDescription.get_set_fields to find out if the field was explicitly set or not.
Computes a hash of a Pango.FontDescription structure.
This is suitable to be used, for example, as an argument
to g_hash_table_new(). The hash value is independent of desc->mask.
the hash value.
Merges the fields that are set in desc_to_merge into the fields in
desc.
If replace_existing is false, only fields in desc that
are not already set are affected. If true, then fields that are
already set will be replaced as well.
If desc_to_merge is null, this function performs nothing.
the Pango.FontDescription to merge from, or null
if true, replace fields in desc with the corresponding values from desc_to_merge, even if they are already exist.
Merges the fields that are set in desc_to_merge into the fields in
desc, without copying allocated fields.
This is like Pango.FontDescription.merge, but only a shallow copy
is made of the family name and other allocated fields. desc can only
be used until desc_to_merge is modified or freed. This is meant to
be used when the merged font description is only needed temporarily.
the Pango.FontDescription to merge from
if true, replace fields in desc with the corresponding values from desc_to_merge, even if they are already exist.
Sets the size field of a font description, in device units.
This is mutually exclusive with Pango.FontDescription.set_size which sets the font size in points.
the new size, in Pango units. There are PANGO_SCALE Pango units in one device unit. For an output backend where a device unit is a pixel, a size value of 10 * PANGO_SCALE gives a 10 pixel font.
Sets the color field of a font description.
This field determines whether the font description should match fonts that have color glyphs, or fonts that don't.
the Pango.FontColor value
Sets the family name field of a font description.
The family name represents a family of related font styles, and will resolve to a particular Pango.FontFamily. In some uses of Pango.FontDescription, it is also possible to use a comma separated list of family names for this field.
a string representing the family name.
Sets the family name field of a font description, without copying the string.
This is like Pango.FontDescription.set_family, except that no
copy of family is made. The caller must make sure that the
string passed in stays around until desc has been freed or the
name is set again. This function can be used if family is a static
string such as a C string literal, or if desc is only needed temporarily.
a string representing the family name
Sets the features field of a font description.
OpenType font features allow to enable or disable certain optional features of a font, such as tabular numbers.
The format of the features string is comma-separated list of feature assignments, with each assignment being one of these forms:
FEATURE=n
where FEATURE must be a 4 character tag that identifies and OpenType feature, and n an integer (depending on the feature, the allowed values may be 0, 1 or bigger numbers). Unknown features are ignored.
Note that font features set in this way are enabled for the entire text that is using the font, which is not appropriate for all OpenType features. The intended use case is to select character variations (features cv01 - c99), style sets (ss01 - ss20) and the like.
Pango does not currently have a way to find supported OpenType features of a font. Both harfbuzz and freetype have API for this. See for example hb_ot_layout_table_get_feature_tags.
Features that are not supported by the font are silently ignored.
Optionalfeatures: stringa string representing the features
Sets the features field of a font description.
This is like Pango.FontDescription.set_features, except
that no copy of featuresis made. The caller must make sure that
the string passed in stays around until desc has been freed
or the name is set again. This function can be used if
features is a static string such as a C string literal,
or if desc is only needed temporarily.
a string representing the features
Sets the gravity field of a font description.
The gravity field
specifies how the glyphs should be rotated. If gravity is
Pango.Gravity.AUTO, this actually unsets the gravity mask on
the font description.
This function is seldom useful to the user. Gravity should normally be set on a Pango.Context.
Sets the size field of a font description in fractional points.
This is mutually exclusive with Pango.FontDescription.set_absolute_size.
the size of the font in points, scaled by PANGO_SCALE. (That is, a size value of 10 * PANGO_SCALE is a 10 point font. The conversion factor between points and device units depends on system configuration and the output device. For screen display, a logical DPI of 96 is common, in which case a 10 point font corresponds to a 10 * (96 / 72) = 13.3 pixel font. Use Pango.FontDescription.set_absolute_size if you need a particular size in device units.
Sets the stretch field of a font description.
The Pango.Stretch field specifies how narrow or wide the font should be.
Sets the style field of a Pango.FontDescription.
The Pango.Style enumeration describes whether the font is slanted and the manner in which it is slanted; it can be either Pango.Style.NORMAL, Pango.Style.ITALIC, or Pango.Style.OBLIQUE.
Most fonts will either have a italic style or an oblique style, but not both, and font matching in Pango will match italic specifications with oblique fonts and vice-versa if an exact match is not found.
Sets the variant field of a font description.
The Pango.Variant can either be Pango.Variant.NORMAL or Pango.Variant.SMALL_CAPS.
Sets the variations field of a font description.
OpenType font variations allow to select a font instance by specifying values for a number of axes, such as width or weight.
The format of the variations string is
AXIS1=VALUE,AXIS2=VALUE...
with each AXIS a 4 character tag that identifies a font axis, and each VALUE a floating point number. Unknown axes are ignored, and values are clamped to their allowed range.
Pango does not currently have a way to find supported axes of a font. Both harfbuzz and freetype have API for this. See for example hb_ot_var_get_axis_infos.
Optionalvariations: stringa string representing the variations
Sets the variations field of a font description.
This is like Pango.FontDescription.set_variations, except
that no copy of variations is made. The caller must make sure that
the string passed in stays around until desc has been freed
or the name is set again. This function can be used if
variations is a static string such as a C string literal,
or if desc is only needed temporarily.
a string representing the variations
Sets the weight field of a font description.
The weight field specifies how bold or light the font should be. In addition to the values of the Pango.Weight enumeration, other intermediate numeric values are possible.
Creates a filename representation of a font description.
The filename is identical to the result from calling Pango.FontDescription.to_string, but with underscores instead of characters that are untypical in filenames, and in lower case only.
a new string that must be freed with g_free().
Creates a string representation of a font description.
See Pango.FontDescription.from_string for a description of the format of the string representation. The family list in the string description will only have a terminating comma if the last word of the list is a valid style option.
a new string that must be freed with g_free().
Unsets some of the fields in a Pango.FontDescription.
The unset fields will get back to their default values.
Staticfrom_Creates a new font description from a string representation.
The string must have the form
[FAMILY-LIST] [STYLE-OPTIONS] [SIZE] [VARIATIONS] [FEATURES]
where FAMILY-LIST is a comma-separated list of families optionally terminated by a comma, STYLE_OPTIONS is a whitespace-separated list of words where each word describes one of style, variant, weight, stretch, or gravity, and SIZE is a decimal number (size in points) or optionally followed by the unit modifier "px" for absolute size.
The following words are understood as styles: "Normal", "Roman", "Oblique", "Italic".
The following words are understood as variants: "Small-Caps", "All-Small-Caps", "Petite-Caps", "All-Petite-Caps", "Unicase", "Title-Caps".
The following words are understood as weights: "Thin", "Ultra-Light", "Extra-Light", "Light", "Semi-Light", "Demi-Light", "Book", "Regular", "Medium", "Semi-Bold", "Demi-Bold", "Bold", "Ultra-Bold", "Extra-Bold", "Heavy", "Black", "Ultra-Black", "Extra-Black".
The following words are understood as stretch values: "Ultra-Condensed", "Extra-Condensed", "Condensed", "Semi-Condensed", "Semi-Expanded", "Expanded", "Extra-Expanded", "Ultra-Expanded".
The following words are understood as gravity values: "Not-Rotated", "South", "Upside-Down", "North", "Rotated-Left", "East", "Rotated-Right", "West".
The following words are understood as color values: "With-Color", "Without-Color".
VARIATIONS is a comma-separated list of font variations of the form @axis1=value,axis2=value,...
FEATURES is a comma-separated list of font features of the form #feature1=value,feature2=value,... The =value part can be ommitted if the value is 1.
Any one of the options may be absent. If FAMILY-LIST is absent, then
the family_name field of the resulting font description will be
initialized to null. If STYLE-OPTIONS is missing, then all style
options will be set to the default values. If SIZE is missing, the
size in the resulting font description will be set to 0.
A typical example:
Cantarell Italic Light 15 @wght=200 #tnum=1
string representation of a font description.
Staticnew
A Pango.FontDescription describes a font in an implementation-independent manner.
Pango.FontDescription structures are used both to list what fonts are available on the system and also for specifying the characteristics of a font to load.