dali/devel-api/text-abstraction/glyph-info.h

   1 #ifndef __DALI_TEXT_ABSTRACTION_GLYPH_INFO_H__
   2 #define __DALI_TEXT_ABSTRACTION_GLYPH_INFO_H__
   3
   4 /*
   5  * Copyright (c) 2015 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/dali-common.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace TextAbstraction
  31 {
  32
  33 /**
  34  * The information describing a glyph (font ID, index, metrics)
  35  * The metrics are in pixels.
  36  */
  37 struct DALI_IMPORT_API GlyphInfo
  38 {
  39   /**
  40    * @brief Default constructor.
  41    */
  42   GlyphInfo();
  43
  44   /**
  45    * @brief Creates the GlyphInfo without metrics.
  46    */
  47   GlyphInfo( FontId font, GlyphIndex i );
  48
  49   FontId fontId;     ///< Identifies the font containing the glyph
  50   GlyphIndex index;  ///< Uniquely identifies a glyph for a given FontId
  51   float width;       ///< The width of the glyph
  52   float height;      ///< The height of the glyph
  53   float xBearing;    ///< The distance from the cursor position to the leftmost border of the glyph
  54   float yBearing;    ///< The distance from the baseline to the topmost border of the glyph
  55   float advance;     ///< The distance to move the cursor for this glyph
  56   float scaleFactor; ///< The scaling applied (fixed-size fonts only)
  57 };
  58
  59 } // Dali
  60
  61 } // TextAbstraction
  62
  63 #endif //__DALI_TEXT_ABSTRACTION_GLYPH_INFO_H__