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) 2019 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/public-api/common/vector-wrapper.h>
  23 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  24 #include <string>
  25
  26 namespace Dali
  27 {
  28
  29 namespace TextAbstraction
  30 {
  31 // Forward declarations
  32 struct BitmapFont;
  33 }
  34
  35 namespace Toolkit
  36 {
  37
  38 namespace DevelText
  39 {
  40
  41 /**
  42  * @brief Struct that stores the needed info to create a bitmap glyph.
  43  */
  44
  45 struct DALI_TOOLKIT_API Glyph
  46 {
  47   /**
  48    * @brief Default constructor.
  49    *
  50    * Initialize the members to its defaults.
  51    */
  52   Glyph();
  53
  54   /**
  55    * @brief Constructor.
  56    *
  57    * Initialize the members with the given values.
  58    *
  59    * @param[in] url The url of the bitmap for that glyph.
  60    * @param[in] utf8 The utf8 codification of the glyph.
  61    * @param[in] ascender The ascender of the glyph.
  62    * @param[in] descender The descender of the glyph.
  63    */
  64   Glyph( const std::string& url, const std::string utf8, float ascender, float descender );
  65
  66   /**
  67    * @brief Default destructor.
  68    */
  69   ~Glyph();
  70
  71   std::string url; ///< The url of the glyph.
  72   uint8_t utf8[4]; ///< the glyph encoded in utf8
  73   float ascender;  ///< The ascender. The distance from the base line to the top of the glyph.
  74   float descender; ///< The descender. The distance from the base line to the bottom of the glyph.
  75 };
  76
  77 /**
  78  * @brief Describes a bitmap font.
  79  */
  80 struct DALI_TOOLKIT_API BitmapFontDescription
  81 {
  82   /**
  83    * @brief Default constructor.
  84    *
  85    * Initialize the members to its defaults.
  86    */
  87   BitmapFontDescription();
  88
  89   /**
  90    * @brief Default destructor.
  91    */
  92   ~BitmapFontDescription();
  93
  94   std::vector<Glyph> glyphs; ///< Vector of glyphs.
  95   std::string name;          ///< Name of the font.
  96   float underlinePosition;   ///< The position of the underline from the base line.
  97   float underlineThickness;  ///< The thickness of the underline.
  98   bool isColorFont:1;        ///< Whether the glyphs of this font have their own colors.
  99 };
 100
 101 /**
 102  * @brief Creates a bitmap font with the given description.
 103  *
 104  * The @p bitmapFont output can be passed to the FontClient::GetFontId()
 105  * method to load the font and get an Id.
 106  *
 107  * @param[in] description The description of the bitmap font.
 108  * @param[out] bitmapFont A bitmap font.
 109  *
 110  * @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.
 111  */
 112 DALI_TOOLKIT_API void CreateBitmapFont( const BitmapFontDescription& description, TextAbstraction::BitmapFont& bitmapFont );
 113
 114 } // namespace DevelText
 115
 116 } // namespace Toolkit
 117
 118 } // namespace Dali
 119
 120 #endif // DALI_TOOLKIT_TEXT_UTILS_DEVEL_H