1 #ifndef DALI_TOOLKIT_TEXT_TYPESETTER_H
2 #define DALI_TOOLKIT_TEXT_TYPESETTER_H
5 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/common/intrusive-ptr.h>
23 #include <dali/public-api/object/ref-object.h>
24 #include <dali/public-api/images/pixel.h>
25 #include <dali/public-api/images/pixel-data.h>
26 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
27 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
28 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
43 typedef IntrusivePtr<Typesetter> TypesetterPtr;
46 * @brief This class is responsible of controlling the data flow of the text's rendering process.
48 class Typesetter : public RefObject
53 * @brief Behaviours of how to render the text.
57 RENDER_TEXT_AND_STYLES, ///< Render both the text and its styles
58 RENDER_NO_TEXT, ///< Do not render the text itself
59 RENDER_NO_STYLES, ///< Do not render any styles
60 RENDER_MASK ///< Render an alpha mask (for color glyphs with no color animation, e.g. emoji)
64 * @brief Styles of the text.
68 STYLE_NONE, ///< No style
69 STYLE_MASK, ///< Alpha mask
70 STYLE_SHADOW, ///< Hard shadow
71 STYLE_SOFT_SHADOW, ///< Soft shadow
72 STYLE_UNDERLINE, ///< Underline
73 STYLE_OUTLINE, ///< Outline
74 STYLE_BACKGROUND ///< Text background
77 public: // Constructor.
79 * @brief Creates a Typesetter instance.
81 * The typesetter composes the final text retrieving the glyphs and the
82 * styles from the text's model.
84 * @param[in] model Pointer to the text's data model.
86 static TypesetterPtr New( const ModelInterface* const model );
90 * @brief Retrieves the pointer to the view model.
92 * @return A pointer to the view model.
94 ViewModel* GetViewModel();
97 * @brief Renders the text.
99 * Does the following operations:
100 * - Finds the visible pages needed to be rendered.
101 * - Elide glyphs if needed.
102 * - Creates image buffers for diffrent text styles with the given size.
103 * - Combines different image buffers to create the pixel data used to generate the final image
105 * @param[in] size The renderer size.
106 * @param[in] textDirection The direction of the text.
107 * @param[in] behaviour The behaviour of how to render the text (i.e. whether to render the text only or the styles only or both).
108 * @param[in] ignoreHorizontalAlignment Whether to ignore the horizontal alignment (i.e. always render as if HORIZONTAL_ALIGN_BEGIN).
109 * @param[in] pixelFormat The format of the pixel in the image that the text is rendered as (i.e. either Pixel::BGRA8888 or Pixel::L8).
111 * @return A pixel data with the text rendered.
113 PixelData Render( const Vector2& size, Toolkit::DevelText::TextDirection::Type textDirection, RenderBehaviour behaviour = RENDER_TEXT_AND_STYLES, bool ignoreHorizontalAlignment = false, Pixel::Format pixelFormat = Pixel::RGBA8888 );
117 * @brief Private constructor.
119 * @param[in] model Pointer to the text's data model.
121 Typesetter( const ModelInterface* const model );
123 // Declared private and left undefined to avoid copies.
124 Typesetter( const Typesetter& handle );
126 // Declared private and left undefined to avoid copies.
127 Typesetter& operator=( const Typesetter& handle );
130 * @brief Create the image buffer for the given range of the glyphs in the given style.
132 * Does the following operations:
133 * - Retrieves the data buffers from the text model.
134 * - Creates the pixel data used to generate the final image with the given size.
135 * - Traverse the visible glyphs, retrieve their bitmaps and compose the final pixel data.
137 * @param[in] bufferWidth The width of the image buffer.
138 * @param[in] bufferHeight The height of the image buffer.
139 * @param[in] style The style of the text.
140 * @param[in] ignoreHorizontalAlignment Whether to ignore the horizontal alignment, not ignored by default.
141 * @param[in] pixelFormat The format of the pixel in the image that the text is rendered as (i.e. either Pixel::BGRA8888 or Pixel::L8).
142 * @param[in] horizontalOffset The horizontal offset to be added to the glyph's position.
143 * @param[in] verticalOffset The vertical offset to be added to the glyph's position.
144 * @param[in] fromGlyphIndex The index of the first glyph within the text to be drawn
145 * @param[in] toGlyphIndex The index of the last glyph within the text to be drawn
147 * @return An image buffer with the text.
149 Devel::PixelBuffer CreateImageBuffer( const unsigned int bufferWidth, const unsigned int bufferHeight, Typesetter::Style style, bool ignoreHorizontalAlignment, Pixel::Format pixelFormat, int horizontalOffset, int verticalOffset, TextAbstraction::GlyphIndex fromGlyphIndex, TextAbstraction::GlyphIndex toGlyphIndex );
152 * @brief Combine the two RGBA image buffers together.
154 * The top layer buffer will blend over the bottom layer buffer:
155 * - If the pixel is not fully opaque from either buffer, it will be blended with
156 * the pixel from the other buffer and copied to the combined buffer.
157 * - If the pixels from both buffers are fully opaque, the pixels from the top layer
158 * buffer will be copied to the combined buffer.
160 * @param[in] topPixelBuffer The top layer buffer.
161 * @param[in] bottomPixelBuffer The bottom layer buffer.
162 * @param[in] bufferWidth The width of the image buffer.
163 * @param[in] bufferHeight The height of the image buffer.
165 * @return The combined image buffer with the text.
168 Devel::PixelBuffer CombineImageBuffer( Devel::PixelBuffer topPixelBuffer, Devel::PixelBuffer bottomPixelBuffer, const unsigned int bufferWidth, const unsigned int bufferHeightbool );
173 * @brief A reference counted object may only be deleted by calling Unreference().
175 * Destroys the visual model.
177 virtual ~Typesetter();
186 } // namespace Toolkit
190 #endif // DALI_TOOLKIT_TEXT_TYPESETTER_H