dali-toolkit/internal/text/rendering/styles/character-spacing-helper-functions.h

   1 #ifndef DALI_TOOLKIT_TEXT_RENDERING_STYLES_CHARACTER_SPACING_HELPER_FUNCTIONS_H
   2 #define DALI_TOOLKIT_TEXT_RENDERING_STYLES_CHARACTER_SPACING_HELPER_FUNCTIONS_H
   3
   4 /*
   5  * Copyright (c) 2022 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/devel-api/text-abstraction/font-metrics.h>
  23 #include <dali/public-api/common/dali-vector.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/text/character-spacing-glyph-run.h>
  27 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
  28
  29 namespace Dali
  30 {
  31 namespace Toolkit
  32 {
  33 namespace Text
  34 {
  35 /**
  36  * @brief Check the glyph at index is had character-spacing or not then return its value. Otherwise return the model character-spacing height.
  37  *
  38  * @param[in] index the index of glyph.
  39  * @param[in] characterSpacingGlyphRuns the character-spacing glyph runs.
  40  * @param[in] modelCharacterSpacing the model character-spacing value.
  41  *
  42  * @return the determined character-spacing value
  43  */
  44 float GetGlyphCharacterSpacing(const GlyphIndex&                       index,
  45                                const Vector<CharacterSpacingGlyphRun>& characterSpacingGlyphRuns,
  46                                const float                             modelCharacterSpacing);
  47
  48 /**
  49  * @brief Create static empty vector and retrun it.
  50  *
  51  * @return The reference for the empty character-spacing glyph runs.
  52  */
  53 const Vector<CharacterSpacingGlyphRun>& GetEmptyCharacterSpacingGlyphRuns();
  54
  55 } // namespace Text
  56
  57 } // namespace Toolkit
  58
  59 } // namespace Dali
  60
  61 #endif // DALI_TOOLKIT_TEXT_RENDERING_STYLES_CHARACTER_SPACING_HELPER_FUNCTIONS_H