Name
pfont:GetMetrics -- get font metrics
Synopsis
metrics = pfont:GetMetrics([language])
Function
Gets overall metric information for a font.

Since the metrics may be substantially different for different scripts, a language tag can be provided to indicate that the metrics should be retrieved that correspond to the script(s) used by that language. If it is specified, the language parameter must be a Pango language object.

If the font is a NULL object, this function gracefully sets some sane values in the output variables and returns.

This function returns a Pango font metrics object. The caller must call pfontmetrics:Free() when finished using the object.

Inputs
language
optional: language tag used to determine which script to get the metrics for; if this parameter is omitted metrics for the entire font will be returned
Results
metrics
a Pango font metrics object

Show TOC