dali-toolkit/devel-api/text/bitmap-font.h

   1 #ifndef DALI_TOOLKIT_FONT_BITMAP_DEVEL_H
   2 #define DALI_TOOLKIT_FONT_BITMAP_DEVEL_H
   3
   4 /*
   5  * Copyright (c) 2020 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 // EXTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  23 #include <dali/public-api/common/vector-wrapper.h>
  24 #include <string>
  25
  26 namespace Dali
  27 {
  28 namespace TextAbstraction
  29 {
  30 // Forward declarations
  31 struct BitmapFont;
  32 } // namespace TextAbstraction
  33
  34 namespace Toolkit
  35 {
  36 namespace DevelText
  37 {
  38 /**
  39  * @brief Struct that stores the needed info to create a bitmap glyph.
  40  */
  41
  42 struct DALI_TOOLKIT_API Glyph
  43 {
  44   /**
  45    * @brief Default constructor.
  46    *
  47    * Initialize the members to its defaults.
  48    */
  49   Glyph();
  50
  51   /**
  52    * @brief Constructor.
  53    *
  54    * Initialize the members with the given values.
  55    *
  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.
  60    */
  61   Glyph(const std::string& url, const std::string utf8, float ascender, float descender);
  62
  63   /**
  64    * @brief Default destructor.
  65    */
  66   ~Glyph();
  67
  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.
  72 };
  73
  74 /**
  75  * @brief Describes a bitmap font.
  76  */
  77 struct DALI_TOOLKIT_API BitmapFontDescription
  78 {
  79   /**
  80    * @brief Default constructor.
  81    *
  82    * Initialize the members to its defaults.
  83    */
  84   BitmapFontDescription();
  85
  86   /**
  87    * @brief Default destructor.
  88    */
  89   ~BitmapFontDescription();
  90
  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.
  96 };
  97
  98 /**
  99  * @brief Creates a bitmap font with the given description.
 100  *
 101  * The @p bitmapFont output can be passed to the FontClient::GetFontId()
 102  * method to load the font and get an Id.
 103  *
 104  * @param[in] description The description of the bitmap font.
 105  * @param[out] bitmapFont A bitmap font.
 106  *
 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.
 108  */
 109 DALI_TOOLKIT_API void CreateBitmapFont(const BitmapFontDescription& description, TextAbstraction::BitmapFont& bitmapFont);
 110
 111 } // namespace DevelText
 112
 113 } // namespace Toolkit
 114
 115 } // namespace Dali
 116
 117 #endif // DALI_TOOLKIT_TEXT_UTILS_DEVEL_H