2 * Copyright (c) 2021 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/devel-api/common/stage.h>
25 #include <dali/devel-api/adaptor-framework/image-loading.h>
26 #include <dali/devel-api/rendering/renderer-devel.h>
27 #include <dali/devel-api/rendering/texture-devel.h>
28 #include <dali/devel-api/scripting/enum-helper.h>
29 #include <dali/devel-api/scripting/scripting.h>
30 #include <dali/integration-api/debug.h>
33 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
34 #include <dali-toolkit/public-api/visuals/visual-properties.h>
35 #include <dali-toolkit/devel-api/visuals/image-visual-actions-devel.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>
44 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
59 DALI_ENUM_TO_STRING_TABLE_BEGIN( FITTING_MODE )
60 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SHRINK_TO_FIT )
61 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SCALE_TO_FILL )
62 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_WIDTH )
63 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_HEIGHT )
64 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, DEFAULT )
65 DALI_ENUM_TO_STRING_TABLE_END( FITTING_MODE )
68 DALI_ENUM_TO_STRING_TABLE_BEGIN( SAMPLING_MODE )
69 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX )
70 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NEAREST )
71 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, LINEAR )
72 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_NEAREST )
73 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_LINEAR )
74 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NO_FILTER )
75 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, DONT_CARE )
76 DALI_ENUM_TO_STRING_TABLE_END( SAMPLING_MODE )
79 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
80 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
81 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
82 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
83 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
84 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
87 DALI_ENUM_TO_STRING_TABLE_BEGIN( LOAD_POLICY )
88 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::ImageVisual::LoadPolicy, IMMEDIATE )
89 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::ImageVisual::LoadPolicy, ATTACHED )
90 DALI_ENUM_TO_STRING_TABLE_END( LOAD_POLICY )
93 DALI_ENUM_TO_STRING_TABLE_BEGIN( RELEASE_POLICY )
94 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::ImageVisual::ReleasePolicy, DETACHED )
95 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::ImageVisual::ReleasePolicy, DESTROYED )
96 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::Toolkit::ImageVisual::ReleasePolicy, NEVER )
97 DALI_ENUM_TO_STRING_TABLE_END( RELEASE_POLICY )
99 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
101 const float PIXEL_ALIGN_ON = 1.0f;
102 const float PIXEL_ALIGN_OFF = 0.0f;
104 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
108 if( gridSize == ImageDimensions( 1, 1 ) )
110 geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
114 geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
120 } // unnamed namespace
123 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
124 ImageVisualShaderFactory& shaderFactory,
125 const VisualUrl& imageUrl,
126 const Property::Map& properties,
127 ImageDimensions size,
128 FittingMode::Type fittingMode,
129 Dali::SamplingMode::Type samplingMode )
131 ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, shaderFactory, imageUrl, size, fittingMode, samplingMode ) );
132 imageVisualPtr->SetProperties( properties );
133 imageVisualPtr->Initialize();
134 return imageVisualPtr;
137 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
138 ImageVisualShaderFactory& shaderFactory,
139 const VisualUrl& imageUrl,
140 ImageDimensions size,
141 FittingMode::Type fittingMode,
142 Dali::SamplingMode::Type samplingMode )
144 ImageVisualPtr imageVisualPtr(new ImageVisual(factoryCache, shaderFactory, imageUrl, size, fittingMode, samplingMode));
145 imageVisualPtr->Initialize();
146 return imageVisualPtr;
149 ImageVisual::ImageVisual(VisualFactoryCache& factoryCache,
150 ImageVisualShaderFactory& shaderFactory,
151 const VisualUrl& imageUrl,
152 ImageDimensions size,
153 FittingMode::Type fittingMode,
154 Dali::SamplingMode::Type samplingMode)
155 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::IMAGE),
156 mPixelArea(FULL_TEXTURE_RECT),
161 mTextureId(TextureManager::INVALID_TEXTURE_ID),
163 mImageVisualShaderFactory(shaderFactory),
164 mFittingMode(fittingMode),
165 mSamplingMode(samplingMode),
166 mWrapModeU(WrapMode::DEFAULT),
167 mWrapModeV(WrapMode::DEFAULT),
168 mLoadPolicy(Toolkit::ImageVisual::LoadPolicy::ATTACHED),
169 mReleasePolicy(Toolkit::ImageVisual::ReleasePolicy::DETACHED),
170 mAtlasRect(0.0f, 0.0f, 0.0f, 0.0f),
171 mAtlasRectSize(0, 0),
172 mLoadState(TextureManager::LoadState::NOT_STARTED),
173 mAttemptAtlasing(false),
174 mOrientationCorrection(true)
176 EnablePreMultipliedAlpha( mFactoryCache.GetPreMultiplyOnLoad() );
179 ImageVisual::~ImageVisual()
181 if( Stage::IsInstalled() )
185 // TextureManager could have been deleted before the actor that contains this
186 // ImageVisual is destroyed (e.g. due to stage shutdown). Ensure the stage
187 // is still valid before accessing texture manager.
188 if( mMaskingData->mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID )
190 TextureManager& textureManager = mFactoryCache.GetTextureManager();
191 textureManager.Remove( mMaskingData->mAlphaMaskId, this );
195 // ImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
196 if( ( mTextureId != TextureManager::INVALID_TEXTURE_ID ) && ( mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER ) )
203 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
205 // Url is already received in constructor
206 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
208 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
209 if( keyValue.first.type == Property::Key::INDEX )
211 DoSetProperty( keyValue.first.indexKey, keyValue.second );
215 if( keyValue.first == IMAGE_FITTING_MODE )
217 DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
219 else if( keyValue.first == IMAGE_SAMPLING_MODE )
221 DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
223 else if( keyValue.first == IMAGE_DESIRED_WIDTH )
225 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
227 else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
229 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
231 else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
233 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
235 else if( keyValue.first == IMAGE_WRAP_MODE_U )
237 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
239 else if( keyValue.first == IMAGE_WRAP_MODE_V )
241 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
243 else if( keyValue.first == SYNCHRONOUS_LOADING )
245 DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
247 else if( keyValue.first == IMAGE_ATLASING )
249 DoSetProperty( Toolkit::ImageVisual::Property::ATLASING, keyValue.second );
251 else if( keyValue.first == ALPHA_MASK_URL )
253 DoSetProperty( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
255 else if( keyValue.first == MASK_CONTENT_SCALE_NAME )
257 DoSetProperty( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second );
259 else if( keyValue.first == CROP_TO_MASK_NAME )
261 DoSetProperty( Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second );
263 else if ( keyValue.first == LOAD_POLICY_NAME )
265 DoSetProperty( Toolkit::ImageVisual::Property::LOAD_POLICY, keyValue.second );
267 else if( keyValue.first == RELEASE_POLICY_NAME )
269 DoSetProperty( Toolkit::ImageVisual::Property::RELEASE_POLICY, keyValue.second );
271 else if( keyValue.first == ORIENTATION_CORRECTION_NAME )
273 DoSetProperty( Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, keyValue.second );
277 // Load image immediately if LOAD_POLICY requires it
278 if ( mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::IMMEDIATE )
280 auto attemptAtlasing = AttemptAtlasing();
281 LoadTexture( attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection,
282 TextureManager::ReloadPolicy::CACHED );
286 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
290 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
293 if( value.Get( sync ) )
297 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
301 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
306 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
311 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
313 float desiredWidth = 0.0f;
314 if( value.Get( desiredWidth ) )
316 mDesiredSize.SetWidth( desiredWidth );
320 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
325 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
327 float desiredHeight = 0.0f;
328 if( value.Get( desiredHeight ) )
330 mDesiredSize.SetHeight( desiredHeight );
334 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
339 case Toolkit::ImageVisual::Property::FITTING_MODE:
342 Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
343 mFittingMode = Dali::FittingMode::Type( fittingMode );
347 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
349 int samplingMode = 0;
350 Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
351 mSamplingMode = Dali::SamplingMode::Type( samplingMode );
355 case Toolkit::ImageVisual::Property::PIXEL_AREA:
357 value.Get( mPixelArea );
361 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
364 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
365 mWrapModeU = Dali::WrapMode::Type( wrapMode );
369 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
372 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
373 mWrapModeV = Dali::WrapMode::Type( wrapMode );
377 case Toolkit::ImageVisual::Property::ATLASING:
379 value.Get( mAttemptAtlasing );
383 case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
385 std::string alphaUrl = "";
386 if( value.Get( alphaUrl ) )
389 mMaskingData->mAlphaMaskUrl = alphaUrl;
394 case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
397 if( value.Get( scale ) )
400 mMaskingData->mContentScaleFactor = scale;
405 case Toolkit::ImageVisual::Property::CROP_TO_MASK:
408 if( value.Get( crop ) )
411 mMaskingData->mCropToMask = crop;
416 case Toolkit::ImageVisual::Property::RELEASE_POLICY:
418 int releasePolicy = 0;
419 Scripting::GetEnumerationProperty( value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy );
420 mReleasePolicy = Toolkit::ImageVisual::ReleasePolicy::Type( releasePolicy );
424 case Toolkit::ImageVisual::Property::LOAD_POLICY:
427 Scripting::GetEnumerationProperty( value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy );
428 mLoadPolicy = Toolkit::ImageVisual::LoadPolicy::Type( loadPolicy );
431 case Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION:
433 bool orientationCorrection( mOrientationCorrection );
434 if( value.Get( orientationCorrection ) )
436 mOrientationCorrection = orientationCorrection;
443 void ImageVisual::AllocateMaskData()
447 mMaskingData.reset(new TextureManager::MaskingData());
451 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
453 if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
455 naturalSize.x = mDesiredSize.GetWidth();
456 naturalSize.y = mDesiredSize.GetHeight();
459 else if( mImpl->mRenderer ) // Check if we have a loaded image
461 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED )
463 naturalSize.x = mAtlasRectSize.GetWidth();
464 naturalSize.y = mAtlasRectSize.GetHeight();
468 auto textureSet = mImpl->mRenderer.GetTextures();
471 auto texture = textureSet.GetTexture(0);
474 naturalSize.x = texture.GetWidth();
475 naturalSize.y = texture.GetHeight();
481 if( mMaskingData != NULL && mMaskingData->mAlphaMaskUrl.IsValid() &&
482 mMaskingData->mCropToMask )
484 ImageDimensions dimensions = Dali::GetClosestImageSize( mMaskingData->mAlphaMaskUrl.GetUrl() );
485 if( dimensions != ImageDimensions( 0, 0 ) )
487 naturalSize.x = dimensions.GetWidth();
488 naturalSize.y = dimensions.GetHeight();
492 else if( mImageUrl.IsValid() )
494 if( mImageUrl.GetProtocolType() == VisualUrl::LOCAL )
496 ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
498 if( dimensions != ImageDimensions( 0, 0 ) )
500 naturalSize.x = dimensions.GetWidth();
501 naturalSize.y = dimensions.GetHeight();
505 Texture brokenImage = mFactoryCache.GetBrokenVisualImage();
507 naturalSize.x = brokenImage.GetWidth();
508 naturalSize.y = brokenImage.GetWidth();
513 naturalSize = Vector2::ZERO;
516 void ImageVisual::OnInitialize()
521 if( mImpl->mCustomShader )
523 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
525 else // Get any geometry associated with the texture
527 TextureManager& textureManager = mFactoryCache.GetTextureManager();
529 uint32_t firstElementCount {0u};
530 uint32_t secondElementCount {0u};
531 geometry = textureManager.GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
533 if(!firstElementCount && !secondElementCount) // Otherwise use quad
535 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
539 Shader shader = GetShader();
541 // Create the renderer
542 mImpl->mRenderer = Renderer::New( geometry, shader );
544 //Register transform properties
545 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
547 EnablePreMultipliedAlpha( IsPreMultipliedAlphaEnabled() );
550 void ImageVisual::LoadTexture( bool& atlasing, Vector4& atlasRect, TextureSet& textures, bool orientationCorrection,
551 TextureManager::ReloadPolicy forceReload )
553 TextureManager& textureManager = mFactoryCache.GetTextureManager();
555 ImageAtlasManagerPtr atlasManager = nullptr;
556 AtlasUploadObserver* atlasUploadObserver = nullptr;
557 auto textureObserver = this;
561 atlasManager = mFactoryCache.GetAtlasManager();
562 atlasUploadObserver = this;
565 auto preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader
566 ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD
567 : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
569 bool synchronousLoading = IsSynchronousLoadingRequired();
572 textures = textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode, mMaskingData, synchronousLoading, mTextureId, atlasRect, mAtlasRectSize, atlasing, loadingStatus, mWrapModeU, mWrapModeV, textureObserver, atlasUploadObserver, atlasManager, mOrientationCorrection, forceReload, preMultiplyOnLoad);
578 mLoadState = TextureManager::LoadState::LOADING;
582 mLoadState = TextureManager::LoadState::LOAD_FINISHED;
585 EnablePreMultipliedAlpha( preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD );
587 else if(synchronousLoading)
589 // Synchronous loading is failed
590 mLoadState = TextureManager::LoadState::LOAD_FAILED;
593 if( atlasing ) // Flag needs to be set before creating renderer
595 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
599 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
603 bool ImageVisual::AttemptAtlasing()
605 return ( ! mImpl->mCustomShader && mImageUrl.GetProtocolType() == VisualUrl::LOCAL && mAttemptAtlasing );
608 void ImageVisual::InitializeRenderer()
610 auto attemptAtlasing = AttemptAtlasing();
612 // Load Texture if mTextures is empty.
613 // mTextures is already set, the mTexture can be used to create Renderer.
614 // There are two cases mTextures is empty.
615 // 1. mTextureId == TextureManager::INVALID_TEXTURE_ID
616 // - Visual is on stage with LoadPolicy::ATTACHED
617 // 2. mTextureId != TextureManager::INVALID_TEXTURE_ID
618 // - If ReleasePolicy is DESTROYED, InitializeRenderer called every on stage called.
619 // - Then every resources those contained in Visual are Reset but mTextureId is remained when the Off stage time,
620 // - So, mTextures needed to be get from texture manager to created resources like mImpl->mRenderer.
623 if( mTextureId == TextureManager::INVALID_TEXTURE_ID )
625 LoadTexture( attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection,
626 TextureManager::ReloadPolicy::CACHED );
630 mTextures = mFactoryCache.GetTextureManager().GetTextureSet( mTextureId );
636 mImpl->mRenderer.SetTextures(mTextures);
637 mTextures.Reset(); // Visual should not keep a handle to the texture after this point.
640 if( attemptAtlasing ) // the texture is packed inside atlas
642 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
644 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
646 if( !defaultWrapMode ) // custom wrap mode
648 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
649 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
650 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
655 void ImageVisual::DoSetOnScene( Actor& actor )
657 if( mImageUrl.IsValid() )
659 InitializeRenderer();
662 if( !mImpl->mRenderer )
667 mPlacementActor = actor;
668 // Search the Actor tree to find if Layer UI behaviour set.
669 Layer layer = actor.GetLayer();
670 if( layer && layer.GetProperty<Layer::Behavior>( Layer::Property::BEHAVIOR ) == Layer::LAYER_3D )
672 // Layer 3D set, do not align pixels
673 mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
676 if( mPixelArea != FULL_TEXTURE_RECT )
678 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
681 if(mLoadState == TextureManager::LoadState::LOAD_FINISHED)
683 actor.AddRenderer( mImpl->mRenderer );
684 mPlacementActor.Reset();
686 // Image loaded and ready to display
687 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
689 else if(mLoadState == TextureManager::LoadState::LOAD_FAILED)
691 Texture brokenImage = mFactoryCache.GetBrokenVisualImage();
693 mTextures = TextureSet::New();
694 mTextures.SetTexture(0u, brokenImage);
695 mImpl->mRenderer.SetTextures(mTextures);
697 actor.AddRenderer(mImpl->mRenderer);
698 mPlacementActor.Reset();
700 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
704 void ImageVisual::DoSetOffScene( Actor& actor )
706 // Visual::Base::SetOffScene only calls DoSetOffScene if mRenderer exists (is on onstage)
708 // Image release is dependent on the ReleasePolicy, renderer is removed.
709 actor.RemoveRenderer( mImpl->mRenderer);
710 if( mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED )
712 RemoveTexture(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
713 mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
715 TextureSet textureSet = TextureSet::New();
716 mImpl->mRenderer.SetTextures(textureSet);
718 mLoadState = TextureManager::LoadState::NOT_STARTED;
721 mPlacementActor.Reset();
724 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
727 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
729 bool sync = IsSynchronousLoadingRequired();
730 map.Insert( SYNCHRONOUS_LOADING, sync );
731 if( mImageUrl.IsValid() )
733 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
734 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
735 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
738 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
739 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
741 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
742 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
743 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
745 map.Insert( Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing );
747 if( mMaskingData != NULL )
749 map.Insert( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl() );
750 map.Insert( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor );
751 map.Insert( Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask );
754 map.Insert( Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy );
755 map.Insert( Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy );
756 map.Insert( Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, mOrientationCorrection );
759 void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
762 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
763 if( mImageUrl.IsValid() )
765 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
766 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
770 void ImageVisual::OnDoAction( const Dali::Property::Index actionName, const Dali::Property::Value& attributes )
772 // Check if action is valid for this visual type and perform action if possible
774 switch ( actionName )
776 case DevelImageVisual::Action::RELOAD:
778 auto attemptAtlasing = AttemptAtlasing();
779 LoadTexture( attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection,
780 TextureManager::ReloadPolicy::FORCED );
786 void ImageVisual::OnSetTransform()
788 if( mImpl->mRenderer )
790 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
794 bool ImageVisual::IsResourceReady() const
796 return ( mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::READY ||
797 mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::FAILED );
800 void ImageVisual::UpdateShader()
804 Shader shader = GetShader();
805 mImpl->mRenderer.SetShader(shader);
809 // From existing atlas manager
810 void ImageVisual::UploadCompleted()
812 // Texture has been uploaded. If weak handle is holding a placement actor,
813 // it is the time to add the renderer to actor.
814 Actor actor = mPlacementActor.GetHandle();
817 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
818 actor.AddRenderer( mImpl->mRenderer );
819 // reset the weak handle so that the renderer only get added to actor once
820 mPlacementActor.Reset();
824 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
825 mLoadState = TextureManager::LoadState::LOAD_FINISHED;
828 // From Texture Manager
829 void ImageVisual::UploadComplete( bool loadingSuccess, int32_t textureId, TextureSet textureSet, bool usingAtlas,
830 const Vector4& atlasRectangle, bool preMultiplied )
832 Toolkit::Visual::ResourceStatus resourceStatus;
833 if( mImpl->mRenderer )
837 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
840 EnablePreMultipliedAlpha( preMultiplied );
842 Actor actor = mPlacementActor.GetHandle();
845 actor.AddRenderer( mImpl->mRenderer );
846 // reset the weak handle so that the renderer only get added to actor once
847 mPlacementActor.Reset();
850 if( !loadingSuccess )
852 Texture brokenImage = mFactoryCache.GetBrokenVisualImage();
854 textureSet = TextureSet::New();
855 textureSet.SetTexture(0u, brokenImage);
856 mImpl->mRenderer.SetTextures( textureSet );
859 Sampler sampler = Sampler::New();
860 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
861 textureSet.SetSampler( 0u, sampler );
862 mImpl->mRenderer.SetTextures(textureSet);
866 // Storing TextureSet needed when renderer staged.
867 if( ! mImpl->mRenderer )
869 mTextures = textureSet;
872 // Image loaded, set status regardless of staged status.
875 resourceStatus = Toolkit::Visual::ResourceStatus::READY;
876 mLoadState = TextureManager::LoadState::LOAD_FINISHED;
880 resourceStatus = Toolkit::Visual::ResourceStatus::FAILED;
881 mLoadState = TextureManager::LoadState::LOAD_FAILED;
884 // use geometry if needed
887 uint32_t firstElementCount{0u};
888 uint32_t secondElementCount{0u};
889 auto geometry = mFactoryCache.GetTextureManager().GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
890 if (mImpl->mRenderer && geometry)
892 mImpl->mRenderer.SetGeometry(geometry);
893 Dali::DevelRenderer::DrawCommand drawCommand{};
894 drawCommand.drawType = DevelRenderer::DrawType::INDEXED;
896 if (firstElementCount)
898 drawCommand.firstIndex = 0;
899 drawCommand.elementCount = firstElementCount;
900 drawCommand.queue = DevelRenderer::RENDER_QUEUE_OPAQUE;
901 DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
904 if (secondElementCount)
906 drawCommand.firstIndex = firstElementCount;
907 drawCommand.elementCount = secondElementCount;
908 drawCommand.queue = DevelRenderer::RENDER_QUEUE_TRANSPARENT;
909 DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
914 // Signal to observers ( control ) that resources are ready. Must be all resources.
915 ResourceReady( resourceStatus );
918 void ImageVisual::RemoveTexture()
920 if( mTextureId != TextureManager::INVALID_TEXTURE_ID )
922 mFactoryCache.GetTextureManager().Remove( mTextureId, this );
923 mTextureId = TextureManager::INVALID_TEXTURE_ID;
927 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
928 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
929 if( index != Property::INVALID_INDEX )
931 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
932 atlasRectValue.Get( atlasRect );
935 TextureSet textureSet = mImpl->mRenderer.GetTextures();
937 if( index != Property::INVALID_INDEX )
939 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
944 Shader ImageVisual::GetShader()
948 std::string_view vertexShaderView;
949 bool usesWholeTexture = true;
950 if(mImpl->mCustomShader && !mImpl->mCustomShader->mVertexShader.empty())
952 vertexShaderView = mImpl->mCustomShader->mVertexShader;
953 usesWholeTexture = false; // Impossible to tell.
957 vertexShaderView = mImageVisualShaderFactory.GetVertexShaderSource();
960 std::string_view fragmentShaderView;
961 if(mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty())
963 fragmentShaderView = mImpl->mCustomShader->mFragmentShader;
967 fragmentShaderView = mImageVisualShaderFactory.GetFragmentShaderSource();
970 // If the texture is native, we may need to change prefix and sampler in
971 // the fragment shader
972 bool modifiedFragmentShader = false;
973 std::string fragmentShaderString;
974 if(mTextures && DevelTexture::IsNative(mTextures.GetTexture(0)))
976 Texture nativeTexture = mTextures.GetTexture(0);
977 fragmentShaderString = std::string(fragmentShaderView);
978 modifiedFragmentShader = DevelTexture::ApplyNativeFragmentShader(nativeTexture, fragmentShaderString);
979 fragmentShaderView = fragmentShaderString;
982 const bool useStandardShader = !mImpl->mCustomShader && !modifiedFragmentShader;
983 if(useStandardShader)
985 // Create and cache the standard shader
986 shader = mImageVisualShaderFactory.GetShader(
988 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
989 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE,
990 IsRoundedCornerRequired() );
992 else if(mImpl->mCustomShader)
994 shader = Shader::New(vertexShaderView, fragmentShaderView, mImpl->mCustomShader->mHints);
998 shader = Shader::New(vertexShaderView, fragmentShaderView);
1001 if(usesWholeTexture)
1003 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
1006 // Set pixel align off as default.
1007 // ToDo: Pixel align causes issues such as rattling image animation.
1008 // We should trun it off until issues are resolved
1009 shader.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
1014 } // namespace Internal
1016 } // namespace Toolkit