dali-toolkit/public-api/text/shaper.h

   1 #ifndef __DALI_TOOLKIT_TEXT_SHAPER_H__
   2 #define __DALI_TOOLKIT_TEXT_SHAPER_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 // INTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-vector.h>
  23 #include <dali-toolkit/public-api/text/font-run.h>
  24 #include <dali-toolkit/public-api/text/script-run.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Toolkit
  30 {
  31
  32 namespace Text
  33 {
  34
  35 /**
  36  * Shapes the whole text.
  37  *
  38  * @param[in] text Vector of UTF-32 characters.
  39  * @param[in] lineBreakInfo The line break info.
  40  * @param[in] scripts Vector containing the script runs for the whole text.
  41  * @param[in] fonts Vector with validated fonts.
  42  * @param[out] glyphs Vector of glyphs in the visual order.
  43  * @param[out] characterIndices Vector containing the first character in the logical model that each glyph relates to.
  44  * @param[out] charactersPerGlyph Vector containing the number of characters per glyph.
  45  */
  46 void ShapeText( const Vector<Character>& text,
  47                 const Vector<LineBreakInfo>& lineBreakInfo,
  48                 const Vector<ScriptRun>& scripts,
  49                 const Vector<FontRun>& fonts,
  50                 Vector<GlyphInfo>& glyphs,
  51                 Vector<CharacterIndex>& characterIndices,
  52                 Vector<Length>& charactersPerGlyph );
  53
  54 } // namespace Text
  55
  56 } // namespace Toolkit
  57
  58 } // namespace Dali
  59
  60 #endif // __DALI_TOOLKIT_TEXT_SHAPER_H__