2 * Copyright (c) 2018 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/public-api/animation/constraints.h>
23 #include <dali/devel-api/rendering/renderer-devel.h>
24 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
27 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
28 #include <dali-toolkit/devel-api/visuals/text-visual-properties-devel.h>
29 #include <dali-toolkit/public-api/visuals/visual-properties.h>
30 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
31 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
32 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
33 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
34 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
35 #include <dali-toolkit/internal/text/text-font-style.h>
36 #include <dali-toolkit/internal/text/text-effects-style.h>
37 #include <dali-toolkit/internal/text/script-run.h>
38 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
39 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
53 // Property names - common properties defined in visual-string-constants.h/cpp
54 const char * const FONT_FAMILY_PROPERTY( "fontFamily" );
55 const char * const FONT_STYLE_PROPERTY( "fontStyle" );
56 const char * const POINT_SIZE_PROPERTY( "pointSize" );
57 const char * const MULTI_LINE_PROPERTY( "multiLine" );
58 const char * const HORIZONTAL_ALIGNMENT_PROPERTY( "horizontalAlignment" );
59 const char * const VERTICAL_ALIGNMENT_PROPERTY( "verticalAlignment" );
60 const char * const TEXT_COLOR_PROPERTY( "textColor" );
61 const char * const ENABLE_MARKUP_PROPERTY( "enableMarkup" );
62 const char * const SHADOW_PROPERTY( "shadow" );
63 const char * const UNDERLINE_PROPERTY( "underline" );
64 const char * const OUTLINE_PROPERTY( "outline" );
65 const char * const BACKGROUND_PROPERTY( "textBackground" );
67 const Vector4 FULL_TEXTURE_RECT( 0.f, 0.f, 1.f, 1.f );
69 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
70 attribute mediump vec2 aPosition;\n
71 uniform mediump mat4 uMvpMatrix;\n
72 uniform mediump vec3 uSize;\n
73 uniform mediump vec4 pixelArea;\n
75 uniform mediump mat4 uModelMatrix;\n
76 uniform mediump mat4 uViewMatrix;\n
77 uniform mediump mat4 uProjection;\n
79 varying mediump vec2 vTexCoord;\n
81 //Visual size and offset
82 uniform mediump vec2 offset;\n
83 uniform mediump vec2 size;\n
84 uniform mediump vec4 offsetSizeMode;\n
85 uniform mediump vec2 origin;\n
86 uniform mediump vec2 anchorPoint;\n
88 vec4 ComputeVertexPosition()\n
90 vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
91 vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
92 return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
97 mediump vec4 nonAlignedVertex = uViewMatrix*uModelMatrix*ComputeVertexPosition();\n
98 mediump vec4 pixelAlignedVertex = vec4 ( floor(nonAlignedVertex.xyz), 1.0 );\n
99 mediump vec4 vertexPosition = uProjection*pixelAlignedVertex;\n
101 vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
102 gl_Position = vertexPosition;\n
106 const char* FRAGMENT_SHADER_SINGLE_COLOR_TEXT = DALI_COMPOSE_SHADER(
107 varying mediump vec2 vTexCoord;\n
108 uniform sampler2D sTexture;\n
109 uniform lowp vec4 uTextColorAnimatable;\n
110 uniform mediump vec4 uAtlasRect;\n
111 uniform lowp vec4 uColor;\n
112 uniform lowp vec3 mixColor;\n
113 uniform lowp float preMultipliedAlpha;\n
117 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
118 mediump float textTexture = texture2D( sTexture, texCoord ).r;\n
120 // Set the color of the text to what it is animated to.
121 gl_FragColor = uTextColorAnimatable * textTexture * uColor * vec4( mixColor, 1.0 );
125 const char* FRAGMENT_SHADER_MULTI_COLOR_TEXT = DALI_COMPOSE_SHADER(
126 varying mediump vec2 vTexCoord;\n
127 uniform sampler2D sTexture;\n
128 uniform mediump vec4 uAtlasRect;\n
129 uniform lowp vec4 uColor;\n
130 uniform lowp vec3 mixColor;\n
131 uniform lowp float preMultipliedAlpha;\n
135 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
136 mediump vec4 textTexture = texture2D( sTexture, texCoord );\n
137 textTexture.rgb *= mix( 1.0, textTexture.a, preMultipliedAlpha );\n
139 gl_FragColor = textTexture * uColor * vec4( mixColor, 1.0 );
143 const char* FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE = DALI_COMPOSE_SHADER(
144 varying mediump vec2 vTexCoord;\n
145 uniform sampler2D sTexture;\n
146 uniform sampler2D sStyle;\n
147 uniform lowp vec4 uTextColorAnimatable;\n
148 uniform mediump vec4 uAtlasRect;\n
149 uniform lowp vec4 uColor;\n
150 uniform lowp vec3 mixColor;\n
151 uniform lowp float preMultipliedAlpha;\n
155 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
156 mediump float textTexture = texture2D( sTexture, texCoord ).r;\n
157 mediump vec4 styleTexture = texture2D( sStyle, texCoord );\n
159 // Draw the text as overlay above the style
160 gl_FragColor = ( uTextColorAnimatable * textTexture + styleTexture * ( 1.0 - textTexture ) ) * uColor * vec4( mixColor, 1.0 );\n
164 const char* FRAGMENT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE = DALI_COMPOSE_SHADER(
165 varying mediump vec2 vTexCoord;\n
166 uniform sampler2D sTexture;\n
167 uniform sampler2D sStyle;\n
168 uniform mediump vec4 uAtlasRect;\n
169 uniform lowp vec4 uColor;\n
170 uniform lowp vec3 mixColor;\n
171 uniform lowp float preMultipliedAlpha;\n
175 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
176 mediump vec4 textTexture = texture2D( sTexture, texCoord );\n
177 mediump vec4 styleTexture = texture2D( sStyle, texCoord );\n
178 textTexture.rgb *= mix( 1.0, textTexture.a, preMultipliedAlpha );\n
180 // Draw the text as overlay above the style
181 gl_FragColor = ( textTexture + styleTexture * ( 1.0 - textTexture.a ) ) * uColor * vec4( mixColor, 1.0 );\n
185 const char* FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI = DALI_COMPOSE_SHADER(
186 varying mediump vec2 vTexCoord;\n
187 uniform sampler2D sTexture;\n
188 uniform sampler2D sMask;\n
189 uniform lowp vec4 uTextColorAnimatable;\n
190 uniform mediump vec4 uAtlasRect;\n
191 uniform lowp vec4 uColor;\n
192 uniform lowp vec3 mixColor;\n
193 uniform lowp float preMultipliedAlpha;\n
197 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
198 mediump vec4 textTexture = texture2D( sTexture, texCoord );\n
199 mediump float maskTexture = texture2D( sMask, texCoord ).r;\n
201 // Set the color of non-transparent pixel in text to what it is animated to.
202 // Markup text with multiple text colors are not animated (but can be supported later on if required).
203 // Emoji color are not animated.
204 mediump float vstep = step( 0.0001, textTexture.a );\n
205 textTexture.rgb = mix( textTexture.rgb, uTextColorAnimatable.rgb, vstep * maskTexture ) * mix( 1.0, textTexture.a, preMultipliedAlpha );\n
207 // Draw the text as overlay above the style
208 gl_FragColor = textTexture * uColor * vec4( mixColor, 1.0 );\n
212 const char* FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI = DALI_COMPOSE_SHADER(
213 varying mediump vec2 vTexCoord;\n
214 uniform sampler2D sTexture;\n
215 uniform sampler2D sStyle;\n
216 uniform sampler2D sMask;\n
217 uniform lowp float uHasMultipleTextColors;\n
218 uniform lowp vec4 uTextColorAnimatable;\n
219 uniform mediump vec4 uAtlasRect;\n
220 uniform lowp vec4 uColor;\n
221 uniform lowp vec3 mixColor;\n
222 uniform lowp float preMultipliedAlpha;\n
226 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
227 mediump vec4 textTexture = texture2D( sTexture, texCoord );\n
228 mediump vec4 styleTexture = texture2D( sStyle, texCoord );\n
229 mediump float maskTexture = texture2D( sMask, texCoord ).r;\n
231 // Set the color of non-transparent pixel in text to what it is animated to.
232 // Markup text with multiple text colors are not animated (but can be supported later on if required).
233 // Emoji color are not animated.
234 mediump float vstep = step( 0.0001, textTexture.a );\n
235 textTexture.rgb = mix( textTexture.rgb, uTextColorAnimatable.rgb, vstep * maskTexture * ( 1.0 - uHasMultipleTextColors ) ) * mix( 1.0, textTexture.a, preMultipliedAlpha );\n
237 // Draw the text as overlay above the style
238 gl_FragColor = ( textTexture + styleTexture * ( 1.0 - textTexture.a ) ) * uColor * vec4( mixColor, 1.0 );\n
243 * Return Property index for the given string key
244 * param[in] stringKey the string index key
245 * return the key as an index
248 Dali::Property::Index StringKeyToIndexKey( const std::string& stringKey )
250 Dali::Property::Index result = Property::INVALID_KEY;
252 if( stringKey == VISUAL_TYPE )
254 result = Toolkit::Visual::Property::TYPE;
256 else if( stringKey == TEXT_PROPERTY )
258 result = Toolkit::TextVisual::Property::TEXT;
260 else if( stringKey == FONT_FAMILY_PROPERTY )
262 result = Toolkit::TextVisual::Property::FONT_FAMILY;
264 else if( stringKey == FONT_STYLE_PROPERTY )
266 result = Toolkit::TextVisual::Property::FONT_STYLE;
268 else if( stringKey == POINT_SIZE_PROPERTY )
270 result = Toolkit::TextVisual::Property::POINT_SIZE;
272 else if( stringKey == MULTI_LINE_PROPERTY )
274 result = Toolkit::TextVisual::Property::MULTI_LINE;
276 else if( stringKey == HORIZONTAL_ALIGNMENT_PROPERTY )
278 result = Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT;
280 else if( stringKey == VERTICAL_ALIGNMENT_PROPERTY )
282 result = Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT;
284 else if( stringKey == TEXT_COLOR_PROPERTY )
286 result = Toolkit::TextVisual::Property::TEXT_COLOR;
288 else if( stringKey == ENABLE_MARKUP_PROPERTY )
290 result = Toolkit::TextVisual::Property::ENABLE_MARKUP;
292 else if( stringKey == SHADOW_PROPERTY )
294 result = Toolkit::TextVisual::Property::SHADOW;
296 else if( stringKey == UNDERLINE_PROPERTY )
298 result = Toolkit::TextVisual::Property::UNDERLINE;
300 else if( stringKey == OUTLINE_PROPERTY )
302 result = Toolkit::DevelTextVisual::Property::OUTLINE;
304 else if( stringKey == BACKGROUND_PROPERTY )
306 result = Toolkit::DevelTextVisual::Property::BACKGROUND;
312 void OpacityConstraint( float& current, const PropertyInputContainer& inputs )
314 current = inputs[0]->GetVector4().a;
317 } // unnamed namespace
319 TextVisualPtr TextVisual::New( VisualFactoryCache& factoryCache, const Property::Map& properties )
321 TextVisualPtr TextVisualPtr( new TextVisual( factoryCache ) );
322 TextVisualPtr->SetProperties( properties );
323 return TextVisualPtr;
326 void TextVisual::ConvertStringKeysToIndexKeys( Property::Map& propertyMap )
328 Property::Map outMap;
330 for( Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index )
332 const KeyValuePair& keyValue = propertyMap.GetKeyValue( index );
334 Property::Index indexKey = keyValue.first.indexKey;
336 if ( keyValue.first.type == Property::Key::STRING )
338 indexKey = StringKeyToIndexKey( keyValue.first.stringKey );
341 outMap.Insert( indexKey, keyValue.second );
344 propertyMap = outMap;
347 float TextVisual::GetHeightForWidth( float width )
349 return mController->GetHeightForWidth( width );
352 void TextVisual::GetNaturalSize( Vector2& naturalSize )
354 naturalSize = mController->GetNaturalSize().GetVectorXY();
357 void TextVisual::DoCreatePropertyMap( Property::Map& map ) const
359 Property::Value value;
362 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT );
365 mController->GetText( text );
366 map.Insert( Toolkit::TextVisual::Property::TEXT, text );
368 map.Insert( Toolkit::TextVisual::Property::FONT_FAMILY, mController->GetDefaultFontFamily() );
370 GetFontStyleProperty( mController, value, Text::FontStyle::DEFAULT );
371 map.Insert( Toolkit::TextVisual::Property::FONT_STYLE, value );
373 map.Insert( Toolkit::TextVisual::Property::POINT_SIZE, mController->GetDefaultFontSize( Text::Controller::POINT_SIZE ) );
375 map.Insert( Toolkit::TextVisual::Property::MULTI_LINE, mController->IsMultiLineEnabled() );
377 map.Insert( Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT, mController->GetHorizontalAlignment() );
379 map.Insert( Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT, mController->GetVerticalAlignment() );
381 map.Insert( Toolkit::TextVisual::Property::TEXT_COLOR, mController->GetDefaultColor() );
383 map.Insert( Toolkit::TextVisual::Property::ENABLE_MARKUP, mController->IsMarkupProcessorEnabled() );
385 GetShadowProperties( mController, value, Text::EffectStyle::DEFAULT );
386 map.Insert( Toolkit::TextVisual::Property::SHADOW, value );
388 GetUnderlineProperties( mController, value, Text::EffectStyle::DEFAULT );
389 map.Insert( Toolkit::TextVisual::Property::UNDERLINE, value );
391 GetOutlineProperties( mController, value, Text::EffectStyle::DEFAULT );
392 map.Insert( Toolkit::DevelTextVisual::Property::OUTLINE, value );
394 GetBackgroundProperties( mController, value, Text::EffectStyle::DEFAULT );
395 map.Insert( Toolkit::DevelTextVisual::Property::BACKGROUND, value );
398 void TextVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
401 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT );
403 mController->GetText( text );
404 map.Insert( Toolkit::TextVisual::Property::TEXT, text );
408 TextVisual::TextVisual( VisualFactoryCache& factoryCache )
409 : Visual::Base( factoryCache, Visual::FittingMode::FIT_KEEP_ASPECT_RATIO ),
410 mController( Text::Controller::New() ),
411 mTypesetter( Text::Typesetter::New( mController->GetTextModel() ) ),
412 mAnimatableTextColorPropertyIndex( Property::INVALID_INDEX ),
413 mRendererUpdateNeeded( false )
417 TextVisual::~TextVisual()
421 void TextVisual::DoSetProperties( const Property::Map& propertyMap )
423 for( Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index )
425 const KeyValuePair& keyValue = propertyMap.GetKeyValue( index );
427 Property::Index indexKey = keyValue.first.indexKey;
429 if( keyValue.first.type == Property::Key::STRING )
431 indexKey = StringKeyToIndexKey( keyValue.first.stringKey );
434 DoSetProperty( indexKey, keyValue.second );
437 // Elide the text if it exceeds the boundaries.
438 mController->SetTextElideEnabled( true );
440 // Retrieve the layout engine to set the cursor's width.
441 Text::Layout::Engine& engine = mController->GetLayoutEngine();
443 // Sets 0 as cursor's width.
444 engine.SetCursorWidth( 0u ); // Do not layout space for the cursor.
447 void TextVisual::DoSetOnStage( Actor& actor )
451 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
452 Shader shader = GetTextShader(mFactoryCache, TextType::SINGLE_COLOR_TEXT, TextType::NO_EMOJI, TextType::NO_STYLES);
454 mImpl->mRenderer = Renderer::New( geometry, shader );
455 mImpl->mRenderer.SetProperty( Dali::Renderer::Property::DEPTH_INDEX, Toolkit::DepthIndex::CONTENT );
457 // Enable the pre-multiplied alpha to improve the text quality
458 EnablePreMultipliedAlpha(true);
460 const Vector4& defaultColor = mController->GetTextModel()->GetDefaultColor();
461 Dali::Property::Index shaderTextColorIndex = mImpl->mRenderer.RegisterProperty( "uTextColorAnimatable", defaultColor );
463 if ( mAnimatableTextColorPropertyIndex != Property::INVALID_INDEX )
465 // Create constraint for the animatable text's color Property with uTextColorAnimatable in the renderer.
466 if( shaderTextColorIndex != Property::INVALID_INDEX )
468 Constraint colorConstraint = Constraint::New<Vector4>( mImpl->mRenderer, shaderTextColorIndex, EqualToConstraint() );
469 colorConstraint.AddSource( Source( actor, mAnimatableTextColorPropertyIndex ) );
470 colorConstraint.Apply();
472 Constraint opacityConstraint = Constraint::New< float >( mImpl->mRenderer, Dali::DevelRenderer::Property::OPACITY, OpacityConstraint );
473 opacityConstraint.AddSource( Source( actor, mAnimatableTextColorPropertyIndex ) );
474 opacityConstraint.Apply();
478 // Renderer needs textures and to be added to control
479 mRendererUpdateNeeded = true;
484 void TextVisual::DoSetOffStage( Actor& actor )
486 if( mImpl->mRenderer )
488 // Removes the renderer from the actor.
489 actor.RemoveRenderer( mImpl->mRenderer );
493 // Resets the renderer.
494 mImpl->mRenderer.Reset();
497 // Resets the control handle.
501 void TextVisual::OnSetTransform()
506 void TextVisual::DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue )
510 case Toolkit::TextVisual::Property::ENABLE_MARKUP:
512 const bool enableMarkup = propertyValue.Get<bool>();
513 mController->SetMarkupProcessorEnabled( enableMarkup );
516 case Toolkit::TextVisual::Property::TEXT:
518 mController->SetText( propertyValue.Get<std::string>() );
521 case Toolkit::TextVisual::Property::FONT_FAMILY:
523 SetFontFamilyProperty( mController, propertyValue );
526 case Toolkit::TextVisual::Property::FONT_STYLE:
528 SetFontStyleProperty( mController, propertyValue, Text::FontStyle::DEFAULT );
531 case Toolkit::TextVisual::Property::POINT_SIZE:
533 const float pointSize = propertyValue.Get<float>();
534 if( !Equals( mController->GetDefaultFontSize( Text::Controller::POINT_SIZE ), pointSize ) )
536 mController->SetDefaultFontSize( pointSize, Text::Controller::POINT_SIZE );
540 case Toolkit::TextVisual::Property::MULTI_LINE:
542 mController->SetMultiLineEnabled( propertyValue.Get<bool>() );
545 case Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT:
549 Text::HorizontalAlignment::Type alignment( static_cast< Text::HorizontalAlignment::Type >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
550 if( Toolkit::Text::GetHorizontalAlignmentEnumeration( propertyValue, alignment ) )
552 mController->SetHorizontalAlignment( alignment );
557 case Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT:
561 Toolkit::Text::VerticalAlignment::Type alignment( static_cast< Text::VerticalAlignment::Type >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
562 if( Toolkit::Text::GetVerticalAlignmentEnumeration( propertyValue, alignment) )
564 mController->SetVerticalAlignment( alignment );
569 case Toolkit::TextVisual::Property::TEXT_COLOR:
571 const Vector4& textColor = propertyValue.Get< Vector4 >();
572 if( mController->GetDefaultColor() != textColor )
574 mController->SetDefaultColor( textColor );
578 case Toolkit::TextVisual::Property::SHADOW:
580 SetShadowProperties( mController, propertyValue, Text::EffectStyle::DEFAULT );
583 case Toolkit::TextVisual::Property::UNDERLINE:
585 SetUnderlineProperties( mController, propertyValue, Text::EffectStyle::DEFAULT );
588 case Toolkit::DevelTextVisual::Property::OUTLINE:
590 SetOutlineProperties( mController, propertyValue, Text::EffectStyle::DEFAULT );
593 case Toolkit::DevelTextVisual::Property::BACKGROUND:
595 SetBackgroundProperties( mController, propertyValue, Text::EffectStyle::DEFAULT );
601 void TextVisual::UpdateRenderer()
603 Actor control = mControl.GetHandle();
610 // Calculates the size to be used to relayout.
611 Vector2 relayoutSize;
613 const bool isWidthRelative = fabsf( mImpl->mTransform.mOffsetSizeMode.z ) < Math::MACHINE_EPSILON_1000;
614 const bool isHeightRelative = fabsf( mImpl->mTransform.mOffsetSizeMode.w ) < Math::MACHINE_EPSILON_1000;
616 // Round the size and offset to avoid pixel alignement issues.
617 relayoutSize.width = floorf( 0.5f + ( isWidthRelative ? mImpl->mControlSize.width * mImpl->mTransform.mSize.x : mImpl->mTransform.mSize.width ) );
618 relayoutSize.height = floorf( 0.5f + ( isHeightRelative ? mImpl->mControlSize.height * mImpl->mTransform.mSize.y : mImpl->mTransform.mSize.height ) );
621 mController->GetText( text );
623 if( ( fabsf( relayoutSize.width ) < Math::MACHINE_EPSILON_1000 ) || ( fabsf( relayoutSize.height ) < Math::MACHINE_EPSILON_1000 ) || text.empty() )
625 // Removes the texture set.
628 // Remove any renderer previously set.
629 if( mImpl->mRenderer )
631 control.RemoveRenderer( mImpl->mRenderer );
634 // Nothing else to do if the relayout size is zero.
635 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
639 const Text::Controller::UpdateTextType updateTextType = mController->Relayout( relayoutSize );
641 if( Text::Controller::NONE_UPDATED != ( Text::Controller::MODEL_UPDATED & updateTextType )
642 || mRendererUpdateNeeded )
644 mRendererUpdateNeeded = false;
646 // Removes the texture set.
649 // Remove any renderer previously set.
650 if( mImpl->mRenderer )
652 control.RemoveRenderer( mImpl->mRenderer );
655 if( ( relayoutSize.width > Math::MACHINE_EPSILON_1000 ) &&
656 ( relayoutSize.height > Math::MACHINE_EPSILON_1000 ) )
658 // Check whether it is a markup text with multiple text colors
659 const Vector4* const colorsBuffer = mController->GetTextModel()->GetColors();
660 bool hasMultipleTextColors = ( NULL != colorsBuffer );
662 // Check whether the text contains any color glyph
663 bool containsColorGlyph = false;
665 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
666 const Text::GlyphInfo* const glyphsBuffer = mController->GetTextModel()->GetGlyphs();
667 const Text::Length numberOfGlyphs = mController->GetTextModel()->GetNumberOfGlyphs();
668 for ( Text::Length glyphIndex = 0; glyphIndex < numberOfGlyphs; glyphIndex++ )
670 // Retrieve the glyph's info.
671 const Text::GlyphInfo* const glyphInfo = glyphsBuffer + glyphIndex;
673 // Whether the current glyph is a color one.
674 if( fontClient.IsColorGlyph( glyphInfo->fontId, glyphInfo->index ) )
676 containsColorGlyph = true;
681 // Check whether the text contains any style colors (e.g. underline color, shadow color, etc.)
683 bool shadowEnabled = false;
684 const Vector2& shadowOffset = mController->GetTextModel()->GetShadowOffset();
685 if ( fabsf( shadowOffset.x ) > Math::MACHINE_EPSILON_1 || fabsf( shadowOffset.y ) > Math::MACHINE_EPSILON_1 )
687 shadowEnabled = true;
690 const bool underlineEnabled = mController->GetTextModel()->IsUnderlineEnabled();
691 const bool outlineEnabled = ( mController->GetTextModel()->GetOutlineWidth() > Math::MACHINE_EPSILON_1 );
692 const bool backgroundEnabled = mController->GetTextModel()->IsBackgroundEnabled();;
694 const bool styleEnabled = ( shadowEnabled || underlineEnabled || outlineEnabled || backgroundEnabled );
696 TextureSet textureSet = GetTextTexture( relayoutSize, hasMultipleTextColors, containsColorGlyph, styleEnabled );
697 mImpl->mRenderer.SetTextures( textureSet );
699 Shader shader = GetTextShader( mFactoryCache, hasMultipleTextColors, containsColorGlyph, styleEnabled );
700 mImpl->mRenderer.SetShader(shader);
702 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
704 Vector4 atlasRect = FULL_TEXTURE_RECT;
705 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
706 mImpl->mRenderer.RegisterProperty( "uHasMultipleTextColors", static_cast<float>( hasMultipleTextColors ) );
708 mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON);
710 //Register transform properties
711 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
713 control.AddRenderer( mImpl->mRenderer );
715 // Text rendered and ready to display
716 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
721 void TextVisual::RemoveTextureSet()
723 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED )
725 // Removes the text's image from the texture atlas.
728 const Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
729 if( index != Property::INVALID_INDEX )
731 const Property::Value& atlasRectValue = mImpl->mRenderer.GetProperty( index );
732 atlasRectValue.Get( atlasRect );
734 const TextureSet& textureSet = mImpl->mRenderer.GetTextures();
735 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
740 TextureSet TextVisual::GetTextTexture( const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled )
742 // Filter mode needs to be set to linear to produce better quality while scaling.
743 Sampler sampler = Sampler::New();
744 sampler.SetFilterMode( FilterMode::LINEAR, FilterMode::LINEAR );
746 TextureSet textureSet = TextureSet::New();
748 // Create RGBA texture if the text contains emojis or multiple text colors, otherwise L8 texture
749 Pixel::Format textPixelFormat = ( containsColorGlyph || hasMultipleTextColors ) ? Pixel::RGBA8888 : Pixel::L8;
751 // Check the text direction
752 Toolkit::DevelText::TextDirection::Type textDirection = mController->GetTextDirection();
754 // Create a texture for the text without any styles
755 PixelData data = mTypesetter->Render( size, textDirection, Text::Typesetter::RENDER_NO_STYLES, false, textPixelFormat );
757 // It may happen the image atlas can't handle a pixel data it exceeds the maximum size.
758 // In that case, create a texture. TODO: should tile the text.
760 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D,
761 data.GetPixelFormat(),
765 texture.Upload( data );
767 textureSet.SetTexture( 0u, texture );
768 textureSet.SetSampler( 0u, sampler );
772 // Create RGBA texture for all the text styles (without the text itself)
773 PixelData styleData = mTypesetter->Render( size, textDirection, Text::Typesetter::RENDER_NO_TEXT, false, Pixel::RGBA8888 );
775 Texture styleTexture = Texture::New( Dali::TextureType::TEXTURE_2D,
776 styleData.GetPixelFormat(),
777 styleData.GetWidth(),
778 styleData.GetHeight() );
780 styleTexture.Upload( styleData );
782 textureSet.SetTexture( 1u, styleTexture );
783 textureSet.SetSampler( 1u, sampler );
786 if ( containsColorGlyph && !hasMultipleTextColors )
788 // Create a L8 texture as a mask to avoid color glyphs (e.g. emojis) to be affected by text color animation
789 PixelData maskData = mTypesetter->Render( size, textDirection, Text::Typesetter::RENDER_MASK, false, Pixel::L8 );
791 Texture maskTexture = Texture::New( Dali::TextureType::TEXTURE_2D,
792 maskData.GetPixelFormat(),
794 maskData.GetHeight() );
796 maskTexture.Upload( maskData );
800 textureSet.SetTexture( 1u, maskTexture );
801 textureSet.SetSampler( 1u, sampler );
805 textureSet.SetTexture( 2u, maskTexture );
806 textureSet.SetSampler( 2u, sampler );
813 Shader TextVisual::GetTextShader( VisualFactoryCache& factoryCache, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled )
817 if( hasMultipleTextColors && !styleEnabled )
819 // We don't animate text color if the text contains multiple colors
820 shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_MULTI_COLOR_TEXT );
823 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_MULTI_COLOR_TEXT );
824 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
825 factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_MULTI_COLOR_TEXT, shader );
828 else if( hasMultipleTextColors && styleEnabled )
830 // We don't animate text color if the text contains multiple colors
831 shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE );
834 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE );
835 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
836 factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE, shader );
839 else if( !hasMultipleTextColors && !containsColorGlyph && !styleEnabled )
841 shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT );
844 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_SINGLE_COLOR_TEXT );
845 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
846 factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT, shader );
849 else if( !hasMultipleTextColors && !containsColorGlyph && styleEnabled )
851 shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE );
854 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE );
855 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
856 factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE, shader );
859 else if( !hasMultipleTextColors && containsColorGlyph && !styleEnabled )
861 shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI );
864 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI );
865 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
866 factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI, shader );
869 else // if( !hasMultipleTextColors && containsColorGlyph && styleEnabled )
871 shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI );
874 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI );
875 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
876 factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI, shader );
883 } // namespace Internal
885 } // namespace Toolkit