QRawFont Class
The QRawFont class provides access to a single physical instance of a font. More...
| Header: | #include <QRawFont> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
- List of all members, including inherited members
- QRawFont is part of Implicitly Shared Classes.
Public Types
| enum | AntialiasingType { PixelAntialiasing, SubPixelAntialiasing } |
| enum | LayoutFlag { SeparateAdvances, KernedAdvances, UseDesignMetrics } |
| flags | LayoutFlags |
Public Functions
| QRawFont() | |
| QRawFont(const QString &fileName, qreal pixelSize, QFont::HintingPreference hintingPreference = QFont::PreferDefaultHinting) | |
| QRawFont(const QByteArray &fontData, qreal pixelSize, QFont::HintingPreference hintingPreference = QFont::PreferDefaultHinting) | |
| QRawFont(const QRawFont &other) | |
| ~QRawFont() | |
| QList<QPointF> | advancesForGlyphIndexes(const QList<quint32> &glyphIndexes, QRawFont::LayoutFlags layoutFlags) const |
| QList<QPointF> | advancesForGlyphIndexes(const QList<quint32> &glyphIndexes) const |
| bool | advancesForGlyphIndexes(const quint32 *glyphIndexes, QPointF *advances, int numGlyphs) const |
| bool | advancesForGlyphIndexes(const quint32 *glyphIndexes, QPointF *advances, int numGlyphs, QRawFont::LayoutFlags layoutFlags) const |
| QImage | alphaMapForGlyph(quint32 glyphIndex, QRawFont::AntialiasingType antialiasingType = SubPixelAntialiasing, const QTransform &transform = QTransform()) const |
| qreal | ascent() const |
| qreal | averageCharWidth() const |
| QRectF | boundingRect(quint32 glyphIndex) const |
| qreal | capHeight() const |
| qreal | descent() const |
| QString | familyName() const |
(since 6.7) QByteArray | fontTable(QFont::Tag tag) const |
| QByteArray | fontTable(const char *tag) const |
| bool | glyphIndexesForChars(const QChar *chars, int numChars, quint32 *glyphIndexes, int *numGlyphs) const |
| QList<quint32> | glyphIndexesForString(const QString &text) const |
| QFont::HintingPreference | hintingPreference() const |
| bool | isValid() const |
| qreal | leading() const |
| qreal | lineThickness() const |
| void | loadFromData(const QByteArray &fontData, qreal pixelSize, QFont::HintingPreference hintingPreference) |
| void | loadFromFile(const QString &fileName, qreal pixelSize, QFont::HintingPreference hintingPreference) |
| qreal | maxCharWidth() const |
| QPainterPath | pathForGlyph(quint32 glyphIndex) const |
| qreal | pixelSize() const |
| void | setPixelSize(qreal pixelSize) |
| QFont::Style | style() const |
| QString | styleName() const |
| QList<QFontDatabase::WritingSystem> | supportedWritingSystems() const |
| bool | supportsCharacter(QChar character) const |
| bool | supportsCharacter(uint ucs4) const |
| void | swap(QRawFont &other) |
| qreal | underlinePosition() const |
| qreal | unitsPerEm() const |
| int | weight() const |
| qreal | xHeight() const |
| bool | operator!=(const QRawFont &other) const |
| QRawFont & | operator=(const QRawFont &other) |
| bool | operator==(const QRawFont &other) const |
Static Public Members
| QRawFont | fromFont(const QFont &font, QFontDatabase::WritingSystem writingSystem = QFontDatabase::Any) |
Related Non-Members
| size_t | qHash(const QRawFont &font, size_t seed = 0) |
Detailed Description
Note: QRawFont is a low level class. For most purposes QFont is a more appropriate class.
Most commonly, when presenting text in a user interface, the exact fonts used to render the characters is to some extent unknown. This can be the case for several reasons: For instance, the actual, physical fonts present on the target system could be unexpected to the developers, or the text could contain user selected styles, sizes or writing systems that are not supported by font chosen in the code.
Therefore, Qt's QFont class really represents a query for fonts. When text is interpreted, Qt will do its best to match the text to the query, but depending on the support, different fonts can be used behind the scenes.
For most use cases, this is both expected and necessary, as it minimizes the possibility of text in the user interface being undisplayable. In some cases, however, more direct control over the process might be useful. It is for these use cases the QRawFont class exists.
A QRawFont object represents a single, physical instance of a given font in a given pixel size. I.e. in the typical case it represents a set of TrueType or OpenType font tables and uses a user specified pixel size to convert metrics into logical pixel units. It can be used in combination with the QGlyphRun class to draw specific glyph indexes at specific positions, and also have accessors to some relevant data in the physical font.
QRawFont only provides support for the main font technologies: GDI and DirectWrite on Windows platforms, FreeType on Linux platforms and CoreText on macOS. For other font back-ends, the APIs will be disabled.
QRawFont can be constructed in a number of ways:
- It can be constructed by calling QTextLayout::glyphs() or QTextFragment::glyphs(). The returned QGlyphs objects will contain QRawFont objects which represent the actual fonts used to render each portion of the text.
- It can be constructed by passing a QFont object to QRawFont::fromFont(). The function will return a QRawFont object representing the font that will be selected as response to the QFont query and the selected writing system.
- It can be constructed by passing a file name or QByteArray directly to the QRawFont constructor, or by calling loadFromFile() or loadFromData(). In this case, the font will not be registered in QFontDatabase, and it will not be available as part of regular font selection.
QRawFont is considered local to the thread in which it is constructed (either using a constructor, or by calling loadFromData() or loadFromFile()). The QRawFont cannot be moved to a different thread, but will have to be recreated in the thread in question.
Note: For the requirement of caching glyph indexes and font selections for static text to avoid reshaping and relayouting in the inner loop of an application, a better choice is the QStaticText class, since it optimizes the memory cost of the cache and also provides the possibility of paint engine specific caches for an additional speed-up.
Member Type Documentation
enum QRawFont::AntialiasingType
This enum represents the different ways a glyph can be rasterized in the function alphaMapForGlyph().
| Constant | Value | Description |
|---|---|---|
QRawFont::PixelAntialiasing | 0 | Will rasterize by measuring the coverage of the shape on whole pixels. The returned image contains the alpha values of each pixel based on the coverage of the glyph shape. |
QRawFont::SubPixelAntialiasing | 1 | Will rasterize by measuring the coverage of each subpixel, returning a separate alpha value for each of the red, green and blue components of each pixel. |
enum QRawFont::LayoutFlag
flags QRawFont::LayoutFlags
This enum tells the function advancesForGlyphIndexes() how to calculate the advances.
| Constant | Value | Description |
|---|---|---|
QRawFont::SeparateAdvances | 0 | Will calculate the advance for each glyph separately. |
QRawFont::KernedAdvances | 1 | Will apply kerning between adjacent glyphs. Note that OpenType GPOS based kerning is currently not supported. |
QRawFont::UseDesignMetrics | 2 | Use design metrics instead of hinted metrics adjusted to the resolution of the paint device. Can be OR-ed with any of the options above. |
The LayoutFlags type is a typedef for QFlags<LayoutFlag>. It stores an OR combination of LayoutFlag values.
Member Function Documentation
QRawFont::QRawFont()
Constructs an invalid QRawFont.
QRawFont::QRawFont(const QString &fileName, qreal pixelSize, QFont::HintingPreference hintingPreference = QFont::PreferDefaultHinting)
Constructs a QRawFont representing the font contained in the file referenced by fileName for the size (in pixels) given by pixelSize, and using the hinting preference specified by hintingPreference.
Note: The referenced file must contain a TrueType or OpenType font.
QRawFont::QRawFont(const QByteArray &fontData, qreal pixelSize, QFont::HintingPreference hintingPreference = QFont::PreferDefaultHinting)
Constructs a QRawFont representing the font contained in the supplied fontData for the size (in pixels) given by pixelSize, and using the hinting preference specified by hintingPreference.
Note: The data must contain a TrueType or OpenType font.
QRawFont::QRawFont(const QRawFont &other)
Creates a QRawFont which is a copy of other.
[noexcept] QRawFont::~QRawFont()
Destroys the QRawFont
QList<QPointF> QRawFont::advancesForGlyphIndexes(const QList<quint32> &glyphIndexes, QRawFont::LayoutFlags layoutFlags) const
Returns the QRawFont's advances for each of the glyphIndexes in pixel units. The advances give the distance from the position of a given glyph to where the next glyph should be drawn to make it appear as if the two glyphs are unspaced. How the advances are calculated is controlled by layoutFlags.
Note: When KernedAdvances is requested, this function will apply kerning rules from the TrueType table KERN, if this is available in the font. In many modern fonts, kerning is handled through OpenType rules or AAT rules, which requires a full shaping step to be applied. To get the results of fully shaping the text, use QTextLayout.
See also QTextLine::horizontalAdvance(), QFontMetricsF::horizontalAdvance(), and QTextLayout::glyphRuns().
QList<QPointF> QRawFont::advancesForGlyphIndexes(const QList<quint32> &glyphIndexes) const
This is an overloaded function.
Returns the QRawFont's advances for each of the glyphIndexes in pixel units. The advances give the distance from the position of a given glyph to where the next glyph should be drawn to make it appear as if the two glyphs are unspaced. The advance of each glyph is calculated separately.
See also QTextLine::horizontalAdvance() and QFontMetricsF::horizontalAdvance().
bool QRawFont::advancesForGlyphIndexes(const quint32 *glyphIndexes, QPointF *advances, int numGlyphs) const
This is an overloaded function.
Returns the QRawFont's advances for each of the glyphIndexes in pixel units. The advances give the distance from the position of a given glyph to where the next glyph should be drawn to make it appear as if the two glyphs are unspaced. The glyph indexes are given with the array glyphIndexes while the results are returned through advances, both of them must have numGlyphs elements. The advance of each glyph is calculated separately
See also QTextLine::horizontalAdvance() and QFontMetricsF::horizontalAdvance().
bool QRawFont::advancesForGlyphIndexes(const quint32 *glyphIndexes, QPointF *advances, int numGlyphs, QRawFont::LayoutFlags layoutFlags) const
Returns the QRawFont's advances for each of the glyphIndexes in pixel units. The advances give the distance from the position of a given glyph to where the next glyph should be drawn to make it appear as if the two glyphs are unspaced. The glyph indexes are given with the array glyphIndexes while the results are returned through advances, both of them must have numGlyphs elements. How the advances are calculated is controlled by layoutFlags.
Note: When KernedAdvances is requested, this function will apply kerning rules from the TrueType table KERN, if this is available in the font. In many modern fonts, kerning is handled through OpenType rules or AAT rules, which requires a full shaping step to be applied. To get the results of fully shaping the text, use QTextLayout.
See also QTextLine::horizontalAdvance(), QFontMetricsF::horizontalAdvance(), and QTextLayout::glyphRuns().
QImage QRawFont::alphaMapForGlyph(quint32 glyphIndex, QRawFont::AntialiasingType antialiasingType = SubPixelAntialiasing, const QTransform &transform = QTransform()) const
This function returns a rasterized image of the glyph at the given glyphIndex in the underlying font, using the transform specified. If the QRawFont is not valid, this function will return an invalid QImage.
If the font is a color font, then the resulting image will contain the rendered glyph at the current pixel size. In this case, the antialiasingType will be ignored.
Otherwise, if antialiasingType is set to QRawFont::SubPixelAntialiasing, then the resulting image will be in QImage::Format_RGB32 and the RGB values of each pixel will represent the subpixel opacities of the pixel in the rasterization of the glyph. Otherwise, the image will be in the format of QImage::Format_Indexed8 and each pixel will contain the opacity of the pixel in the rasterization.
See also pathForGlyph() and QPainter::drawGlyphRun().
qreal QRawFont::ascent() const
Returns the ascent of this QRawFont in pixel units.
The ascent of a font is the distance from the baseline to the highest position characters extend to. In practice, some font designers break this rule, e.g. when they put more than one accent on top of a character, or to accommodate an unusual character in an exotic language, so it is possible (though rare) that this value will be too small.
See also QFontMetricsF::ascent().
qreal QRawFont::averageCharWidth() const
Returns the average character width of this QRawFont in pixel units.
See also QFontMetricsF::averageCharWidth().
QRectF QRawFont::boundingRect(quint32 glyphIndex) const
Returns the smallest rectangle containing the glyph with the given glyphIndex.
qreal QRawFont::capHeight() const
Returns the cap height of this QRawFont in pixel units.
The cap height of a font is the height of a capital letter above the baseline. It specifically is the height of capital letters that are flat - such as H or I - as opposed to round letters such as O, or pointed letters like A, both of which may display overshoot.
See also QFontMetricsF::capHeight().
qreal QRawFont::descent() const
Returns the descent of this QRawFont in pixel units.
The descent is the distance from the base line to the lowest point characters extend to. In practice, some font designers break this rule, e.g. to accommodate an unusual character in an exotic language, so it is possible (though rare) that this value will be too small.
See also QFontMetricsF::descent().
QString QRawFont::familyName() const
Returns the family name of this QRawFont.
[since 6.7] QByteArray QRawFont::fontTable(QFont::Tag tag) const
Retrieves the sfnt table specified by tag from the underlying physical font, or an empty byte array if no such table was found. The returned font table's byte order is Big Endian, like the sfnt format specifies.
This function was introduced in Qt 6.7.
QByteArray QRawFont::fontTable(const char *tag) const
This function overloads fontTable(QFont::Tag).
The name must be a four-character string.
[static] QRawFont QRawFont::fromFont(const QFont &font, QFontDatabase::WritingSystem writingSystem = QFontDatabase::Any)
Fetches the physical representation based on a font query. The physical font returned is the font that will be preferred by Qt in order to display text in the selected writingSystem.
Warning: This function is potentially expensive and should not be called in performance sensitive code.
bool QRawFont::glyphIndexesForChars(const QChar *chars, int numChars, quint32 *glyphIndexes, int *numGlyphs) const
Converts a string of unicode points to glyph indexes using the CMAP table in the underlying font. The function works like glyphIndexesForString() except it take an array (chars), the results will be returned though glyphIndexes array and number of glyphs will be set in numGlyphs. The size of glyphIndexes array must be at least numChars, if that's still not enough, this function will return false, then you can resize glyphIndexes from the size returned in numGlyphs.
See also glyphIndexesForString(), advancesForGlyphIndexes(), QGlyphRun, QTextLayout::glyphRuns(), and QTextFragment::glyphRuns().
QList<quint32> QRawFont::glyphIndexesForString(const QString &text) const
Converts the string of unicode points given by text to glyph indexes using the CMAP table in the underlying font, and returns a list containing the result.
Note that, in cases where there are other tables in the font that affect the shaping of the text, the returned glyph indexes will not correctly represent the rendering of the text. To get the correctly shaped text, you can use QTextLayout to lay out and shape the text, then call QTextLayout::glyphs() to get the set of glyph index list and QRawFont pairs.
See also advancesForGlyphIndexes(), glyphIndexesForChars(), QGlyphRun, QTextLayout::glyphRuns(), and QTextFragment::glyphRuns().
QFont::HintingPreference QRawFont::hintingPreference() const
Returns the hinting preference used to construct this QRawFont.
See also QFont::hintingPreference().
bool QRawFont::isValid() const
Returns true if the QRawFont is valid and false otherwise.
qreal QRawFont::leading() const
Returns the leading of this QRawFont in pixel units.
This is the natural inter-line spacing.
See also QFontMetricsF::leading().
qreal QRawFont::lineThickness() const
Returns the thickness for drawing lines (underline, overline, etc.) along with text drawn in this font.
void QRawFont::loadFromData(const QByteArray &fontData, qreal pixelSize, QFont::HintingPreference hintingPreference)
Replaces the current QRawFont with the font contained in the supplied fontData for the size (in pixels) given by pixelSize, and using the hinting preference specified by hintingPreference.
The fontData must contain a TrueType or OpenType font.
See also loadFromFile().
void QRawFont::loadFromFile(const QString &fileName, qreal pixelSize, QFont::HintingPreference hintingPreference)
Replaces the current QRawFont with the contents of the file referenced by fileName for the size (in pixels) given by pixelSize, and using the hinting preference specified by hintingPreference.
The file must reference a TrueType or OpenType font.
See also loadFromData().
qreal QRawFont::maxCharWidth() const
Returns the width of the widest character in the font.
See also QFontMetricsF::maxWidth().
QPainterPath QRawFont::pathForGlyph(quint32 glyphIndex) const
This function returns the shape of the glyph at a given glyphIndex in the underlying font if the QRawFont is valid. Otherwise, it returns an empty QPainterPath.
The returned glyph will always be unhinted.
See also alphaMapForGlyph() and QPainterPath::addText().
qreal QRawFont::pixelSize() const
Returns the pixel size set for this QRawFont. The pixel size affects how glyphs are rasterized, the size of glyphs returned by pathForGlyph(), and is used to convert internal metrics from design units to logical pixel units.
See also setPixelSize().
void QRawFont::setPixelSize(qreal pixelSize)
Sets the pixel size with which this font should be rendered to pixelSize.
See also pixelSize().
QFont::Style QRawFont::style() const
Returns the style of this QRawFont.
See also QFont::style().
QString QRawFont::styleName() const
Returns the style name of this QRawFont.
See also QFont::styleName().
QList<QFontDatabase::WritingSystem> QRawFont::supportedWritingSystems() const
Returns a list of writing systems supported by the font according to designer supplied information in the font file. Please note that this does not guarantee support for a specific unicode point in the font. You can use the supportsCharacter() to check support for a single, specific character.
Note: The list is determined based on the unicode ranges and codepage ranges set in the font's OS/2 table and requires such a table to be present in the underlying font file.
See also supportsCharacter().
bool QRawFont::supportsCharacter(QChar character) const
Returns true if the font has a glyph that corresponds to the given character.
See also supportedWritingSystems().
bool QRawFont::supportsCharacter(uint ucs4) const
This is an overloaded function.
Returns true if the font has a glyph that corresponds to the UCS-4 encoded character ucs4.
See also supportedWritingSystems().
[noexcept] void QRawFont::swap(QRawFont &other)
Swaps this raw font with other. This function is very fast and never fails.
qreal QRawFont::underlinePosition() const
Returns the position from baseline for drawing underlines below the text rendered with this font.
qreal QRawFont::unitsPerEm() const
Returns the number of design units define the width and height of the em square for this QRawFont. This value is used together with the pixel size when converting design metrics to pixel units, as the internal metrics are specified in design units and the pixel size gives the size of 1 em in pixels.
See also pixelSize() and setPixelSize().
int QRawFont::weight() const
Returns the weight of this QRawFont.
See also QFont::weight().
qreal QRawFont::xHeight() const
Returns the xHeight of this QRawFont in pixel units.
This is often but not always the same as the height of the character 'x'.
See also QFontMetricsF::xHeight().
bool QRawFont::operator!=(const QRawFont &other) const
Returns true if this QRawFont is not equal to other. Otherwise, returns false.
QRawFont &QRawFont::operator=(const QRawFont &other)
Assigns other to this QRawFont.
bool QRawFont::operator==(const QRawFont &other) const
Returns true if this QRawFont is equal to other. Otherwise, returns false.
Related Non-Members
[noexcept] size_t qHash(const QRawFont &font, size_t seed = 0)
Returns the hash value for font. If specified, seed is used to initialize the hash.