dali/devel-api/text-abstraction/font-client.h

   1 #ifndef DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H
   2 #define DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H
   3
   4 /*
   5  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/devel-api/text-abstraction/font-list.h>
  23 #include <dali/devel-api/text-abstraction/glyph-buffer-data.h>
  24 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
  25 #include <dali/public-api/common/dali-vector.h>
  26 #include <dali/public-api/dali-adaptor-common.h>
  27 #include <dali/public-api/images/pixel-data.h>
  28 #include <dali/public-api/object/base-handle.h>
  29
  30 namespace Dali
  31 {
  32 namespace TextAbstraction
  33 {
  34 struct FontMetrics;
  35 struct GlyphInfo;
  36 struct BitmapFont;
  37
  38 namespace Internal DALI_INTERNAL
  39 {
  40 class FontClient;
  41 }
  42
  43 /**
  44  * @brief FontClient provides access to font information and resources.
  45  *
  46  * <h3>Querying the System Fonts</h3>
  47  *
  48  * A "system font" is described by a "path" to a font file on the native filesystem, along with a "family" and "style".
  49  * For example on the Ubuntu system a "Regular" style font from the "Ubuntu Mono" family can be accessed from "/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf".
  50  *
  51  * <h3>Accessing Fonts</h3>
  52  *
  53  * A "font" is created from the system for a specific point size in 26.6 fractional points. A "FontId" is used to identify each font.
  54  * For example two different fonts with point sizes 10 & 12 can be created from the "Ubuntu Mono" family:
  55  * @code
  56  * FontClient fontClient   = FontClient::Get();
  57  * FontId ubuntuMonoTen    = fontClient.GetFontId( "/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf", 10*64 );
  58  * FontId ubuntuMonoTwelve = fontClient.GetFontId( "/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf", 12*64 );
  59  * @endcode
  60  * Glyph metrics and bitmap resources can then be retrieved using the FontId.
  61  */
  62 class DALI_ADAPTOR_API FontClient : public BaseHandle
  63 {
  64 public:
  65   static const PointSize26Dot6 DEFAULT_POINT_SIZE;   ///< The default point size.
  66   static const float           DEFAULT_ITALIC_ANGLE; ///< The default software italic angle in radians.
  67
  68   static const bool     DEFAULT_ATLAS_LIMITATION_ENABLED; ///< The default behavior of whether atlas limitation is enabled in dali.
  69   static const uint32_t DEFAULT_TEXT_ATLAS_WIDTH;         ///< The default width of text-atlas-block.
  70   static const uint32_t DEFAULT_TEXT_ATLAS_HEIGHT;        ///< The default height of text-atlas-block.
  71   static const Size     DEFAULT_TEXT_ATLAS_SIZE;          ///< The default size(width, height) of text-atlas-block.
  72
  73   static const uint32_t MAX_TEXT_ATLAS_WIDTH;  ///< The maximum width of text-atlas-block.
  74   static const uint32_t MAX_TEXT_ATLAS_HEIGHT; ///< The maximum height of text-atlas-block.
  75   static const Size     MAX_TEXT_ATLAS_SIZE;   ///< The maximum height of text-atlas-block.
  76
  77   static const uint16_t PADDING_TEXT_ATLAS_BLOCK; ///< Padding per edge. How much the block size (width, height) less than the text-atlas-block size (width, height).
  78   static const Size     MAX_SIZE_FIT_IN_ATLAS;    ///< The maximum block's size fit into text-atlas-block.
  79
  80   static const uint32_t NUMBER_OF_POINTS_PER_ONE_UNIT_OF_POINT_SIZE; ///< Factor multiply point-size in toolkit.
  81
  82   // For Debug
  83   static uint32_t GetPerformanceLogThresholdTime(); ///< Return performance log threshold time in miliseconds for debug.
  84   static bool     IsPerformanceLogEnabled();        ///< Whether performance log is enabled.
  85
  86   /**
  87    * @brief Used to load an embedded item into the font client.
  88    */
  89   struct EmbeddedItemDescription
  90   {
  91     std::string       url;               ///< The url path of the image.
  92     unsigned int      width;             ///< The width of the item.
  93     unsigned int      height;            ///< The height of the item.
  94     ColorBlendingMode colorblendingMode; ///< Whether the color of the image is multiplied by the color of the text.
  95   };
  96
  97 public:
  98   /**
  99    * @brief Retrieve a handle to the FontClient instance.
 100    *
 101    * @return A handle to the FontClient
 102    */
 103   static FontClient Get();
 104
 105   /**
 106    * @brief Create a handle to the new FontClient instance.
 107    *
 108    * @param[in] horizontalDpi The horizontal resolution in DPI.
 109    * @param[in] verticalDpi The vertical resolution in DPI.
 110    * @return A handle to the FontClient
 111    */
 112   static FontClient New(uint32_t horizontalDpi, uint32_t verticalDpi);
 113
 114   /**
 115    * @brief Create an uninitialized TextAbstraction handle.
 116    */
 117   FontClient();
 118
 119   /**
 120    * @brief Destructor
 121    *
 122    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 123    */
 124   ~FontClient();
 125
 126   /**
 127    * @brief This copy constructor is required for (smart) pointer semantics.
 128    *
 129    * @param[in] handle A reference to the copied handle.
 130    */
 131   FontClient(const FontClient& handle);
 132
 133   /**
 134    * @brief This assignment operator is required for (smart) pointer semantics.
 135    *
 136    * @param [in] handle  A reference to the copied handle.
 137    * @return A reference to this.
 138    */
 139   FontClient& operator=(const FontClient& handle);
 140
 141   /**
 142    * @brief This move constructor is required for (smart) pointer semantics.
 143    *
 144    * @param[in] handle A reference to the moved handle.
 145    */
 146   FontClient(FontClient&& handle);
 147
 148   /**
 149    * @brief This move assignment operator is required for (smart) pointer semantics.
 150    *
 151    * @param [in] handle  A reference to the moved handle.
 152    * @return A reference to this.
 153    */
 154   FontClient& operator=(FontClient&& handle);
 155
 156   ////////////////////////////////////////
 157   // Font management and validation.
 158   ////////////////////////////////////////
 159
 160   /**
 161    * @brief Clear all caches in FontClient
 162    *
 163    */
 164   void ClearCache();
 165
 166   /**
 167    * @brief Set the DPI of the target window.
 168    *
 169    * @note Multiple windows are not currently supported.
 170    * @param[in] horizontalDpi The horizontal resolution in DPI.
 171    * @param[in] verticalDpi The vertical resolution in DPI.
 172    */
 173   void SetDpi(unsigned int horizontalDpi, unsigned int verticalDpi);
 174
 175   /**
 176    * @brief Retrieves the DPI previously set to the target window.
 177    *
 178    * @note Multiple windows are not currently supported.
 179    * @param[out] horizontalDpi The horizontal resolution in DPI.
 180    * @param[out] verticalDpi The vertical resolution in DPI.
 181    */
 182   void GetDpi(unsigned int& horizontalDpi, unsigned int& verticalDpi);
 183
 184   /**
 185    * @brief Called by Dali to retrieve the default font size for the platform.
 186    *
 187    * This is an accessibility size, which is mapped to a UI Control specific point-size in stylesheets.
 188    * For example if zero the smallest size, this could potentially map to TextLabel point-size 8.
 189    * @return The default font size.
 190    */
 191   int GetDefaultFontSize();
 192
 193   /**
 194    * @brief Called when the user changes the system defaults.
 195    *
 196    * @post Previously cached system defaults are removed.
 197    */
 198   void ResetSystemDefaults();
 199
 200   /**
 201    * @brief Retrieve the list of default fonts supported by the system.
 202    *
 203    * @param[out] defaultFonts A list of default font paths, family, width, weight and slant.
 204    */
 205   void GetDefaultFonts(FontList& defaultFonts);
 206
 207   /**
 208    * @brief Initializes and caches default font from the system.
 209    */
 210   void InitDefaultFontDescription();
 211
 212   /**
 213    * @brief Retrieve the active default font from the system.
 214    *
 215    * @param[out] fontDescription font structure describing the default font.
 216    */
 217   void GetDefaultPlatformFontDescription(FontDescription& fontDescription);
 218
 219   /**
 220    * @brief Retrieve the list of fonts supported by the system.
 221    *
 222    * @param[out] systemFonts A list of font paths, family, width, weight and slant.
 223    */
 224   void GetSystemFonts(FontList& systemFonts);
 225
 226   /**
 227    * @brief Retrieves the font description of a given font @p fontId.
 228    *
 229    * @param[in] fontId The font identifier.
 230    * @param[out] fontDescription The path, family & style (width, weight and slant) describing the font.
 231    */
 232   void GetDescription(FontId fontId, FontDescription& fontDescription);
 233
 234   /**
 235    * @brief Retrieves the font point size of a given font @p fontId.
 236    *
 237    * @param[in] fontId The font identifier.
 238    *
 239    * @return The point size in 26.6 fractional points.
 240    */
 241   PointSize26Dot6 GetPointSize(FontId fontId);
 242
 243   /**
 244    * @brief Whether the given @p character is supported by the font.
 245    *
 246    * @param[in] fontId The id of the font.
 247    * @param[in] character The character.
 248    *
 249    * @return @e true if the character is supported by the font.
 250    */
 251   bool IsCharacterSupportedByFont(FontId fontId, Character character);
 252
 253   /**
 254    * @brief Find the default font for displaying a UTF-32 character.
 255    *
 256    * This is useful when localised strings are provided for multiple languages
 257    * i.e. when a single default font does not work for all languages.
 258    *
 259    * @param[in] charcode The character for which a font is needed.
 260    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 261    * @param[in] preferColor @e true if a color font is preferred.
 262    *
 263    * @return A valid font identifier, or zero if the font does not exist.
 264    */
 265   FontId FindDefaultFont(Character       charcode,
 266                          PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 267                          bool            preferColor        = false);
 268
 269   /**
 270    * @brief Find a fallback-font for displaying a UTF-32 character.
 271    *
 272    * This is useful when localised strings are provided for multiple languages
 273    * i.e. when a single default font does not work for all languages.
 274    *
 275    * @param[in] charcode The character for which a font is needed.
 276    * @param[in] preferredFontDescription Description of the preferred font which may not provide a glyph for @p charcode.
 277    *                                     The fallback-font will be the closest match to @p preferredFontDescription, which does support the required glyph.
 278    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 279    * @param[in] preferColor @e true if a color font is preferred.
 280    *
 281    * @return A valid font identifier, or zero if the font does not exist.
 282    */
 283   FontId FindFallbackFont(Character              charcode,
 284                           const FontDescription& preferredFontDescription,
 285                           PointSize26Dot6        requestedPointSize = DEFAULT_POINT_SIZE,
 286                           bool                   preferColor        = false);
 287
 288   /**
 289    * @brief Retrieve the unique identifier for a font.
 290    *
 291    * @param[in] path The path to a font file.
 292    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 293    * @param[in] faceIndex The index of the font face (optional).
 294    *
 295    * @return A valid font identifier, or zero if the font does not exist.
 296    */
 297   FontId GetFontId(const FontPath& path,
 298                    PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 299                    FaceIndex       faceIndex          = 0);
 300
 301   /**
 302    * @brief Retrieves a unique font identifier for a given description.
 303    *
 304    * @param[in] preferredFontDescription Description of the preferred font.
 305    *                                     The font will be the closest match to @p preferredFontDescription.
 306    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 307    * @param[in] faceIndex The index of the font face (optional).
 308    *
 309    * @return A valid font identifier, or zero if no font is found.
 310    */
 311   FontId GetFontId(const FontDescription& preferredFontDescription,
 312                    PointSize26Dot6        requestedPointSize = DEFAULT_POINT_SIZE,
 313                    FaceIndex              faceIndex          = 0);
 314
 315   /**
 316    * @brief Retrieves a unique font identifier for a given bitmap font.
 317    * If the font is not present, it will cache the given font, and give it a new font id.
 318    *
 319    * @param[in] bitmapFont A bitmap font.
 320    *
 321    * @return A valid font identifier.
 322    */
 323   FontId GetFontId(const BitmapFont& bitmapFont);
 324
 325   /**
 326    * @brief Check to see if a font is scalable.
 327    *
 328    * @param[in] path The path to a font file.
 329    * @return true if scalable.
 330    */
 331   bool IsScalable(const FontPath& path);
 332
 333   /**
 334    * @brief Check to see if a font is scalable.
 335    *
 336    * @note It the font style is not empty, it will be used instead the font weight and font slant slant.
 337    *
 338    * @param[in] fontDescription A font description.
 339    *
 340    * @return true if scalable
 341    */
 342   bool IsScalable(const FontDescription& fontDescription);
 343
 344   /**
 345    * @brief Get a list of sizes available for a fixed size font.
 346    *
 347    * @param[in] path The path to a font file.
 348    * @param[out] sizes A list of the available sizes, if no sizes available will return empty.
 349    */
 350   void GetFixedSizes(const FontPath& path, Dali::Vector<PointSize26Dot6>& sizes);
 351
 352   /**
 353    * @brief Get a list of sizes available for a fixed size font.
 354    *
 355    * @note It the font style is not empty, it will be used instead the font weight and font slant slant.
 356    *
 357    * @param[in] fontDescription A font description.
 358    * @param[out] sizes A list of the available sizes, if no sizes available will return empty.
 359    */
 360   void GetFixedSizes(const FontDescription&         fontDescription,
 361                      Dali::Vector<PointSize26Dot6>& sizes);
 362
 363   /**
 364    * @brief Whether the font has Italic style.
 365    *
 366    * @param[in] fontId The font identifier.
 367    *
 368    * @return true if the font has italic style.
 369    */
 370   bool HasItalicStyle(FontId fontId) const;
 371
 372   ////////////////////////////////////////
 373   // Font metrics, glyphs and bitmaps.
 374   ////////////////////////////////////////
 375
 376   /**
 377    * @brief Query the metrics for a font.
 378    *
 379    * @param[in] fontId The identifier of the font for the required glyph.
 380    * @param[out] metrics The font metrics.
 381    */
 382   void GetFontMetrics(FontId fontId, FontMetrics& metrics);
 383
 384   /**
 385    * @brief Retrieve the glyph index for a UTF-32 character code.
 386    *
 387    * @param[in] fontId The identifier of the font for the required glyph.
 388    * @param[in] charcode The UTF-32 character code.
 389    *
 390    * @return The glyph index, or zero if the character code is undefined.
 391    */
 392   GlyphIndex GetGlyphIndex(FontId fontId, Character charcode);
 393
 394   /**
 395    * @brief Return the glyph index of a given character code as modified by the variation selector.
 396    *
 397    * @param[in] fontId The identifier of the font for the required glyph.
 398    * @param[in] charcode The UTF-32 character code.
 399    * @param[in] variantSelector The UTF-32 character code point of the variation selector.
 400    *
 401    * @return The glyph index, or zero if the character code is undefined.
 402    */
 403   GlyphIndex GetGlyphIndex(FontId fontId, Character charcode, Character variantSelector);
 404
 405   /**
 406    * @brief Retrieve the metrics for a series of glyphs.
 407    *
 408    * @param[in,out] array An array of glyph-info structures with initialized FontId & GlyphIndex values.
 409    *                      It may contain the advance and an offset set into the bearing from the shaping tool.
 410    *                      On return, the glyph's size value will be initialized. The bearing value will be updated by adding the font's glyph bearing to the one set by the shaping tool.
 411    * @param[in] size The size of the array.
 412    * @param[in] type The type of glyphs used for rendering; either bitmaps or vectors.
 413    * @param[in] horizontal True for horizontal layouts (set to false for vertical layouting).
 414    *
 415    * @return @e true if all of the requested metrics were found.
 416    */
 417   bool GetGlyphMetrics(GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal = true);
 418
 419   /**
 420    * @brief Create a bitmap representation of a glyph.
 421    *
 422    * @note The caller is responsible for deallocating the bitmap data @p data.buffer using delete[].
 423    *
 424    * @param[in]  fontId           The identifier of the font.
 425    * @param[in]  glyphIndex       The index of a glyph within the specified font.
 426    * @param[in]  isItalicRequired Whether the glyph requires italic style.
 427    * @param[in]  isBoldRequired   Whether the glyph requires bold style.
 428    * @param[out] data             The bitmap data.
 429    * @param[in]  outlineWidth     The width of the glyph outline in pixels.
 430    */
 431   void CreateBitmap(FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, GlyphBufferData& data, int outlineWidth);
 432
 433   /**
 434    * @brief Create a bitmap representation of a glyph.
 435    *
 436    * @param[in] fontId The identifier of the font.
 437    * @param[in] glyphIndex The index of a glyph within the specified font.
 438    * @param[in] outlineWidth The width of the glyph outline in pixels.
 439    *
 440    * @return A valid PixelData, or an empty handle if the glyph could not be rendered.
 441    */
 442   PixelData CreateBitmap(FontId fontId, GlyphIndex glyphIndex, int outlineWidth);
 443
 444   /**
 445    * @brief Create a vector representation of a glyph.
 446    *
 447    * @note This feature requires highp shader support and is not available on all platforms
 448    * @param[in] fontId The identifier of the font.
 449    * @param[in] glyphIndex The index of a glyph within the specified font.
 450    * @param[out] blob A blob of data; this is owned by FontClient and should be copied by the caller of CreateVectorData().
 451    * @param[out] blobLength The length of the blob data, or zero if the blob creation failed.
 452    * @param[out] nominalWidth The width of the blob.
 453    * @param[out] nominalHeight The height of the blob.
 454    */
 455   void CreateVectorBlob(FontId        fontId,
 456                         GlyphIndex    glyphIndex,
 457                         VectorBlob*&  blob,
 458                         unsigned int& blobLength,
 459                         unsigned int& nominalWidth,
 460                         unsigned int& nominalHeight);
 461
 462   /**
 463    * @brief Retrieves the ellipsis glyph for a requested point size.
 464    *
 465    * @param[in] requestedPointSize The requested point size.
 466    *
 467    * @return The ellipsis glyph.
 468    */
 469   const GlyphInfo& GetEllipsisGlyph(PointSize26Dot6 requestedPointSize);
 470
 471   /**
 472    * @brief Whether the given glyph @p glyphIndex is a color glyph.
 473    *
 474    * @param[in] fontId The font id.
 475    * @param[in] glyphIndex The glyph index.
 476    *
 477    * @return @e true if the glyph is a color one.
 478    */
 479   bool IsColorGlyph(FontId fontId, GlyphIndex glyphIndex);
 480
 481   /**
 482    * @brief  Add custom fonts directory
 483    *
 484    * @param[in] path to the fonts directory
 485    *
 486    * @return true if the fonts can be added.
 487    */
 488   bool AddCustomFontDirectory(const FontPath& path);
 489
 490   /**
 491    * @brief Creates and stores an embedded item and it's metrics.
 492    *
 493    * If in the @p description there is a non empty url, it calls Dali::LoadImageFromFile() internally.
 494    * If in the @p description there is a url and @e width or @e height are zero it stores the default size. Otherwise the image is resized.
 495    * If the url in the @p description is empty it stores the size.
 496    *
 497    * @param[in] description The description of the embedded item.
 498    * @param[out] pixelFormat The pixel format of the image.
 499    *
 500    * return The index within the vector of embedded items.
 501    */
 502   GlyphIndex CreateEmbeddedItem(const EmbeddedItemDescription& description, Pixel::Format& pixelFormat);
 503
 504   /**
 505    * @brief true to enable Atlas-Limitation.
 506    *
 507    * @note Used default configuration.
 508    * @param[in] enabled The on/off value to enable/disable Atlas-Limitation.
 509    */
 510   void EnableAtlasLimitation(bool enabled);
 511
 512   /**
 513    * @brief Check Atlas-Limitation is enabled or disabled.
 514    *
 515    * @note Used default configuration.
 516    * return true if Atlas-Limitation is enabled, otherwise false.
 517    */
 518   bool IsAtlasLimitationEnabled() const;
 519
 520   /**
 521    * @brief retrieve the maximum allowed width and height for text-atlas-block.
 522    *
 523    * @note Used default configuration.
 524    * return the maximum width and height of text-atlas-block.
 525    */
 526   Size GetMaximumTextAtlasSize() const;
 527
 528   /**
 529    * @brief retrieve the default width and height for text-atlas-block.
 530    *
 531    * @note Used default configuration.
 532    * return the default width and height of text-atlas-block.
 533    */
 534   Size GetDefaultTextAtlasSize() const;
 535
 536   /**
 537    * @brief retrieve the current maximum width and height for text-atlas-block.
 538    *
 539    * @note Used default configuration.
 540    * return the current maximum width and height of text-atlas-block.
 541    */
 542   Size GetCurrentMaximumBlockSizeFitInAtlas() const;
 543
 544   /**
 545    * @brief set the achieved size (width and height) for text-atlas-block.
 546    * If @p currentMaximumBlockSizeFitInAtlas larger than the current maximum text atlas then store, otherwise ignore.
 547    *
 548    * @note Used default configuration.
 549    * return true if the current maximum text atlas size is changed, otherwise false.
 550    */
 551   bool SetCurrentMaximumBlockSizeFitInAtlas(const Size& currentMaximumBlockSizeFitInAtlas);
 552
 553   /**
 554    * @brief retrieve the number of points to scale-up one unit of point-size.
 555    *
 556    * @note Used default configuration.
 557    * return the number of points per one unit of point-size
 558    */
 559   uint32_t GetNumberOfPointsPerOneUnitOfPointSize() const;
 560
 561 public: // Not intended for application developers
 562   /**
 563    * @brief This constructor is used by FontClient::Get().
 564    *
 565    * @param[in] fontClient  A pointer to the internal fontClient object.
 566    */
 567   explicit DALI_INTERNAL FontClient(Internal::FontClient* fontClient);
 568 };
 569
 570 /**
 571  * @brief This is used to improve application launch performance
 572  *
 573  * @return A pre-initialized FontClient
 574  */
 575 DALI_ADAPTOR_API FontClient FontClientPreInitialize();
 576
 577 /**
 578  * @brief This is used to pre-cache FontConfig in order to improve the runtime performance of the application.
 579  *
 580  * @param[in] fallbackFamilyList A list of fallback font families to be pre-cached.
 581  * @param[in] extraFamilyList A list of additional font families to be pre-cached.
 582  * @param[in] localeFamily A locale font family to be pre-cached.
 583  * @param[in] useThread True if the font client should create thread and perform pre-caching, false otherwise.
 584  * @param[in] syncCreation True if thread creation guarantees syncronization with the main thread, false async creation.
 585  */
 586 DALI_ADAPTOR_API void FontClientPreCache(const FontFamilyList& fallbackFamilyList, const FontFamilyList& extraFamilyList, const FontFamily& localeFamily, bool useThread, bool syncCreation);
 587
 588 /**
 589  * @brief This is used to pre-load FreeType font face in order to improve the runtime performance of the application.
 590  *
 591  * @param[in] fontPathList A list of font paths to be pre-loaded.
 592  * @param[in] memoryFontPathList A list of memory font paths to be pre-loaded.
 593  * @param[in] useThread True if the font client should create thread and perform font pre-loading, false otherwise.
 594  * @param[in] syncCreation True if thread creation guarantees syncronization with the main thread, false async creation.
 595  *
 596  * @note
 597  * The fonts in the fontPathList perform FT_New_Face during pre-loading,
 598  * which can provide some performace benefits.
 599  *
 600  * The fonts in the memoryFontPathList read the font file and cache the buffer in memory during pre-load.
 601  * This enables the use of FT_New_Memory_Face during runtime and provides a performance boost.
 602  * It requires memory equivalent to the size of each font file.
 603  */
 604 DALI_ADAPTOR_API void FontClientFontPreLoad(const FontPathList& fontPathList, const FontPathList& memoryFontPathList, bool useThread, bool syncCreation);
 605
 606 /**
 607   * @brief Joins font threads, waiting for their execution to complete.
 608   */
 609 DALI_ADAPTOR_API void FontClientJoinFontThreads();
 610
 611 } // namespace TextAbstraction
 612
 613 } // namespace Dali
 614
 615 #endif // DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H