2 * Copyright (c) 2020 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 return imageVisualPtr;
136 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
137 ImageVisualShaderFactory& shaderFactory,
138 const VisualUrl& imageUrl,
139 ImageDimensions size,
140 FittingMode::Type fittingMode,
141 Dali::SamplingMode::Type samplingMode )
143 return new ImageVisual( factoryCache, shaderFactory, imageUrl, size, fittingMode, samplingMode );
146 ImageVisual::ImageVisual(VisualFactoryCache& factoryCache,
147 ImageVisualShaderFactory& shaderFactory,
148 const VisualUrl& imageUrl,
149 ImageDimensions size,
150 FittingMode::Type fittingMode,
151 Dali::SamplingMode::Type samplingMode)
152 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::IMAGE),
153 mPixelArea(FULL_TEXTURE_RECT),
158 mTextureId(TextureManager::INVALID_TEXTURE_ID),
160 mImageVisualShaderFactory(shaderFactory),
161 mFittingMode(fittingMode),
162 mSamplingMode(samplingMode),
163 mWrapModeU(WrapMode::DEFAULT),
164 mWrapModeV(WrapMode::DEFAULT),
165 mLoadPolicy(Toolkit::ImageVisual::LoadPolicy::ATTACHED),
166 mReleasePolicy(Toolkit::ImageVisual::ReleasePolicy::DETACHED),
167 mAtlasRect(0.0f, 0.0f, 0.0f, 0.0f),
168 mAtlasRectSize(0, 0),
169 mLoadState(TextureManager::LoadState::NOT_STARTED),
170 mAttemptAtlasing(false),
171 mOrientationCorrection(true)
173 EnablePreMultipliedAlpha( mFactoryCache.GetPreMultiplyOnLoad() );
176 ImageVisual::~ImageVisual()
178 if( Stage::IsInstalled() )
182 // TextureManager could have been deleted before the actor that contains this
183 // ImageVisual is destroyed (e.g. due to stage shutdown). Ensure the stage
184 // is still valid before accessing texture manager.
185 if( mMaskingData->mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID )
187 TextureManager& textureManager = mFactoryCache.GetTextureManager();
188 textureManager.Remove( mMaskingData->mAlphaMaskId, this );
192 // ImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
193 if( ( mTextureId != TextureManager::INVALID_TEXTURE_ID ) && ( mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER ) )
200 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
202 // Url is already received in constructor
203 for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
205 KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
206 if( keyValue.first.type == Property::Key::INDEX )
208 DoSetProperty( keyValue.first.indexKey, keyValue.second );
212 if( keyValue.first == IMAGE_FITTING_MODE )
214 DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
216 else if( keyValue.first == IMAGE_SAMPLING_MODE )
218 DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
220 else if( keyValue.first == IMAGE_DESIRED_WIDTH )
222 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
224 else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
226 DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
228 else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
230 DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
232 else if( keyValue.first == IMAGE_WRAP_MODE_U )
234 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
236 else if( keyValue.first == IMAGE_WRAP_MODE_V )
238 DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
240 else if( keyValue.first == SYNCHRONOUS_LOADING )
242 DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
244 else if( keyValue.first == IMAGE_ATLASING )
246 DoSetProperty( Toolkit::ImageVisual::Property::ATLASING, keyValue.second );
248 else if( keyValue.first == ALPHA_MASK_URL )
250 DoSetProperty( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second );
252 else if( keyValue.first == MASK_CONTENT_SCALE_NAME )
254 DoSetProperty( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second );
256 else if( keyValue.first == CROP_TO_MASK_NAME )
258 DoSetProperty( Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second );
260 else if ( keyValue.first == LOAD_POLICY_NAME )
262 DoSetProperty( Toolkit::ImageVisual::Property::LOAD_POLICY, keyValue.second );
264 else if( keyValue.first == RELEASE_POLICY_NAME )
266 DoSetProperty( Toolkit::ImageVisual::Property::RELEASE_POLICY, keyValue.second );
268 else if( keyValue.first == ORIENTATION_CORRECTION_NAME )
270 DoSetProperty( Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, keyValue.second );
274 // Load image immediately if LOAD_POLICY requires it
275 if ( mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::IMMEDIATE )
277 auto attemptAtlasing = AttemptAtlasing();
278 LoadTexture( attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection,
279 TextureManager::ReloadPolicy::CACHED );
283 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
287 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
290 if( value.Get( sync ) )
294 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
298 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
303 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
308 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
310 float desiredWidth = 0.0f;
311 if( value.Get( desiredWidth ) )
313 mDesiredSize.SetWidth( desiredWidth );
317 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
322 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
324 float desiredHeight = 0.0f;
325 if( value.Get( desiredHeight ) )
327 mDesiredSize.SetHeight( desiredHeight );
331 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
336 case Toolkit::ImageVisual::Property::FITTING_MODE:
339 Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
340 mFittingMode = Dali::FittingMode::Type( fittingMode );
344 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
346 int samplingMode = 0;
347 Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
348 mSamplingMode = Dali::SamplingMode::Type( samplingMode );
352 case Toolkit::ImageVisual::Property::PIXEL_AREA:
354 value.Get( mPixelArea );
358 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
361 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
362 mWrapModeU = Dali::WrapMode::Type( wrapMode );
366 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
369 Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
370 mWrapModeV = Dali::WrapMode::Type( wrapMode );
374 case Toolkit::ImageVisual::Property::ATLASING:
376 value.Get( mAttemptAtlasing );
380 case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
382 std::string alphaUrl = "";
383 if( value.Get( alphaUrl ) )
386 mMaskingData->mAlphaMaskUrl = alphaUrl;
391 case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
394 if( value.Get( scale ) )
397 mMaskingData->mContentScaleFactor = scale;
402 case Toolkit::ImageVisual::Property::CROP_TO_MASK:
405 if( value.Get( crop ) )
408 mMaskingData->mCropToMask = crop;
413 case Toolkit::ImageVisual::Property::RELEASE_POLICY:
415 int releasePolicy = 0;
416 Scripting::GetEnumerationProperty( value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy );
417 mReleasePolicy = Toolkit::ImageVisual::ReleasePolicy::Type( releasePolicy );
421 case Toolkit::ImageVisual::Property::LOAD_POLICY:
424 Scripting::GetEnumerationProperty( value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy );
425 mLoadPolicy = Toolkit::ImageVisual::LoadPolicy::Type( loadPolicy );
428 case Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION:
430 bool orientationCorrection( mOrientationCorrection );
431 if( value.Get( orientationCorrection ) )
433 mOrientationCorrection = orientationCorrection;
440 void ImageVisual::AllocateMaskData()
444 mMaskingData.reset(new TextureManager::MaskingData());
448 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
450 if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
452 naturalSize.x = mDesiredSize.GetWidth();
453 naturalSize.y = mDesiredSize.GetHeight();
456 else if( mImpl->mRenderer ) // Check if we have a loaded image
458 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED )
460 naturalSize.x = mAtlasRectSize.GetWidth();
461 naturalSize.y = mAtlasRectSize.GetHeight();
465 auto textureSet = mImpl->mRenderer.GetTextures();
468 auto texture = textureSet.GetTexture(0);
471 naturalSize.x = texture.GetWidth();
472 naturalSize.y = texture.GetHeight();
478 if( mMaskingData != NULL && mMaskingData->mAlphaMaskUrl.IsValid() &&
479 mMaskingData->mCropToMask )
481 ImageDimensions dimensions = Dali::GetClosestImageSize( mMaskingData->mAlphaMaskUrl.GetUrl() );
482 if( dimensions != ImageDimensions( 0, 0 ) )
484 naturalSize.x = dimensions.GetWidth();
485 naturalSize.y = dimensions.GetHeight();
489 else if( mImageUrl.IsValid() )
491 if( mImageUrl.GetProtocolType() == VisualUrl::LOCAL )
493 ImageDimensions dimensions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
495 if( dimensions != ImageDimensions( 0, 0 ) )
497 naturalSize.x = dimensions.GetWidth();
498 naturalSize.y = dimensions.GetHeight();
502 Texture brokenImage = mFactoryCache.GetBrokenVisualImage();
504 naturalSize.x = brokenImage.GetWidth();
505 naturalSize.y = brokenImage.GetWidth();
510 naturalSize = Vector2::ZERO;
513 void ImageVisual::CreateRenderer( TextureSet& textureSet )
518 if( mImpl->mCustomShader )
520 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
522 else // Get any geometry associated with the texture
524 TextureManager& textureManager = mFactoryCache.GetTextureManager();
526 uint32_t firstElementCount {0u};
527 uint32_t secondElementCount {0u};
528 geometry = textureManager.GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
530 if(!firstElementCount && !secondElementCount) // Otherwise use quad
532 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
536 Shader shader = GetShader();
538 // Create the renderer
539 mImpl->mRenderer = Renderer::New( geometry, shader );
543 mImpl->mRenderer.SetTextures( textureSet );
545 // else still waiting for texture load to finish.
547 //Register transform properties
548 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
550 EnablePreMultipliedAlpha( IsPreMultipliedAlphaEnabled() );
554 void ImageVisual::LoadTexture( bool& atlasing, Vector4& atlasRect, TextureSet& textures, bool orientationCorrection,
555 TextureManager::ReloadPolicy forceReload )
557 TextureManager& textureManager = mFactoryCache.GetTextureManager();
559 ImageAtlasManagerPtr atlasManager = nullptr;
560 AtlasUploadObserver* atlasUploadObserver = nullptr;
561 auto textureObserver = this;
565 atlasManager = mFactoryCache.GetAtlasManager();
566 atlasUploadObserver = this;
569 auto preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader
570 ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD
571 : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
573 bool synchronousLoading = IsSynchronousLoadingRequired();
576 textures = textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode, mMaskingData, synchronousLoading, mTextureId, atlasRect, mAtlasRectSize, atlasing, loadingStatus, mWrapModeU, mWrapModeV, textureObserver, atlasUploadObserver, atlasManager, mOrientationCorrection, forceReload, preMultiplyOnLoad);
582 mLoadState = TextureManager::LoadState::LOADING;
586 mLoadState = TextureManager::LoadState::LOAD_FINISHED;
589 EnablePreMultipliedAlpha( preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD );
591 else if(synchronousLoading)
593 // Synchronous loading is failed
594 mLoadState = TextureManager::LoadState::LOAD_FAILED;
597 if( atlasing ) // Flag needs to be set before creating renderer
599 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
603 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
607 bool ImageVisual::AttemptAtlasing()
609 return ( ! mImpl->mCustomShader && mImageUrl.GetProtocolType() == VisualUrl::LOCAL && mAttemptAtlasing );
612 void ImageVisual::InitializeRenderer()
614 auto attemptAtlasing = AttemptAtlasing();
616 // Load Texture if mTextures is empty.
617 // mTextures is already set, the mTexture can be used to create Renderer.
618 // There are two cases mTextures is empty.
619 // 1. mTextureId == TextureManager::INVALID_TEXTURE_ID
620 // - Visual is on stage with LoadPolicy::ATTACHED
621 // 2. mTextureId != TextureManager::INVALID_TEXTURE_ID
622 // - If ReleasePolicy is DESTROYED, InitializeRenderer called every on stage called.
623 // - Then every resources those contained in Visual are Reset but mTextureId is remained when the Off stage time,
624 // - So, mTextures needed to be get from texture manager to created resources like mImpl->mRenderer.
627 if( mTextureId == TextureManager::INVALID_TEXTURE_ID )
629 LoadTexture( attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection,
630 TextureManager::ReloadPolicy::CACHED );
634 mTextures = mFactoryCache.GetTextureManager().GetTextureSet( mTextureId );
638 CreateRenderer( mTextures );
639 mTextures.Reset(); // Visual should not keep a handle to the texture after this point.
641 if( attemptAtlasing ) // the texture is packed inside atlas
643 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
645 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
647 if( !defaultWrapMode ) // custom wrap mode
649 Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
650 wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
651 mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
656 void ImageVisual::DoSetOnScene( Actor& actor )
658 if( mImageUrl.IsValid() )
660 InitializeRenderer();
663 if( !mImpl->mRenderer )
668 mPlacementActor = actor;
669 // Search the Actor tree to find if Layer UI behaviour set.
670 Layer layer = actor.GetLayer();
671 if( layer && layer.GetProperty<Layer::Behavior>( Layer::Property::BEHAVIOR ) == Layer::LAYER_3D )
673 // Layer 3D set, do not align pixels
674 mImpl->mRenderer.RegisterProperty( PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF );
677 if( mPixelArea != FULL_TEXTURE_RECT )
679 mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
682 if(mLoadState == TextureManager::LoadState::LOAD_FINISHED)
684 actor.AddRenderer( mImpl->mRenderer );
685 mPlacementActor.Reset();
687 // Image loaded and ready to display
688 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
690 else if(mLoadState == TextureManager::LoadState::LOAD_FAILED)
692 Texture brokenImage = mFactoryCache.GetBrokenVisualImage();
694 mTextures = TextureSet::New();
695 mTextures.SetTexture(0u, brokenImage);
696 mImpl->mRenderer.SetTextures(mTextures);
698 actor.AddRenderer(mImpl->mRenderer);
699 mPlacementActor.Reset();
701 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
705 void ImageVisual::DoSetOffScene( Actor& actor )
707 // Visual::Base::SetOffScene only calls DoSetOffScene if mRenderer exists (is on onstage)
709 // Image release is dependent on the ReleasePolicy, renderer is destroyed.
710 actor.RemoveRenderer( mImpl->mRenderer);
711 if( mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED )
713 RemoveTexture(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
714 mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
716 mLoadState = TextureManager::LoadState::NOT_STARTED;
719 mImpl->mRenderer.Reset();
720 mPlacementActor.Reset();
723 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
726 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
728 bool sync = IsSynchronousLoadingRequired();
729 map.Insert( SYNCHRONOUS_LOADING, sync );
730 if( mImageUrl.IsValid() )
732 map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
733 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
734 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
737 map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
738 map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
740 map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
741 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
742 map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
744 map.Insert( Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing );
746 if( mMaskingData != NULL )
748 map.Insert( Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl() );
749 map.Insert( Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor );
750 map.Insert( Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask );
753 map.Insert( Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy );
754 map.Insert( Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy );
755 map.Insert( Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, mOrientationCorrection );
758 void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
761 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE );
762 if( mImageUrl.IsValid() )
764 map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
765 map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
769 void ImageVisual::OnDoAction( const Dali::Property::Index actionName, const Dali::Property::Value& attributes )
771 // Check if action is valid for this visual type and perform action if possible
773 switch ( actionName )
775 case DevelImageVisual::Action::RELOAD:
777 auto attemptAtlasing = AttemptAtlasing();
778 LoadTexture( attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection,
779 TextureManager::ReloadPolicy::FORCED );
785 void ImageVisual::OnSetTransform()
787 if( mImpl->mRenderer )
789 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
793 bool ImageVisual::IsResourceReady() const
795 return ( mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::READY ||
796 mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::FAILED );
799 void ImageVisual::UpdateShader()
803 Shader shader = GetShader();
804 mImpl->mRenderer.SetShader(shader);
808 // From existing atlas manager
809 void ImageVisual::UploadCompleted()
811 // Texture has been uploaded. If weak handle is holding a placement actor,
812 // it is the time to add the renderer to actor.
813 Actor actor = mPlacementActor.GetHandle();
816 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
817 actor.AddRenderer( mImpl->mRenderer );
818 // reset the weak handle so that the renderer only get added to actor once
819 mPlacementActor.Reset();
823 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
824 mLoadState = TextureManager::LoadState::LOAD_FINISHED;
827 // From Texture Manager
828 void ImageVisual::UploadComplete( bool loadingSuccess, int32_t textureId, TextureSet textureSet, bool usingAtlas,
829 const Vector4& atlasRectangle, bool preMultiplied )
831 Toolkit::Visual::ResourceStatus resourceStatus;
832 if( mImpl->mRenderer )
836 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, mAtlasRect );
839 EnablePreMultipliedAlpha( preMultiplied );
841 Actor actor = mPlacementActor.GetHandle();
844 actor.AddRenderer( mImpl->mRenderer );
845 // reset the weak handle so that the renderer only get added to actor once
846 mPlacementActor.Reset();
849 if( !loadingSuccess )
851 Texture brokenImage = mFactoryCache.GetBrokenVisualImage();
853 textureSet = TextureSet::New();
854 textureSet.SetTexture(0u, brokenImage);
855 mImpl->mRenderer.SetTextures( textureSet );
858 Sampler sampler = Sampler::New();
859 sampler.SetWrapMode( mWrapModeU, mWrapModeV );
860 textureSet.SetSampler( 0u, sampler );
861 mImpl->mRenderer.SetTextures(textureSet);
865 // Storing TextureSet needed when renderer staged.
866 if( ! mImpl->mRenderer )
868 mTextures = textureSet;
871 // Image loaded, set status regardless of staged status.
874 resourceStatus = Toolkit::Visual::ResourceStatus::READY;
875 mLoadState = TextureManager::LoadState::LOAD_FINISHED;
879 resourceStatus = Toolkit::Visual::ResourceStatus::FAILED;
880 mLoadState = TextureManager::LoadState::LOAD_FAILED;
883 // use geometry if needed
886 uint32_t firstElementCount{0u};
887 uint32_t secondElementCount{0u};
888 auto geometry = mFactoryCache.GetTextureManager().GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
889 if (mImpl->mRenderer && geometry)
891 mImpl->mRenderer.SetGeometry(geometry);
892 Dali::DevelRenderer::DrawCommand drawCommand{};
893 drawCommand.drawType = DevelRenderer::DrawType::INDEXED;
895 if (firstElementCount)
897 drawCommand.firstIndex = 0;
898 drawCommand.elementCount = firstElementCount;
899 drawCommand.queue = DevelRenderer::RENDER_QUEUE_OPAQUE;
900 DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
903 if (secondElementCount)
905 drawCommand.firstIndex = firstElementCount;
906 drawCommand.elementCount = secondElementCount;
907 drawCommand.queue = DevelRenderer::RENDER_QUEUE_TRANSPARENT;
908 DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
913 // Signal to observers ( control ) that resources are ready. Must be all resources.
914 ResourceReady( resourceStatus );
917 void ImageVisual::RemoveTexture()
919 if( mTextureId != TextureManager::INVALID_TEXTURE_ID )
921 mFactoryCache.GetTextureManager().Remove( mTextureId, this );
922 mTextureId = TextureManager::INVALID_TEXTURE_ID;
926 Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
927 Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
928 if( index != Property::INVALID_INDEX )
930 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
931 atlasRectValue.Get( atlasRect );
934 TextureSet textureSet = mImpl->mRenderer.GetTextures();
935 mImpl->mRenderer.Reset();
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