2 * Copyright (c) 2017 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/image/image-visual.h>
22 #include <cstring> // for strlen()
23 #include <dali/public-api/actors/layer.h>
24 #include <dali/public-api/common/stage.h>
25 #include <dali/public-api/images/resource-image.h>
26 #include <dali/public-api/images/native-image.h>
27 #include <dali/devel-api/images/texture-set-image.h>
28 #include <dali/devel-api/adaptor-framework/image-loading.h>
29 #include <dali/devel-api/scripting/enum-helper.h>
30 #include <dali/devel-api/scripting/scripting.h>
31 #include <dali/integration-api/debug.h>
34 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
35 #include <dali-toolkit/public-api/visuals/visual-properties.h>
36 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
37 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
38 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
39 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
40 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
41 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
42 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
43 #include <dali-toolkit/internal/visuals/visual-url.h>
58 const char * const IMAGE_FITTING_MODE( "fittingMode" );
59 const char * const IMAGE_SAMPLING_MODE( "samplingMode" );
60 const char * const IMAGE_DESIRED_WIDTH( "desiredWidth" );
61 const char * const IMAGE_DESIRED_HEIGHT( "desiredHeight" );
62 const char * const SYNCHRONOUS_LOADING( "synchronousLoading" );
63 const char * const IMAGE_ATLASING("atlasing");
64 const char * const ALPHA_MASK_URL("alphaMaskUrl");
67 DALI_ENUM_TO_STRING_TABLE_BEGIN( FITTING_MODE )
68 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SHRINK_TO_FIT )
69 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SCALE_TO_FILL )
70 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_WIDTH )
71 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_HEIGHT )
72 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, DEFAULT )
73 DALI_ENUM_TO_STRING_TABLE_END( FITTING_MODE )
76 DALI_ENUM_TO_STRING_TABLE_BEGIN( SAMPLING_MODE )
77 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX )
78 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NEAREST )
79 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, LINEAR )
80 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_NEAREST )
81 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_LINEAR )
82 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NO_FILTER )
83 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, DONT_CARE )
84 DALI_ENUM_TO_STRING_TABLE_END( SAMPLING_MODE )
87 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
88 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
89 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
90 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
91 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
92 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
94 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
96 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
98 const float PIXEL_ALIGN_ON = 1.0f;
99 const float PIXEL_ALIGN_OFF = 0.0f;
101 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
102 attribute mediump vec2 aPosition;\n
103 uniform mediump mat4 uModelMatrix;\n
104 uniform mediump mat4 uViewMatrix;\n
105 uniform mediump mat4 uProjection;\n
106 uniform mediump vec3 uSize;\n
107 uniform mediump vec4 pixelArea;
108 varying mediump vec2 vTexCoord;\n
109 uniform lowp float uPixelAligned;\n
111 //Visual size and offset
112 uniform mediump vec2 offset;\n
113 uniform mediump vec2 size;\n
114 uniform mediump vec4 offsetSizeMode;\n
115 uniform mediump vec2 origin;\n
116 uniform mediump vec2 anchorPoint;\n
118 vec4 ComputeVertexPosition()\n
120 vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
121 vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
122 return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
127 mediump vec4 vertexPosition = uViewMatrix * uModelMatrix * ComputeVertexPosition();\n
128 vec4 alignedVertexPosition = vertexPosition;\n
129 alignedVertexPosition.xy = floor ( vertexPosition.xy );\n // Pixel alignment
130 vertexPosition = uProjection * mix( vertexPosition, alignedVertexPosition, uPixelAligned );\n
131 vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
132 gl_Position = vertexPosition;\n
136 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
137 varying mediump vec2 vTexCoord;\n
138 uniform sampler2D sTexture;\n
139 uniform lowp vec4 uColor;\n
140 uniform lowp vec3 mixColor;\n
141 uniform lowp float opacity;\n
142 uniform lowp float preMultipliedAlpha;\n
144 lowp vec4 visualMixColor()\n
146 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
150 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * visualMixColor();\n
154 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
155 varying mediump vec2 vTexCoord;\n
156 uniform sampler2D sTexture;\n
157 uniform mediump vec4 uAtlasRect;\n
158 uniform lowp vec4 uColor;\n
159 uniform lowp vec3 mixColor;\n
160 uniform lowp float opacity;\n
161 uniform lowp float preMultipliedAlpha;\n
163 lowp vec4 visualMixColor()\n
165 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
170 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
171 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
175 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
176 varying mediump vec2 vTexCoord;\n
177 uniform sampler2D sTexture;\n
178 uniform mediump vec4 uAtlasRect;\n
179 // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
180 uniform lowp vec2 wrapMode;\n
181 uniform lowp vec4 uColor;\n
182 uniform lowp vec3 mixColor;\n
183 uniform lowp float opacity;\n
184 uniform lowp float preMultipliedAlpha;\n
186 mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
188 mediump float coord;\n
189 if( wrap > 1.5 )\n // REFLECT
190 coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
191 else \n// warp == 0 or 1
192 coord = mix(coordinate, fract( coordinate ), wrap);\n
193 return clamp( mix(range.x, range.y, coord), range.x, range.y );
196 lowp vec4 visualMixColor()\n
198 return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
203 mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
204 wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
205 gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
209 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
213 if( gridSize == ImageDimensions( 1, 1 ) )
215 geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
219 geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
225 } // unnamed namespace
227 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
228 const VisualUrl& imageUrl,
229 const Property::Map& properties,
230 ImageDimensions size,
231 FittingMode::Type fittingMode,
232 Dali::SamplingMode::Type samplingMode )
234 ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
235 imageVisualPtr->SetProperties( properties );
236 return imageVisualPtr;
239 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
240 const VisualUrl& imageUrl,
241 ImageDimensions size,
242 FittingMode::Type fittingMode,
243 Dali::SamplingMode::Type samplingMode )
245 return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
248 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
250 return new ImageVisual( factoryCache, image );
253 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
254 const VisualUrl& imageUrl,
255 ImageDimensions size,
256 FittingMode::Type fittingMode,
257 Dali::SamplingMode::Type samplingMode )
258 : Visual::Base( factoryCache ),
260 mPixelArea( FULL_TEXTURE_RECT ),
262 mImageUrl( imageUrl ),
264 mDesiredSize( size ),
265 mTextureId( TextureManager::INVALID_TEXTURE_ID ),
266 mFittingMode( fittingMode ),
267 mSamplingMode( samplingMode ),
268 mWrapModeU( WrapMode::DEFAULT ),
269 mWrapModeV( WrapMode::DEFAULT ),
270 mAttemptAtlasing( false ),
271 mLoadingStatus( false )
275 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
276 : Visual::Base( factoryCache ),
278 mPixelArea( FULL_TEXTURE_RECT ),
283 mTextureId( TextureManager::INVALID_TEXTURE_ID ),
284 mFittingMode( FittingMode::DEFAULT ),
285 mSamplingMode( SamplingMode::DEFAULT ),
286 mWrapModeU( WrapMode::DEFAULT ),
287 mWrapModeV( WrapMode::DEFAULT ),
288 mAttemptAtlasing( false ),
289 mLoadingStatus( false )
293 ImageVisual::~ImageVisual()
295 if( mMaskingData && Stage::IsInstalled() )
297 // TextureManager could have been deleted before the actor that contains this
298 // ImageVisual is destroyed (e.g. due to stage shutdown). Ensure the stage
299 // is still valid before accessing texture manager.
300 if( mMaskingData->mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID )
302 TextureManager& textureManager = mFactoryCache.GetTextureManager();
303 textureManager.Remove( mMaskingData->mAlphaMaskId );
308 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
310 // Url is already received in constructor
311 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
313 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
314 if( keyValue.first.type == Property::Key::INDEX )
316 DoSetProperty( keyValue.first.indexKey, keyValue.second );
320 if( keyValue.first == IMAGE_FITTING_MODE )
322 DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
324 else if( keyValue.first == IMAGE_SAMPLING_MODE )
326 DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
328 else if( keyValue.first == IMAGE_DESIRED_WIDTH )
330 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
332 else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
334 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
336 else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
338 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
340 else if( keyValue.first == IMAGE_WRAP_MODE_U )
342 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
344 else if( keyValue.first == IMAGE_WRAP_MODE_V )
346 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
348 else if( keyValue.first == SYNCHRONOUS_LOADING )
350 DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
352 else if ( keyValue.first == IMAGE_ATLASING )
354 DoSetProperty( Toolkit::ImageVisual::Property::ATLASING, keyValue.second );
356 else if ( keyValue.first == ALPHA_MASK_URL )
358 DoSetProperty( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
360 else if ( keyValue.first == MASK_CONTENT_SCALE_NAME )
362 DoSetProperty( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second );
364 else if ( keyValue.first == CROP_TO_MASK_NAME )
366 DoSetProperty( Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second );
372 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
376 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
379 if( value.Get( sync ) )
383 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
387 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
392 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
397 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
400 if( value.Get( desiredWidth ) )
402 mDesiredSize.SetWidth( desiredWidth );
406 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
411 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
414 if( value.Get( desiredHeight ) )
416 mDesiredSize.SetHeight( desiredHeight );
420 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
425 case Toolkit::ImageVisual::Property::FITTING_MODE:
428 Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
429 mFittingMode = Dali::FittingMode::Type( fittingMode );
433 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
436 Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
437 mSamplingMode = Dali::SamplingMode::Type( samplingMode );
441 case Toolkit::ImageVisual::Property::PIXEL_AREA:
443 value.Get( mPixelArea );
447 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
450 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
451 mWrapModeU = Dali::WrapMode::Type( wrapMode );
455 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
458 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
459 mWrapModeV = Dali::WrapMode::Type( wrapMode );
463 case Toolkit::ImageVisual::Property::ATLASING:
465 bool atlasing = false;
466 mAttemptAtlasing = value.Get( atlasing );
470 case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
472 std::string alphaUrl;
473 if( value.Get( alphaUrl ) )
476 // Immediately trigger the alpha mask loading (it may just get a cached value)
477 mMaskingData->mAlphaMaskUrl = alphaUrl;
478 TextureManager& textureManager = mFactoryCache.GetTextureManager();
479 mMaskingData->mAlphaMaskId = textureManager.RequestMaskLoad( alphaUrl );
484 case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
487 if( value.Get( scale ) )
490 mMaskingData->mContentScaleFactor = scale;
495 case Toolkit::ImageVisual::Property::CROP_TO_MASK:
498 if( value.Get( crop ) )
501 mMaskingData->mCropToMask = crop;
508 void ImageVisual::AllocateMaskData()
512 mMaskingData.reset(new TextureManager::MaskingData());
516 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
520 naturalSize.x = mImage.GetWidth();
521 naturalSize.y = mImage.GetHeight();
524 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
526 naturalSize.x = mDesiredSize.GetWidth();
527 naturalSize.y = mDesiredSize.GetHeight();
530 else if( mImpl->mRenderer ) // Check if we have a loaded image
532 auto textureSet = mImpl->mRenderer.GetTextures();
536 auto texture = textureSet.GetTexture(0);
537 naturalSize.x = texture.GetWidth();
538 naturalSize.y = texture.GetHeight();
543 if( mMaskingData != NULL && mMaskingData->mAlphaMaskUrl.IsValid() &&
544 mMaskingData->mCropToMask )
546 ImageDimensions dimensions = Dali::GetClosestImageSize( mMaskingData->mAlphaMaskUrl.GetUrl() );
547 if( dimensions != ImageDimensions( 0, 0 ) )
549 naturalSize.x = dimensions.GetWidth();
550 naturalSize.y = dimensions.GetHeight();
554 else if( mImageUrl.IsValid() )
556 if( mImageUrl.GetProtocolType() == VisualUrl::LOCAL )
558 ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
560 if( dimensions != ImageDimensions( 0, 0 ) )
562 naturalSize.x = dimensions.GetWidth();
563 naturalSize.y = dimensions.GetHeight();
567 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
569 naturalSize.x = brokenImage.GetWidth();
570 naturalSize.y = brokenImage.GetWidth();
576 naturalSize = Vector2::ZERO;
579 void ImageVisual::CreateRenderer( TextureSet& textureSet )
584 if( !mImpl->mCustomShader )
586 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
588 shader = GetImageShader( mFactoryCache,
589 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
590 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
594 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
595 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
597 shader = GetImageShader( mFactoryCache, false, true );
601 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
602 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
603 mImpl->mCustomShader->mHints );
604 if( mImpl->mCustomShader->mVertexShader.empty() )
606 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
611 // Set pixel align off as default.
612 // ToDo: Pixel align causes issues such as rattling image animation.
613 // We should trun it off until issues are resolved
614 shader.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
616 mImpl->mRenderer = Renderer::New( geometry, shader );
619 mImpl->mRenderer.SetTextures( textureSet );
621 // else still waiting for texture load to finish.
623 //Register transform properties
624 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
627 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
632 std::string fragmentShader;
633 const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
634 const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
638 fragmentShader = fragmentPreFix;
639 fragmentShader += "\n";
642 if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
644 fragmentShader += mImpl->mCustomShader->mFragmentShader;
648 fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
651 if( customSamplerTypename )
653 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
656 if( !mImpl->mCustomShader )
658 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
660 shader = Shader::New( VERTEX_SHADER, fragmentShader );
661 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
665 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
666 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
668 mImpl->mCustomShader->mHints );
669 if( mImpl->mCustomShader->mVertexShader.empty() )
671 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
675 mImpl->mRenderer = Renderer::New( geometry, shader );
677 //Register transform properties
678 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
682 bool ImageVisual::IsSynchronousResourceLoading() const
684 return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
688 ( VisualUrl& url, Dali::ImageDimensions desiredSize, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode,
689 ImageVisual::MaskingData* maskInfo, bool synchronousLoading,
690 TextureManager::TextureId textureId, Vector4& textureRect, bool& atlasingStatus, bool& loadingStatus
692 void ImageVisual::InitializeRenderer()
694 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
696 TextureManager& textureManager = mFactoryCache.GetTextureManager();
698 if( ! mImpl->mCustomShader && mImageUrl.GetProtocolType() == VisualUrl::LOCAL )
700 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
704 auto attemptAtlasing = mAttemptAtlasing;
706 // texture set has to be created first as we need to know if atlasing succeeded or not
707 // when selecting the shader
708 TextureSet textures =
709 textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode,
710 mMaskingData, IsSynchronousResourceLoading(), mTextureId,
711 atlasRect, attemptAtlasing, mLoadingStatus, mWrapModeU,
712 mWrapModeV, this, this, mFactoryCache.GetAtlasManager());
715 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
717 CreateRenderer( textures );
719 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
721 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
722 if( !defaultWrapMode ) // custom wrap mode
724 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
725 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
726 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
732 auto attemptAtlasing = false;
733 // for custom shader or remote image, atlas is not applied
734 Vector4 atlasRect; // ignored in this case
735 TextureSet textures =
736 textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode,
737 mMaskingData, IsSynchronousResourceLoading(), mTextureId,
738 atlasRect, attemptAtlasing, mLoadingStatus, mWrapModeU, mWrapModeV, this,
739 nullptr, nullptr); // no atlasing
740 DALI_ASSERT_DEBUG(attemptAtlasing == false);
741 CreateRenderer( textures );
745 void ImageVisual::InitializeRenderer( const Image& image )
747 TextureSet textures = TextureSet::New();
749 NativeImage nativeImage = NativeImage::DownCast( image );
752 CreateNativeImageRenderer( nativeImage );
753 DALI_ASSERT_DEBUG( textures );
754 mImpl->mRenderer.SetTextures( textures );
758 // reuse existing code for regular images
759 CreateRenderer( textures );
761 ApplyImageToSampler( image );
764 void ImageVisual::DoSetOnStage( Actor& actor )
766 if( mImageUrl.IsValid() )
768 InitializeRenderer();
772 InitializeRenderer( mImage );
775 if ( !mImpl->mRenderer )
780 mPlacementActor = actor;
781 // Search the Actor tree to find if Layer UI behaviour set.
782 Layer layer = actor.GetLayer();
783 if ( layer && layer.GetBehavior() == Layer::LAYER_3D )
785 // Layer 3D set, do not align pixels
786 mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
789 if( mPixelArea != FULL_TEXTURE_RECT )
791 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
794 if( mLoadingStatus == false )
796 actor.AddRenderer( mImpl->mRenderer );
797 mPlacementActor.Reset();
799 // Image loaded and ready to display
804 void ImageVisual::DoSetOffStage( Actor& actor )
806 // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
808 //If we own the image then make sure we release it when we go off stage
809 actor.RemoveRenderer( mImpl->mRenderer);
810 if( mImageUrl.IsValid() )
812 RemoveTexture( mImageUrl.GetUrl() );
815 mLoadingStatus = false;
816 mImpl->mRenderer.Reset();
817 mPlacementActor.Reset();
820 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
823 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
825 bool sync = IsSynchronousResourceLoading();
826 map.Insert( SYNCHRONOUS_LOADING, sync );
827 if( mImageUrl.IsValid() )
829 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
830 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
831 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
835 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
836 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
838 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
841 map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
845 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
846 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
848 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
849 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
850 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
852 map.Insert( Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing );
853 if( mMaskingData != NULL )
855 map.Insert( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl() );
856 map.Insert( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor );
857 map.Insert( Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask );
861 void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
864 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
865 if( mImageUrl.IsValid() )
867 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
868 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
872 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
873 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
877 void ImageVisual::OnSetTransform()
879 if( mImpl->mRenderer )
881 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
885 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
890 if( defaultTextureWrapping )
892 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
895 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
896 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
897 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
902 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
905 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
906 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
907 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
913 shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
916 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
917 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
918 factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
925 void ImageVisual::ApplyImageToSampler( const Image& image )
929 TextureSet textureSet = mImpl->mRenderer.GetTextures();
930 DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
932 TextureSetImage( textureSet, 0u, image );
933 Sampler sampler = Sampler::New();
934 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
935 textureSet.SetSampler( 0u, sampler );
939 // From existing atlas manager
940 void ImageVisual::UploadCompleted()
942 // Texture has been uploaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
943 Actor actor = mPlacementActor.GetHandle();
946 actor.AddRenderer( mImpl->mRenderer );
948 // reset the weak handle so that the renderer only get added to actor once
949 mPlacementActor.Reset();
951 mLoadingStatus = false;
954 // From Texture Manager
955 void ImageVisual::UploadComplete( bool loadingSuccess, int32_t textureId, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle )
957 Actor actor = mPlacementActor.GetHandle();
960 if( mImpl->mRenderer )
962 actor.AddRenderer( mImpl->mRenderer );
963 // reset the weak handle so that the renderer only get added to actor once
964 mPlacementActor.Reset();
968 Sampler sampler = Sampler::New();
969 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
970 textureSet.SetSampler( 0u, sampler );
971 mImpl->mRenderer.SetTextures(textureSet);
975 Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
977 textureSet = TextureSet::New();
978 mImpl->mRenderer.SetTextures( textureSet );
980 ApplyImageToSampler( brokenImage );
982 // Image loaded and ready to display
986 mLoadingStatus = false;
989 void ImageVisual::RemoveTexture(const std::string& url)
991 if( mTextureId != TextureManager::INVALID_TEXTURE_ID )
993 mFactoryCache.GetTextureManager().Remove( mTextureId );
994 mTextureId = TextureManager::INVALID_TEXTURE_ID;
998 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
999 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
1000 if( index != Property::INVALID_INDEX )
1002 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
1003 atlasRectValue.Get( atlasRect );
1006 TextureSet textureSet = mImpl->mRenderer.GetTextures();
1007 mImpl->mRenderer.Reset();
1009 if( index != Property::INVALID_INDEX )
1011 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
1016 } // namespace Internal
1018 } // namespace Toolkit