X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fdevel-api%2Ftext-abstraction%2Ffont-client.h;h=b1d63176fc0a51253c877cd5cb194c2e2abc3ed9;hb=c95ad6d50d9549451e01c351d8338d83a937d98a;hp=2c95f9c5c25dc9ffe9384ebc8d52c9ec896b5eda;hpb=7f66199426a7e8e76fab46617e108ebeddd566fb;p=platform%2Fcore%2Fuifw%2Fdali-adaptor.git diff --git a/dali/devel-api/text-abstraction/font-client.h b/dali/devel-api/text-abstraction/font-client.h old mode 100755 new mode 100644 index 2c95f9c..b1d6317 --- a/dali/devel-api/text-abstraction/font-client.h +++ b/dali/devel-api/text-abstraction/font-client.h @@ -2,7 +2,7 @@ #define DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H /* - * Copyright (c) 2019 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -19,20 +19,17 @@ */ // INTERNAL INCLUDES -#include -#include -#include -#include #include #include +#include #include +#include +#include namespace Dali { - namespace TextAbstraction { - struct FontMetrics; struct GlyphInfo; struct BitmapFont; @@ -64,8 +61,22 @@ class FontClient; class DALI_ADAPTOR_API FontClient : public BaseHandle { public: - static const PointSize26Dot6 DEFAULT_POINT_SIZE; ///< The default point size. - static const float DEFAULT_ITALIC_ANGLE; ///< The default software italic angle in radians. + static const PointSize26Dot6 DEFAULT_POINT_SIZE; ///< The default point size. + static const float DEFAULT_ITALIC_ANGLE; ///< The default software italic angle in radians. + + static const bool DEFAULT_ATLAS_LIMITATION_ENABLED; ///< The default behavior of whether atlas limitation is enabled in dali. + static const uint32_t DEFAULT_TEXT_ATLAS_WIDTH; ///< The default width of text-atlas-block. + static const uint32_t DEFAULT_TEXT_ATLAS_HEIGHT; ///< The default height of text-atlas-block. + static const Size DEFAULT_TEXT_ATLAS_SIZE; ///< The default size(width, height) of text-atlas-block. + + static const uint32_t MAX_TEXT_ATLAS_WIDTH; ///< The maximum width of text-atlas-block. + static const uint32_t MAX_TEXT_ATLAS_HEIGHT; ///< The maximum height of text-atlas-block. + static const Size MAX_TEXT_ATLAS_SIZE; ///< The maximum height of text-atlas-block. + + 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). + static const Size MAX_SIZE_FIT_IN_ATLAS; ///< The maximum block's size fit into text-atlas-block. + + static const uint32_t NUMBER_OF_POINTS_PER_ONE_UNIT_OF_POINT_SIZE; ///< Factor multiply point-size in toolkit. /** * @brief Struct used to retrieve the glyph's bitmap. @@ -84,12 +95,14 @@ public: */ ~GlyphBufferData(); - unsigned char* buffer; ///< The glyph's bitmap buffer data. - unsigned int width; ///< The width of the bitmap. - unsigned int height; ///< The height of the bitmap. - Pixel::Format format; ///< The pixel's format of the bitmap. - bool isColorEmoji:1; ///< Whether the glyph is an emoji. - bool isColorBitmap:1; ///< Whether the glyph is a color bitmap. + unsigned char* buffer; ///< The glyph's bitmap buffer data. + unsigned int width; ///< The width of the bitmap. + unsigned int height; ///< The height of the bitmap. + int outlineOffsetX; ///< The additional horizontal offset to be added for the glyph's position for outline. + int outlineOffsetY; ///< The additional vertical offset to be added for the glyph's position for outline. + Pixel::Format format; ///< The pixel's format of the bitmap. + bool isColorEmoji : 1; ///< Whether the glyph is an emoji. + bool isColorBitmap : 1; ///< Whether the glyph is a color bitmap. }; /** @@ -104,7 +117,6 @@ public: }; public: - /** * @brief Retrieve a handle to the FontClient instance. * @@ -129,7 +141,7 @@ public: * * @param[in] handle A reference to the copied handle. */ - FontClient( const FontClient& handle ); + FontClient(const FontClient& handle); /** * @brief This assignment operator is required for (smart) pointer semantics. @@ -137,7 +149,7 @@ public: * @param [in] handle A reference to the copied handle. * @return A reference to this. */ - FontClient& operator=( const FontClient& handle ); + FontClient& operator=(const FontClient& handle); //////////////////////////////////////// // Font management and validation. @@ -156,7 +168,7 @@ public: * @param[in] horizontalDpi The horizontal resolution in DPI. * @param[in] verticalDpi The vertical resolution in DPI. */ - void SetDpi( unsigned int horizontalDpi, unsigned int verticalDpi ); + void SetDpi(unsigned int horizontalDpi, unsigned int verticalDpi); /** * @brief Retrieves the DPI previously set to the target window. @@ -165,7 +177,7 @@ public: * @param[out] horizontalDpi The horizontal resolution in DPI. * @param[out] verticalDpi The vertical resolution in DPI. */ - void GetDpi( unsigned int& horizontalDpi, unsigned int& verticalDpi ); + void GetDpi(unsigned int& horizontalDpi, unsigned int& verticalDpi); /** * @brief Called by Dali to retrieve the default font size for the platform. @@ -188,21 +200,21 @@ public: * * @param[out] defaultFonts A list of default font paths, family, width, weight and slant. */ - void GetDefaultFonts( FontList& defaultFonts ); + void GetDefaultFonts(FontList& defaultFonts); /** * @brief Retrieve the active default font from the system. * * @param[out] fontDescription font structure describing the default font. */ - void GetDefaultPlatformFontDescription( FontDescription& fontDescription ); + void GetDefaultPlatformFontDescription(FontDescription& fontDescription); /** * @brief Retrieve the list of fonts supported by the system. * * @param[out] systemFonts A list of font paths, family, width, weight and slant. */ - void GetSystemFonts( FontList& systemFonts ); + void GetSystemFonts(FontList& systemFonts); /** * @brief Retrieves the font description of a given font @p id. @@ -210,7 +222,7 @@ public: * @param[in] id The font identifier. * @param[out] fontDescription The path, family & style (width, weight and slant) describing the font. */ - void GetDescription( FontId id, FontDescription& fontDescription ); + void GetDescription(FontId id, FontDescription& fontDescription); /** * @brief Retrieves the font point size of a given font @p id. @@ -219,7 +231,7 @@ public: * * @return The point size in 26.6 fractional points. */ - PointSize26Dot6 GetPointSize( FontId id ); + PointSize26Dot6 GetPointSize(FontId id); /** * @brief Whether the given @p character is supported by the font. @@ -229,7 +241,7 @@ public: * * @return @e true if the character is supported by the font. */ - bool IsCharacterSupportedByFont( FontId fontId, Character character ); + bool IsCharacterSupportedByFont(FontId fontId, Character character); /** * @brief Find the default font for displaying a UTF-32 character. @@ -243,9 +255,9 @@ public: * * @return A valid font identifier, or zero if the font does not exist. */ - FontId FindDefaultFont( Character charcode, - PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE, - bool preferColor = false ); + FontId FindDefaultFont(Character charcode, + PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE, + bool preferColor = false); /** * @brief Find a fallback-font for displaying a UTF-32 character. @@ -261,10 +273,10 @@ public: * * @return A valid font identifier, or zero if the font does not exist. */ - FontId FindFallbackFont( Character charcode, - const FontDescription& preferredFontDescription, - PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE, - bool preferColor = false ); + FontId FindFallbackFont(Character charcode, + const FontDescription& preferredFontDescription, + PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE, + bool preferColor = false); /** * @brief Retrieve the unique identifier for a font. @@ -275,9 +287,9 @@ public: * * @return A valid font identifier, or zero if the font does not exist. */ - FontId GetFontId( const FontPath& path, - PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE, - FaceIndex faceIndex = 0 ); + FontId GetFontId(const FontPath& path, + PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE, + FaceIndex faceIndex = 0); /** * @brief Retrieves a unique font identifier for a given description. @@ -289,18 +301,19 @@ public: * * @return A valid font identifier, or zero if no font is found. */ - FontId GetFontId( const FontDescription& preferredFontDescription, - PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE, - FaceIndex faceIndex = 0 ); + FontId GetFontId(const FontDescription& preferredFontDescription, + PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE, + FaceIndex faceIndex = 0); /** * @brief Retrieves a unique font identifier for a given bitmap font. + * If the font is not present, it will cache the given font, and give it a new font id. * * @param[in] bitmapFont A bitmap font. * - * @return A valid font identifier, or zero if no bitmap font is created. + * @return A valid font identifier. */ - FontId GetFontId( const BitmapFont& bitmapFont ); + FontId GetFontId(const BitmapFont& bitmapFont); /** * @brief Check to see if a font is scalable. @@ -308,7 +321,7 @@ public: * @param[in] path The path to a font file. * @return true if scalable. */ - bool IsScalable( const FontPath& path ); + bool IsScalable(const FontPath& path); /** * @brief Check to see if a font is scalable. @@ -319,7 +332,7 @@ public: * * @return true if scalable */ - bool IsScalable( const FontDescription& fontDescription ); + bool IsScalable(const FontDescription& fontDescription); /** * @brief Get a list of sizes available for a fixed size font. @@ -327,7 +340,7 @@ public: * @param[in] path The path to a font file. * @param[out] sizes A list of the available sizes, if no sizes available will return empty. */ - void GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes ); + void GetFixedSizes(const FontPath& path, Dali::Vector& sizes); /** * @brief Get a list of sizes available for a fixed size font. @@ -337,8 +350,8 @@ public: * @param[in] fontDescription A font description. * @param[out] sizes A list of the available sizes, if no sizes available will return empty. */ - void GetFixedSizes( const FontDescription& fontDescription, - Dali::Vector< PointSize26Dot6 >& sizes ); + void GetFixedSizes(const FontDescription& fontDescription, + Dali::Vector& sizes); /** * @brief Whether the font has Italic style. @@ -347,7 +360,7 @@ public: * * @return true if the font has italic style. */ - bool HasItalicStyle( FontId fontId ) const; + bool HasItalicStyle(FontId fontId) const; //////////////////////////////////////// // Font metrics, glyphs and bitmaps. @@ -359,7 +372,7 @@ public: * @param[in] fontId The identifier of the font for the required glyph. * @param[out] metrics The font metrics. */ - void GetFontMetrics( FontId fontId, FontMetrics& metrics ); + void GetFontMetrics(FontId fontId, FontMetrics& metrics); /** * @brief Retrieve the glyph index for a UTF-32 character code. @@ -369,7 +382,7 @@ public: * * @return The glyph index, or zero if the character code is undefined. */ - GlyphIndex GetGlyphIndex( FontId fontId, Character charcode ); + GlyphIndex GetGlyphIndex(FontId fontId, Character charcode); /** * @brief Retrieve the metrics for a series of glyphs. @@ -383,7 +396,7 @@ public: * * @return @e true if all of the requested metrics were found. */ - bool GetGlyphMetrics( GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal = true ); + bool GetGlyphMetrics(GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal = true); /** * @brief Create a bitmap representation of a glyph. @@ -397,7 +410,7 @@ public: * @param[out] data The bitmap data. * @param[in] outlineWidth The width of the glyph outline in pixels. */ - void CreateBitmap( FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, GlyphBufferData& data, int outlineWidth ); + void CreateBitmap(FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, GlyphBufferData& data, int outlineWidth); /** * @brief Create a bitmap representation of a glyph. @@ -406,9 +419,9 @@ public: * @param[in] glyphIndex The index of a glyph within the specified font. * @param[in] outlineWidth The width of the glyph outline in pixels. * - * @return A valid BufferImage, or an empty handle if the glyph could not be rendered. + * @return A valid PixelData, or an empty handle if the glyph could not be rendered. */ - PixelData CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth ); + PixelData CreateBitmap(FontId fontId, GlyphIndex glyphIndex, int outlineWidth); /** * @brief Create a vector representation of a glyph. @@ -421,12 +434,12 @@ public: * @param[out] nominalWidth The width of the blob. * @param[out] nominalHeight The height of the blob. */ - void CreateVectorBlob( FontId fontId, - GlyphIndex glyphIndex, - VectorBlob*& blob, - unsigned int& blobLength, - unsigned int& nominalWidth, - unsigned int& nominalHeight ); + void CreateVectorBlob(FontId fontId, + GlyphIndex glyphIndex, + VectorBlob*& blob, + unsigned int& blobLength, + unsigned int& nominalWidth, + unsigned int& nominalHeight); /** * @brief Retrieves the ellipsis glyph for a requested point size. @@ -435,7 +448,7 @@ public: * * @return The ellipsis glyph. */ - const GlyphInfo& GetEllipsisGlyph( PointSize26Dot6 requestedPointSize ); + const GlyphInfo& GetEllipsisGlyph(PointSize26Dot6 requestedPointSize); /** * @brief Whether the given glyph @p glyphIndex is a color glyph. @@ -445,7 +458,7 @@ public: * * @return @e true if the glyph is a color one. */ - bool IsColorGlyph( FontId fontId, GlyphIndex glyphIndex ); + bool IsColorGlyph(FontId fontId, GlyphIndex glyphIndex); /** * @brief Add custom fonts directory @@ -454,7 +467,7 @@ public: * * @return true if the fonts can be added. */ - bool AddCustomFontDirectory( const FontPath& path ); + bool AddCustomFontDirectory(const FontPath& path); /** * @brief Creates and stores an embedded item and it's metrics. @@ -468,8 +481,64 @@ public: * * return The index within the vector of embedded items. */ - GlyphIndex CreateEmbeddedItem( const EmbeddedItemDescription& description, Pixel::Format& pixelFormat); + GlyphIndex CreateEmbeddedItem(const EmbeddedItemDescription& description, Pixel::Format& pixelFormat); + + /** + * @brief true to enable Atlas-Limitation. + * + * @note Used default configuration. + * @param[in] enabled The on/off value to enable/disable Atlas-Limitation. + */ + void EnableAtlasLimitation(bool enabled); + + /** + * @brief Check Atlas-Limitation is enabled or disabled. + * + * @note Used default configuration. + * return true if Atlas-Limitation is enabled, otherwise false. + */ + bool IsAtlasLimitationEnabled() const; + + /** + * @brief retrieve the maximum allowed width and height for text-atlas-block. + * + * @note Used default configuration. + * return the maximum width and height of text-atlas-block. + */ + Size GetMaximumTextAtlasSize() const; + + /** + * @brief retrieve the default width and height for text-atlas-block. + * + * @note Used default configuration. + * return the default width and height of text-atlas-block. + */ + Size GetDefaultTextAtlasSize() const; + + /** + * @brief retrieve the current maximum width and height for text-atlas-block. + * + * @note Used default configuration. + * return the current maximum width and height of text-atlas-block. + */ + Size GetCurrentMaximumBlockSizeFitInAtlas() const; + /** + * @brief set the achieved size (width and height) for text-atlas-block. + * If @p currentMaximumBlockSizeFitInAtlas larger than the current maximum text atlas then store, otherwise ignore. + * + * @note Used default configuration. + * return true if the current maximum text atlas size is changed, otherwise false. + */ + bool SetCurrentMaximumBlockSizeFitInAtlas(const Size& currentMaximumBlockSizeFitInAtlas); + + /** + * @brief retrieve the number of points to scale-up one unit of point-size. + * + * @note Used default configuration. + * return the number of points per one unit of point-size + */ + uint32_t GetNumberOfPointsPerOneUnitOfPointSize() const; public: // Not intended for application developers /** @@ -477,9 +546,16 @@ public: // Not intended for application developers * * @param[in] fontClient A pointer to the internal fontClient object. */ - explicit DALI_INTERNAL FontClient( Internal::FontClient* fontClient ); + explicit DALI_INTERNAL FontClient(Internal::FontClient* fontClient); }; +/** + * @brief This is used to improve application launch performance + * + * @return A pre-initialized FontClient + */ +DALI_ADAPTOR_API FontClient FontClientPreInitialize(); + } // namespace TextAbstraction } // namespace Dali