dali/devel-api/text-abstraction/font-metrics.h

   1 #ifndef DALI_TEXT_ABSTRACTION_FONT_METRICS_H
   2 #define DALI_TEXT_ABSTRACTION_FONT_METRICS_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 // INTERNAL INCLUDES
  22 #include <dali/public-api/dali-adaptor-common.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace TextAbstraction
  28 {
  29
  30 /**
  31  * The metrics for a Font expressed in pixels.
  32  */
  33 struct DALI_ADAPTOR_API FontMetrics
  34 {
  35   /**
  36    * @brief Default constructor.
  37    */
  38   FontMetrics();
  39
  40   /**
  41    * @brief Create the font metrics in pixels.
  42    */
  43   FontMetrics( float ascenderPixels,
  44                float descenderPixels,
  45                float heightPixels,
  46                float underlinePositionPixels,
  47                float underlineThicknessPixels );
  48
  49   float ascender;             ///< The ascender in pixels.
  50   float descender;            ///< The descender in pixels.
  51   float height;               ///< The height in pixels.
  52   float underlinePosition;    ///< The underline position in pixels.
  53   float underlineThickness;   ///< The vertical height of the underline in pixels.
  54 };
  55
  56 } // Dali
  57
  58 } // TextAbstraction
  59
  60 #endif //DALI_TEXT_ABSTRACTION_FONT_METRICS_H