2 * Copyright (c) 2022 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 <dali/public-api/rendering/decorated-visual-renderer.h>
31 #include <cstring> // for strlen()
34 #include <dali-toolkit/devel-api/visuals/image-visual-actions-devel.h>
35 #include <dali-toolkit/internal/texture-manager/texture-manager-impl.h>
36 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
37 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
38 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
39 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
40 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
41 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
42 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
43 #include <dali-toolkit/internal/visuals/visual-url.h>
44 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
45 #include <dali-toolkit/public-api/visuals/visual-properties.h>
55 const int CUSTOM_PROPERTY_COUNT(7); // ltr, wrap, pixel area, atlas, pixalign, crop to mask, mask texture ratio
58 DALI_ENUM_TO_STRING_TABLE_BEGIN(FITTING_MODE)
59 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, SHRINK_TO_FIT)
60 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, SCALE_TO_FILL)
61 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, FIT_WIDTH)
62 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, FIT_HEIGHT)
63 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::FittingMode, DEFAULT)
64 DALI_ENUM_TO_STRING_TABLE_END(FITTING_MODE)
67 DALI_ENUM_TO_STRING_TABLE_BEGIN(SAMPLING_MODE)
68 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, BOX)
69 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, NEAREST)
70 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, LINEAR)
71 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, BOX_THEN_NEAREST)
72 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, BOX_THEN_LINEAR)
73 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, NO_FILTER)
74 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::SamplingMode, DONT_CARE)
75 DALI_ENUM_TO_STRING_TABLE_END(SAMPLING_MODE)
78 DALI_ENUM_TO_STRING_TABLE_BEGIN(WRAP_MODE)
79 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, DEFAULT)
80 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, CLAMP_TO_EDGE)
81 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, REPEAT)
82 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::WrapMode, MIRRORED_REPEAT)
83 DALI_ENUM_TO_STRING_TABLE_END(WRAP_MODE)
86 DALI_ENUM_TO_STRING_TABLE_BEGIN(LOAD_POLICY)
87 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::LoadPolicy, IMMEDIATE)
88 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::LoadPolicy, ATTACHED)
89 DALI_ENUM_TO_STRING_TABLE_END(LOAD_POLICY)
92 DALI_ENUM_TO_STRING_TABLE_BEGIN(RELEASE_POLICY)
93 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, DETACHED)
94 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, DESTROYED)
95 DALI_ENUM_TO_STRING_WITH_SCOPE(Dali::Toolkit::ImageVisual::ReleasePolicy, NEVER)
96 DALI_ENUM_TO_STRING_TABLE_END(RELEASE_POLICY)
98 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
100 const float PIXEL_ALIGN_ON = 1.0f;
101 const float PIXEL_ALIGN_OFF = 0.0f;
103 constexpr uint32_t TEXTURE_COUNT_FOR_GPU_ALPHA_MASK = 2u;
105 Geometry CreateGeometry(VisualFactoryCache& factoryCache, ImageDimensions gridSize)
109 if(gridSize == ImageDimensions(1, 1))
111 geometry = factoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
115 geometry = VisualFactoryCache::CreateGridGeometry(gridSize);
121 } // 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())
183 if(mImageUrl.IsValid())
185 // Decrease reference count of External Resources :
186 // EncodedImageBuffer or ExternalTextures.
187 // Ensure the stage is still valid before accessing texture manager.
188 if(mImageUrl.GetProtocolType() == VisualUrl::TEXTURE)
190 TextureManager& textureManager = mFactoryCache.GetTextureManager();
191 textureManager.RemoveExternalTexture(mImageUrl.GetUrl());
193 else if(mImageUrl.IsBufferResource())
195 TextureManager& textureManager = mFactoryCache.GetTextureManager();
196 textureManager.RemoveEncodedImageBuffer(mImageUrl.GetUrl());
200 // ImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
201 if((mTextureId != TextureManager::INVALID_TEXTURE_ID) && (mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER))
208 void ImageVisual::DoSetProperties(const Property::Map& propertyMap)
210 // Url is already received in constructor
211 for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
213 KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
214 if(keyValue.first.type == Property::Key::INDEX)
216 DoSetProperty(keyValue.first.indexKey, keyValue.second);
220 if(keyValue.first == IMAGE_FITTING_MODE)
222 DoSetProperty(Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second);
224 else if(keyValue.first == IMAGE_SAMPLING_MODE)
226 DoSetProperty(Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second);
228 else if(keyValue.first == IMAGE_DESIRED_WIDTH)
230 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
232 else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
234 DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
236 else if(keyValue.first == PIXEL_AREA_UNIFORM_NAME)
238 DoSetProperty(Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second);
240 else if(keyValue.first == IMAGE_WRAP_MODE_U)
242 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second);
244 else if(keyValue.first == IMAGE_WRAP_MODE_V)
246 DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second);
248 else if(keyValue.first == SYNCHRONOUS_LOADING)
250 DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
252 else if(keyValue.first == IMAGE_ATLASING)
254 DoSetProperty(Toolkit::ImageVisual::Property::ATLASING, keyValue.second);
256 else if(keyValue.first == ALPHA_MASK_URL)
258 DoSetProperty(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second);
260 else if(keyValue.first == MASK_CONTENT_SCALE_NAME)
262 DoSetProperty(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second);
264 else if(keyValue.first == CROP_TO_MASK_NAME)
266 DoSetProperty(Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second);
268 else if(keyValue.first == MASKING_TYPE_NAME)
270 DoSetProperty(Toolkit::DevelImageVisual::Property::MASKING_TYPE, keyValue.second);
272 else if(keyValue.first == LOAD_POLICY_NAME)
274 DoSetProperty(Toolkit::ImageVisual::Property::LOAD_POLICY, keyValue.second);
276 else if(keyValue.first == RELEASE_POLICY_NAME)
278 DoSetProperty(Toolkit::ImageVisual::Property::RELEASE_POLICY, keyValue.second);
280 else if(keyValue.first == ORIENTATION_CORRECTION_NAME)
282 DoSetProperty(Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, keyValue.second);
286 // Load image immediately if LOAD_POLICY requires it
287 if(mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::IMMEDIATE)
289 auto attemptAtlasing = AttemptAtlasing();
290 LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::CACHED);
294 void ImageVisual::DoSetProperty(Property::Index index, const Property::Value& value)
298 case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
305 mImpl->mFlags |= Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
309 mImpl->mFlags &= ~Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
314 DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
319 case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
321 float desiredWidth = 0.0f;
322 if(value.Get(desiredWidth))
324 mDesiredSize.SetWidth(desiredWidth);
328 DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
333 case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
335 float desiredHeight = 0.0f;
336 if(value.Get(desiredHeight))
338 mDesiredSize.SetHeight(desiredHeight);
342 DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
347 case Toolkit::ImageVisual::Property::FITTING_MODE:
350 Scripting::GetEnumerationProperty(value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode);
351 mFittingMode = Dali::FittingMode::Type(fittingMode);
355 case Toolkit::ImageVisual::Property::SAMPLING_MODE:
357 int samplingMode = 0;
358 Scripting::GetEnumerationProperty(value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode);
359 mSamplingMode = Dali::SamplingMode::Type(samplingMode);
363 case Toolkit::ImageVisual::Property::PIXEL_AREA:
365 value.Get(mPixelArea);
369 case Toolkit::ImageVisual::Property::WRAP_MODE_U:
372 Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode);
373 mWrapModeU = Dali::WrapMode::Type(wrapMode);
377 case Toolkit::ImageVisual::Property::WRAP_MODE_V:
380 Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode);
381 mWrapModeV = Dali::WrapMode::Type(wrapMode);
385 case Toolkit::ImageVisual::Property::ATLASING:
387 value.Get(mAttemptAtlasing);
391 case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
393 std::string alphaUrl = "";
394 if(value.Get(alphaUrl))
397 mMaskingData->mAlphaMaskUrl = alphaUrl;
402 case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
408 mMaskingData->mContentScaleFactor = scale;
413 case Toolkit::ImageVisual::Property::CROP_TO_MASK:
419 mMaskingData->mCropToMask = crop;
424 case Toolkit::DevelImageVisual::Property::MASKING_TYPE:
427 if(value.Get(maskingType))
430 mMaskingData->mPreappliedMasking = Toolkit::DevelImageVisual::MaskingType::Type(maskingType) == Toolkit::DevelImageVisual::MaskingType::MASKING_ON_LOADING ? true : false;
435 case Toolkit::ImageVisual::Property::RELEASE_POLICY:
437 int releasePolicy = 0;
438 Scripting::GetEnumerationProperty(value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy);
439 mReleasePolicy = Toolkit::ImageVisual::ReleasePolicy::Type(releasePolicy);
443 case Toolkit::ImageVisual::Property::LOAD_POLICY:
446 Scripting::GetEnumerationProperty(value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy);
447 mLoadPolicy = Toolkit::ImageVisual::LoadPolicy::Type(loadPolicy);
450 case Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION:
452 bool orientationCorrection(mOrientationCorrection);
453 if(value.Get(orientationCorrection))
455 mOrientationCorrection = orientationCorrection;
462 void ImageVisual::AllocateMaskData()
466 mMaskingData.reset(new TextureManager::MaskingData());
470 void ImageVisual::GetNaturalSize(Vector2& naturalSize)
472 if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
474 naturalSize.x = mDesiredSize.GetWidth();
475 naturalSize.y = mDesiredSize.GetHeight();
478 else if(mImpl->mRenderer) // Check if we have a loaded image
480 if(mImpl->mFlags & Visual::Base::Impl::IS_ATLASING_APPLIED)
482 naturalSize.x = mAtlasRectSize.GetWidth();
483 naturalSize.y = mAtlasRectSize.GetHeight();
487 auto textureSet = mImpl->mRenderer.GetTextures();
488 if(textureSet && textureSet.GetTextureCount())
490 if(mTextureSize != Vector2::ZERO)
492 naturalSize = mTextureSize;
498 if(mMaskingData != NULL && mMaskingData->mAlphaMaskUrl.IsValid() &&
499 mMaskingData->mCropToMask)
501 ImageDimensions dimensions = Dali::GetClosestImageSize(mMaskingData->mAlphaMaskUrl.GetUrl());
502 if(dimensions != ImageDimensions(0, 0))
504 naturalSize.x = dimensions.GetWidth();
505 naturalSize.y = dimensions.GetHeight();
509 else if(mImageUrl.IsValid())
511 if(mImageUrl.GetProtocolType() == VisualUrl::LOCAL)
513 ImageDimensions dimensions = Dali::GetClosestImageSize(mImageUrl.GetUrl());
515 if(dimensions != ImageDimensions(0, 0))
517 naturalSize.x = dimensions.GetWidth();
518 naturalSize.y = dimensions.GetHeight();
522 Actor actor = mPlacementActor.GetHandle();
523 Vector2 imageSize = Vector2::ZERO;
526 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
528 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
529 Texture brokenImage = mImpl->mRenderer.GetTextures().GetTexture(0);
530 naturalSize.x = brokenImage.GetWidth();
531 naturalSize.y = brokenImage.GetWidth();
536 naturalSize = Vector2::ZERO;
539 void ImageVisual::OnInitialize()
544 if(mImpl->mCustomShader)
546 geometry = CreateGeometry(mFactoryCache, mImpl->mCustomShader->mGridSize);
548 else // Get any geometry associated with the texture
550 TextureManager& textureManager = mFactoryCache.GetTextureManager();
552 uint32_t firstElementCount{0u};
553 uint32_t secondElementCount{0u};
554 geometry = textureManager.GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
556 if(!firstElementCount && !secondElementCount) // Otherwise use quad
558 geometry = CreateGeometry(mFactoryCache, ImageDimensions(1, 1));
562 // Increase reference count of External Resources :
563 // EncodedImageBuffer or ExternalTextures.
564 // Reference count will be decreased at destructor of the visual.
565 if(mImageUrl.IsValid() && (mImageUrl.IsBufferResource() || mImageUrl.GetProtocolType() == VisualUrl::TEXTURE))
567 TextureManager& textureManager = mFactoryCache.GetTextureManager();
568 textureManager.UseExternalResource(mImageUrl.GetUrl());
571 Shader shader = GenerateShader();
573 // Create the renderer
574 mImpl->mRenderer = DecoratedVisualRenderer::New(geometry, shader);
575 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
577 //Register transform properties
578 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
580 EnablePreMultipliedAlpha(IsPreMultipliedAlphaEnabled());
584 mImpl->mRenderer.RegisterProperty(CROP_TO_MASK_NAME, static_cast<float>(mMaskingData->mCropToMask));
588 void ImageVisual::LoadTexture(bool& atlasing, Vector4& atlasRect, TextureSet& textures, bool orientationCorrection, TextureManager::ReloadPolicy forceReload)
590 TextureManager& textureManager = mFactoryCache.GetTextureManager();
592 ImageAtlasManagerPtr atlasManager = nullptr;
593 AtlasUploadObserver* atlasUploadObserver = nullptr;
594 auto textureObserver = this;
598 atlasManager = mFactoryCache.GetAtlasManager();
599 atlasUploadObserver = this;
602 auto preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader
603 ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD
604 : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
606 bool synchronousLoading = IsSynchronousLoadingRequired();
609 textures = textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode, mMaskingData, synchronousLoading, mTextureId, atlasRect, mAtlasRectSize, atlasing, loadingStatus, textureObserver, atlasUploadObserver, atlasManager, mOrientationCorrection, forceReload, preMultiplyOnLoad);
615 mLoadState = TextureManager::LoadState::LOADING;
619 mLoadState = TextureManager::LoadState::LOAD_FINISHED;
622 EnablePreMultipliedAlpha(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
625 Sampler sampler = Sampler::New();
626 sampler.SetWrapMode(mWrapModeU, mWrapModeV);
627 textures.SetSampler(0u, sampler);
630 else if(synchronousLoading)
632 // Synchronous loading is failed
633 mLoadState = TextureManager::LoadState::LOAD_FAILED;
636 if(atlasing) // Flag needs to be set before creating renderer
638 mImpl->mFlags |= Visual::Base::Impl::IS_ATLASING_APPLIED;
642 mImpl->mFlags &= ~Visual::Base::Impl::IS_ATLASING_APPLIED;
646 bool ImageVisual::AttemptAtlasing()
648 return (!mImpl->mCustomShader && (mImageUrl.IsLocalResource() || mImageUrl.IsBufferResource()) && mAttemptAtlasing);
651 void ImageVisual::InitializeRenderer()
653 auto attemptAtlasing = AttemptAtlasing();
655 // Load Texture if mTextures is empty.
656 // mTextures is already set, the mTexture can be used to create Renderer.
657 // There are two cases mTextures is empty.
658 // 1. mTextureId == TextureManager::INVALID_TEXTURE_ID
659 // - Visual is on stage with LoadPolicy::ATTACHED
660 // 2. mTextureId != TextureManager::INVALID_TEXTURE_ID
661 // - If ReleasePolicy is DESTROYED, InitializeRenderer called every on stage called.
662 // - Then every resources those contained in Visual are Reset but mTextureId is remained when the Off stage time,
663 // - So, mTextures needed to be get from texture manager to created resources like mImpl->mRenderer.
666 if(mTextureId == TextureManager::INVALID_TEXTURE_ID)
668 LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::CACHED);
672 mTextures = mFactoryCache.GetTextureManager().GetTextureSet(mTextureId);
673 if(!(mImpl->mFlags & Visual::Base::Impl::IS_ATLASING_APPLIED) && mTextures)
675 Sampler sampler = Sampler::New();
676 sampler.SetWrapMode(mWrapModeU, mWrapModeV);
677 mTextures.SetSampler(0u, sampler);
684 mImpl->mRenderer.SetTextures(mTextures);
685 ComputeTextureSize();
688 bool needToUpdateShader = DevelTexture::IsNative(mTextures.GetTexture(0));
690 if(mTextures.GetTextureCount() == 3)
692 if(mTextures.GetTexture(0).GetPixelFormat() == Pixel::L8 && mTextures.GetTexture(1).GetPixelFormat() == Pixel::CHROMINANCE_U && mTextures.GetTexture(2).GetPixelFormat() == Pixel::CHROMINANCE_V)
694 mNeedYuvToRgb = true;
695 needToUpdateShader = true;
699 if(needToUpdateShader)
703 mTextures.Reset(); // Visual should not keep a handle to the texture after this point.
706 if(attemptAtlasing) // the texture is packed inside atlas
708 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
710 bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
712 if(!defaultWrapMode) // custom wrap mode
714 Vector2 wrapMode(mWrapModeU - WrapMode::CLAMP_TO_EDGE, mWrapModeV - WrapMode::CLAMP_TO_EDGE);
715 wrapMode.Clamp(Vector2::ZERO, Vector2(2.f, 2.f));
716 mImpl->mRenderer.RegisterProperty(WRAP_MODE_UNIFORM_NAME, wrapMode);
721 void ImageVisual::DoSetOnScene(Actor& actor)
723 if(mImageUrl.IsValid())
725 InitializeRenderer();
728 if(!mImpl->mRenderer)
733 mPlacementActor = actor;
734 // Search the Actor tree to find if Layer UI behaviour set.
735 Layer layer = actor.GetLayer();
736 if(layer && layer.GetProperty<Layer::Behavior>(Layer::Property::BEHAVIOR) == Layer::LAYER_3D)
738 // Layer 3D set, do not align pixels
739 mImpl->mRenderer.RegisterProperty(PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF);
742 if(mPixelArea != FULL_TEXTURE_RECT)
744 mImpl->mRenderer.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, mPixelArea);
747 if(mLoadState == TextureManager::LoadState::LOAD_FINISHED)
749 actor.AddRenderer(mImpl->mRenderer);
750 mPlacementActor.Reset();
752 // Image loaded and ready to display
753 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
755 else if(mLoadState == TextureManager::LoadState::LOAD_FAILED)
757 Vector2 imageSize = Vector2::ZERO;
760 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
762 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
763 actor.AddRenderer(mImpl->mRenderer);
764 mPlacementActor.Reset();
766 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
770 void ImageVisual::DoSetOffScene(Actor& actor)
772 // Visual::Base::SetOffScene only calls DoSetOffScene if mRenderer exists (is on onstage)
774 // Image release is dependent on the ReleasePolicy, renderer is removed.
775 actor.RemoveRenderer(mImpl->mRenderer);
776 if(mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
778 RemoveTexture(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
779 mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
781 TextureSet textureSet = TextureSet::New();
782 mImpl->mRenderer.SetTextures(textureSet);
783 ComputeTextureSize();
785 mLoadState = TextureManager::LoadState::NOT_STARTED;
788 mPlacementActor.Reset();
791 void ImageVisual::DoCreatePropertyMap(Property::Map& map) const
794 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
796 bool sync = IsSynchronousLoadingRequired();
797 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync);
798 if(mImageUrl.IsValid())
800 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
801 map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
802 map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
805 map.Insert(Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode);
806 map.Insert(Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode);
808 map.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea);
809 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU);
810 map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV);
812 map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
814 if(mMaskingData != NULL)
816 map.Insert(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl());
817 map.Insert(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor);
818 map.Insert(Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask);
819 map.Insert(Toolkit::DevelImageVisual::Property::MASKING_TYPE, mMaskingData->mPreappliedMasking ? DevelImageVisual::MaskingType::MASKING_ON_LOADING : DevelImageVisual::MaskingType::MASKING_ON_RENDERING);
822 map.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy);
823 map.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy);
824 map.Insert(Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, mOrientationCorrection);
827 void ImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
830 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
831 if(mImageUrl.IsValid())
833 map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
834 map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
838 void ImageVisual::OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes)
840 // Check if action is valid for this visual type and perform action if possible
844 case DevelImageVisual::Action::RELOAD:
846 auto attemptAtlasing = AttemptAtlasing();
847 LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::FORCED);
853 void ImageVisual::OnSetTransform()
857 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
861 void ImageVisual::UpdateShader()
865 Shader shader = GenerateShader();
866 mImpl->mRenderer.SetShader(shader);
870 // From existing atlas manager
871 void ImageVisual::UploadCompleted()
873 // Texture has been uploaded. If weak handle is holding a placement actor,
874 // it is the time to add the renderer to actor.
875 Actor actor = mPlacementActor.GetHandle();
878 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
879 actor.AddRenderer(mImpl->mRenderer);
880 // reset the weak handle so that the renderer only get added to actor once
881 mPlacementActor.Reset();
885 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
886 mLoadState = TextureManager::LoadState::LOAD_FINISHED;
889 // From Texture Manager
890 void ImageVisual::LoadComplete(bool loadingSuccess, TextureInformation textureInformation)
892 Toolkit::Visual::ResourceStatus resourceStatus;
895 if(textureInformation.useAtlasing)
897 mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
900 EnablePreMultipliedAlpha(textureInformation.preMultiplied);
902 Actor actor = mPlacementActor.GetHandle();
905 Vector2 imageSize = Vector2::ZERO;
908 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
910 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
911 textureInformation.textureSet = mImpl->mRenderer.GetTextures();
915 if(!textureInformation.useAtlasing)
917 Sampler sampler = Sampler::New();
918 sampler.SetWrapMode(mWrapModeU, mWrapModeV);
919 textureInformation.textureSet.SetSampler(0u, sampler);
922 mImpl->mRenderer.SetTextures(textureInformation.textureSet);
923 ComputeTextureSize();
926 if(textureInformation.textureSet.GetTextureCount() == 3)
928 if(textureInformation.textureSet.GetTexture(0).GetPixelFormat() == Pixel::L8 && textureInformation.textureSet.GetTexture(1).GetPixelFormat() == Pixel::CHROMINANCE_U && textureInformation.textureSet.GetTexture(2).GetPixelFormat() == Pixel::CHROMINANCE_V)
930 mNeedYuvToRgb = true;
938 actor.AddRenderer(mImpl->mRenderer);
939 // reset the weak handle so that the renderer only get added to actor once
940 mPlacementActor.Reset();
944 // Storing TextureSet needed when renderer staged.
945 if(!mImpl->mRenderer)
947 mTextures = textureInformation.textureSet;
950 // Image loaded, set status regardless of staged status.
953 resourceStatus = Toolkit::Visual::ResourceStatus::READY;
954 mLoadState = TextureManager::LoadState::LOAD_FINISHED;
958 resourceStatus = Toolkit::Visual::ResourceStatus::FAILED;
959 mLoadState = TextureManager::LoadState::LOAD_FAILED;
962 // use geometry if needed
965 uint32_t firstElementCount{0u};
966 uint32_t secondElementCount{0u};
967 auto geometry = mFactoryCache.GetTextureManager().GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
968 if(mImpl->mRenderer && geometry)
970 mImpl->mRenderer.SetGeometry(geometry);
971 Dali::DevelRenderer::DrawCommand drawCommand{};
972 drawCommand.drawType = DevelRenderer::DrawType::INDEXED;
974 if(firstElementCount)
976 drawCommand.firstIndex = 0;
977 drawCommand.elementCount = firstElementCount;
978 drawCommand.queue = DevelRenderer::RENDER_QUEUE_OPAQUE;
979 DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
982 if(secondElementCount)
984 drawCommand.firstIndex = firstElementCount;
985 drawCommand.elementCount = secondElementCount;
986 drawCommand.queue = DevelRenderer::RENDER_QUEUE_TRANSPARENT;
987 DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
992 // Signal to observers ( control ) that resources are ready. Must be all resources.
993 ResourceReady(resourceStatus);
996 void ImageVisual::RemoveTexture()
998 if(mTextureId != TextureManager::INVALID_TEXTURE_ID)
1000 mFactoryCache.GetTextureManager().Remove(mTextureId, this);
1001 mTextureId = TextureManager::INVALID_TEXTURE_ID;
1005 Vector4 atlasRect(0.f, 0.f, 1.f, 1.f);
1006 Property::Index index = mImpl->mRenderer.GetPropertyIndex(ATLAS_RECT_UNIFORM_NAME);
1007 if(index != Property::INVALID_INDEX)
1009 Property::Value atlasRectValue = mImpl->mRenderer.GetProperty(index);
1010 atlasRectValue.Get(atlasRect);
1013 TextureSet textureSet = mImpl->mRenderer.GetTextures();
1015 if(index != Property::INVALID_INDEX)
1017 mFactoryCache.GetAtlasManager()->Remove(textureSet, atlasRect);
1022 void ImageVisual::ComputeTextureSize()
1024 if(mImpl->mRenderer)
1026 auto textureSet = mImpl->mRenderer.GetTextures();
1027 if(textureSet && textureSet.GetTextureCount())
1029 auto texture = textureSet.GetTexture(0);
1032 mTextureSize.x = texture.GetWidth();
1033 mTextureSize.y = texture.GetHeight();
1034 if(textureSet.GetTextureCount() > 1u && mMaskingData && !mMaskingData->mPreappliedMasking && mMaskingData->mCropToMask)
1036 Texture maskTexture = textureSet.GetTexture(1);
1039 mTextureSize.x = std::min(static_cast<uint32_t>(mTextureSize.x * mMaskingData->mContentScaleFactor), maskTexture.GetWidth());
1040 mTextureSize.y = std::min(static_cast<uint32_t>(mTextureSize.y * mMaskingData->mContentScaleFactor), maskTexture.GetHeight());
1048 Vector2 ImageVisual::ComputeMaskTextureRatio()
1050 Vector2 maskTextureRatio;
1051 if(mImpl->mRenderer)
1053 auto textureSet = mImpl->mRenderer.GetTextures();
1054 if(textureSet && textureSet.GetTextureCount())
1056 auto texture = textureSet.GetTexture(0);
1059 if(textureSet.GetTextureCount() > 1u && mMaskingData && !mMaskingData->mPreappliedMasking && mMaskingData->mCropToMask)
1061 Texture maskTexture = textureSet.GetTexture(1);
1064 float textureWidth = std::max(static_cast<float>(texture.GetWidth() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
1065 float textureHeight = std::max(static_cast<float>(texture.GetHeight() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
1066 maskTextureRatio = Vector2(std::min(static_cast<float>(maskTexture.GetWidth()), textureWidth) / textureWidth,
1067 std::min(static_cast<float>(maskTexture.GetHeight()), textureHeight) / textureHeight);
1073 return maskTextureRatio;
1076 Shader ImageVisual::GenerateShader() const
1080 bool usesWholeTexture = true;
1081 const bool useStandardShader = !mImpl->mCustomShader;
1082 const bool useNativeImage = (mTextures && DevelTexture::IsNative(mTextures.GetTexture(0)));
1084 if(useStandardShader)
1086 bool requiredAlphaMaskingOnRendering = (mMaskingData && !mMaskingData->mMaskImageLoadingFailed) ? !mMaskingData->mPreappliedMasking : false;
1087 // Create and cache the standard shader
1088 shader = mImageVisualShaderFactory.GetShader(
1090 ImageVisualShaderFeature::FeatureBuilder()
1091 .EnableTextureAtlas(mImpl->mFlags & Visual::Base::Impl::IS_ATLASING_APPLIED && !useNativeImage)
1092 .ApplyDefaultTextureWrapMode(mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE)
1093 .EnableRoundedCorner(IsRoundedCornerRequired())
1094 .EnableBorderline(IsBorderlineRequired())
1095 .SetTextureForFragmentShaderCheck(useNativeImage ? mTextures.GetTexture(0) : Dali::Texture())
1096 .EnableAlphaMaskingOnRendering(requiredAlphaMaskingOnRendering)
1097 .EnableYuvToRgb(mNeedYuvToRgb));
1101 std::string_view vertexShaderView;
1102 std::string_view fragmentShaderView;
1104 if(mImpl->mCustomShader && !mImpl->mCustomShader->mVertexShader.empty())
1106 vertexShaderView = mImpl->mCustomShader->mVertexShader;
1107 usesWholeTexture = false; // Impossible to tell.
1111 vertexShaderView = mImageVisualShaderFactory.GetVertexShaderSource();
1114 if(mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty())
1116 fragmentShaderView = mImpl->mCustomShader->mFragmentShader;
1120 fragmentShaderView = mImageVisualShaderFactory.GetFragmentShaderSource();
1123 // If the texture is native, we may need to change prefix and sampler in
1124 // the fragment shader
1127 bool modifiedFragmentShader = false;
1128 Texture nativeTexture = mTextures.GetTexture(0);
1129 std::string fragmentShaderString = std::string(fragmentShaderView);
1131 modifiedFragmentShader = DevelTexture::ApplyNativeFragmentShader(nativeTexture, fragmentShaderString);
1132 if(modifiedFragmentShader)
1134 fragmentShaderView = fragmentShaderString;
1137 // Create shader here cause fragmentShaderString scope issue
1138 shader = Shader::New(vertexShaderView, fragmentShaderView, mImpl->mCustomShader->mHints);
1142 shader = Shader::New(vertexShaderView, fragmentShaderView, mImpl->mCustomShader->mHints);
1146 if(usesWholeTexture)
1148 shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
1151 // Set pixel align off as default.
1152 // ToDo: Pixel align causes issues such as rattling image animation.
1153 // We should trun it off until issues are resolved
1154 shader.RegisterProperty(PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF);
1159 void ImageVisual::CheckMaskTexture()
1161 if(mMaskingData && !mMaskingData->mPreappliedMasking)
1163 bool maskLoadFailed = true;
1164 TextureSet textures = mImpl->mRenderer.GetTextures();
1165 if(textures && textures.GetTextureCount() >= TEXTURE_COUNT_FOR_GPU_ALPHA_MASK)
1167 if(mMaskingData->mCropToMask)
1169 mImpl->mRenderer.RegisterProperty(MASK_TEXTURE_RATIO_NAME, ComputeMaskTextureRatio());
1171 maskLoadFailed = false;
1174 if(mMaskingData->mMaskImageLoadingFailed != maskLoadFailed)
1176 mMaskingData->mMaskImageLoadingFailed = maskLoadFailed;
1182 } // namespace Internal
1184 } // namespace Toolkit