`PangoCairoFont` is an interface exported by fonts for
use with Cairo.
The actual type of the font will depend on the particular
font technology Cairo was compiled to use.
Gets the `cairo_scaled_font_t` used by @font.
The scaled font can be referenced and kept using
cairo_scaled_font_reference().
the `cairo_scaled_font_t`
used by @font
a `PangoFont` from a `PangoCairoFontMap`
`PangoCairoFontMap` is an interface exported by font maps for
use with Cairo.
The actual type of the font map will depend on the particular
font technology Cairo was compiled to use.
Gets a default `PangoCairoFontMap` to use with Cairo.
Note that the type of the returned object will depend on the
particular font backend Cairo was compiled to use; you generally
should only use the `PangoFontMap` and `PangoCairoFontMap`
interfaces on the returned object.
The default Cairo fontmap can be changed by using
[method@PangoCairo.FontMap.set_default]. This can be used to
change the Cairo font backend that the default fontmap uses
for example.
Note that since Pango 1.32.6, the default fontmap is per-thread.
Each thread gets its own default fontmap. In this way, PangoCairo
can be used safely from multiple threads.
the default PangoCairo fontmap
for the current thread. This object is owned by Pango and must
not be freed.
Creates a new `PangoCairoFontMap` object.
A fontmap is used to cache information about available fonts,
and holds certain global parameters such as the resolution.
In most cases, you can use `func@PangoCairo.font_map_get_default]
instead.
Note that the type of the returned object will depend
on the particular font backend Cairo was compiled to use;
You generally should only use the `PangoFontMap` and
`PangoCairoFontMap` interfaces on the returned object.
You can override the type of backend returned by using an
environment variable %PANGOCAIRO_BACKEND. Supported types,
based on your build, are fc (fontconfig), win32, and coretext.
If requested type is not available, NULL is returned. Ie.
this is only useful for testing, when at least two backends
are compiled in.
the newly allocated `PangoFontMap`,
which should be freed with g_object_unref().
Creates a new `PangoCairoFontMap` object of the type suitable
to be used with cairo font backend of type @fonttype.
In most cases one should simply use [func@PangoCairo.FontMap.new], or
in fact in most of those cases, just use [func@PangoCairo.FontMap.get_default].
the newly allocated
`PangoFontMap` of suitable type which should be freed with
g_object_unref(), or %NULL if the requested cairo font backend
is not supported / compiled in.
desired #cairo_font_type_t
Create a `PangoContext` for the given fontmap.
Use pango_font_map_create_context() instead.
the newly created context; free with g_object_unref().
a `PangoCairoFontMap`
Gets the type of Cairo font backend that @fontmap uses.
the `cairo_font_type_t` cairo font backend type
a `PangoCairoFontMap`
Gets the resolution for the fontmap.
See [method@PangoCairo.FontMap.set_resolution].
the resolution in "dots per inch"
a `PangoCairoFontMap`
Sets a default `PangoCairoFontMap` to use with Cairo.
This can be used to change the Cairo font backend that the
default fontmap uses for example. The old default font map
is unreffed and the new font map referenced.
Note that since Pango 1.32.6, the default fontmap is per-thread.
This function only changes the default fontmap for
the current thread. Default fontmaps of existing threads
are not changed. Default fontmaps of any new threads will
still be created using [func@PangoCairo.FontMap.new].
A value of %NULL for @fontmap will cause the current default
font map to be released and a new default font map to be created
on demand, using [func@PangoCairo.FontMap.new].
The new default font map
Sets the resolution for the fontmap.
This is a scale factor between
points specified in a `PangoFontDescription` and Cairo units. The
default value is 96, meaning that a 10 point font will be 13
units high. (10 * 96. / 72. = 13.3).
a `PangoCairoFontMap`
the resolution in "dots per inch". (Physical inches aren't actually
involved; the terminology is conventional.)
Function type for rendering attributes of type %PANGO_ATTR_SHAPE
with Pango's Cairo renderer.
a Cairo context with current point set to where the shape should
be rendered
the %PANGO_ATTR_SHAPE to render
whether only the shape path should be appended to current
path of @cr and no filling/stroking done. This will be set
to %TRUE when called from pango_cairo_layout_path() and
pango_cairo_layout_line_path() rendering functions.
user data passed to pango_cairo_context_set_shape_renderer()
Retrieves any font rendering options previously set with
[func@PangoCairo.context_set_font_options].
This function does not report options that are derived from
the target surface by [func@update_context].
the font options previously set on the
context, or %NULL if no options have been set. This value is
owned by the context and must not be modified or freed.
a `PangoContext`, from a pangocairo font map
Gets the resolution for the context.
See [func@PangoCairo.context_set_resolution]
the resolution in "dots per inch". A negative value will
be returned if no resolution has previously been set.
a `PangoContext`, from a pangocairo font map
Sets callback function for context to use for rendering attributes
of type %PANGO_ATTR_SHAPE.
See `PangoCairoShapeRendererFunc` for details.
Retrieves callback function and associated user data for rendering
attributes of type %PANGO_ATTR_SHAPE as set by
[func@PangoCairo.context_set_shape_renderer], if any.
the shape rendering callback
previously set on the context, or %NULL if no shape rendering callback
have been set.
a `PangoContext`, from a pangocairo font map
Pointer to `gpointer` to return user data
Sets the font options used when rendering text with this context.
These options override any options that [func@update_context]
derives from the target surface.
a `PangoContext`, from a pangocairo font map
a `cairo_font_options_t`, or %NULL to unset
any previously set options. A copy is made.
Sets the resolution for the context.
This is a scale factor between points specified in a `PangoFontDescription`
and Cairo units. The default value is 96, meaning that a 10 point font will
be 13 units high. (10 * 96. / 72. = 13.3).
a `PangoContext`, from a pangocairo font map
the resolution in "dots per inch". (Physical inches aren't actually
involved; the terminology is conventional.) A 0 or negative value
means to use the resolution from the font map.
Sets callback function for context to use for rendering attributes
of type %PANGO_ATTR_SHAPE.
See `PangoCairoShapeRendererFunc` for details.
a `PangoContext`, from a pangocairo font map
Callback function for rendering attributes of
type %PANGO_ATTR_SHAPE, or %NULL to disable shape rendering.
User data that will be passed to @func.
Callback that will be called when the
context is freed to release @data
Creates a context object set up to match the current transformation
and target surface of the Cairo context.
This context can then be
used to create a layout using [ctor@Pango.Layout.new].
This function is a convenience function that creates a context using
the default font map, then updates it to @cr. If you just need to
create a layout for use with @cr and do not need to access `PangoContext`
directly, you can use [func@create_layout] instead.
the newly created `PangoContext`
a Cairo context
Creates a layout object set up to match the current transformation
and target surface of the Cairo context.
This layout can then be used for text measurement with functions
like [method@Pango.Layout.get_size] or drawing with functions like
[func@show_layout]. If you change the transformation or target
surface for @cr, you need to call [func@update_layout].
This function is the most convenient way to use Cairo with Pango,
however it is slightly inefficient since it creates a separate
`PangoContext` object for each layout. This might matter in an
application that was laying out large amounts of text.
the newly created `PangoLayout`
a Cairo context
Add a squiggly line to the current path in the specified cairo context that
approximately covers the given rectangle in the style of an underline used
to indicate a spelling error.
The width of the underline is rounded to an integer number of up/down
segments and the resulting rectangle is centered in the original rectangle.
a Cairo context
The X coordinate of one corner of the rectangle
The Y coordinate of one corner of the rectangle
Non-negative width of the rectangle
Non-negative height of the rectangle
Gets a default `PangoCairoFontMap` to use with Cairo.
Note that the type of the returned object will depend on the
particular font backend Cairo was compiled to use; you generally
should only use the `PangoFontMap` and `PangoCairoFontMap`
interfaces on the returned object.
The default Cairo fontmap can be changed by using
[method@PangoCairo.FontMap.set_default]. This can be used to
change the Cairo font backend that the default fontmap uses
for example.
Note that since Pango 1.32.6, the default fontmap is per-thread.
Each thread gets its own default fontmap. In this way, PangoCairo
can be used safely from multiple threads.
the default PangoCairo fontmap
for the current thread. This object is owned by Pango and must
not be freed.
Creates a new `PangoCairoFontMap` object.
A fontmap is used to cache information about available fonts,
and holds certain global parameters such as the resolution.
In most cases, you can use `func@PangoCairo.font_map_get_default]
instead.
Note that the type of the returned object will depend
on the particular font backend Cairo was compiled to use;
You generally should only use the `PangoFontMap` and
`PangoCairoFontMap` interfaces on the returned object.
You can override the type of backend returned by using an
environment variable %PANGOCAIRO_BACKEND. Supported types,
based on your build, are fc (fontconfig), win32, and coretext.
If requested type is not available, NULL is returned. Ie.
this is only useful for testing, when at least two backends
are compiled in.
the newly allocated `PangoFontMap`,
which should be freed with g_object_unref().
Creates a new `PangoCairoFontMap` object of the type suitable
to be used with cairo font backend of type @fonttype.
In most cases one should simply use [func@PangoCairo.FontMap.new], or
in fact in most of those cases, just use [func@PangoCairo.FontMap.get_default].
the newly allocated
`PangoFontMap` of suitable type which should be freed with
g_object_unref(), or %NULL if the requested cairo font backend
is not supported / compiled in.
desired #cairo_font_type_t
Adds the glyphs in @glyphs to the current path in the specified
cairo context.
The origin of the glyphs (the left edge of the baseline)
will be at the current point of the cairo context.
a Cairo context
a `PangoFont` from a `PangoCairoFontMap`
a `PangoGlyphString`
Adds the text in `PangoLayoutLine` to the current path in the
specified cairo context.
The origin of the glyphs (the left edge of the line) will be
at the current point of the cairo context.
a Cairo context
a `PangoLayoutLine`
Adds the text in a `PangoLayout` to the current path in the
specified cairo context.
The top-left corner of the `PangoLayout` will be at the
current point of the cairo context.
a Cairo context
a Pango layout
Draw a squiggly line in the specified cairo context that approximately
covers the given rectangle in the style of an underline used to indicate a
spelling error.
The width of the underline is rounded to an integer
number of up/down segments and the resulting rectangle is centered in the
original rectangle.
a Cairo context
The X coordinate of one corner of the rectangle
The Y coordinate of one corner of the rectangle
Non-negative width of the rectangle
Non-negative height of the rectangle
Draws the glyphs in @glyph_item in the specified cairo context,
embedding the text associated with the glyphs in the output if the
output format supports it (PDF for example), otherwise it acts
similar to [func@show_glyph_string].
The origin of the glyphs (the left edge of the baseline) will
be drawn at the current point of the cairo context.
Note that @text is the start of the text for layout, which is then
indexed by `glyph_item->item->offset`.
a Cairo context
the UTF-8 text that @glyph_item refers to
a `PangoGlyphItem`
Draws the glyphs in @glyphs in the specified cairo context.
The origin of the glyphs (the left edge of the baseline) will
be drawn at the current point of the cairo context.
a Cairo context
a `PangoFont` from a `PangoCairoFontMap`
a `PangoGlyphString`
Draws a `PangoLayout` in the specified cairo context.
The top-left corner of the `PangoLayout` will be drawn
at the current point of the cairo context.
a Cairo context
a Pango layout
Draws a `PangoLayoutLine` in the specified cairo context.
The origin of the glyphs (the left edge of the line) will
be drawn at the current point of the cairo context.
a Cairo context
a `PangoLayoutLine`
Updates a `PangoContext` previously created for use with Cairo to
match the current transformation and target surface of a Cairo
context.
If any layouts have been created for the context, it's necessary
to call [method@Pango.Layout.context_changed] on those layouts.
a Cairo context
a `PangoContext`, from a pangocairo font map
Updates the private `PangoContext` of a `PangoLayout` created with
[func@create_layout] to match the current transformation and target
surface of a Cairo context.
a Cairo context
a `PangoLayout`, from [func@create_layout]