Added in API level 31

PositionedGlyphs


class PositionedGlyphs
kotlin.Any
   ↳ android.graphics.text.PositionedGlyphs

Text shaping result object for single style text. You can get text shaping result by TextRunShaper#shapeTextRun(char[], int, int, int, int, float, float, boolean, Paint) and TextRunShaper#shapeTextRun(CharSequence, int, int, int, int, float, float, boolean,.

Summary

Constants
static Float

A special value returned by getWeightOverride(int) and getItalicOverride(int) that indicates no font variation setting is overridden.

Public methods
Boolean
equals(other: Any?)

Float

Returns the total amount of advance consumed by this positioned glyphs.

Float

Effective ascent value of this positioned glyphs.

Float

Effective descent value of this positioned glyphs.

Boolean
getFakeBold(index: Int)

Returns true if the fake bold option used for drawing, otherwise false.

Boolean

Returns true if the fake italic option used for drawing, otherwise false.

Font
getFont(index: Int)

Returns the font object used for drawing the glyph at the given index.

Int
getGlyphId(index: Int)

Returns the glyph ID used for drawing the glyph at the given index.

Float
getGlyphX(index: Int)

Returns the x coordinate of the glyph position at the given index.

Float
getGlyphY(index: Int)

Returns the y coordinate of the glyph position at the given index.

Float

Returns overridden italic value if the font is variable font and `ital` value is overridden for drawing.

Float

Returns the amount of X offset added to glyph position.

Float

Returns the amount of Y offset added to glyph position.

Float

Returns overridden weight value if the font is variable font and `wght` value is overridden for drawing.

Int

Returns the number of glyphs stored.

Int

String

Constants

NO_OVERRIDE

Added in API level 35
static val NO_OVERRIDE: Float

A special value returned by getWeightOverride(int) and getItalicOverride(int) that indicates no font variation setting is overridden.

Value: 1.4E-45f

Public methods

equals

Added in API level 31
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getAdvance

Added in API level 31
fun getAdvance(): Float

Returns the total amount of advance consumed by this positioned glyphs. The advance is an amount of width consumed by the glyph. The total amount of advance is a total amount of advance consumed by this series of glyphs. In other words, if another glyph is placed next to this series of glyphs, it's X offset should be shifted this amount of width.

Return
Float total amount of advance

getAscent

Added in API level 31
fun getAscent(): Float

Effective ascent value of this positioned glyphs. If two or more font files are used in this series of glyphs, the effective ascent will be the minimum ascent value across the all font files.

Return
Float effective ascent value

getDescent

Added in API level 31
fun getDescent(): Float

Effective descent value of this positioned glyphs. If two or more font files are used in this series of glyphs, the effective descent will be the maximum descent value across the all font files.

Return
Float effective descent value

getFakeBold

Added in API level 35
fun getFakeBold(index: Int): Boolean

Returns true if the fake bold option used for drawing, otherwise false.

Parameters
index Int: the glyph index Value is 0 or greater
Return
Boolean true if the fake bold option is on, otherwise off.

getFakeItalic

Added in API level 35
fun getFakeItalic(index: Int): Boolean

Returns true if the fake italic option used for drawing, otherwise false.

Parameters
index Int: the glyph index Value is 0 or greater
Return
Boolean true if the fake italic option is on, otherwise off.

getFont

Added in API level 31
fun getFont(index: Int): Font

Returns the font object used for drawing the glyph at the given index.

Parameters
index Int: the glyph index Value is 0 or greater
Return
Font the font object used for drawing the glyph at the given index This value cannot be null.

getGlyphId

Added in API level 31
fun getGlyphId(index: Int): Int

Returns the glyph ID used for drawing the glyph at the given index.

Parameters
index Int: the glyph index Value is 0 or greater
Return
Int A glyph ID of the font. Value is 0 or greater

getGlyphX

Added in API level 31
fun getGlyphX(index: Int): Float

Returns the x coordinate of the glyph position at the given index.

Parameters
index Int: the glyph index Value is 0 or greater
Return
Float A X offset in pixels

getGlyphY

Added in API level 31
fun getGlyphY(index: Int): Float

Returns the y coordinate of the glyph position at the given index.

Parameters
index Int: the glyph index Value is 0 or greater
Return
Float A Y offset in pixels.

getItalicOverride

Added in API level 35
fun getItalicOverride(index: Int): Float

Returns overridden italic value if the font is variable font and `ital` value is overridden for drawing. Otherwise returns NO_OVERRIDE.

Parameters
index Int: the glyph index Value is 0 or greater
Return
Float overridden weight value or NO_OVERRIDE.

getOffsetX

Added in API level 31
fun getOffsetX(): Float

Returns the amount of X offset added to glyph position.

Return
Float The X offset added to glyph position.

getOffsetY

Added in API level 31
fun getOffsetY(): Float

Returns the amount of Y offset added to glyph position.

Return
Float The Y offset added to glyph position.

getWeightOverride

Added in API level 35
fun getWeightOverride(index: Int): Float

Returns overridden weight value if the font is variable font and `wght` value is overridden for drawing. Otherwise returns NO_OVERRIDE.

Parameters
index Int: the glyph index Value is 0 or greater
Return
Float overridden weight value or NO_OVERRIDE.

glyphCount

Added in API level 31
fun glyphCount(): Int

Returns the number of glyphs stored.

Return
Int the number of glyphs Value is 0 or greater

hashCode

Added in API level 31
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 31
fun toString(): String
Return
String a string representation of the object.