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