1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_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/public-api/animation/constraint.h>
23 #include <dali/public-api/object/base-object.h>
24 #include <dali/public-api/object/weak-handle.h>
25 #include <dali/public-api/rendering/visual-renderer.h>
28 #include <dali-toolkit/internal/text/rendering/text-typesetter.h>
29 #include <dali-toolkit/internal/text/text-controller.h>
30 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
39 typedef IntrusivePtr<TextVisual> TextVisualPtr;
42 * The visual which renders text
44 * The following properties are optional:
46 * | %Property Name | Type |
47 * |---------------------|---------|
48 * | renderingBackend | INTEGER |
50 * | fontFamily | STRING |
51 * | fontStyle | STRING |
52 * | pointSize | FLOAT |
53 * | multiLine | BOOLEAN |
54 * | horizontalAlignment | STRING |
55 * | verticalAlignment | STRING |
56 * | textColor | VECTOR4 |
57 * | enableMarkup | BOOLEAN |
58 * | enableAutoScroll | BOOLEAN |
59 * | autoScrollSpeed | INTEGER |
60 * | autoScrollLoopCount | INTEGER |
61 * | autoScrollGap | INTEGER |
62 * | lineSpacing | FLOAT |
63 * | underline | STRING |
65 * | outline | STRING |
68 class TextVisual : public Visual::Base
72 * @brief Create a new text visual.
74 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
75 * @param[in] properties A Property::Map containing settings for this visual
76 * @return A smart-pointer to the newly allocated visual.
78 static TextVisualPtr New(VisualFactoryCache& factoryCache, const Property::Map& properties);
81 * @brief Converts all strings keys in property map to index keys. Property Map can then be merged correctly.
82 * @param[in] propertyMap containing string keys or a mix of strings and indexes.
83 * @return Property::Map containing index keys.
85 static Property::Map ConvertStringKeysToIndexKeys(const Property::Map& propertyMap);
88 * @brief Retrieve the text's controller.
89 * @param[in] visual The text visual.
90 * @return The text controller
92 static Text::ControllerPtr GetController(Toolkit::Visual::Base visual)
94 return GetVisualObject(visual).mController;
98 * @brief Set the index of the animatable text color property.
99 * @param[in] visual The text visual.
100 * @param[in] animatablePropertyIndex The index of the animatable property
102 static void SetAnimatableTextColorProperty(Toolkit::Visual::Base visual, Property::Index animatablePropertyIndex)
104 GetVisualObject(visual).mAnimatableTextColorPropertyIndex = animatablePropertyIndex;
108 * @brief Set the flag to trigger the textures to be initialized and renderer to be added to the control.
109 * @param[in] visual The text visual.
111 static void EnableRendererUpdate(Toolkit::Visual::Base visual)
113 GetVisualObject(visual).mRendererUpdateNeeded = true;
117 * @brief Instantly updates the renderer
118 * @param[in] visual The text visual.
120 static void UpdateRenderer(Toolkit::Visual::Base visual)
122 GetVisualObject(visual).UpdateRenderer();
125 public: // from Visual::Base
127 * @copydoc Visual::Base::GetHeightForWidth()
129 float GetHeightForWidth(float width) override;
132 * @copydoc Visual::Base::GetNaturalSize()
134 void GetNaturalSize(Vector2& naturalSize) override;
137 * @copydoc Visual::Base::CreatePropertyMap()
139 void DoCreatePropertyMap(Property::Map& map) const override;
142 * @copydoc Visual::Base::CreateInstancePropertyMap
144 void DoCreateInstancePropertyMap(Property::Map& map) const override;
147 * @copydoc Visual::Base::EnablePreMultipliedAlpha
149 void EnablePreMultipliedAlpha(bool preMultiplied) override;
153 * @brief Constructor.
155 * @param[in] factoryCache The VisualFactoryCache object
157 TextVisual(VisualFactoryCache& factoryCache);
160 * @brief A reference counted object may only be deleted by calling Unreference().
162 virtual ~TextVisual();
165 * @copydoc Visual::Base::OnInitialize
167 void OnInitialize() override;
172 * @copydoc Visual::Base::DoSetProperties()
174 void DoSetProperties(const Property::Map& propertyMap) override;
177 * @copydoc Visual::Base::DoSetOnScene()
179 void DoSetOnScene(Actor& actor) override;
182 * @copydoc Visual::Base::DoSetOffScene()
184 void DoSetOffScene(Actor& actor) override;
187 * @copydoc Visual::Base::OnSetTransform
189 void OnSetTransform() override;
194 unsigned char* textBuffer;
195 unsigned char* styleBuffer;
196 unsigned char* maskBuffer;
199 Pixel::Format textPixelFormat;
203 TilingInfo(int width, int height, Pixel::Format textPixelFormat)
209 textPixelFormat(textPixelFormat),
233 * @brief Set the individual property to the given value.
235 * @param[in] index The index key used to reference this value within the initial property map.
237 * @param[in] propertyValue The value to set.
239 void DoSetProperty(Dali::Property::Index index, const Dali::Property::Value& propertyValue);
242 * @brief Updates the text's renderer.
244 void UpdateRenderer();
247 * @brief Removes the text's renderer.
249 void RemoveRenderer(Actor& actor);
252 * @brief Create a texture in textureSet and add it.
253 * @param[in] textureSet The textureSet to which the texture will be added.
254 * @param[in] data The PixelData to be uploaded to texture
255 * @param[in] sampler The sampler.
256 * @param[in] textureSetIndex The Index of TextureSet.
258 void AddTexture(TextureSet& textureSet, PixelData& data, Sampler& sampler, unsigned int textureSetIndex);
261 * @brief Convert the buffer to pixelData.
262 * @param[in] buffer The Buffer to be converted to pixelData.
263 * @param[in] width The width of pixel data.
264 * @param[in] height The height of pixel data.
265 * @param[in] offsetPosition The The buffer's start position.
266 * @param[in] textPixelFormat The PixelForma of text.
268 PixelData ConvertToPixelData(unsigned char* buffer, int width, int height, int offsetPosition, const Pixel::Format textPixelFormat);
271 * @brief Create the text's texture.
272 * @param[in] info This is the information you need to create a Tiling.
273 * @param[in] renderer The renderer to which the TextureSet will be added.
274 * @param[in] sampler The sampler.
275 * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
276 * @param[in] containsColorGlyph Whether the text contains color glyph.
277 * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
278 * @param[in] isOverlayStyle Whether the style needs to overlay on the text (e.g. strikethrough, underline, etc.).
280 void CreateTextureSet(TilingInfo& info, VisualRenderer& renderer, Sampler& sampler, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle);
283 * Create renderer of the text for rendering.
284 * @param[in] actor The actor.
285 * @param[in] size The texture size.
286 * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
287 * @param[in] containsColorGlyph Whether the text contains color glyph.
288 * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
289 * @param[in] isOverlayStyle Whether the style needs to overlay on the text (e.g. strikethrough, underline, etc.).
291 void AddRenderer(Actor& actor, const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle);
294 * Get the texture of the text for rendering.
295 * @param[in] size The texture size.
296 * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
297 * @param[in] containsColorGlyph Whether the text contains color glyph.
298 * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
299 * @param[in] isOverlayStyle Whether the style needs to overlay on the text (e.g. strikethrough, underline, etc.).
301 TextureSet GetTextTexture(const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle);
304 * Get the text rendering shader.
305 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
306 * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
307 * @param[in] containsColorGlyph Whether the text contains color glyph.
308 * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
310 Shader GetTextShader(VisualFactoryCache& factoryCache, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled);
313 * @brief Retrieve the TextVisual object.
314 * @param[in] visual A handle to the TextVisual
315 * @return The TextVisual object
317 static TextVisual& GetVisualObject(Toolkit::Visual::Base visual)
319 return static_cast<TextVisual&>(Toolkit::GetImplementation(visual).GetVisualObject());
323 typedef std::vector<Renderer> RendererContainer;
326 * Used as an alternative to boolean so that it is obvious whether the text contains single or multiple text colors, and emoji and styles.
332 SINGLE_COLOR_TEXT = 0, ///< The text contains single color only.
333 MULTI_COLOR_TEXT = 1, ///< The text contains multiple colors.
334 NO_EMOJI = 0, ///< The text contains no emoji.
335 HAS_EMOJI = 1, ///< The text contains emoji.
336 NO_STYLES = 0, ///< The text contains contains no styles.
337 HAS_SYLES = 1 ///< The text contains contains styles.
342 Text::ControllerPtr mController; ///< The text's controller.
343 Text::TypesetterPtr mTypesetter; ///< The text's typesetter.
344 WeakHandle<Actor> mControl; ///< The control where the renderer is added.
345 Constraint mColorConstraint{}; ///< Color constraint
346 Constraint mOpacityConstraint{}; ///< Opacity constraint
347 Property::Index mAnimatableTextColorPropertyIndex; ///< The index of animatable text color property registered by the control.
348 Property::Index mTextColorAnimatableIndex; ///< The index of uTextColorAnimatable property.
349 bool mRendererUpdateNeeded : 1; ///< The flag to indicate whether the renderer needs to be updated.
350 RendererContainer mRendererList;
353 } // namespace Internal
355 } // namespace Toolkit
359 #endif /* DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H */