dali-toolkit/internal/text/layouts/layout-parameters.h

   1 #ifndef __DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_H__
   2 #define __DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_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/math/vector2.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/internal/text/text-definitions.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Toolkit
  31 {
  32
  33 namespace Text
  34 {
  35
  36 struct BidirectionalLineInfoRun;
  37
  38 /**
  39  * @brief Struct used to pass parameters.
  40  */
  41 struct LayoutParameters
  42 {
  43   /**
  44    * Constructor with the needed parameters to layout the text.
  45    *
  46    * @param[in] boundingBox The size of the box containing the text.
  47    * @param[in] textBuffer The text buffer.
  48    * @param[in] lineBreakInfoBuffer The line break info.
  49    * @param[in] wordBreakInfoBuffer The word break info.
  50    * @param[in] totalNumberOfGlyphs The number of glyphs.
  51    * @param[in] glyphsBuffer A vector with glyphs.
  52    * @param[in] glyphsToCharactersBuffer Vector with indices pointing the first character of each glyph.
  53    * @param[in] charactersPerGlyphBuffer Vector with the number of characters that forms each glyph.
  54    */
  55   LayoutParameters( const Vector2& boundingBox,
  56                     const Character* const textBuffer,
  57                     const LineBreakInfo* const lineBreakInfoBuffer,
  58                     const WordBreakInfo* const wordBreakInfoBuffer,
  59                     const CharacterDirection* const characterDirectionBuffer,
  60                     Length totalNumberOfGlyphs,
  61                     const GlyphInfo* const glyphsBuffer,
  62                     const CharacterIndex* const glyphsToCharactersBuffer,
  63                     const Length* const charactersPerGlyphBuffer )
  64   : boundingBox( boundingBox ),
  65     textBuffer( textBuffer ),
  66     lineBreakInfoBuffer( lineBreakInfoBuffer ),
  67     wordBreakInfoBuffer( wordBreakInfoBuffer ),
  68     characterDirectionBuffer( characterDirectionBuffer ),
  69     totalNumberOfGlyphs( totalNumberOfGlyphs ),
  70     glyphsBuffer( glyphsBuffer ),
  71     glyphsToCharactersBuffer( glyphsToCharactersBuffer ),
  72     charactersPerGlyphBuffer( charactersPerGlyphBuffer ),
  73     charactersToGlyphsBuffer( NULL ),
  74     glyphsPerCharacterBuffer( NULL ),
  75     lineBidirectionalInfoRunsBuffer( NULL ),
  76     numberOfBidirectionalInfoRuns( 0u )
  77   {}
  78
  79   Vector2                         boundingBox;
  80   const Character* const          textBuffer;
  81   const LineBreakInfo* const      lineBreakInfoBuffer;
  82   const WordBreakInfo* const      wordBreakInfoBuffer;
  83   const CharacterDirection* const characterDirectionBuffer;
  84   Length                          totalNumberOfGlyphs;
  85   const GlyphInfo* const          glyphsBuffer;
  86   const CharacterIndex* const     glyphsToCharactersBuffer;
  87   const Length* const             charactersPerGlyphBuffer;
  88   GlyphIndex*                     charactersToGlyphsBuffer;        ///< The character to glyph conversion table.
  89   Length*                         glyphsPerCharacterBuffer;        ///< The number of glyphs per character.
  90   BidirectionalLineInfoRun*       lineBidirectionalInfoRunsBuffer; ///< Bidirectional conversion tables per line.
  91   Length                          numberOfBidirectionalInfoRuns;   ///< The number of lines with bidirectional info.
  92 };
  93
  94 } // namespace Text
  95
  96 } // namespace Toolkit
  97
  98 } // namespace Dali
  99
 100 #endif // __DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_H__