Merge "Text Rendering via Atlas Renderer" into new_text
[platform/core/uifw/dali-toolkit.git] / 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] lineBreakInfoBuffer The line break info.
48    * @param[in] wordBreakInfoBuffer The word break info.
49    * @param[in] totalNumberOfGlyphs The number of glyphs.
50    * @param[in] glyphsBuffer A vector with glyphs.
51    * @param[in] glyphsToCharactersBuffer Vector with indices pointing the first character of each glyph.
52    * @param[in] charactersPerGlyphBuffer Vector with the number of characters that forms each glyph.
53    */
54   LayoutParameters( const Vector2& boundingBox,
55                     const LineBreakInfo* const lineBreakInfoBuffer,
56                     const WordBreakInfo* const wordBreakInfoBuffer,
57                     Length totalNumberOfGlyphs,
58                     const GlyphInfo* const glyphsBuffer,
59                     const CharacterIndex* const glyphsToCharactersBuffer,
60                     const Length* const charactersPerGlyphBuffer )
61   : boundingBox( boundingBox ),
62     lineBreakInfoBuffer( lineBreakInfoBuffer ),
63     wordBreakInfoBuffer( wordBreakInfoBuffer ),
64     totalNumberOfGlyphs( totalNumberOfGlyphs ),
65     glyphsBuffer( glyphsBuffer ),
66     glyphsToCharactersBuffer( glyphsToCharactersBuffer ),
67     charactersPerGlyphBuffer( charactersPerGlyphBuffer ),
68     charactersToGlyphsBuffer( NULL ),
69     glyphsPerCharacterBuffer( NULL ),
70     lineBidirectionalInfoRunsBuffer( NULL ),
71     numberOfBidirectionalInfoRuns( 0u )
72   {}
73
74   Vector2                     boundingBox;
75   const LineBreakInfo* const  lineBreakInfoBuffer;
76   const WordBreakInfo* const  wordBreakInfoBuffer;
77   Length                      totalNumberOfGlyphs;
78   const GlyphInfo* const      glyphsBuffer;
79   const CharacterIndex* const glyphsToCharactersBuffer;
80   const Length* const         charactersPerGlyphBuffer;
81   GlyphIndex*                 charactersToGlyphsBuffer;        ///< The character to glyph conversion table.
82   Length*                     glyphsPerCharacterBuffer;        ///< The number of glyphs per character.
83   BidirectionalLineInfoRun*   lineBidirectionalInfoRunsBuffer; ///< Bidirectional conversion tables per line.
84   Length                      numberOfBidirectionalInfoRuns;   ///< The number of lines with bidirectional info.
85 };
86
87 } // namespace Text
88
89 } // namespace Toolkit
90
91 } // namespace Dali
92
93 #endif // __DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_H__