1 #ifndef DALI_TOOLKIT_FONT_BITMAP_DEVEL_H
2 #define DALI_TOOLKIT_FONT_BITMAP_DEVEL_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali-toolkit/public-api/dali-toolkit-common.h>
23 #include <dali/public-api/common/vector-wrapper.h>
28 namespace TextAbstraction
30 // Forward declarations
32 } // namespace TextAbstraction
39 * @brief Struct that stores the needed info to create a bitmap glyph.
42 struct DALI_TOOLKIT_API Glyph
45 * @brief Default constructor.
47 * Initialize the members to its defaults.
54 * Initialize the members with the given values.
56 * @param[in] url The url of the bitmap for that glyph.
57 * @param[in] utf8 The utf8 codification of the glyph.
58 * @param[in] ascender The ascender of the glyph.
59 * @param[in] descender The descender of the glyph.
61 Glyph(const std::string& url, const std::string utf8, float ascender, float descender);
64 * @brief Default destructor.
68 std::string url; ///< The url of the glyph.
69 uint8_t utf8[4]; ///< the glyph encoded in utf8
70 float ascender; ///< The ascender. The distance from the base line to the top of the glyph.
71 float descender; ///< The descender. The distance from the base line to the bottom of the glyph.
75 * @brief Describes a bitmap font.
77 struct DALI_TOOLKIT_API BitmapFontDescription
80 * @brief Default constructor.
82 * Initialize the members to its defaults.
84 BitmapFontDescription();
87 * @brief Default destructor.
89 ~BitmapFontDescription();
91 std::vector<Glyph> glyphs; ///< Vector of glyphs.
92 std::string name; ///< Name of the font.
93 float underlinePosition; ///< The position of the underline from the base line.
94 float underlineThickness; ///< The thickness of the underline.
95 bool isColorFont : 1; ///< Whether the glyphs of this font have their own colors.
99 * @brief Creates a bitmap font with the given description.
101 * The @p bitmapFont output can be passed to the FontClient::GetFontId()
102 * method to load the font and get an Id.
104 * @param[in] description The description of the bitmap font.
105 * @param[out] bitmapFont A bitmap font.
107 * @note If the @e ascender and @e descender of the glyphs are zero, the @e descender value will be left as zero and all the bitmaps will be loaded to find out the @e ascender value.
109 DALI_TOOLKIT_API void CreateBitmapFont(const BitmapFontDescription& description, TextAbstraction::BitmapFont& bitmapFont);
111 } // namespace DevelText
113 } // namespace Toolkit
117 #endif // DALI_TOOLKIT_TEXT_UTILS_DEVEL_H