Description
The font options specify how fonts should be rendered. Most of the
time the font options implied by a surface are just right and do not
need any changes, but for pixel-based targets tweaking font options
may result in superior output on a particular display.
Functions
cairo_font_options_create ()
cairo_font_options_t *
cairo_font_options_create (void);
Allocates a new font options object with all options initialized
to default values.
Since: 1.0
cairo_font_options_copy ()
cairo_font_options_t *
cairo_font_options_copy (const cairo_font_options_t *original);
Allocates a new font options object copying the option values from
original
.
Since: 1.0
cairo_font_options_status ()
cairo_status_t
cairo_font_options_status (cairo_font_options_t *options);
Checks whether an error has previously occurred for this
font options object
Since: 1.0
cairo_font_options_merge ()
void
cairo_font_options_merge (cairo_font_options_t *options,
const cairo_font_options_t *other);
Merges non-default options from other
into options
, replacing
existing values. This operation can be thought of as somewhat
similar to compositing other
onto options
with the operation
of CAIRO_OPERATOR_OVER.
Since: 1.0
cairo_font_options_hash ()
unsigned long
cairo_font_options_hash (const cairo_font_options_t *options);
Compute a hash for the font options object; this value will
be useful when storing an object containing a cairo_font_options_t
in a hash table.
Returns
the hash value for the font options object.
The return value can be cast to a 32-bit type if a
32-bit hash value is needed.
Since: 1.0
cairo_font_options_equal ()
cairo_bool_t
cairo_font_options_equal (const cairo_font_options_t *options,
const cairo_font_options_t *other);
Compares two font options objects for equality.
Returns
TRUE if all fields of the two font options objects match.
Note that this function will return FALSE if either object is in
error.
Since: 1.0
cairo_font_options_set_antialias ()
void
cairo_font_options_set_antialias (cairo_font_options_t *options,
cairo_antialias_t antialias);
Sets the antialiasing mode for the font options object. This
specifies the type of antialiasing to do when rendering text.
Since: 1.0
cairo_font_options_get_antialias ()
cairo_antialias_t
cairo_font_options_get_antialias (const cairo_font_options_t *options);
Gets the antialiasing mode for the font options object.
Returns
the antialiasing mode
Since: 1.0
cairo_font_options_set_subpixel_order ()
void
cairo_font_options_set_subpixel_order (cairo_font_options_t *options,
cairo_subpixel_order_t subpixel_order);
Sets the subpixel order for the font options object. The subpixel
order specifies the order of color elements within each pixel on
the display device when rendering with an antialiasing mode of
CAIRO_ANTIALIAS_SUBPIXEL. See the documentation for
cairo_subpixel_order_t for full details.
Since: 1.0
cairo_font_options_get_subpixel_order ()
cairo_subpixel_order_t
cairo_font_options_get_subpixel_order (const cairo_font_options_t *options);
Gets the subpixel order for the font options object.
See the documentation for cairo_subpixel_order_t for full details.
Returns
the subpixel order for the font options object
Since: 1.0
cairo_font_options_set_hint_style ()
void
cairo_font_options_set_hint_style (cairo_font_options_t *options,
cairo_hint_style_t hint_style);
Sets the hint style for font outlines for the font options object.
This controls whether to fit font outlines to the pixel grid,
and if so, whether to optimize for fidelity or contrast.
See the documentation for cairo_hint_style_t for full details.
Since: 1.0
cairo_font_options_get_hint_style ()
cairo_hint_style_t
cairo_font_options_get_hint_style (const cairo_font_options_t *options);
Gets the hint style for font outlines for the font options object.
See the documentation for cairo_hint_style_t for full details.
Returns
the hint style for the font options object
Since: 1.0
cairo_font_options_set_hint_metrics ()
void
cairo_font_options_set_hint_metrics (cairo_font_options_t *options,
cairo_hint_metrics_t hint_metrics);
Sets the metrics hinting mode for the font options object. This
controls whether metrics are quantized to integer values in
device units.
See the documentation for cairo_hint_metrics_t for full details.
Since: 1.0
cairo_font_options_get_hint_metrics ()
cairo_hint_metrics_t
cairo_font_options_get_hint_metrics (const cairo_font_options_t *options);
Gets the metrics hinting mode for the font options object.
See the documentation for cairo_hint_metrics_t for full details.
Returns
the metrics hinting mode for the font options object
Since: 1.0
Types and Values
enum cairo_subpixel_order_t
The subpixel order specifies the order of color elements within
each pixel on the display device when rendering with an
antialiasing mode of CAIRO_ANTIALIAS_SUBPIXEL.
Since: 1.0
enum cairo_hint_style_t
Specifies the type of hinting to do on font outlines. Hinting
is the process of fitting outlines to the pixel grid in order
to improve the appearance of the result. Since hinting outlines
involves distorting them, it also reduces the faithfulness
to the original outline shapes. Not all of the outline hinting
styles are supported by all font backends.
New entries may be added in future versions.
Since: 1.0
enum cairo_hint_metrics_t
Specifies whether to hint font metrics; hinting font metrics
means quantizing them so that they are integer values in
device space. Doing this improves the consistency of
letter and line spacing, however it also means that text
will be laid out differently at different zoom factors.
Since: 1.0