Functions

The following functions are available globally.

  • Retrieves any font rendering options previously set with [funcPangoCairo.context_set_font_options].

    This function does not report options that are derived from the target surface by [funcupdate_context].

    Declaration

    Swift

    @inlinable
public func contextGetFontOptions<PangoContextT>(context: PangoContextT) -> Cairo.FontOptionsRef!
    Show on GitHub

  • Gets the resolution for the context.

    See [funcPangoCairo.context_set_resolution]

    Declaration

    Swift

    @inlinable
public func contextGetResolution<PangoContextT>(context: PangoContextT) -> CDouble
    Show on GitHub

  • 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 [funcPangoCairo.context_set_shape_renderer], if any.

    Declaration

    Swift

    @inlinable
public func contextGetShapeRenderer<PangoContextT>(context: PangoContextT, data: UnsafeMutablePointer<gpointer?>? = nil) -> PangoCairoShapeRendererFunc!
    Show on GitHub

  • Sets the font options used when rendering text with this context.

    These options override any options that [funcupdate_context] derives from the target surface.

    Declaration

    Swift

    @inlinable
public func contextSetFontOptions<PangoContextT>(context: PangoContextT, options: Cairo.FontOptionsRef? = nil)
    Show on GitHub

  • Sets the font options used when rendering text with this context.

    These options override any options that [funcupdate_context] derives from the target surface.

    Declaration

    Swift

    @inlinable
public func contextSetFontOptions<PangoContextT, cairoFontOptionsT>(context: PangoContextT, options: cairoFontOptionsT?) where cairoFontOptionsT : FontOptionsProtocol
    Show on GitHub

  • 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).

    Declaration

    Swift

    @inlinable
public func contextSetResolution<PangoContextT>(context: PangoContextT, dpi: CDouble)
    Show on GitHub

  • Sets callback function for context to use for rendering attributes of type PANGO_ATTR_SHAPE.

    See PangoCairoShapeRendererFunc for details.

    Declaration

    Swift

    @inlinable
public func contextSetShapeRenderer<PangoContextT>(context: PangoContextT, func: PangoCairoShapeRendererFunc? = nil, data: gpointer? = nil, dnotify: GDestroyNotify? = nil)
    Show on GitHub

  • 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 [ctorPango.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 [funccreate_layout] instead.

    Declaration

    Swift

    @inlinable
public func createContext<cairoContextT>(cr: cairoContextT) -> Pango.ContextRef! where cairoContextT : ContextProtocol
    Show on GitHub

  • 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 [methodPango.Layout.get_size] or drawing with functions like [funcshow_layout]. If you change the transformation or target surface for cr, you need to call [funcupdate_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.

    Declaration

    Swift

    @inlinable
public func createLayout<cairoContextT>(cr: cairoContextT) -> Pango.LayoutRef! where cairoContextT : ContextProtocol
    Show on GitHub

  • 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.

    Declaration

    Swift

    @inlinable
public func errorUnderlinePath<cairoContextT>(cr: cairoContextT, x: CDouble, y: CDouble, width: CDouble, height: CDouble) where cairoContextT : ContextProtocol
    Show on GitHub

  • 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 [methodPangoCairo.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.

    Declaration

    Swift

    @inlinable
public func fontMapGetDefault() -> Pango.FontMapRef!
    Show on GitHub

  • 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 funcPangoCairo.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.

    Declaration

    Swift

    @inlinable
public func fontMapNew() -> Pango.FontMapRef!
    Show on GitHub

  • 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 [funcPangoCairo.FontMap.new], or in fact in most of those cases, just use [funcPangoCairo.FontMap.get_default].

    Declaration

    Swift

    @inlinable
public func fontMapNewForFontType(fonttype: cairo_font_type_t) -> Pango.FontMapRef!
    Show on GitHub

  • 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.

    Declaration

    Swift

    @inlinable
public func glyphStringPath<PangoFontT, PangoGlyphStringT, cairoContextT>(cr: cairoContextT, font: PangoFontT, glyphs: PangoGlyphStringT) where cairoContextT : ContextProtocol
    Show on GitHub

  • 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.

    Declaration

    Swift

    @inlinable
public func layoutLinePath<PangoLayoutLineT, cairoContextT>(cr: cairoContextT, line: PangoLayoutLineT) where cairoContextT : ContextProtocol
    Show on GitHub

  • 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.

    Declaration

    Swift

    @inlinable
public func layoutPath<PangoLayoutT, cairoContextT>(cr: cairoContextT, layout: PangoLayoutT) where cairoContextT : ContextProtocol
    Show on GitHub

  • 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.

    Declaration

    Swift

    @inlinable
public func showErrorUnderline<cairoContextT>(cr: cairoContextT, x: CDouble, y: CDouble, width: CDouble, height: CDouble) where cairoContextT : ContextProtocol
    Show on GitHub

  • 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 [funcshow_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-&gt;item-&gt;offset.

    Declaration

    Swift

    @inlinable
public func showGlyphItem<PangoGlyphItemT, cairoContextT>(cr: cairoContextT, text: UnsafePointer<CChar>!, glyphItem: PangoGlyphItemT) where cairoContextT : ContextProtocol
    Show on GitHub

  • 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.

    Declaration

    Swift

    @inlinable
public func showGlyphString<PangoFontT, PangoGlyphStringT, cairoContextT>(cr: cairoContextT, font: PangoFontT, glyphs: PangoGlyphStringT) where cairoContextT : ContextProtocol
    Show on GitHub

  • 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.

    Declaration

    Swift

    @inlinable
public func showLayout<PangoLayoutT, cairoContextT>(cr: cairoContextT, layout: PangoLayoutT) where cairoContextT : ContextProtocol
    Show on GitHub

  • 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.

    Declaration

    Swift

    @inlinable
public func showLayoutLine<PangoLayoutLineT, cairoContextT>(cr: cairoContextT, line: PangoLayoutLineT) where cairoContextT : ContextProtocol
    Show on GitHub

  • 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 [methodPango.Layout.context_changed] on those layouts.

    Declaration

    Swift

    @inlinable
public func updateContext<PangoContextT, cairoContextT>(cr: cairoContextT, context: PangoContextT) where cairoContextT : ContextProtocol
    Show on GitHub

  • Updates the private PangoContext of a PangoLayout created with [funccreate_layout] to match the current transformation and target surface of a Cairo context.

    Declaration

    Swift

    @inlinable
public func updateLayout<PangoLayoutT, cairoContextT>(cr: cairoContextT, layout: PangoLayoutT) where cairoContextT : ContextProtocol
    Show on GitHub