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>
42 typedef IntrusivePtr<Typesetter> TypesetterPtr;
45 * @brief This class is responsible of controlling the data flow of the text's rendering process.
47 class Typesetter : public RefObject
52 * @brief Behaviours of how to render the text.
56 RENDER_TEXT_AND_STYLES, ///< Render both the text and its styles
57 RENDER_NO_TEXT, ///< Do not render the text itself
58 RENDER_NO_STYLES, ///< Do not render any styles
59 RENDER_MASK ///< Render an alpha mask (for color glyphs with no color animation, e.g. emoji)
63 * @brief Styles of the text.
67 STYLE_NONE, ///< No style
68 STYLE_MASK, ///< Alpha mask
69 STYLE_SHADOW, ///< Hard shadow
70 STYLE_SOFT_SHADOW, ///< Soft shadow
71 STYLE_UNDERLINE, ///< Underline
72 STYLE_OUTLINE, ///< Outline
73 STYLE_BACKGROUND ///< Text background
76 public: // Constructor.
78 * @brief Creates a Typesetter instance.
80 * The typesetter composes the final text retrieving the glyphs and the
81 * styles from the text's model.
83 * @param[in] model Pointer to the text's data model.
85 static TypesetterPtr New( const ModelInterface* const model );
89 * @brief Retrieves the pointer to the view model.
91 * @return A pointer to the view model.
93 ViewModel* GetViewModel();
96 * @brief Renders the text.
98 * Does the following operations:
99 * - Finds the visible pages needed to be rendered.
100 * - Elide glyphs if needed.
101 * - Creates image buffers for diffrent text styles with the given size.
102 * - Combines different image buffers to create the pixel data used to generate the final image
104 * @param[in] size The renderer size.
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, 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 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] verticalOffset The vertical offset to be added to the glyph's position.
141 * @param[in] fromGlyphIndex The index of the first glyph within the text to be drawn
142 * @param[in] toGlyphIndex The index of the last glyph within the text to be drawn
144 * @return An image buffer with the text.
146 Devel::PixelBuffer CreateImageBuffer( const unsigned int bufferWidth, const unsigned int bufferHeight, Typesetter::Style style, bool ignoreHorizontalAlignment, Pixel::Format pixelFormat, int verticalOffset, TextAbstraction::GlyphIndex fromGlyphIndex, TextAbstraction::GlyphIndex toGlyphIndex );
149 * @brief Combine the two RGBA image buffers together.
151 * The top layer buffer will blend over the bottom layer buffer:
152 * - If the pixel is not fully opaque from either buffer, it will be blended with
153 * the pixel from the other buffer and copied to the combined buffer.
154 * - If the pixels from both buffers are fully opaque, the pixels from the top layer
155 * buffer will be copied to the combined buffer.
157 * @param[in] topPixelBuffer The top layer buffer.
158 * @param[in] bottomPixelBuffer The bottom layer buffer.
159 * @param[in] bufferWidth The width of the image buffer.
160 * @param[in] bufferHeight The height of the image buffer.
162 * @return The combined image buffer with the text.
165 Devel::PixelBuffer CombineImageBuffer( Devel::PixelBuffer topPixelBuffer, Devel::PixelBuffer bottomPixelBuffer, const unsigned int bufferWidth, const unsigned int bufferHeightbool );
170 * @brief A reference counted object may only be deleted by calling Unreference().
172 * Destroys the visual model.
174 virtual ~Typesetter();
183 } // namespace Toolkit
187 #endif // DALI_TOOLKIT_TEXT_TYPESETTER_H