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

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