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 <dali/devel-api/adaptor-framework/image-loading.h>
23 #include <dali/devel-api/common/stage.h>
24 #include <dali/devel-api/rendering/renderer-devel.h>
25 #include <dali/devel-api/rendering/texture-devel.h>
26 #include <dali/devel-api/scripting/enum-helper.h>
27 #include <dali/devel-api/scripting/scripting.h>
28 #include <dali/integration-api/debug.h>
29 #include <dali/public-api/actors/layer.h>
30 #include <cstring> // for strlen()
33 #include <dali-toolkit/devel-api/visuals/image-visual-actions-devel.h>
34 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
35 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
36 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
37 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
38 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
39 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
40 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
41 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
42 #include <dali-toolkit/internal/visuals/visual-url.h>
43 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
44 #include <dali-toolkit/public-api/visuals/visual-properties.h>
55 DALI_ENUM_TO_STRING_TABLE_BEGIN(FITTING_MODE)
56 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, SHRINK_TO_FIT)
57 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, SCALE_TO_FILL)
58 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, FIT_WIDTH)
59 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, FIT_HEIGHT)
60 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, DEFAULT)
61 DALI_ENUM_TO_STRING_TABLE_END(FITTING_MODE)
64 DALI_ENUM_TO_STRING_TABLE_BEGIN(SAMPLING_MODE)
65 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, BOX)
66 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, NEAREST)
67 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, LINEAR)
68 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, BOX_THEN_NEAREST)
69 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, BOX_THEN_LINEAR)
70 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, NO_FILTER)
71 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, DONT_CARE)
72 DALI_ENUM_TO_STRING_TABLE_END(SAMPLING_MODE)
75 DALI_ENUM_TO_STRING_TABLE_BEGIN(WRAP_MODE)
76 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, DEFAULT)
77 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, CLAMP_TO_EDGE)
78 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, REPEAT)
79 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, MIRRORED_REPEAT)
80 DALI_ENUM_TO_STRING_TABLE_END(WRAP_MODE)
83 DALI_ENUM_TO_STRING_TABLE_BEGIN(LOAD_POLICY)
84 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::LoadPolicy, IMMEDIATE)
85 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::LoadPolicy, ATTACHED)
86 DALI_ENUM_TO_STRING_TABLE_END(LOAD_POLICY)
89 DALI_ENUM_TO_STRING_TABLE_BEGIN(RELEASE_POLICY)
90 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, DETACHED)
91 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, DESTROYED)
92 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, NEVER)
93 DALI_ENUM_TO_STRING_TABLE_END(RELEASE_POLICY)
95 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
97 const float PIXEL_ALIGN_ON = 1.0f;
98 const float PIXEL_ALIGN_OFF = 0.0f;
100 Geometry CreateGeometry(VisualFactoryCache& factoryCache, ImageDimensions gridSize)
104 if(gridSize == ImageDimensions(1, 1))
106 geometry = factoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
110 geometry = VisualFactoryCache::CreateGridGeometry(gridSize);
116 } // unnamed namespace
118 ImageVisualPtr ImageVisual::New(VisualFactoryCache& factoryCache,
119 ImageVisualShaderFactory& shaderFactory,
120 const VisualUrl& imageUrl,
121 const Property::Map& properties,
122 ImageDimensions size,
123 FittingMode::Type fittingMode,
124 Dali::SamplingMode::Type samplingMode)
126 ImageVisualPtr imageVisualPtr(new ImageVisual(factoryCache, shaderFactory, imageUrl, size, fittingMode, samplingMode));
127 imageVisualPtr->SetProperties(properties);
128 imageVisualPtr->Initialize();
129 return imageVisualPtr;
132 ImageVisualPtr ImageVisual::New(VisualFactoryCache& factoryCache,
133 ImageVisualShaderFactory& shaderFactory,
134 const VisualUrl& imageUrl,
135 ImageDimensions size,
136 FittingMode::Type fittingMode,
137 Dali::SamplingMode::Type samplingMode)
139 ImageVisualPtr imageVisualPtr(new ImageVisual(factoryCache, shaderFactory, imageUrl, size, fittingMode, samplingMode));
140 imageVisualPtr->Initialize();
141 return imageVisualPtr;
144 ImageVisual::ImageVisual(VisualFactoryCache& factoryCache,
145 ImageVisualShaderFactory& shaderFactory,
146 const VisualUrl& imageUrl,
147 ImageDimensions size,
148 FittingMode::Type fittingMode,
149 Dali::SamplingMode::Type samplingMode)
150 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::IMAGE),
151 mPixelArea(FULL_TEXTURE_RECT),
156 mTextureId(TextureManager::INVALID_TEXTURE_ID),
158 mImageVisualShaderFactory(shaderFactory),
159 mFittingMode(fittingMode),
160 mSamplingMode(samplingMode),
161 mWrapModeU(WrapMode::DEFAULT),
162 mWrapModeV(WrapMode::DEFAULT),
163 mLoadPolicy(Toolkit::ImageVisual::LoadPolicy::ATTACHED),
164 mReleasePolicy(Toolkit::ImageVisual::ReleasePolicy::DETACHED),
165 mAtlasRect(0.0f, 0.0f, 0.0f, 0.0f),
166 mAtlasRectSize(0, 0),
167 mLoadState(TextureManager::LoadState::NOT_STARTED),
168 mAttemptAtlasing(false),
169 mOrientationCorrection(true)
171 EnablePreMultipliedAlpha(mFactoryCache.GetPreMultiplyOnLoad());
174 ImageVisual::~ImageVisual()
176 if(Stage::IsInstalled())
180 // TextureManager could have been deleted before the actor that contains this
181 // ImageVisual is destroyed (e.g. due to stage shutdown). Ensure the stage
182 // is still valid before accessing texture manager.
183 if(mMaskingData->mAlphaMaskId != TextureManager::INVALID_TEXTURE_ID)
185 TextureManager& textureManager = mFactoryCache.GetTextureManager();
186 textureManager.Remove(mMaskingData->mAlphaMaskId, this);
190 // ImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
191 if((mTextureId != TextureManager::INVALID_TEXTURE_ID) && (mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER))
198 void ImageVisual::DoSetProperties(const Property::Map& propertyMap)
200 // Url is already received in constructor
201 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
203 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
204 if(keyValue.first.type == Property::Key::INDEX)
206 DoSetProperty(keyValue.first.indexKey, keyValue.second);
210 if(keyValue.first == IMAGE_FITTING_MODE)
212 DoSetProperty(Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second);
214 else if(keyValue.first == IMAGE_SAMPLING_MODE)
216 DoSetProperty(Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second);
218 else if(keyValue.first == IMAGE_DESIRED_WIDTH)
220 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
222 else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
224 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
226 else if(keyValue.first == PIXEL_AREA_UNIFORM_NAME)
228 DoSetProperty(Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second);
230 else if(keyValue.first == IMAGE_WRAP_MODE_U)
232 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second);
234 else if(keyValue.first == IMAGE_WRAP_MODE_V)
236 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second);
238 else if(keyValue.first == SYNCHRONOUS_LOADING)
240 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
242 else if(keyValue.first == IMAGE_ATLASING)
244 DoSetProperty(Toolkit::ImageVisual::Property::ATLASING, keyValue.second);
246 else if(keyValue.first == ALPHA_MASK_URL)
248 DoSetProperty(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second);
250 else if(keyValue.first == MASK_CONTENT_SCALE_NAME)
252 DoSetProperty(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second);
254 else if(keyValue.first == CROP_TO_MASK_NAME)
256 DoSetProperty(Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second);
258 else if(keyValue.first == LOAD_POLICY_NAME)
260 DoSetProperty(Toolkit::ImageVisual::Property::LOAD_POLICY, keyValue.second);
262 else if(keyValue.first == RELEASE_POLICY_NAME)
264 DoSetProperty(Toolkit::ImageVisual::Property::RELEASE_POLICY, keyValue.second);
266 else if(keyValue.first == ORIENTATION_CORRECTION_NAME)
268 DoSetProperty(Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, keyValue.second);
272 // Load image immediately if LOAD_POLICY requires it
273 if(mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::IMMEDIATE)
275 auto attemptAtlasing = AttemptAtlasing();
276 LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::CACHED);
280 void ImageVisual::DoSetProperty(Property::Index index, const Property::Value& value)
284 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
291 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
295 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
300 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
305 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
307 float desiredWidth = 0.0f;
308 if(value.Get(desiredWidth))
310 mDesiredSize.SetWidth(desiredWidth);
314 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
319 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
321 float desiredHeight = 0.0f;
322 if(value.Get(desiredHeight))
324 mDesiredSize.SetHeight(desiredHeight);
328 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
333 case Toolkit::ImageVisual::Property::FITTING_MODE:
336 Scripting::GetEnumerationProperty(value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode);
337 mFittingMode = Dali::FittingMode::Type(fittingMode);
341 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
343 int samplingMode = 0;
344 Scripting::GetEnumerationProperty(value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode);
345 mSamplingMode = Dali::SamplingMode::Type(samplingMode);
349 case Toolkit::ImageVisual::Property::PIXEL_AREA:
351 value.Get(mPixelArea);
355 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
358 Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode);
359 mWrapModeU = Dali::WrapMode::Type(wrapMode);
363 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
366 Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode);
367 mWrapModeV = Dali::WrapMode::Type(wrapMode);
371 case Toolkit::ImageVisual::Property::ATLASING:
373 value.Get(mAttemptAtlasing);
377 case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
379 std::string alphaUrl = "";
380 if(value.Get(alphaUrl))
383 mMaskingData->mAlphaMaskUrl = alphaUrl;
388 case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
394 mMaskingData->mContentScaleFactor = scale;
399 case Toolkit::ImageVisual::Property::CROP_TO_MASK:
405 mMaskingData->mCropToMask = crop;
410 case Toolkit::ImageVisual::Property::RELEASE_POLICY:
412 int releasePolicy = 0;
413 Scripting::GetEnumerationProperty(value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy);
414 mReleasePolicy = Toolkit::ImageVisual::ReleasePolicy::Type(releasePolicy);
418 case Toolkit::ImageVisual::Property::LOAD_POLICY:
421 Scripting::GetEnumerationProperty(value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy);
422 mLoadPolicy = Toolkit::ImageVisual::LoadPolicy::Type(loadPolicy);
425 case Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION:
427 bool orientationCorrection(mOrientationCorrection);
428 if(value.Get(orientationCorrection))
430 mOrientationCorrection = orientationCorrection;
437 void ImageVisual::AllocateMaskData()
441 mMaskingData.reset(new TextureManager::MaskingData());
445 void ImageVisual::GetNaturalSize(Vector2& naturalSize)
447 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
449 naturalSize.x = mDesiredSize.GetWidth();
450 naturalSize.y = mDesiredSize.GetHeight();
453 else if(mImpl->mRenderer) // Check if we have a loaded image
455 if(mImpl->mFlags & Impl::IS_ATLASING_APPLIED)
457 naturalSize.x = mAtlasRectSize.GetWidth();
458 naturalSize.y = mAtlasRectSize.GetHeight();
462 auto textureSet = mImpl->mRenderer.GetTextures();
465 auto texture = textureSet.GetTexture(0);
468 naturalSize.x = texture.GetWidth();
469 naturalSize.y = texture.GetHeight();
475 if(mMaskingData != NULL && mMaskingData->mAlphaMaskUrl.IsValid() &&
476 mMaskingData->mCropToMask)
478 ImageDimensions dimensions = Dali::GetClosestImageSize(mMaskingData->mAlphaMaskUrl.GetUrl());
479 if(dimensions != ImageDimensions(0, 0))
481 naturalSize.x = dimensions.GetWidth();
482 naturalSize.y = dimensions.GetHeight();
486 else if(mImageUrl.IsValid())
488 if(mImageUrl.GetProtocolType() == VisualUrl::LOCAL)
490 ImageDimensions dimensions = Dali::GetClosestImageSize(mImageUrl.GetUrl());
492 if(dimensions != ImageDimensions(0, 0))
494 naturalSize.x = dimensions.GetWidth();
495 naturalSize.y = dimensions.GetHeight();
499 Texture brokenImage = mFactoryCache.GetBrokenVisualImage();
501 naturalSize.x = brokenImage.GetWidth();
502 naturalSize.y = brokenImage.GetWidth();
507 naturalSize = Vector2::ZERO;
510 void ImageVisual::OnInitialize()
515 if(mImpl->mCustomShader)
517 geometry = CreateGeometry(mFactoryCache, mImpl->mCustomShader->mGridSize);
519 else // Get any geometry associated with the texture
521 TextureManager& textureManager = mFactoryCache.GetTextureManager();
523 uint32_t firstElementCount{0u};
524 uint32_t secondElementCount{0u};
525 geometry = textureManager.GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
527 if(!firstElementCount && !secondElementCount) // Otherwise use quad
529 geometry = CreateGeometry(mFactoryCache, ImageDimensions(1, 1));
533 Shader shader = GetShader();
535 // Create the renderer
536 mImpl->mRenderer = Renderer::New(geometry, shader);
538 //Register transform properties
539 mImpl->mTransform.RegisterUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
541 EnablePreMultipliedAlpha(IsPreMultipliedAlphaEnabled());
544 void ImageVisual::LoadTexture(bool& atlasing, Vector4& atlasRect, TextureSet& textures, bool orientationCorrection, TextureManager::ReloadPolicy forceReload)
546 TextureManager& textureManager = mFactoryCache.GetTextureManager();
548 ImageAtlasManagerPtr atlasManager = nullptr;
549 AtlasUploadObserver* atlasUploadObserver = nullptr;
550 auto textureObserver = this;
554 atlasManager = mFactoryCache.GetAtlasManager();
555 atlasUploadObserver = this;
558 auto preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader
559 ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD
560 : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
562 bool synchronousLoading = IsSynchronousLoadingRequired();
565 textures = textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode, mMaskingData, synchronousLoading, mTextureId, atlasRect, mAtlasRectSize, atlasing, loadingStatus, mWrapModeU, mWrapModeV, textureObserver, atlasUploadObserver, atlasManager, mOrientationCorrection, forceReload, preMultiplyOnLoad);
571 mLoadState = TextureManager::LoadState::LOADING;
575 mLoadState = TextureManager::LoadState::LOAD_FINISHED;
578 EnablePreMultipliedAlpha(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
580 else if(synchronousLoading)
582 // Synchronous loading is failed
583 mLoadState = TextureManager::LoadState::LOAD_FAILED;
586 if(atlasing) // Flag needs to be set before creating renderer
588 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
592 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
596 bool ImageVisual::AttemptAtlasing()
598 return (!mImpl->mCustomShader && mImageUrl.GetProtocolType() == VisualUrl::LOCAL && mAttemptAtlasing);
601 void ImageVisual::InitializeRenderer()
603 auto attemptAtlasing = AttemptAtlasing();
605 // Load Texture if mTextures is empty.
606 // mTextures is already set, the mTexture can be used to create Renderer.
607 // There are two cases mTextures is empty.
608 // 1. mTextureId == TextureManager::INVALID_TEXTURE_ID
609 // - Visual is on stage with LoadPolicy::ATTACHED
610 // 2. mTextureId != TextureManager::INVALID_TEXTURE_ID
611 // - If ReleasePolicy is DESTROYED, InitializeRenderer called every on stage called.
612 // - Then every resources those contained in Visual are Reset but mTextureId is remained when the Off stage time,
613 // - So, mTextures needed to be get from texture manager to created resources like mImpl->mRenderer.
616 if(mTextureId == TextureManager::INVALID_TEXTURE_ID)
618 LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::CACHED);
622 mTextures = mFactoryCache.GetTextureManager().GetTextureSet(mTextureId);
628 mImpl->mRenderer.SetTextures(mTextures);
629 if(DevelTexture::IsNative(mTextures.GetTexture(0)))
633 mTextures.Reset(); // Visual should not keep a handle to the texture after this point.
636 if(attemptAtlasing) // the texture is packed inside atlas
638 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
640 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
642 if(!defaultWrapMode) // custom wrap mode
644 Vector2 wrapMode(mWrapModeU - WrapMode::CLAMP_TO_EDGE, mWrapModeV - WrapMode::CLAMP_TO_EDGE);
645 wrapMode.Clamp(Vector2::ZERO, Vector2(2.f, 2.f));
646 mImpl->mRenderer.RegisterProperty(WRAP_MODE_UNIFORM_NAME, wrapMode);
651 void ImageVisual::DoSetOnScene(Actor& actor)
653 if(mImageUrl.IsValid())
655 InitializeRenderer();
658 if(!mImpl->mRenderer)
663 mPlacementActor = actor;
664 // Search the Actor tree to find if Layer UI behaviour set.
665 Layer layer = actor.GetLayer();
666 if(layer && layer.GetProperty<Layer::Behavior>(Layer::Property::BEHAVIOR) == Layer::LAYER_3D)
668 // Layer 3D set, do not align pixels
669 mImpl->mRenderer.RegisterProperty(PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF);
672 if(mPixelArea != FULL_TEXTURE_RECT)
674 mImpl->mRenderer.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, mPixelArea);
677 if(mLoadState == TextureManager::LoadState::LOAD_FINISHED)
679 actor.AddRenderer(mImpl->mRenderer);
680 mPlacementActor.Reset();
682 // Image loaded and ready to display
683 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
685 else if(mLoadState == TextureManager::LoadState::LOAD_FAILED)
687 Texture brokenImage = mFactoryCache.GetBrokenVisualImage();
689 mTextures = TextureSet::New();
690 mTextures.SetTexture(0u, brokenImage);
691 mImpl->mRenderer.SetTextures(mTextures);
693 actor.AddRenderer(mImpl->mRenderer);
694 mPlacementActor.Reset();
696 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
700 void ImageVisual::DoSetOffScene(Actor& actor)
702 // Visual::Base::SetOffScene only calls DoSetOffScene if mRenderer exists (is on onstage)
704 // Image release is dependent on the ReleasePolicy, renderer is removed.
705 actor.RemoveRenderer(mImpl->mRenderer);
706 if(mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
708 RemoveTexture(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
709 mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
711 TextureSet textureSet = TextureSet::New();
712 mImpl->mRenderer.SetTextures(textureSet);
714 mLoadState = TextureManager::LoadState::NOT_STARTED;
717 mPlacementActor.Reset();
720 void ImageVisual::DoCreatePropertyMap(Property::Map& map) const
723 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
725 bool sync = IsSynchronousLoadingRequired();
726 map.Insert(SYNCHRONOUS_LOADING, sync);
727 if(mImageUrl.IsValid())
729 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
730 map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
731 map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
734 map.Insert(Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode);
735 map.Insert(Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode);
737 map.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea);
738 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU);
739 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV);
741 map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
743 if(mMaskingData != NULL)
745 map.Insert(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl());
746 map.Insert(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor);
747 map.Insert(Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask);
750 map.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy);
751 map.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy);
752 map.Insert(Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, mOrientationCorrection);
755 void ImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
758 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
759 if(mImageUrl.IsValid())
761 map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
762 map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
766 void ImageVisual::OnDoAction(const Dali::Property::Index actionName, const Dali::Property::Value& attributes)
768 // Check if action is valid for this visual type and perform action if possible
772 case DevelImageVisual::Action::RELOAD:
774 auto attemptAtlasing = AttemptAtlasing();
775 LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::FORCED);
781 void ImageVisual::OnSetTransform()
785 mImpl->mTransform.RegisterUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
789 bool ImageVisual::IsResourceReady() const
791 return (mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::READY ||
792 mImpl->mResourceStatus == Toolkit::Visual::ResourceStatus::FAILED);
795 void ImageVisual::UpdateShader()
799 Shader shader = GetShader();
800 mImpl->mRenderer.SetShader(shader);
804 // From existing atlas manager
805 void ImageVisual::UploadCompleted()
807 // Texture has been uploaded. If weak handle is holding a placement actor,
808 // it is the time to add the renderer to actor.
809 Actor actor = mPlacementActor.GetHandle();
812 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
813 actor.AddRenderer(mImpl->mRenderer);
814 // reset the weak handle so that the renderer only get added to actor once
815 mPlacementActor.Reset();
819 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
820 mLoadState = TextureManager::LoadState::LOAD_FINISHED;
823 // From Texture Manager
824 void ImageVisual::UploadComplete(bool loadingSuccess, int32_t textureId, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle, bool preMultiplied)
826 Toolkit::Visual::ResourceStatus resourceStatus;
831 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
834 EnablePreMultipliedAlpha(preMultiplied);
836 Actor actor = mPlacementActor.GetHandle();
839 actor.AddRenderer(mImpl->mRenderer);
840 // reset the weak handle so that the renderer only get added to actor once
841 mPlacementActor.Reset();
846 Texture brokenImage = mFactoryCache.GetBrokenVisualImage();
848 textureSet = TextureSet::New();
849 textureSet.SetTexture(0u, brokenImage);
850 mImpl->mRenderer.SetTextures(textureSet);
853 Sampler sampler = Sampler::New();
854 sampler.SetWrapMode(mWrapModeU, mWrapModeV);
855 textureSet.SetSampler(0u, sampler);
856 mImpl->mRenderer.SetTextures(textureSet);
859 // Storing TextureSet needed when renderer staged.
860 if(!mImpl->mRenderer)
862 mTextures = textureSet;
865 // Image loaded, set status regardless of staged status.
868 resourceStatus = Toolkit::Visual::ResourceStatus::READY;
869 mLoadState = TextureManager::LoadState::LOAD_FINISHED;
873 resourceStatus = Toolkit::Visual::ResourceStatus::FAILED;
874 mLoadState = TextureManager::LoadState::LOAD_FAILED;
877 // use geometry if needed
880 uint32_t firstElementCount{0u};
881 uint32_t secondElementCount{0u};
882 auto geometry = mFactoryCache.GetTextureManager().GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
883 if(mImpl->mRenderer && geometry)
885 mImpl->mRenderer.SetGeometry(geometry);
886 Dali::DevelRenderer::DrawCommand drawCommand{};
887 drawCommand.drawType = DevelRenderer::DrawType::INDEXED;
889 if(firstElementCount)
891 drawCommand.firstIndex = 0;
892 drawCommand.elementCount = firstElementCount;
893 drawCommand.queue = DevelRenderer::RENDER_QUEUE_OPAQUE;
894 DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
897 if(secondElementCount)
899 drawCommand.firstIndex = firstElementCount;
900 drawCommand.elementCount = secondElementCount;
901 drawCommand.queue = DevelRenderer::RENDER_QUEUE_TRANSPARENT;
902 DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
907 // Signal to observers ( control ) that resources are ready. Must be all resources.
908 ResourceReady(resourceStatus);
911 void ImageVisual::RemoveTexture()
913 if(mTextureId != TextureManager::INVALID_TEXTURE_ID)
915 mFactoryCache.GetTextureManager().Remove(mTextureId, this);
916 mTextureId = TextureManager::INVALID_TEXTURE_ID;
920 Vector4 atlasRect(0.f, 0.f, 1.f, 1.f);
921 Property::Index index = mImpl->mRenderer.GetPropertyIndex(ATLAS_RECT_UNIFORM_NAME);
922 if(index != Property::INVALID_INDEX)
924 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty(index);
925 atlasRectValue.Get(atlasRect);
928 TextureSet textureSet = mImpl->mRenderer.GetTextures();
930 if(index != Property::INVALID_INDEX)
932 mFactoryCache.GetAtlasManager()->Remove(textureSet, atlasRect);
937 Shader ImageVisual::GetShader()
941 std::string_view vertexShaderView;
942 bool usesWholeTexture = true;
943 if(mImpl->mCustomShader && !mImpl->mCustomShader->mVertexShader.empty())
945 vertexShaderView = mImpl->mCustomShader->mVertexShader;
946 usesWholeTexture = false; // Impossible to tell.
950 vertexShaderView = mImageVisualShaderFactory.GetVertexShaderSource();
953 std::string_view fragmentShaderView;
954 if(mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty())
956 fragmentShaderView = mImpl->mCustomShader->mFragmentShader;
960 fragmentShaderView = mImageVisualShaderFactory.GetFragmentShaderSource();
963 // If the texture is native, we may need to change prefix and sampler in
964 // the fragment shader
965 bool modifiedFragmentShader = false;
966 std::string fragmentShaderString;
967 if(mTextures && DevelTexture::IsNative(mTextures.GetTexture(0)))
969 Texture nativeTexture = mTextures.GetTexture(0);
970 fragmentShaderString = std::string(fragmentShaderView);
971 modifiedFragmentShader = DevelTexture::ApplyNativeFragmentShader(nativeTexture, fragmentShaderString);
972 fragmentShaderView = fragmentShaderString;
975 const bool useStandardShader = !mImpl->mCustomShader && !modifiedFragmentShader;
976 if(useStandardShader)
978 // Create and cache the standard shader
979 shader = mImageVisualShaderFactory.GetShader(
981 mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
982 mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE,
983 IsRoundedCornerRequired());
985 else if(mImpl->mCustomShader)
987 shader = Shader::New(vertexShaderView, fragmentShaderView, mImpl->mCustomShader->mHints);
991 shader = Shader::New(vertexShaderView, fragmentShaderView);
996 shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
999 // Set pixel align off as default.
1000 // ToDo: Pixel align causes issues such as rattling image animation.
1001 // We should trun it off until issues are resolved
1002 shader.RegisterProperty(PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF);
1007 } // namespace Internal
1009 } // namespace Toolkit