2 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali-toolkit/internal/visuals/text/text-visual.h>
22 #include <dali/devel-api/adaptor-framework/image-loading.h>
23 #include <dali/devel-api/images/pixel-data-devel.h>
24 #include <dali/devel-api/rendering/renderer-devel.h>
25 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
26 #include <dali/integration-api/debug.h>
30 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
31 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
32 #include <dali-toolkit/devel-api/visuals/text-visual-properties-devel.h>
33 #include <dali-toolkit/internal/graphics/builtin-shader-extern-gen.h>
34 #include <dali-toolkit/internal/text/script-run.h>
35 #include <dali-toolkit/internal/text/text-effects-style.h>
36 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
37 #include <dali-toolkit/internal/text/text-font-style.h>
38 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
39 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
40 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
41 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
42 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
43 #include <dali-toolkit/public-api/visuals/visual-properties.h>
53 const int CUSTOM_PROPERTY_COUNT(5); // anim,premul,size,offset,multicol
55 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
58 * Return Property index for the given string key
59 * param[in] stringKey the string index key
60 * return the key as an index
63 Dali::Property::Index StringKeyToIndexKey(const std::string& stringKey)
65 Dali::Property::Index result = Property::INVALID_KEY;
67 if(stringKey == VISUAL_TYPE)
69 result = Toolkit::Visual::Property::TYPE;
71 else if(stringKey == TEXT_PROPERTY)
73 result = Toolkit::TextVisual::Property::TEXT;
75 else if(stringKey == FONT_FAMILY_PROPERTY)
77 result = Toolkit::TextVisual::Property::FONT_FAMILY;
79 else if(stringKey == FONT_STYLE_PROPERTY)
81 result = Toolkit::TextVisual::Property::FONT_STYLE;
83 else if(stringKey == POINT_SIZE_PROPERTY)
85 result = Toolkit::TextVisual::Property::POINT_SIZE;
87 else if(stringKey == MULTI_LINE_PROPERTY)
89 result = Toolkit::TextVisual::Property::MULTI_LINE;
91 else if(stringKey == HORIZONTAL_ALIGNMENT_PROPERTY)
93 result = Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT;
95 else if(stringKey == VERTICAL_ALIGNMENT_PROPERTY)
97 result = Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT;
99 else if(stringKey == TEXT_COLOR_PROPERTY)
101 result = Toolkit::TextVisual::Property::TEXT_COLOR;
103 else if(stringKey == ENABLE_MARKUP_PROPERTY)
105 result = Toolkit::TextVisual::Property::ENABLE_MARKUP;
107 else if(stringKey == SHADOW_PROPERTY)
109 result = Toolkit::TextVisual::Property::SHADOW;
111 else if(stringKey == UNDERLINE_PROPERTY)
113 result = Toolkit::TextVisual::Property::UNDERLINE;
115 else if(stringKey == OUTLINE_PROPERTY)
117 result = Toolkit::DevelTextVisual::Property::OUTLINE;
119 else if(stringKey == BACKGROUND_PROPERTY)
121 result = Toolkit::DevelTextVisual::Property::BACKGROUND;
127 void TextColorConstraint(Vector4& current, const PropertyInputContainer& inputs)
129 Vector4 color = inputs[0]->GetVector4();
130 current.r = color.r * color.a;
131 current.g = color.g * color.a;
132 current.b = color.b * color.a;
136 void OpacityConstraint(float& current, const PropertyInputContainer& inputs)
138 // Make zero if the alpha value of text color is zero to skip rendering text
139 if(EqualsZero(inputs[0]->GetVector4().a))
149 } // unnamed namespace
151 TextVisualPtr TextVisual::New(VisualFactoryCache& factoryCache, TextVisualShaderFactory& shaderFactory, const Property::Map& properties)
153 TextVisualPtr textVisualPtr(new TextVisual(factoryCache, shaderFactory));
154 textVisualPtr->SetProperties(properties);
155 textVisualPtr->Initialize();
156 return textVisualPtr;
159 Property::Map TextVisual::ConvertStringKeysToIndexKeys(const Property::Map& propertyMap)
161 Property::Map outMap;
163 for(Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index)
165 const KeyValuePair& keyValue = propertyMap.GetKeyValue(index);
167 Property::Index indexKey = keyValue.first.indexKey;
169 if(keyValue.first.type == Property::Key::STRING)
171 indexKey = StringKeyToIndexKey(keyValue.first.stringKey);
174 outMap.Insert(indexKey, keyValue.second);
180 float TextVisual::GetHeightForWidth(float width)
182 return mController->GetHeightForWidth(width);
185 void TextVisual::GetNaturalSize(Vector2& naturalSize)
187 naturalSize = mController->GetNaturalSize().GetVectorXY();
190 void TextVisual::DoCreatePropertyMap(Property::Map& map) const
192 Property::Value value;
195 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT);
198 mController->GetText(text);
199 map.Insert(Toolkit::TextVisual::Property::TEXT, text);
201 map.Insert(Toolkit::TextVisual::Property::FONT_FAMILY, mController->GetDefaultFontFamily());
203 GetFontStyleProperty(mController, value, Text::FontStyle::DEFAULT);
204 map.Insert(Toolkit::TextVisual::Property::FONT_STYLE, value);
206 map.Insert(Toolkit::TextVisual::Property::POINT_SIZE, mController->GetDefaultFontSize(Text::Controller::POINT_SIZE));
208 map.Insert(Toolkit::TextVisual::Property::MULTI_LINE, mController->IsMultiLineEnabled());
210 map.Insert(Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT, mController->GetHorizontalAlignment());
212 map.Insert(Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT, mController->GetVerticalAlignment());
214 map.Insert(Toolkit::TextVisual::Property::TEXT_COLOR, mController->GetDefaultColor());
216 map.Insert(Toolkit::TextVisual::Property::ENABLE_MARKUP, mController->IsMarkupProcessorEnabled());
218 GetShadowProperties(mController, value, Text::EffectStyle::DEFAULT);
219 map.Insert(Toolkit::TextVisual::Property::SHADOW, value);
221 GetUnderlineProperties(mController, value, Text::EffectStyle::DEFAULT);
222 map.Insert(Toolkit::TextVisual::Property::UNDERLINE, value);
224 GetOutlineProperties(mController, value, Text::EffectStyle::DEFAULT);
225 map.Insert(Toolkit::DevelTextVisual::Property::OUTLINE, value);
227 GetBackgroundProperties(mController, value, Text::EffectStyle::DEFAULT);
228 map.Insert(Toolkit::DevelTextVisual::Property::BACKGROUND, value);
230 GetStrikethroughProperties(mController, value, Text::EffectStyle::DEFAULT);
231 map.Insert(Toolkit::DevelTextVisual::Property::STRIKETHROUGH, value);
234 void TextVisual::DoCreateInstancePropertyMap(Property::Map& map) const
237 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT);
239 mController->GetText(text);
240 map.Insert(Toolkit::TextVisual::Property::TEXT, text);
243 void TextVisual::EnablePreMultipliedAlpha(bool preMultiplied)
245 // Make always enable pre multiplied alpha whether preMultiplied value is false.
248 DALI_LOG_WARNING("Note : TextVisual cannot disable PreMultipliedAlpha\n");
252 TextVisual::TextVisual(VisualFactoryCache& factoryCache, TextVisualShaderFactory& shaderFactory)
253 : Visual::Base(factoryCache, Visual::FittingMode::FIT_KEEP_ASPECT_RATIO, Toolkit::Visual::TEXT),
254 mController(Text::Controller::New()),
255 mTypesetter(Text::Typesetter::New(mController->GetTextModel())),
256 mTextVisualShaderFactory(shaderFactory),
257 mTextShaderFeatureCache(),
258 mAnimatableTextColorPropertyIndex(Property::INVALID_INDEX),
259 mTextColorAnimatableIndex(Property::INVALID_INDEX),
260 mRendererUpdateNeeded(false)
262 // Enable the pre-multiplied alpha to improve the text quality
263 mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
266 TextVisual::~TextVisual()
270 void TextVisual::OnInitialize()
272 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
273 Shader shader = GetTextShader(mFactoryCache, TextVisualShaderFeature::FeatureBuilder());
275 mImpl->mRenderer = VisualRenderer::New(geometry, shader);
276 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
279 void TextVisual::DoSetProperties(const Property::Map& propertyMap)
281 for(Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index)
283 const KeyValuePair& keyValue = propertyMap.GetKeyValue(index);
285 Property::Index indexKey = keyValue.first.indexKey;
287 if(keyValue.first.type == Property::Key::STRING)
289 indexKey = StringKeyToIndexKey(keyValue.first.stringKey);
292 DoSetProperty(indexKey, keyValue.second);
295 // Elide the text if it exceeds the boundaries.
296 mController->SetTextElideEnabled(true);
298 // Retrieve the layout engine to set the cursor's width.
299 Text::Layout::Engine& engine = mController->GetLayoutEngine();
301 // Sets 0 as cursor's width.
302 engine.SetCursorWidth(0u); // Do not layout space for the cursor.
305 void TextVisual::DoSetOnScene(Actor& actor)
309 mImpl->mRenderer.SetProperty(Dali::Renderer::Property::DEPTH_INDEX, Toolkit::DepthIndex::CONTENT);
311 const Vector4& defaultColor = mController->GetTextModel()->GetDefaultColor();
312 if(mTextColorAnimatableIndex == Property::INVALID_INDEX)
314 mTextColorAnimatableIndex = mImpl->mRenderer.RegisterUniqueProperty("uTextColorAnimatable", defaultColor);
318 mImpl->mRenderer.SetProperty(mTextColorAnimatableIndex, defaultColor);
321 if(mAnimatableTextColorPropertyIndex != Property::INVALID_INDEX)
323 // Create constraint for the animatable text's color Property with uTextColorAnimatable in the renderer.
324 if(mTextColorAnimatableIndex != Property::INVALID_INDEX)
326 if(!mColorConstraint)
328 mColorConstraint = Constraint::New<Vector4>(mImpl->mRenderer, mTextColorAnimatableIndex, TextColorConstraint);
329 mColorConstraint.AddSource(Source(actor, mAnimatableTextColorPropertyIndex));
331 mColorConstraint.Apply();
334 // Make zero if the alpha value of text color is zero to skip rendering text
335 if(!mOpacityConstraint)
337 // VisualRenderer::Property::OPACITY uses same animatable property internally.
338 mOpacityConstraint = Constraint::New<float>(mImpl->mRenderer, Dali::DevelRenderer::Property::OPACITY, OpacityConstraint);
339 mOpacityConstraint.AddSource(Source(actor, mAnimatableTextColorPropertyIndex));
341 mOpacityConstraint.Apply();
344 // Renderer needs textures and to be added to control
345 mRendererUpdateNeeded = true;
350 void TextVisual::RemoveRenderer(Actor& actor)
352 for(RendererContainer::iterator iter = mRendererList.begin(); iter != mRendererList.end(); ++iter)
354 Renderer renderer = (*iter);
357 // Removes the renderer from the actor.
358 actor.RemoveRenderer(renderer);
361 // Clear the renderer list
362 mRendererList.clear();
365 void TextVisual::DoSetOffScene(Actor& actor)
369 mColorConstraint.Remove();
371 if(mOpacityConstraint)
373 mOpacityConstraint.Remove();
376 RemoveRenderer(actor);
378 // Resets the control handle.
382 void TextVisual::OnSetTransform()
387 void TextVisual::DoSetProperty(Dali::Property::Index index, const Dali::Property::Value& propertyValue)
391 case Toolkit::TextVisual::Property::ENABLE_MARKUP:
393 const bool enableMarkup = propertyValue.Get<bool>();
394 mController->SetMarkupProcessorEnabled(enableMarkup);
397 case Toolkit::TextVisual::Property::TEXT:
399 mController->SetText(propertyValue.Get<std::string>());
402 case Toolkit::TextVisual::Property::FONT_FAMILY:
404 SetFontFamilyProperty(mController, propertyValue);
407 case Toolkit::TextVisual::Property::FONT_STYLE:
409 SetFontStyleProperty(mController, propertyValue, Text::FontStyle::DEFAULT);
412 case Toolkit::TextVisual::Property::POINT_SIZE:
414 const float pointSize = propertyValue.Get<float>();
415 if(!Equals(mController->GetDefaultFontSize(Text::Controller::POINT_SIZE), pointSize))
417 mController->SetDefaultFontSize(pointSize, Text::Controller::POINT_SIZE);
421 case Toolkit::TextVisual::Property::MULTI_LINE:
423 mController->SetMultiLineEnabled(propertyValue.Get<bool>());
426 case Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT:
430 Text::HorizontalAlignment::Type alignment(static_cast<Text::HorizontalAlignment::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
431 if(Toolkit::Text::GetHorizontalAlignmentEnumeration(propertyValue, alignment))
433 mController->SetHorizontalAlignment(alignment);
438 case Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT:
442 Toolkit::Text::VerticalAlignment::Type alignment(static_cast<Text::VerticalAlignment::Type>(-1)); // Set to invalid value to ensure a valid mode does get set
443 if(Toolkit::Text::GetVerticalAlignmentEnumeration(propertyValue, alignment))
445 mController->SetVerticalAlignment(alignment);
450 case Toolkit::TextVisual::Property::TEXT_COLOR:
452 const Vector4& textColor = propertyValue.Get<Vector4>();
453 if(mController->GetDefaultColor() != textColor)
455 mController->SetDefaultColor(textColor);
459 case Toolkit::TextVisual::Property::SHADOW:
461 SetShadowProperties(mController, propertyValue, Text::EffectStyle::DEFAULT);
464 case Toolkit::TextVisual::Property::UNDERLINE:
466 SetUnderlineProperties(mController, propertyValue, Text::EffectStyle::DEFAULT);
469 case Toolkit::DevelTextVisual::Property::OUTLINE:
471 SetOutlineProperties(mController, propertyValue, Text::EffectStyle::DEFAULT);
474 case Toolkit::DevelTextVisual::Property::BACKGROUND:
476 SetBackgroundProperties(mController, propertyValue, Text::EffectStyle::DEFAULT);
479 case Toolkit::DevelTextVisual::Property::STRIKETHROUGH:
481 SetStrikethroughProperties(mController, propertyValue, Text::EffectStyle::DEFAULT);
487 void TextVisual::UpdateRenderer()
489 Actor control = mControl.GetHandle();
496 // Calculates the size to be used to relayout.
497 Vector2 relayoutSize;
499 const bool isWidthRelative = fabsf(mImpl->mTransform.mOffsetSizeMode.z) < Math::MACHINE_EPSILON_1000;
500 const bool isHeightRelative = fabsf(mImpl->mTransform.mOffsetSizeMode.w) < Math::MACHINE_EPSILON_1000;
502 // Round the size and offset to avoid pixel alignement issues.
503 relayoutSize.width = floorf(0.5f + (isWidthRelative ? mImpl->mControlSize.width * mImpl->mTransform.mSize.x : mImpl->mTransform.mSize.width));
504 relayoutSize.height = floorf(0.5f + (isHeightRelative ? mImpl->mControlSize.height * mImpl->mTransform.mSize.y : mImpl->mTransform.mSize.height));
507 mController->GetText(text);
509 if((fabsf(relayoutSize.width) < Math::MACHINE_EPSILON_1000) || (fabsf(relayoutSize.height) < Math::MACHINE_EPSILON_1000) || text.empty())
511 // Remove the texture set and any renderer previously set.
512 RemoveRenderer(control);
514 // Nothing else to do if the relayout size is zero.
515 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
519 Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(control);
521 const Text::Controller::UpdateTextType updateTextType = mController->Relayout(relayoutSize, layoutDirection);
523 if(Text::Controller::NONE_UPDATED != (Text::Controller::MODEL_UPDATED & updateTextType) || mRendererUpdateNeeded)
525 mRendererUpdateNeeded = false;
527 // Remove the texture set and any renderer previously set.
528 RemoveRenderer(control);
530 if((relayoutSize.width > Math::MACHINE_EPSILON_1000) &&
531 (relayoutSize.height > Math::MACHINE_EPSILON_1000))
533 // Check whether it is a markup text with multiple text colors
534 const Vector4* const colorsBuffer = mController->GetTextModel()->GetColors();
535 bool hasMultipleTextColors = (NULL != colorsBuffer);
537 // Check whether the text contains any color glyph
538 bool containsColorGlyph = false;
540 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
541 const Text::GlyphInfo* const glyphsBuffer = mController->GetTextModel()->GetGlyphs();
542 const Text::Length numberOfGlyphs = mController->GetTextModel()->GetNumberOfGlyphs();
543 for(Text::Length glyphIndex = 0; glyphIndex < numberOfGlyphs; glyphIndex++)
545 // Retrieve the glyph's info.
546 const Text::GlyphInfo* const glyphInfo = glyphsBuffer + glyphIndex;
548 // Whether the current glyph is a color one.
549 if(fontClient.IsColorGlyph(glyphInfo->fontId, glyphInfo->index))
551 containsColorGlyph = true;
556 // Check whether the text contains any style colors (e.g. underline color, shadow color, etc.)
558 bool shadowEnabled = false;
559 const Vector2& shadowOffset = mController->GetTextModel()->GetShadowOffset();
560 if(fabsf(shadowOffset.x) > Math::MACHINE_EPSILON_1 || fabsf(shadowOffset.y) > Math::MACHINE_EPSILON_1)
562 shadowEnabled = true;
565 const bool outlineEnabled = (mController->GetTextModel()->GetOutlineWidth() > Math::MACHINE_EPSILON_1);
566 const bool backgroundEnabled = mController->GetTextModel()->IsBackgroundEnabled();
567 const bool markupProcessorEnabled = mController->IsMarkupProcessorEnabled();
568 const bool markupUnderlineEnabled = markupProcessorEnabled && mController->GetTextModel()->IsMarkupUnderlineSet();
569 const bool markupStrikethroughEnabled = markupProcessorEnabled && mController->GetTextModel()->IsMarkupStrikethroughSet();
570 const bool underlineEnabled = mController->GetTextModel()->IsUnderlineEnabled() || markupUnderlineEnabled;
571 const bool strikethroughEnabled = mController->GetTextModel()->IsStrikethroughEnabled() || markupStrikethroughEnabled;
572 const bool styleEnabled = (shadowEnabled || outlineEnabled || backgroundEnabled || markupProcessorEnabled);
573 const bool isOverlayStyle = underlineEnabled || strikethroughEnabled;
575 AddRenderer(control, relayoutSize, hasMultipleTextColors, containsColorGlyph, styleEnabled, isOverlayStyle);
577 // Text rendered and ready to display
578 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
583 void TextVisual::AddTexture(TextureSet& textureSet, PixelData& data, Sampler& sampler, unsigned int textureSetIndex)
585 Texture texture = Texture::New(Dali::TextureType::TEXTURE_2D,
586 data.GetPixelFormat(),
589 texture.Upload(data);
591 textureSet.SetTexture(textureSetIndex, texture);
592 textureSet.SetSampler(textureSetIndex, sampler);
595 PixelData TextVisual::ConvertToPixelData(unsigned char* buffer, int width, int height, int offsetPosition, const Pixel::Format textPixelFormat)
597 int bpp = Pixel::GetBytesPerPixel(textPixelFormat);
598 unsigned int bufferSize = width * height * bpp;
599 unsigned char* dstBuffer = static_cast<unsigned char*>(malloc(bufferSize));
600 memcpy(dstBuffer, buffer + offsetPosition * bpp, bufferSize);
601 PixelData pixelData = Dali::PixelData::New(dstBuffer,
606 Dali::PixelData::FREE);
610 void TextVisual::CreateTextureSet(TilingInfo& info, VisualRenderer& renderer, Sampler& sampler)
612 TextureSet textureSet = TextureSet::New();
613 unsigned int textureSetIndex = 0u;
615 // Convert the buffer to pixel data to make it a texture.
619 PixelData data = ConvertToPixelData(info.textBuffer, info.width, info.height, info.offsetPosition, info.textPixelFormat);
620 AddTexture(textureSet, data, sampler, textureSetIndex);
624 if(mTextShaderFeatureCache.IsEnabledStyle() && info.styleBuffer)
626 PixelData styleData = ConvertToPixelData(info.styleBuffer, info.width, info.height, info.offsetPosition, Pixel::RGBA8888);
627 AddTexture(textureSet, styleData, sampler, textureSetIndex);
631 if(mTextShaderFeatureCache.IsEnabledOverlay() && info.overlayStyleBuffer)
633 PixelData overlayStyleData = ConvertToPixelData(info.overlayStyleBuffer, info.width, info.height, info.offsetPosition, Pixel::RGBA8888);
634 AddTexture(textureSet, overlayStyleData, sampler, textureSetIndex);
638 if(mTextShaderFeatureCache.IsEnabledEmoji() && !mTextShaderFeatureCache.IsEnabledMultiColor() && info.maskBuffer)
640 PixelData maskData = ConvertToPixelData(info.maskBuffer, info.width, info.height, info.offsetPosition, Pixel::L8);
641 AddTexture(textureSet, maskData, sampler, textureSetIndex);
644 renderer.SetTextures(textureSet);
646 //Register transform properties
647 mImpl->mTransform.SetUniforms(renderer, Direction::LEFT_TO_RIGHT);
649 // Enable the pre-multiplied alpha to improve the text quality
650 renderer.SetProperty(Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, true);
651 renderer.RegisterProperty(PREMULTIPLIED_ALPHA, 1.0f);
653 // Set size and offset for the tiling.
654 renderer.SetProperty(VisualRenderer::Property::TRANSFORM_SIZE, Vector2(info.width, info.height));
655 renderer.SetProperty(VisualRenderer::Property::TRANSFORM_OFFSET, Vector2(info.offSet.x, info.offSet.y));
656 renderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::ON);
657 renderer.RegisterProperty("uHasMultipleTextColors", static_cast<float>(mTextShaderFeatureCache.IsEnabledMultiColor()));
659 mRendererList.push_back(renderer);
662 void TextVisual::AddRenderer(Actor& actor, const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle)
664 Shader shader = GetTextShader(mFactoryCache, TextVisualShaderFeature::FeatureBuilder().EnableMultiColor(hasMultipleTextColors).EnableEmoji(containsColorGlyph).EnableStyle(styleEnabled).EnableOverlay(isOverlayStyle));
665 mImpl->mRenderer.SetShader(shader);
667 // Get the maximum size.
668 const int maxTextureSize = Dali::GetMaxTextureSize();
670 // No tiling required. Use the default renderer.
671 if(size.height < maxTextureSize)
673 TextureSet textureSet = GetTextTexture(size);
675 mImpl->mRenderer.SetTextures(textureSet);
676 //Register transform properties
677 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
678 mImpl->mRenderer.RegisterProperty("uHasMultipleTextColors", static_cast<float>(hasMultipleTextColors));
679 mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::ON);
681 mRendererList.push_back(mImpl->mRenderer);
683 // If the pixel data exceeds the maximum size, tiling is required.
686 // Filter mode needs to be set to linear to produce better quality while scaling.
687 Sampler sampler = Sampler::New();
688 sampler.SetFilterMode(FilterMode::LINEAR, FilterMode::LINEAR);
690 // Create RGBA texture if the text contains emojis or multiple text colors, otherwise L8 texture
691 Pixel::Format textPixelFormat = (containsColorGlyph || hasMultipleTextColors) ? Pixel::RGBA8888 : Pixel::L8;
693 // Check the text direction
694 Toolkit::DevelText::TextDirection::Type textDirection = mController->GetTextDirection();
696 // Create a texture for the text without any styles
697 PixelData data = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_NO_STYLES, false, textPixelFormat);
699 int verifiedWidth = data.GetWidth();
700 int verifiedHeight = data.GetHeight();
702 // Set information for creating textures.
703 TilingInfo info(verifiedWidth, maxTextureSize, textPixelFormat);
705 // Get the buffer of text.
706 Dali::DevelPixelData::PixelDataBuffer textPixelData = Dali::DevelPixelData::ReleasePixelDataBuffer(data);
707 info.textBuffer = textPixelData.buffer;
709 if(mTextShaderFeatureCache.IsEnabledStyle())
711 // Create RGBA texture for all the text styles (without the text itself)
712 PixelData styleData = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_NO_TEXT, false, Pixel::RGBA8888);
713 Dali::DevelPixelData::PixelDataBuffer stylePixelData = Dali::DevelPixelData::ReleasePixelDataBuffer(styleData);
714 info.styleBuffer = stylePixelData.buffer;
717 if(mTextShaderFeatureCache.IsEnabledOverlay())
719 // Create RGBA texture for all the overlay styles
720 PixelData overlayStyleData = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_OVERLAY_STYLE, false, Pixel::RGBA8888);
721 Dali::DevelPixelData::PixelDataBuffer overlayStylePixelData = Dali::DevelPixelData::ReleasePixelDataBuffer(overlayStyleData);
722 info.overlayStyleBuffer = overlayStylePixelData.buffer;
725 if(mTextShaderFeatureCache.IsEnabledEmoji() && !mTextShaderFeatureCache.IsEnabledMultiColor())
727 // Create a L8 texture as a mask to avoid color glyphs (e.g. emojis) to be affected by text color animation
728 PixelData maskData = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_MASK, false, Pixel::L8);
729 Dali::DevelPixelData::PixelDataBuffer maskPixelData = Dali::DevelPixelData::ReleasePixelDataBuffer(maskData);
730 info.maskBuffer = maskPixelData.buffer;
733 // Get the current offset for recalculate the offset when tiling.
734 Property::Map retMap;
735 mImpl->mTransform.GetPropertyMap(retMap);
736 Property::Value* offsetValue = retMap.Find(Dali::Toolkit::Visual::Transform::Property::OFFSET);
739 offsetValue->Get(info.offSet);
742 // Create a textureset in the default renderer.
743 CreateTextureSet(info, mImpl->mRenderer, sampler);
745 verifiedHeight -= maxTextureSize;
747 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
749 int offsetPosition = verifiedWidth * maxTextureSize;
750 // Create a renderer by cutting maxTextureSize.
751 while(verifiedHeight > 0)
753 VisualRenderer tilingRenderer = VisualRenderer::New(geometry, shader);
754 tilingRenderer.SetProperty(Dali::Renderer::Property::DEPTH_INDEX, Toolkit::DepthIndex::CONTENT);
755 // New offset position of buffer for tiling.
756 info.offsetPosition += offsetPosition;
757 // New height for tiling.
758 info.height = (verifiedHeight - maxTextureSize) > 0 ? maxTextureSize : verifiedHeight;
759 // New offset for tiling.
760 info.offSet.y += maxTextureSize;
761 // Create a textureset int the new tiling renderer.
762 CreateTextureSet(info, tilingRenderer, sampler);
764 verifiedHeight -= maxTextureSize;
768 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
770 const Vector4& defaultColor = mController->GetTextModel()->GetDefaultColor();
772 for(RendererContainer::iterator iter = mRendererList.begin(); iter != mRendererList.end(); ++iter)
774 Renderer renderer = (*iter);
777 actor.AddRenderer(renderer);
779 if(renderer != mImpl->mRenderer)
781 // Set constraint for text label's color for non-default renderers.
782 if(mAnimatableTextColorPropertyIndex != Property::INVALID_INDEX)
784 // Register unique property, or get property for default renderer.
785 Property::Index index = renderer.RegisterUniqueProperty("uTextColorAnimatable", defaultColor);
787 // Create constraint for the animatable text's color Property with uTextColorAnimatable in the renderer.
788 if(index != Property::INVALID_INDEX)
790 Constraint colorConstraint = Constraint::New<Vector4>(renderer, index, TextColorConstraint);
791 colorConstraint.AddSource(Source(actor, mAnimatableTextColorPropertyIndex));
792 colorConstraint.Apply();
795 // Make zero if the alpha value of text color is zero to skip rendering text
796 // VisualRenderer::Property::OPACITY uses same animatable property internally.
797 Constraint opacityConstraint = Constraint::New<float>(renderer, Dali::DevelRenderer::Property::OPACITY, OpacityConstraint);
798 opacityConstraint.AddSource(Source(actor, mAnimatableTextColorPropertyIndex));
799 opacityConstraint.Apply();
806 TextureSet TextVisual::GetTextTexture(const Vector2& size)
808 // Filter mode needs to be set to linear to produce better quality while scaling.
809 Sampler sampler = Sampler::New();
810 sampler.SetFilterMode(FilterMode::LINEAR, FilterMode::LINEAR);
812 TextureSet textureSet = TextureSet::New();
814 // Create RGBA texture if the text contains emojis or multiple text colors, otherwise L8 texture
815 Pixel::Format textPixelFormat = (mTextShaderFeatureCache.IsEnabledEmoji() || mTextShaderFeatureCache.IsEnabledMultiColor()) ? Pixel::RGBA8888 : Pixel::L8;
817 // Check the text direction
818 Toolkit::DevelText::TextDirection::Type textDirection = mController->GetTextDirection();
820 // Create a texture for the text without any styles
821 PixelData data = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_NO_STYLES, false, textPixelFormat);
823 // It may happen the image atlas can't handle a pixel data it exceeds the maximum size.
824 // In that case, create a texture. TODO: should tile the text.
825 unsigned int textureSetIndex = 0u;
826 AddTexture(textureSet, data, sampler, textureSetIndex);
829 if(mTextShaderFeatureCache.IsEnabledStyle())
831 // Create RGBA texture for all the text styles that render in the background (without the text itself)
832 PixelData styleData = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_NO_TEXT, false, Pixel::RGBA8888);
833 AddTexture(textureSet, styleData, sampler, textureSetIndex);
837 if(mTextShaderFeatureCache.IsEnabledOverlay())
839 // Create RGBA texture for overlay styles such as underline and strikethrough (without the text itself)
840 PixelData overlayStyleData = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_OVERLAY_STYLE, false, Pixel::RGBA8888);
841 AddTexture(textureSet, overlayStyleData, sampler, textureSetIndex);
845 if(mTextShaderFeatureCache.IsEnabledEmoji() && !mTextShaderFeatureCache.IsEnabledMultiColor())
847 // Create a L8 texture as a mask to avoid color glyphs (e.g. emojis) to be affected by text color animation
848 PixelData maskData = mTypesetter->Render(size, textDirection, Text::Typesetter::RENDER_MASK, false, Pixel::L8);
850 AddTexture(textureSet, maskData, sampler, textureSetIndex);
856 Shader TextVisual::GetTextShader(VisualFactoryCache& factoryCache, const TextVisualShaderFeature::FeatureBuilder& featureBuilder)
858 // Cache feature builder informations.
859 mTextShaderFeatureCache = featureBuilder;
861 Shader shader = mTextVisualShaderFactory.GetShader(factoryCache, mTextShaderFeatureCache);
862 shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
866 } // namespace Internal
868 } // namespace Toolkit