dali-toolkit/internal/text/color-segmentation.h

   1 #ifndef DALI_TOOLKIT_TEXT_COLOR_SEGMENTATION_H
   2 #define DALI_TOOLKIT_TEXT_COLOR_SEGMENTATION_H
   3
   4 /*
   5  * Copyright (c) 2021 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-vector.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/internal/text/color-run.h>
  26
  27 namespace Dali
  28 {
  29 namespace Toolkit
  30 {
  31 namespace Text
  32 {
  33 class LogicalModel;
  34
  35 /**
  36  * @brief Creates color glyph runs.
  37  *
  38  * @param[in] colorRuns The color runs in characters (set in the mark-up string).
  39  * @param[in] charactersToGlyph Conversion table from characters to glyphs.
  40  * @param[in] glyphsPerCharacter Table with the number of glyphs for each character.
  41  * @param[in] startCharacterIndex The character from where the text is shaped.
  42  * @param[in] startGlyphIndex The glyph from where the text is shaped.
  43  * @param[in] numberOfCharacters The number of characters to be shaped.
  44  * @param[out] colors The vector of colors.
  45  * @param[out] colorIndices Indices to the vector of colors.
  46  */
  47 void SetColorSegmentationInfo(const Vector<ColorRun>&   colorRuns,
  48                               const Vector<GlyphIndex>& charactersToGlyph,
  49                               const Vector<Length>&     glyphsPerCharacter,
  50                               CharacterIndex            startCharacterIndex,
  51                               GlyphIndex                startGlyphIndex,
  52                               Length                    numberOfCharacters,
  53                               Vector<Vector4>&          colors,
  54                               Vector<ColorIndex>&       colorIndices);
  55
  56 } // namespace Text
  57
  58 } // namespace Toolkit
  59
  60 } // namespace Dali
  61
  62 #endif // DALI_TOOLKIT_TEXT_COLOR_SEGMENTATION_H