Pango-1.0 ▶ Pango ▶ GlyphString

constructor

• new GlyphString(
      properties?: Partial<
          { glyphs: GlyphInfo[]; log_clusters: number; num_glyphs: number },
      >,
  ): GlyphString

  Parameters

  • Optionalproperties: Partial<{ glyphs: GlyphInfo[]; log_clusters: number; num_glyphs: number }>

  Returns GlyphString

glyphs

log_clusters

num_glyphs

Static$gtype

copy

• copy(): GlyphString

  Copy a glyph string and associated storage.

  Returns GlyphString

  the newly allocated Pango.GlyphString

extents

• extents(font: Pango.Font): [Pango.Rectangle, Pango.Rectangle]

  Compute the logical and ink extents of a glyph string.

  See the documentation for Pango.Font.get_glyph_extents for details about the interpretation of the rectangles.

  Examples of logical (red) and ink (green) rects:

  

  Parameters

  • font: Pango.Font

    a Pango.Font

  Returns [Pango.Rectangle, Pango.Rectangle]

extents_range

• extents_range(
      start: number,
      end: number,
      font: Pango.Font,
  ): [Pango.Rectangle, Pango.Rectangle]

  Computes the extents of a sub-portion of a glyph string.

  The extents are relative to the start of the glyph string range (the origin of their coordinate system is at the start of the range, not at the start of the entire glyph string).

  Parameters

  • start: number

    start index

  • end: number

    end index (the range is the set of bytes with indices such that start <= index < end)

  • font: Pango.Font

    a Pango.Font

  Returns [Pango.Rectangle, Pango.Rectangle]

free

• free(): void

  Free a glyph string and associated storage.

  Returns void

get_logical_widths

• get_logical_widths(
      text: string,
      length: number,
      embedding_level: number,
  ): number[]

  Given a Pango.GlyphString and corresponding text, determine the width corresponding to each character.

  When multiple characters compose a single cluster, the width of the entire cluster is divided equally among the characters.

  See also Pango.GlyphItem.get_logical_widths.

  Parameters

  • text: string

    the text corresponding to the glyphs

  • length: number

    the length of text, in bytes

  • embedding_level: number

    the embedding level of the string

  Returns number[]

get_width

• get_width(): number

  Computes the logical width of the glyph string.

  This can also be computed using Pango.GlyphString.extents. However, since this only computes the width, it's much faster. This is in fact only a convenience function that computes the sum of geometry.width for each glyph in the glyphs.

  Returns number

  the logical width of the glyph string.

index_to_x

• index_to_x(
      text: string,
      length: number,
      analysis: Analysis,
      index_: number,
      trailing: boolean,
  ): number

  Converts from character position to x position.

  The X position is measured from the left edge of the run. Character positions are obtained using font metrics for ligatures where available, and computed by dividing up each cluster into equal portions, otherwise.

  

  Parameters

  • text: string

    the text for the run

  • length: number

    the number of bytes (not characters) in text.

  • analysis: Analysis

    the analysis information return from itemize

  • index_: number

    the byte index within text

  • trailing: boolean

    whether we should compute the result for the beginning (false) or end (true) of the character.

  Returns number

index_to_x_full

• index_to_x_full(
      text: string,
      length: number,
      analysis: Analysis,
      attrs: LogAttr,
      index_: number,
      trailing: boolean,
  ): number

  Converts from character position to x position.

  This variant of Pango.GlyphString.index_to_x additionally accepts a Pango.LogAttr array. The grapheme boundary information in it can be used to disambiguate positioning inside some complex clusters.

  Parameters

  • text: string

    the text for the run

  • length: number

    the number of bytes (not characters) in text.

  • analysis: Analysis

    the analysis information return from itemize

  • attrs: LogAttr

    Pango.LogAttr array for text

  • index_: number

    the byte index within text

  • trailing: boolean

    whether we should compute the result for the beginning (false) or end (true) of the character.

  Returns number

set_size

• set_size(new_len: number): void

  Resize a glyph string to the given length.

  Parameters

  • new_len: number

    the new length of the string

  Returns void

x_to_index

• x_to_index(
      text: string,
      length: number,
      analysis: Analysis,
      x_pos: number,
  ): [number, number]

  Convert from x offset to character position.

  Character positions are computed by dividing up each cluster into equal portions. In scripts where positioning within a cluster is not allowed (such as Thai), the returned value may not be a valid cursor position; the caller must combine the result with the logical attributes for the text to compute the valid cursor position.

  Parameters

  • text: string

    the text for the run

  • length: number

    the number of bytes (not characters) in text.

  • analysis: Analysis

    the analysis information return from itemize

  • x_pos: number

    the x offset (in Pango units)

  Returns [number, number]

Staticnew

• new(): GlyphString

  Returns GlyphString