1 #ifndef DALI_TOOLKIT_TEXT_TYPESETTER_H
2 #define DALI_TOOLKIT_TEXT_TYPESETTER_H
5 * Copyright (c) 2022 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-toolkit/devel-api/text/text-enumerations-devel.h>
23 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
24 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
25 #include <dali/public-api/common/intrusive-ptr.h>
26 #include <dali/public-api/images/pixel-data.h>
27 #include <dali/public-api/images/pixel.h>
28 #include <dali/public-api/object/ref-object.h>
40 typedef IntrusivePtr<Typesetter> TypesetterPtr;
43 * @brief This class is responsible of controlling the data flow of the text's rendering process.
45 class Typesetter : public RefObject
49 * @brief Behaviours of how to render the text.
53 RENDER_TEXT_AND_STYLES, ///< Render both the text and its styles
54 RENDER_NO_TEXT, ///< Do not render the text itself but render the background styles such as outline and background.
55 RENDER_NO_STYLES, ///< Do not render any styles
56 RENDER_MASK, ///< Render an alpha mask (for color glyphs with no color animation, e.g. emoji)
57 RENDER_OVERLAY_STYLE ///< Do not render the text itself but render the style but overlay the style on the text (foreground styles such as strikethrough and underline)
61 * @brief Styles of the text.
65 STYLE_NONE, ///< No style
66 STYLE_MASK, ///< Alpha mask
67 STYLE_SHADOW, ///< Hard shadow
68 STYLE_SOFT_SHADOW, ///< Soft shadow
69 STYLE_UNDERLINE, ///< Underline
70 STYLE_OUTLINE, ///< Outline
71 STYLE_BACKGROUND, ///< Text background
72 STYLE_STRIKETHROUGH ///< Strikethrough
75 public: // Constructor.
77 * @brief Creates a Typesetter instance.
79 * The typesetter composes the final text retrieving the glyphs and the
80 * styles from the text's model.
82 * @param[in] model Pointer to the text's data model.
84 static TypesetterPtr New(const ModelInterface* const model);
88 * @brief Retrieves the pointer to the view model.
90 * @return A pointer to the view model.
92 ViewModel* GetViewModel();
95 * @brief Renders the text.
97 * Does the following operations:
98 * - Finds the visible pages needed to be rendered.
99 * - Elide glyphs if needed.
100 * - Creates image buffers for diffrent text styles with the given size.
101 * - Combines different image buffers to create the pixel data used to generate the final image
103 * @param[in] size The renderer size.
104 * @param[in] textDirection The direction of the text.
105 * @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).
106 * @param[in] ignoreHorizontalAlignment Whether to ignore the horizontal alignment (i.e. always render as if HORIZONTAL_ALIGN_BEGIN).
107 * @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).
109 * @return A pixel data with the text rendered.
111 PixelData Render(const Vector2& size, Toolkit::DevelText::TextDirection::Type textDirection, RenderBehaviour behaviour = RENDER_TEXT_AND_STYLES, bool ignoreHorizontalAlignment = false, Pixel::Format pixelFormat = Pixel::RGBA8888);
115 * @brief Private constructor.
117 * @param[in] model Pointer to the text's data model.
119 Typesetter(const ModelInterface* const model);
121 // Declared private and left undefined to avoid copies.
122 Typesetter(const Typesetter& handle);
124 // Declared private and left undefined to avoid copies.
125 Typesetter& operator=(const Typesetter& handle);
128 * @brief Create & draw the image buffer for the given range of the glyphs in the given style.
130 * Does the following operations:
131 * - Retrieves the data buffers from the text model.
132 * - Creates the pixel data used to generate the final image with the given size.
133 * - Traverse the visible glyphs, retrieve their bitmaps and compose the final pixel data.
135 * @param[in] bufferWidth The width of the image buffer.
136 * @param[in] bufferHeight The height of the image buffer.
137 * @param[in] style The style of the text.
138 * @param[in] ignoreHorizontalAlignment Whether to ignore the horizontal alignment, not ignored by default.
139 * @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).
140 * @param[in] horizontalOffset The horizontal offset to be added to the glyph's position.
141 * @param[in] verticalOffset The vertical offset to be added to the glyph's position.
142 * @param[in] fromGlyphIndex The index of the first glyph within the text to be drawn
143 * @param[in] toGlyphIndex The index of the last glyph within the text to be drawn
145 * @return An image buffer with the text.
147 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);
150 * @brief Create an initialized image buffer.
152 * Creates the pixel data used to generate the final image with the given size.
154 * @param[in] bufferWidth The width of the image buffer.
155 * @param[in] bufferHeight The height of the image buffer.
156 * @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).
158 * @return An image buffer.
160 Devel::PixelBuffer CreateImageBuffer(const unsigned int bufferWidth, const unsigned int bufferHeight, Pixel::Format pixelFormat);
163 * @brief Combine the two RGBA image buffers together.
165 * The top layer buffer will blend over the bottom layer buffer:
166 * - If the pixel is not fully opaque from either buffer, it will be blended with
167 * the pixel from the other buffer and copied to the combined buffer.
168 * - If the pixels from both buffers are fully opaque, the pixels from the top layer
169 * buffer will be copied to the combined buffer.
171 * @param[in] topPixelBuffer The top layer buffer.
172 * @param[in] bottomPixelBuffer The bottom layer buffer.
173 * @param[in] bufferWidth The width of the image buffer.
174 * @param[in] bufferHeight The height of the image buffer.
176 * @return The combined image buffer with the text.
179 Devel::PixelBuffer CombineImageBuffer(Devel::PixelBuffer topPixelBuffer, Devel::PixelBuffer bottomPixelBuffer, const unsigned int bufferWidth, const unsigned int bufferHeightbool);
182 * @brief Apply behaviour of tags if the markup-processor is enabled.
184 * @param[in] topPixelBuffer The top layer buffer.
185 * @param[in] bufferWidth The width of the image buffer.
186 * @param[in] bufferHeight The height of the image buffer.
187 * @param[in] ignoreHorizontalAlignment Whether to ignore the horizontal alignment, not ignored by default.
188 * @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).
189 * @param[in] horizontalOffset The horizontal offset to be added to the glyph's position.
190 * @param[in] verticalOffset The vertical offset to be added to the glyph's position.
192 * @return The image buffer with the markup.
194 Devel::PixelBuffer ApplyMarkupProcessorOnPixelBuffer(Devel::PixelBuffer topPixelBuffer, const unsigned int bufferWidth, const unsigned int bufferHeight, bool ignoreHorizontalAlignment, Pixel::Format pixelFormat, int horizontalOffset, int verticalOffset);
197 * @brief Apply markup underline tags.
199 * The properties on TextLabel override the behavior of Markup.
200 * Because the markup will be the bottom layer buffer
201 * - i.e: If you set property UNDERLINE to enabled and blue.
202 * And the TEXT is "<color value='green'>Hello</color> <u>World</u> <i>Hello</i> <b>World</b>".
203 * Then the output of the whole text is underlined by blue line.
205 * @param[in] topPixelBuffer The top layer buffer.
206 * @param[in] bufferWidth The width of the image buffer.
207 * @param[in] bufferHeight The height of the image buffer.
208 * @param[in] ignoreHorizontalAlignment Whether to ignore the horizontal alignment, not ignored by default.
209 * @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).
210 * @param[in] horizontalOffset The horizontal offset to be added to the glyph's position.
211 * @param[in] verticalOffset The vertical offset to be added to the glyph's position.
213 * @return The image buffer with the markup.
215 Devel::PixelBuffer ApplyUnderlineMarkupImageBuffer(Devel::PixelBuffer topPixelBuffer, const unsigned int bufferWidth, const unsigned int bufferHeight, bool ignoreHorizontalAlignment, Pixel::Format pixelFormat, int horizontalOffset, int verticalOffset);
218 * @brief Apply markup strikethrough tags.
220 * The properties on TextLabel override the behavior of Markup.
221 * Because the markup will be the bottom layer buffer
222 * - i.e: If you set property STRIKETHROUGH to enabled and blue.
223 * And the TEXT is "<color value='green'>Hello</color> <s>World</s> <i>Hello</i> <b>World</b>".
224 * Then the whole text will have a blue line strikethrough.
226 * @param[in] topPixelBuffer The top layer buffer.
227 * @param[in] bufferWidth The width of the image buffer.
228 * @param[in] bufferHeight The height of the image buffer.
229 * @param[in] ignoreHorizontalAlignment Whether to ignore the horizontal alignment, not ignored by default.
230 * @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).
231 * @param[in] horizontalOffset The horizontal offset to be added to the glyph's position.
232 * @param[in] verticalOffset The vertical offset to be added to the glyph's position.
234 * @return The image buffer with the markup.
236 Devel::PixelBuffer ApplyStrikethroughMarkupImageBuffer(Devel::PixelBuffer topPixelBuffer, const unsigned int bufferWidth, const unsigned int bufferHeight, bool ignoreHorizontalAlignment, Pixel::Format pixelFormat, int horizontalOffset, int verticalOffset);
240 * @brief A reference counted object may only be deleted by calling Unreference().
242 * Destroys the visual model.
244 virtual ~Typesetter();
252 } // namespace Toolkit
256 #endif // DALI_TOOLKIT_TEXT_TYPESETTER_H