dali-toolkit/internal/visuals/image/image-visual.cpp

   1 /*
   2  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/visuals/image/image-visual.h>
  20
  21 // EXTERNAL HEADERS
  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()
  32
  33 // INTERNAL HEADERS
  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>
  46
  47 namespace Dali
  48 {
  49 namespace Toolkit
  50 {
  51 namespace Internal
  52 {
  53 namespace
  54 {
  55 const int CUSTOM_PROPERTY_COUNT(7); // ltr, wrap, pixel area, atlas, pixalign, crop to mask, mask texture ratio
  56
  57 // fitting modes
  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)
  65
  66 // sampling modes
  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)
  76
  77 // wrap modes
  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)
  84
  85 // load policies
  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)
  90
  91 // release policies
  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)
  97
  98 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
  99
 100 constexpr uint32_t TEXTURE_COUNT_FOR_GPU_ALPHA_MASK = 2u;
 101
 102 Geometry CreateGeometry(VisualFactoryCache& factoryCache, ImageDimensions gridSize)
 103 {
 104   Geometry geometry;
 105
 106   if(gridSize == ImageDimensions(1, 1))
 107   {
 108     geometry = factoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
 109   }
 110   else
 111   {
 112     geometry = VisualFactoryCache::CreateGridGeometry(gridSize);
 113   }
 114
 115   return geometry;
 116 }
 117
 118 } // unnamed namespace
 119
 120 ImageVisualPtr ImageVisual::New(VisualFactoryCache&       factoryCache,
 121                                 ImageVisualShaderFactory& shaderFactory,
 122                                 const VisualUrl&          imageUrl,
 123                                 const Property::Map&      properties,
 124                                 ImageDimensions           size,
 125                                 FittingMode::Type         fittingMode,
 126                                 Dali::SamplingMode::Type  samplingMode)
 127 {
 128   ImageVisualPtr imageVisualPtr(new ImageVisual(factoryCache, shaderFactory, imageUrl, size, fittingMode, samplingMode));
 129   imageVisualPtr->SetProperties(properties);
 130   imageVisualPtr->Initialize();
 131   return imageVisualPtr;
 132 }
 133
 134 ImageVisualPtr ImageVisual::New(VisualFactoryCache&       factoryCache,
 135                                 ImageVisualShaderFactory& shaderFactory,
 136                                 const VisualUrl&          imageUrl,
 137                                 ImageDimensions           size,
 138                                 FittingMode::Type         fittingMode,
 139                                 Dali::SamplingMode::Type  samplingMode)
 140 {
 141   ImageVisualPtr imageVisualPtr(new ImageVisual(factoryCache, shaderFactory, imageUrl, size, fittingMode, samplingMode));
 142   imageVisualPtr->Initialize();
 143   return imageVisualPtr;
 144 }
 145
 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),
 154   mPlacementActor(),
 155   mImageUrl(imageUrl),
 156   mMaskingData(),
 157   mDesiredSize(size),
 158   mTextureId(TextureManager::INVALID_TEXTURE_ID),
 159   mTextures(),
 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)
 172 {
 173   EnablePreMultipliedAlpha(mFactoryCache.GetPreMultiplyOnLoad());
 174 }
 175
 176 ImageVisual::~ImageVisual()
 177 {
 178   if(Stage::IsInstalled())
 179   {
 180     if(mImageUrl.IsValid())
 181     {
 182       // Decrease reference count of External Resources :
 183       // EncodedImageBuffer or ExternalTextures.
 184       // Ensure the stage is still valid before accessing texture manager.
 185       if(mImageUrl.GetProtocolType() == VisualUrl::TEXTURE)
 186       {
 187         TextureManager& textureManager = mFactoryCache.GetTextureManager();
 188         textureManager.RemoveExternalTexture(mImageUrl.GetUrl());
 189       }
 190       else if(mImageUrl.IsBufferResource())
 191       {
 192         TextureManager& textureManager = mFactoryCache.GetTextureManager();
 193         textureManager.RemoveEncodedImageBuffer(mImageUrl.GetUrl());
 194       }
 195     }
 196
 197     // ImageVisual destroyed so remove texture unless ReleasePolicy is set to never release
 198     if((mTextureId != TextureManager::INVALID_TEXTURE_ID) && (mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER))
 199     {
 200       RemoveTexture();
 201     }
 202   }
 203 }
 204
 205 void ImageVisual::DoSetProperties(const Property::Map& propertyMap)
 206 {
 207   // Url is already received in constructor
 208   for(Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter)
 209   {
 210     KeyValuePair keyValue = propertyMap.GetKeyValue(iter);
 211     if(keyValue.first.type == Property::Key::INDEX)
 212     {
 213       DoSetProperty(keyValue.first.indexKey, keyValue.second);
 214     }
 215     else
 216     {
 217       if(keyValue.first == IMAGE_FITTING_MODE)
 218       {
 219         DoSetProperty(Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second);
 220       }
 221       else if(keyValue.first == IMAGE_SAMPLING_MODE)
 222       {
 223         DoSetProperty(Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second);
 224       }
 225       else if(keyValue.first == IMAGE_DESIRED_WIDTH)
 226       {
 227         DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second);
 228       }
 229       else if(keyValue.first == IMAGE_DESIRED_HEIGHT)
 230       {
 231         DoSetProperty(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second);
 232       }
 233       else if(keyValue.first == PIXEL_AREA_UNIFORM_NAME)
 234       {
 235         DoSetProperty(Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second);
 236       }
 237       else if(keyValue.first == IMAGE_WRAP_MODE_U)
 238       {
 239         DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second);
 240       }
 241       else if(keyValue.first == IMAGE_WRAP_MODE_V)
 242       {
 243         DoSetProperty(Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second);
 244       }
 245       else if(keyValue.first == SYNCHRONOUS_LOADING)
 246       {
 247         DoSetProperty(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second);
 248       }
 249       else if(keyValue.first == IMAGE_ATLASING)
 250       {
 251         DoSetProperty(Toolkit::ImageVisual::Property::ATLASING, keyValue.second);
 252       }
 253       else if(keyValue.first == ALPHA_MASK_URL)
 254       {
 255         DoSetProperty(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, keyValue.second);
 256       }
 257       else if(keyValue.first == MASK_CONTENT_SCALE_NAME)
 258       {
 259         DoSetProperty(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, keyValue.second);
 260       }
 261       else if(keyValue.first == CROP_TO_MASK_NAME)
 262       {
 263         DoSetProperty(Toolkit::ImageVisual::Property::CROP_TO_MASK, keyValue.second);
 264       }
 265       else if(keyValue.first == MASKING_TYPE_NAME)
 266       {
 267         DoSetProperty(Toolkit::DevelImageVisual::Property::MASKING_TYPE, keyValue.second);
 268       }
 269       else if(keyValue.first == LOAD_POLICY_NAME)
 270       {
 271         DoSetProperty(Toolkit::ImageVisual::Property::LOAD_POLICY, keyValue.second);
 272       }
 273       else if(keyValue.first == RELEASE_POLICY_NAME)
 274       {
 275         DoSetProperty(Toolkit::ImageVisual::Property::RELEASE_POLICY, keyValue.second);
 276       }
 277       else if(keyValue.first == ORIENTATION_CORRECTION_NAME)
 278       {
 279         DoSetProperty(Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, keyValue.second);
 280       }
 281     }
 282   }
 283   // Load image immediately if LOAD_POLICY requires it
 284   if(mLoadPolicy == Toolkit::ImageVisual::LoadPolicy::IMMEDIATE)
 285   {
 286     auto attemptAtlasing = AttemptAtlasing();
 287     LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::CACHED);
 288   }
 289 }
 290
 291 void ImageVisual::DoSetProperty(Property::Index index, const Property::Value& value)
 292 {
 293   switch(index)
 294   {
 295     case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
 296     {
 297       bool sync = false;
 298       if(value.Get(sync))
 299       {
 300         if(sync)
 301         {
 302           mImpl->mFlags |= Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 303         }
 304         else
 305         {
 306           mImpl->mFlags &= ~Visual::Base::Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 307         }
 308       }
 309       else
 310       {
 311         DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
 312       }
 313       break;
 314     }
 315
 316     case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
 317     {
 318       int32_t desiredWidth = 0;
 319       if(value.Get(desiredWidth))
 320       {
 321         mDesiredSize.SetWidth(desiredWidth);
 322       }
 323       else
 324       {
 325         DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
 326       }
 327       break;
 328     }
 329
 330     case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
 331     {
 332       int32_t desiredHeight = 0;
 333       if(value.Get(desiredHeight))
 334       {
 335         mDesiredSize.SetHeight(desiredHeight);
 336       }
 337       else
 338       {
 339         DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
 340       }
 341       break;
 342     }
 343
 344     case Toolkit::ImageVisual::Property::FITTING_MODE:
 345     {
 346       int fittingMode = 0;
 347       Scripting::GetEnumerationProperty(value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode);
 348       mFittingMode = Dali::FittingMode::Type(fittingMode);
 349       break;
 350     }
 351
 352     case Toolkit::ImageVisual::Property::SAMPLING_MODE:
 353     {
 354       int samplingMode = 0;
 355       Scripting::GetEnumerationProperty(value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode);
 356       mSamplingMode = Dali::SamplingMode::Type(samplingMode);
 357       break;
 358     }
 359
 360     case Toolkit::ImageVisual::Property::PIXEL_AREA:
 361     {
 362       value.Get(mPixelArea);
 363       break;
 364     }
 365
 366     case Toolkit::ImageVisual::Property::WRAP_MODE_U:
 367     {
 368       int wrapMode = 0;
 369       Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode);
 370       mWrapModeU = Dali::WrapMode::Type(wrapMode);
 371       break;
 372     }
 373
 374     case Toolkit::ImageVisual::Property::WRAP_MODE_V:
 375     {
 376       int wrapMode = 0;
 377       Scripting::GetEnumerationProperty(value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode);
 378       mWrapModeV = Dali::WrapMode::Type(wrapMode);
 379       break;
 380     }
 381
 382     case Toolkit::ImageVisual::Property::ATLASING:
 383     {
 384       value.Get(mAttemptAtlasing);
 385       break;
 386     }
 387
 388     case Toolkit::ImageVisual::Property::ALPHA_MASK_URL:
 389     {
 390       std::string alphaUrl = "";
 391       if(value.Get(alphaUrl))
 392       {
 393         AllocateMaskData();
 394         mMaskingData->mAlphaMaskUrl = alphaUrl;
 395       }
 396       break;
 397     }
 398
 399     case Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE:
 400     {
 401       float scale = 1.0f;
 402       if(value.Get(scale))
 403       {
 404         AllocateMaskData();
 405         mMaskingData->mContentScaleFactor = scale;
 406       }
 407       break;
 408     }
 409
 410     case Toolkit::ImageVisual::Property::CROP_TO_MASK:
 411     {
 412       bool crop = false;
 413       if(value.Get(crop))
 414       {
 415         AllocateMaskData();
 416         mMaskingData->mCropToMask = crop;
 417       }
 418       break;
 419     }
 420
 421     case Toolkit::DevelImageVisual::Property::MASKING_TYPE:
 422     {
 423       int maskingType = 0;
 424       if(value.Get(maskingType))
 425       {
 426         AllocateMaskData();
 427         mMaskingData->mPreappliedMasking = Toolkit::DevelImageVisual::MaskingType::Type(maskingType) == Toolkit::DevelImageVisual::MaskingType::MASKING_ON_LOADING ? true : false;
 428       }
 429       break;
 430     }
 431
 432     case Toolkit::ImageVisual::Property::RELEASE_POLICY:
 433     {
 434       int releasePolicy = 0;
 435       Scripting::GetEnumerationProperty(value, RELEASE_POLICY_TABLE, RELEASE_POLICY_TABLE_COUNT, releasePolicy);
 436       mReleasePolicy = Toolkit::ImageVisual::ReleasePolicy::Type(releasePolicy);
 437       break;
 438     }
 439
 440     case Toolkit::ImageVisual::Property::LOAD_POLICY:
 441     {
 442       int loadPolicy = 0;
 443       Scripting::GetEnumerationProperty(value, LOAD_POLICY_TABLE, LOAD_POLICY_TABLE_COUNT, loadPolicy);
 444       mLoadPolicy = Toolkit::ImageVisual::LoadPolicy::Type(loadPolicy);
 445       break;
 446     }
 447     case Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION:
 448     {
 449       bool orientationCorrection(mOrientationCorrection);
 450       if(value.Get(orientationCorrection))
 451       {
 452         mOrientationCorrection = orientationCorrection;
 453       }
 454       break;
 455     }
 456   }
 457 }
 458
 459 void ImageVisual::AllocateMaskData()
 460 {
 461   if(!mMaskingData)
 462   {
 463     mMaskingData.reset(new TextureManager::MaskingData());
 464   }
 465 }
 466
 467 void ImageVisual::GetNaturalSize(Vector2& naturalSize)
 468 {
 469   if(mDesiredSize.GetWidth() > 0 && mDesiredSize.GetHeight() > 0)
 470   {
 471     naturalSize.x = mDesiredSize.GetWidth();
 472     naturalSize.y = mDesiredSize.GetHeight();
 473     return;
 474   }
 475   else if(mImpl->mRenderer) // Check if we have a loaded image
 476   {
 477     if(mImpl->mFlags & Visual::Base::Impl::IS_ATLASING_APPLIED)
 478     {
 479       naturalSize.x = mAtlasRectSize.GetWidth();
 480       naturalSize.y = mAtlasRectSize.GetHeight();
 481       return;
 482     }
 483
 484     auto textureSet = mImpl->mRenderer.GetTextures();
 485     if(textureSet && textureSet.GetTextureCount())
 486     {
 487       if(mTextureSize != Vector2::ZERO)
 488       {
 489         naturalSize = mTextureSize;
 490         return;
 491       }
 492     }
 493   }
 494
 495   if(mMaskingData != NULL && mMaskingData->mAlphaMaskUrl.IsValid() &&
 496      mMaskingData->mCropToMask)
 497   {
 498     ImageDimensions dimensions = Dali::GetClosestImageSize(mMaskingData->mAlphaMaskUrl.GetUrl());
 499     if(dimensions != ImageDimensions(0, 0))
 500     {
 501       naturalSize.x = dimensions.GetWidth();
 502       naturalSize.y = dimensions.GetHeight();
 503     }
 504     return;
 505   }
 506   else if(mImageUrl.IsValid())
 507   {
 508     if(mImageUrl.GetProtocolType() == VisualUrl::LOCAL)
 509     {
 510       ImageDimensions dimensions = Dali::GetClosestImageSize(mImageUrl.GetUrl());
 511
 512       if(dimensions != ImageDimensions(0, 0))
 513       {
 514         naturalSize.x = dimensions.GetWidth();
 515         naturalSize.y = dimensions.GetHeight();
 516       }
 517       else
 518       {
 519         Actor   actor     = mPlacementActor.GetHandle();
 520         Vector2 imageSize = Vector2::ZERO;
 521         if(actor)
 522         {
 523           imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 524         }
 525         else
 526         {
 527           imageSize = mPlacementActorSize;
 528         }
 529
 530         mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 531         Texture brokenImage = mImpl->mRenderer.GetTextures().GetTexture(0);
 532         naturalSize.x       = brokenImage.GetWidth();
 533         naturalSize.y       = brokenImage.GetWidth();
 534       }
 535       return;
 536     }
 537   }
 538   naturalSize = Vector2::ZERO;
 539 }
 540
 541 void ImageVisual::OnInitialize()
 542 {
 543   Geometry geometry;
 544
 545   // Get the geometry
 546   if(mImpl->mCustomShader)
 547   {
 548     geometry = CreateGeometry(mFactoryCache, mImpl->mCustomShader->mGridSize);
 549   }
 550   else // Get any geometry associated with the texture
 551   {
 552     TextureManager& textureManager = mFactoryCache.GetTextureManager();
 553
 554     uint32_t firstElementCount{0u};
 555     uint32_t secondElementCount{0u};
 556     geometry = textureManager.GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
 557
 558     if(!firstElementCount && !secondElementCount) // Otherwise use quad
 559     {
 560       geometry = CreateGeometry(mFactoryCache, ImageDimensions(1, 1));
 561     }
 562   }
 563
 564   // Increase reference count of External Resources :
 565   // EncodedImageBuffer or ExternalTextures.
 566   // Reference count will be decreased at destructor of the visual.
 567   if(mImageUrl.IsValid() && (mImageUrl.IsBufferResource() || mImageUrl.GetProtocolType() == VisualUrl::TEXTURE))
 568   {
 569     TextureManager& textureManager = mFactoryCache.GetTextureManager();
 570     textureManager.UseExternalResource(mImageUrl.GetUrl());
 571   }
 572
 573   Shader shader = GenerateShader();
 574
 575   // Create the renderer
 576   mImpl->mRenderer = DecoratedVisualRenderer::New(geometry, shader);
 577   mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
 578
 579   //Register transform properties
 580   mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 581
 582   EnablePreMultipliedAlpha(IsPreMultipliedAlphaEnabled());
 583
 584   if(mMaskingData)
 585   {
 586     mImpl->mRenderer.RegisterProperty(CROP_TO_MASK_NAME, static_cast<float>(mMaskingData->mCropToMask));
 587   }
 588 }
 589
 590 void ImageVisual::LoadTexture(bool& atlasing, Vector4& atlasRect, TextureSet& textures, bool orientationCorrection, TextureManager::ReloadPolicy forceReload)
 591 {
 592   TextureManager& textureManager = mFactoryCache.GetTextureManager();
 593
 594   ImageAtlasManagerPtr atlasManager        = nullptr;
 595   AtlasUploadObserver* atlasUploadObserver = nullptr;
 596   auto                 textureObserver     = this;
 597
 598   if(atlasing)
 599   {
 600     atlasManager        = mFactoryCache.GetAtlasManager();
 601     atlasUploadObserver = this;
 602   }
 603
 604   auto preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader
 605                              ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD
 606                              : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
 607
 608   bool synchronousLoading = IsSynchronousLoadingRequired();
 609   bool loadingStatus;
 610
 611   textures = textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode, mMaskingData, synchronousLoading, mTextureId, atlasRect, mAtlasRectSize, atlasing, loadingStatus, textureObserver, atlasUploadObserver, atlasManager, mOrientationCorrection, forceReload, preMultiplyOnLoad);
 612
 613   if(textures)
 614   {
 615     if(loadingStatus)
 616     {
 617       mLoadState = TextureManager::LoadState::LOADING;
 618     }
 619     else
 620     {
 621       mLoadState = TextureManager::LoadState::LOAD_FINISHED;
 622     }
 623
 624     EnablePreMultipliedAlpha(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
 625     if(!atlasing)
 626     {
 627       Sampler sampler = Sampler::New();
 628       sampler.SetWrapMode(mWrapModeU, mWrapModeV);
 629       textures.SetSampler(0u, sampler);
 630     }
 631   }
 632   else if(synchronousLoading)
 633   {
 634     // Synchronous loading is failed
 635     mLoadState = TextureManager::LoadState::LOAD_FAILED;
 636   }
 637
 638   if(atlasing) // Flag needs to be set before creating renderer
 639   {
 640     mImpl->mFlags |= Visual::Base::Impl::IS_ATLASING_APPLIED;
 641   }
 642   else
 643   {
 644     mImpl->mFlags &= ~Visual::Base::Impl::IS_ATLASING_APPLIED;
 645   }
 646 }
 647
 648 bool ImageVisual::AttemptAtlasing()
 649 {
 650   return (!mImpl->mCustomShader && (mImageUrl.IsLocalResource() || mImageUrl.IsBufferResource()) && mAttemptAtlasing);
 651 }
 652
 653 void ImageVisual::InitializeRenderer()
 654 {
 655   auto attemptAtlasing = AttemptAtlasing();
 656
 657   // Load Texture if mTextures is empty.
 658   // mTextures is already set, the mTexture can be used to create Renderer.
 659   // There are two cases mTextures is empty.
 660   // 1. mTextureId == TextureManager::INVALID_TEXTURE_ID
 661   //  - Visual is on stage with LoadPolicy::ATTACHED
 662   // 2. mTextureId != TextureManager::INVALID_TEXTURE_ID
 663   //  - If ReleasePolicy is DESTROYED, InitializeRenderer called every on stage called.
 664   //  - Then every resources those contained in Visual are Reset but mTextureId is remained when the Off stage time,
 665   //  - So, mTextures needed to be get from texture manager to created resources like mImpl->mRenderer.
 666   if(!mTextures)
 667   {
 668     if(mTextureId == TextureManager::INVALID_TEXTURE_ID)
 669     {
 670       LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::CACHED);
 671     }
 672     else
 673     {
 674       mTextures = mFactoryCache.GetTextureManager().GetTextureSet(mTextureId);
 675       if(!(mImpl->mFlags & Visual::Base::Impl::IS_ATLASING_APPLIED) && mTextures)
 676       {
 677         Sampler sampler = Sampler::New();
 678         sampler.SetWrapMode(mWrapModeU, mWrapModeV);
 679         mTextures.SetSampler(0u, sampler);
 680       }
 681     }
 682   }
 683
 684   if(mTextures)
 685   {
 686     mImpl->mRenderer.SetTextures(mTextures);
 687     ComputeTextureSize();
 688     CheckMaskTexture();
 689
 690     bool needToUpdateShader = DevelTexture::IsNative(mTextures.GetTexture(0));
 691
 692     if(mTextures.GetTextureCount() == 3)
 693     {
 694       if(mTextures.GetTexture(0).GetPixelFormat() == Pixel::L8 && mTextures.GetTexture(1).GetPixelFormat() == Pixel::CHROMINANCE_U && mTextures.GetTexture(2).GetPixelFormat() == Pixel::CHROMINANCE_V)
 695       {
 696         mNeedYuvToRgb      = true;
 697         needToUpdateShader = true;
 698       }
 699     }
 700
 701     if(needToUpdateShader)
 702     {
 703       UpdateShader();
 704     }
 705     mTextures.Reset(); // Visual should not keep a handle to the texture after this point.
 706   }
 707
 708   if(attemptAtlasing) // the texture is packed inside atlas
 709   {
 710     mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
 711
 712     bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
 713
 714     if(!defaultWrapMode) // custom wrap mode
 715     {
 716       Vector2 wrapMode(mWrapModeU - WrapMode::CLAMP_TO_EDGE, mWrapModeV - WrapMode::CLAMP_TO_EDGE);
 717       wrapMode.Clamp(Vector2::ZERO, Vector2(2.f, 2.f));
 718       mImpl->mRenderer.RegisterProperty(WRAP_MODE_UNIFORM_NAME, wrapMode);
 719     }
 720   }
 721 }
 722
 723 void ImageVisual::DoSetOnScene(Actor& actor)
 724 {
 725   if(mImageUrl.IsValid())
 726   {
 727     InitializeRenderer();
 728   }
 729
 730   if(!mImpl->mRenderer)
 731   {
 732     return;
 733   }
 734
 735   mPlacementActor = actor;
 736
 737   if(mPixelArea != FULL_TEXTURE_RECT)
 738   {
 739     mImpl->mRenderer.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, mPixelArea);
 740   }
 741
 742   if(mLoadState == TextureManager::LoadState::LOAD_FINISHED)
 743   {
 744     actor.AddRenderer(mImpl->mRenderer);
 745     mPlacementActor.Reset();
 746
 747     // Image loaded and ready to display
 748     ResourceReady(Toolkit::Visual::ResourceStatus::READY);
 749   }
 750   else if(mLoadState == TextureManager::LoadState::LOAD_FAILED)
 751   {
 752     Vector2 imageSize = Vector2::ZERO;
 753     if(actor)
 754     {
 755       imageSize           = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 756       mPlacementActorSize = imageSize;
 757     }
 758
 759     mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 760     actor.AddRenderer(mImpl->mRenderer);
 761     mPlacementActor.Reset();
 762
 763     ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
 764   }
 765 }
 766
 767 void ImageVisual::DoSetOffScene(Actor& actor)
 768 {
 769   // Visual::Base::SetOffScene only calls DoSetOffScene if mRenderer exists (is on onstage)
 770
 771   // Image release is dependent on the ReleasePolicy, renderer is removed.
 772   actor.RemoveRenderer(mImpl->mRenderer);
 773   if(mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
 774   {
 775     RemoveTexture(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
 776     mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
 777
 778     TextureSet textureSet = TextureSet::New();
 779     mImpl->mRenderer.SetTextures(textureSet);
 780     ComputeTextureSize();
 781
 782     mLoadState = TextureManager::LoadState::NOT_STARTED;
 783   }
 784
 785   mPlacementActor.Reset();
 786 }
 787
 788 void ImageVisual::DoCreatePropertyMap(Property::Map& map) const
 789 {
 790   map.Clear();
 791   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
 792
 793   bool sync = IsSynchronousLoadingRequired();
 794   map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync);
 795   if(mImageUrl.IsValid())
 796   {
 797     map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
 798     map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
 799     map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
 800   }
 801
 802   map.Insert(Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode);
 803   map.Insert(Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode);
 804
 805   map.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea);
 806   map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU);
 807   map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV);
 808
 809   map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
 810
 811   if(mMaskingData != NULL)
 812   {
 813     map.Insert(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl());
 814     map.Insert(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor);
 815     map.Insert(Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask);
 816     map.Insert(Toolkit::DevelImageVisual::Property::MASKING_TYPE, mMaskingData->mPreappliedMasking ? DevelImageVisual::MaskingType::MASKING_ON_LOADING : DevelImageVisual::MaskingType::MASKING_ON_RENDERING);
 817   }
 818
 819   map.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy);
 820   map.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy);
 821   map.Insert(Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, mOrientationCorrection);
 822 }
 823
 824 void ImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
 825 {
 826   map.Clear();
 827   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
 828   if(mImageUrl.IsValid())
 829   {
 830     map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
 831     map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
 832   }
 833 }
 834
 835 void ImageVisual::OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes)
 836 {
 837   // Check if action is valid for this visual type and perform action if possible
 838
 839   switch(actionId)
 840   {
 841     case DevelImageVisual::Action::RELOAD:
 842     {
 843       auto attemptAtlasing = AttemptAtlasing();
 844       LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::FORCED);
 845       break;
 846     }
 847   }
 848 }
 849
 850 void ImageVisual::OnSetTransform()
 851 {
 852   if(mImpl->mRenderer)
 853   {
 854     mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 855   }
 856 }
 857
 858 void ImageVisual::UpdateShader()
 859 {
 860   if(mImpl->mRenderer)
 861   {
 862     Shader shader = GenerateShader();
 863     mImpl->mRenderer.SetShader(shader);
 864   }
 865 }
 866
 867 // From existing atlas manager
 868 void ImageVisual::UploadCompleted()
 869 {
 870   // Texture has been uploaded. If weak handle is holding a placement actor,
 871   // it is the time to add the renderer to actor.
 872   Actor actor = mPlacementActor.GetHandle();
 873   if(actor)
 874   {
 875     mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
 876     actor.AddRenderer(mImpl->mRenderer);
 877     // reset the weak handle so that the renderer only get added to actor once
 878     mPlacementActor.Reset();
 879   }
 880
 881   // Image loaded
 882   ResourceReady(Toolkit::Visual::ResourceStatus::READY);
 883   mLoadState = TextureManager::LoadState::LOAD_FINISHED;
 884 }
 885
 886 // From Texture Manager
 887 void ImageVisual::LoadComplete(bool loadingSuccess, TextureInformation textureInformation)
 888 {
 889   Toolkit::Visual::ResourceStatus resourceStatus;
 890   if(mImpl->mRenderer)
 891   {
 892     if(textureInformation.useAtlasing)
 893     {
 894       mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
 895     }
 896
 897     EnablePreMultipliedAlpha(textureInformation.preMultiplied);
 898
 899     Actor actor = mPlacementActor.GetHandle();
 900     if(!loadingSuccess)
 901     {
 902       Vector2 imageSize = Vector2::ZERO;
 903       if(actor)
 904       {
 905         imageSize           = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 906         mPlacementActorSize = imageSize;
 907       }
 908       else
 909       {
 910         imageSize = mPlacementActorSize;
 911       }
 912
 913       mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 914       textureInformation.textureSet = mImpl->mRenderer.GetTextures();
 915     }
 916     else
 917     {
 918       if(!textureInformation.useAtlasing)
 919       {
 920         Sampler sampler = Sampler::New();
 921         sampler.SetWrapMode(mWrapModeU, mWrapModeV);
 922         textureInformation.textureSet.SetSampler(0u, sampler);
 923       }
 924
 925       mImpl->mRenderer.SetTextures(textureInformation.textureSet);
 926       ComputeTextureSize();
 927       CheckMaskTexture();
 928
 929       if(textureInformation.textureSet.GetTextureCount() == 3)
 930       {
 931         if(textureInformation.textureSet.GetTexture(0).GetPixelFormat() == Pixel::L8 && textureInformation.textureSet.GetTexture(1).GetPixelFormat() == Pixel::CHROMINANCE_U && textureInformation.textureSet.GetTexture(2).GetPixelFormat() == Pixel::CHROMINANCE_V)
 932         {
 933           mNeedYuvToRgb = true;
 934           UpdateShader();
 935         }
 936       }
 937     }
 938
 939     if(actor)
 940     {
 941       actor.AddRenderer(mImpl->mRenderer);
 942       // reset the weak handle so that the renderer only get added to actor once
 943       mPlacementActor.Reset();
 944     }
 945   }
 946
 947   // Storing TextureSet needed when renderer staged.
 948   if(!mImpl->mRenderer)
 949   {
 950     mTextures = textureInformation.textureSet;
 951   }
 952
 953   // Image loaded, set status regardless of staged status.
 954   if(loadingSuccess)
 955   {
 956     resourceStatus = Toolkit::Visual::ResourceStatus::READY;
 957     mLoadState     = TextureManager::LoadState::LOAD_FINISHED;
 958   }
 959   else
 960   {
 961     resourceStatus = Toolkit::Visual::ResourceStatus::FAILED;
 962     mLoadState     = TextureManager::LoadState::LOAD_FAILED;
 963   }
 964
 965   // use geometry if needed
 966   if(loadingSuccess)
 967   {
 968     uint32_t firstElementCount{0u};
 969     uint32_t secondElementCount{0u};
 970     auto     geometry = mFactoryCache.GetTextureManager().GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
 971     if(mImpl->mRenderer && geometry)
 972     {
 973       mImpl->mRenderer.SetGeometry(geometry);
 974       Dali::DevelRenderer::DrawCommand drawCommand{};
 975       drawCommand.drawType = DevelRenderer::DrawType::INDEXED;
 976
 977       if(firstElementCount)
 978       {
 979         drawCommand.firstIndex   = 0;
 980         drawCommand.elementCount = firstElementCount;
 981         drawCommand.queue        = DevelRenderer::RENDER_QUEUE_OPAQUE;
 982         DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
 983       }
 984
 985       if(secondElementCount)
 986       {
 987         drawCommand.firstIndex   = firstElementCount;
 988         drawCommand.elementCount = secondElementCount;
 989         drawCommand.queue        = DevelRenderer::RENDER_QUEUE_TRANSPARENT;
 990         DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
 991       }
 992     }
 993   }
 994
 995   // Signal to observers ( control ) that resources are ready. Must be all resources.
 996   ResourceReady(resourceStatus);
 997 }
 998
 999 void ImageVisual::RemoveTexture()
1000 {
1001   if(mTextureId != TextureManager::INVALID_TEXTURE_ID)
1002   {
1003     mFactoryCache.GetTextureManager().Remove(mTextureId, this);
1004     mTextureId = TextureManager::INVALID_TEXTURE_ID;
1005   }
1006   else
1007   {
1008     Vector4         atlasRect(0.f, 0.f, 1.f, 1.f);
1009     Property::Index index = mImpl->mRenderer.GetPropertyIndex(ATLAS_RECT_UNIFORM_NAME);
1010     if(index != Property::INVALID_INDEX)
1011     {
1012       Property::Value atlasRectValue = mImpl->mRenderer.GetProperty(index);
1013       atlasRectValue.Get(atlasRect);
1014     }
1015
1016     TextureSet textureSet = mImpl->mRenderer.GetTextures();
1017
1018     if(index != Property::INVALID_INDEX)
1019     {
1020       mFactoryCache.GetAtlasManager()->Remove(textureSet, atlasRect);
1021     }
1022   }
1023 }
1024
1025 void ImageVisual::ComputeTextureSize()
1026 {
1027   if(mImpl->mRenderer)
1028   {
1029     auto textureSet = mImpl->mRenderer.GetTextures();
1030     if(textureSet && textureSet.GetTextureCount())
1031     {
1032       auto texture = textureSet.GetTexture(0);
1033       if(texture)
1034       {
1035         mTextureSize.x = texture.GetWidth();
1036         mTextureSize.y = texture.GetHeight();
1037         if(textureSet.GetTextureCount() > 1u && mMaskingData && !mMaskingData->mPreappliedMasking && mMaskingData->mCropToMask)
1038         {
1039           Texture maskTexture = textureSet.GetTexture(1);
1040           if(maskTexture)
1041           {
1042             mTextureSize.x = std::min(static_cast<uint32_t>(mTextureSize.x * mMaskingData->mContentScaleFactor), maskTexture.GetWidth());
1043             mTextureSize.y = std::min(static_cast<uint32_t>(mTextureSize.y * mMaskingData->mContentScaleFactor), maskTexture.GetHeight());
1044           }
1045         }
1046       }
1047     }
1048   }
1049 }
1050
1051 Vector2 ImageVisual::ComputeMaskTextureRatio()
1052 {
1053   Vector2 maskTextureRatio;
1054   if(mImpl->mRenderer)
1055   {
1056     auto textureSet = mImpl->mRenderer.GetTextures();
1057     if(textureSet && textureSet.GetTextureCount())
1058     {
1059       auto texture = textureSet.GetTexture(0);
1060       if(texture)
1061       {
1062         if(textureSet.GetTextureCount() > 1u && mMaskingData && !mMaskingData->mPreappliedMasking && mMaskingData->mCropToMask)
1063         {
1064           Texture maskTexture = textureSet.GetTexture(1);
1065           if(maskTexture)
1066           {
1067             float textureWidth  = std::max(static_cast<float>(texture.GetWidth() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
1068             float textureHeight = std::max(static_cast<float>(texture.GetHeight() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
1069             maskTextureRatio    = Vector2(std::min(static_cast<float>(maskTexture.GetWidth()), textureWidth) / textureWidth,
1070                                        std::min(static_cast<float>(maskTexture.GetHeight()), textureHeight) / textureHeight);
1071           }
1072         }
1073       }
1074     }
1075   }
1076   return maskTextureRatio;
1077 }
1078
1079 Shader ImageVisual::GenerateShader() const
1080 {
1081   Shader shader;
1082
1083   bool       usesWholeTexture  = true;
1084   const bool useStandardShader = !mImpl->mCustomShader;
1085   const bool useNativeImage    = (mTextures && DevelTexture::IsNative(mTextures.GetTexture(0)));
1086
1087   if(useStandardShader)
1088   {
1089     bool requiredAlphaMaskingOnRendering = (mMaskingData && !mMaskingData->mMaskImageLoadingFailed) ? !mMaskingData->mPreappliedMasking : false;
1090     // Create and cache the standard shader
1091     shader = mImageVisualShaderFactory.GetShader(
1092       mFactoryCache,
1093       ImageVisualShaderFeature::FeatureBuilder()
1094         .EnableTextureAtlas(mImpl->mFlags & Visual::Base::Impl::IS_ATLASING_APPLIED && !useNativeImage)
1095         .ApplyDefaultTextureWrapMode(mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE)
1096         .EnableRoundedCorner(IsRoundedCornerRequired())
1097         .EnableBorderline(IsBorderlineRequired())
1098         .SetTextureForFragmentShaderCheck(useNativeImage ? mTextures.GetTexture(0) : Dali::Texture())
1099         .EnableAlphaMaskingOnRendering(requiredAlphaMaskingOnRendering)
1100         .EnableYuvToRgb(mNeedYuvToRgb));
1101   }
1102   else
1103   {
1104     std::string_view vertexShaderView;
1105     std::string_view fragmentShaderView;
1106
1107     if(mImpl->mCustomShader && !mImpl->mCustomShader->mVertexShader.empty())
1108     {
1109       vertexShaderView = mImpl->mCustomShader->mVertexShader;
1110       usesWholeTexture = false; // Impossible to tell.
1111     }
1112     else
1113     {
1114       vertexShaderView = mImageVisualShaderFactory.GetVertexShaderSource();
1115     }
1116
1117     if(mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty())
1118     {
1119       fragmentShaderView = mImpl->mCustomShader->mFragmentShader;
1120     }
1121     else
1122     {
1123       fragmentShaderView = mImageVisualShaderFactory.GetFragmentShaderSource();
1124     }
1125
1126     // If the texture is native, we may need to change prefix and sampler in
1127     // the fragment shader
1128     if(useNativeImage)
1129     {
1130       bool        modifiedFragmentShader = false;
1131       Texture     nativeTexture          = mTextures.GetTexture(0);
1132       std::string fragmentShaderString   = std::string(fragmentShaderView);
1133
1134       modifiedFragmentShader = DevelTexture::ApplyNativeFragmentShader(nativeTexture, fragmentShaderString);
1135       if(modifiedFragmentShader)
1136       {
1137         fragmentShaderView = fragmentShaderString;
1138       }
1139
1140       // Create shader here cause fragmentShaderString scope issue
1141       shader = Shader::New(vertexShaderView, fragmentShaderView, mImpl->mCustomShader->mHints);
1142     }
1143     else
1144     {
1145       shader = Shader::New(vertexShaderView, fragmentShaderView, mImpl->mCustomShader->mHints);
1146     }
1147   }
1148
1149   if(usesWholeTexture)
1150   {
1151     shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
1152   }
1153
1154   return shader;
1155 }
1156
1157 void ImageVisual::CheckMaskTexture()
1158 {
1159   if(mMaskingData && !mMaskingData->mPreappliedMasking)
1160   {
1161     bool       maskLoadFailed = true;
1162     TextureSet textures       = mImpl->mRenderer.GetTextures();
1163     if(textures && textures.GetTextureCount() >= TEXTURE_COUNT_FOR_GPU_ALPHA_MASK)
1164     {
1165       if(mMaskingData->mCropToMask)
1166       {
1167         mImpl->mRenderer.RegisterProperty(MASK_TEXTURE_RATIO_NAME, ComputeMaskTextureRatio());
1168       }
1169       maskLoadFailed = false;
1170     }
1171
1172     if(mMaskingData->mMaskImageLoadingFailed != maskLoadFailed)
1173     {
1174       mMaskingData->mMaskImageLoadingFailed = maskLoadFailed;
1175       UpdateShader();
1176     }
1177   }
1178 }
1179
1180 } // namespace Internal
1181
1182 } // namespace Toolkit
1183
1184 } // namespace Dali