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, 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     if(!atlasing)
 624     {
 625       Sampler sampler = Sampler::New();
 626       sampler.SetWrapMode(mWrapModeU, mWrapModeV);
 627       textures.SetSampler(0u, sampler);
 628     }
 629   }
 630   else if(synchronousLoading)
 631   {
 632     // Synchronous loading is failed
 633     mLoadState = TextureManager::LoadState::LOAD_FAILED;
 634   }
 635
 636   if(atlasing) // Flag needs to be set before creating renderer
 637   {
 638     mImpl->mFlags |= Visual::Base::Impl::IS_ATLASING_APPLIED;
 639   }
 640   else
 641   {
 642     mImpl->mFlags &= ~Visual::Base::Impl::IS_ATLASING_APPLIED;
 643   }
 644 }
 645
 646 bool ImageVisual::AttemptAtlasing()
 647 {
 648   return (!mImpl->mCustomShader && (mImageUrl.IsLocalResource() || mImageUrl.IsBufferResource()) && mAttemptAtlasing);
 649 }
 650
 651 void ImageVisual::InitializeRenderer()
 652 {
 653   auto attemptAtlasing = AttemptAtlasing();
 654
 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.
 664   if(!mTextures)
 665   {
 666     if(mTextureId == TextureManager::INVALID_TEXTURE_ID)
 667     {
 668       LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::CACHED);
 669     }
 670     else
 671     {
 672       mTextures = mFactoryCache.GetTextureManager().GetTextureSet(mTextureId);
 673       if(!(mImpl->mFlags & Visual::Base::Impl::IS_ATLASING_APPLIED) && mTextures)
 674       {
 675         Sampler sampler = Sampler::New();
 676         sampler.SetWrapMode(mWrapModeU, mWrapModeV);
 677         mTextures.SetSampler(0u, sampler);
 678       }
 679     }
 680   }
 681
 682   if(mTextures)
 683   {
 684     mImpl->mRenderer.SetTextures(mTextures);
 685     ComputeTextureSize();
 686     CheckMaskTexture();
 687
 688     bool needToUpdateShader = DevelTexture::IsNative(mTextures.GetTexture(0));
 689
 690     if(mTextures.GetTextureCount() == 3)
 691     {
 692       if(mTextures.GetTexture(0).GetPixelFormat() == Pixel::L8 && mTextures.GetTexture(1).GetPixelFormat() == Pixel::CHROMINANCE_U && mTextures.GetTexture(2).GetPixelFormat() == Pixel::CHROMINANCE_V)
 693       {
 694         mNeedYuvToRgb      = true;
 695         needToUpdateShader = true;
 696       }
 697     }
 698
 699     if(needToUpdateShader)
 700     {
 701       UpdateShader();
 702     }
 703     mTextures.Reset(); // Visual should not keep a handle to the texture after this point.
 704   }
 705
 706   if(attemptAtlasing) // the texture is packed inside atlas
 707   {
 708     mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
 709
 710     bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
 711
 712     if(!defaultWrapMode) // custom wrap mode
 713     {
 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);
 717     }
 718   }
 719 }
 720
 721 void ImageVisual::DoSetOnScene(Actor& actor)
 722 {
 723   if(mImageUrl.IsValid())
 724   {
 725     InitializeRenderer();
 726   }
 727
 728   if(!mImpl->mRenderer)
 729   {
 730     return;
 731   }
 732
 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)
 737   {
 738     // Layer 3D set, do not align pixels
 739     mImpl->mRenderer.RegisterProperty(PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF);
 740   }
 741
 742   if(mPixelArea != FULL_TEXTURE_RECT)
 743   {
 744     mImpl->mRenderer.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, mPixelArea);
 745   }
 746
 747   if(mLoadState == TextureManager::LoadState::LOAD_FINISHED)
 748   {
 749     actor.AddRenderer(mImpl->mRenderer);
 750     mPlacementActor.Reset();
 751
 752     // Image loaded and ready to display
 753     ResourceReady(Toolkit::Visual::ResourceStatus::READY);
 754   }
 755   else if(mLoadState == TextureManager::LoadState::LOAD_FAILED)
 756   {
 757     Vector2 imageSize = Vector2::ZERO;
 758     if(actor)
 759     {
 760       imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 761     }
 762     mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 763     actor.AddRenderer(mImpl->mRenderer);
 764     mPlacementActor.Reset();
 765
 766     ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
 767   }
 768 }
 769
 770 void ImageVisual::DoSetOffScene(Actor& actor)
 771 {
 772   // Visual::Base::SetOffScene only calls DoSetOffScene if mRenderer exists (is on onstage)
 773
 774   // Image release is dependent on the ReleasePolicy, renderer is removed.
 775   actor.RemoveRenderer(mImpl->mRenderer);
 776   if(mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
 777   {
 778     RemoveTexture(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
 779     mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
 780
 781     TextureSet textureSet = TextureSet::New();
 782     mImpl->mRenderer.SetTextures(textureSet);
 783     ComputeTextureSize();
 784
 785     mLoadState = TextureManager::LoadState::NOT_STARTED;
 786   }
 787
 788   mPlacementActor.Reset();
 789 }
 790
 791 void ImageVisual::DoCreatePropertyMap(Property::Map& map) const
 792 {
 793   map.Clear();
 794   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
 795
 796   bool sync = IsSynchronousLoadingRequired();
 797   map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync);
 798   if(mImageUrl.IsValid())
 799   {
 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());
 803   }
 804
 805   map.Insert(Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode);
 806   map.Insert(Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode);
 807
 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);
 811
 812   map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
 813
 814   if(mMaskingData != NULL)
 815   {
 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);
 820   }
 821
 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);
 825 }
 826
 827 void ImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
 828 {
 829   map.Clear();
 830   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
 831   if(mImageUrl.IsValid())
 832   {
 833     map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
 834     map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
 835   }
 836 }
 837
 838 void ImageVisual::OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes)
 839 {
 840   // Check if action is valid for this visual type and perform action if possible
 841
 842   switch(actionId)
 843   {
 844     case DevelImageVisual::Action::RELOAD:
 845     {
 846       auto attemptAtlasing = AttemptAtlasing();
 847       LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::FORCED);
 848       break;
 849     }
 850   }
 851 }
 852
 853 void ImageVisual::OnSetTransform()
 854 {
 855   if(mImpl->mRenderer)
 856   {
 857     mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 858   }
 859 }
 860
 861 void ImageVisual::UpdateShader()
 862 {
 863   if(mImpl->mRenderer)
 864   {
 865     Shader shader = GenerateShader();
 866     mImpl->mRenderer.SetShader(shader);
 867   }
 868 }
 869
 870 // From existing atlas manager
 871 void ImageVisual::UploadCompleted()
 872 {
 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();
 876   if(actor)
 877   {
 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();
 882   }
 883
 884   // Image loaded
 885   ResourceReady(Toolkit::Visual::ResourceStatus::READY);
 886   mLoadState = TextureManager::LoadState::LOAD_FINISHED;
 887 }
 888
 889 // From Texture Manager
 890 void ImageVisual::LoadComplete(bool loadingSuccess, TextureInformation textureInformation)
 891 {
 892   Toolkit::Visual::ResourceStatus resourceStatus;
 893   if(mImpl->mRenderer)
 894   {
 895     if(textureInformation.useAtlasing)
 896     {
 897       mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
 898     }
 899
 900     EnablePreMultipliedAlpha(textureInformation.preMultiplied);
 901
 902     Actor actor = mPlacementActor.GetHandle();
 903     if(!loadingSuccess)
 904     {
 905       Vector2 imageSize = Vector2::ZERO;
 906       if(actor)
 907       {
 908         imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 909       }
 910       mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 911       textureInformation.textureSet = mImpl->mRenderer.GetTextures();
 912     }
 913     else
 914     {
 915       if(!textureInformation.useAtlasing)
 916       {
 917         Sampler sampler = Sampler::New();
 918         sampler.SetWrapMode(mWrapModeU, mWrapModeV);
 919         textureInformation.textureSet.SetSampler(0u, sampler);
 920       }
 921
 922       mImpl->mRenderer.SetTextures(textureInformation.textureSet);
 923       ComputeTextureSize();
 924       CheckMaskTexture();
 925
 926       if(textureInformation.textureSet.GetTextureCount() == 3)
 927       {
 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)
 929         {
 930           mNeedYuvToRgb = true;
 931           UpdateShader();
 932         }
 933       }
 934     }
 935
 936     if(actor)
 937     {
 938       actor.AddRenderer(mImpl->mRenderer);
 939       // reset the weak handle so that the renderer only get added to actor once
 940       mPlacementActor.Reset();
 941     }
 942   }
 943
 944   // Storing TextureSet needed when renderer staged.
 945   if(!mImpl->mRenderer)
 946   {
 947     mTextures = textureInformation.textureSet;
 948   }
 949
 950   // Image loaded, set status regardless of staged status.
 951   if(loadingSuccess)
 952   {
 953     resourceStatus = Toolkit::Visual::ResourceStatus::READY;
 954     mLoadState     = TextureManager::LoadState::LOAD_FINISHED;
 955   }
 956   else
 957   {
 958     resourceStatus = Toolkit::Visual::ResourceStatus::FAILED;
 959     mLoadState     = TextureManager::LoadState::LOAD_FAILED;
 960   }
 961
 962   // use geometry if needed
 963   if(loadingSuccess)
 964   {
 965     uint32_t firstElementCount{0u};
 966     uint32_t secondElementCount{0u};
 967     auto     geometry = mFactoryCache.GetTextureManager().GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
 968     if(mImpl->mRenderer && geometry)
 969     {
 970       mImpl->mRenderer.SetGeometry(geometry);
 971       Dali::DevelRenderer::DrawCommand drawCommand{};
 972       drawCommand.drawType = DevelRenderer::DrawType::INDEXED;
 973
 974       if(firstElementCount)
 975       {
 976         drawCommand.firstIndex   = 0;
 977         drawCommand.elementCount = firstElementCount;
 978         drawCommand.queue        = DevelRenderer::RENDER_QUEUE_OPAQUE;
 979         DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
 980       }
 981
 982       if(secondElementCount)
 983       {
 984         drawCommand.firstIndex   = firstElementCount;
 985         drawCommand.elementCount = secondElementCount;
 986         drawCommand.queue        = DevelRenderer::RENDER_QUEUE_TRANSPARENT;
 987         DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
 988       }
 989     }
 990   }
 991
 992   // Signal to observers ( control ) that resources are ready. Must be all resources.
 993   ResourceReady(resourceStatus);
 994 }
 995
 996 void ImageVisual::RemoveTexture()
 997 {
 998   if(mTextureId != TextureManager::INVALID_TEXTURE_ID)
 999   {
1000     mFactoryCache.GetTextureManager().Remove(mTextureId, this);
1001     mTextureId = TextureManager::INVALID_TEXTURE_ID;
1002   }
1003   else
1004   {
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)
1008     {
1009       Property::Value atlasRectValue = mImpl->mRenderer.GetProperty(index);
1010       atlasRectValue.Get(atlasRect);
1011     }
1012
1013     TextureSet textureSet = mImpl->mRenderer.GetTextures();
1014
1015     if(index != Property::INVALID_INDEX)
1016     {
1017       mFactoryCache.GetAtlasManager()->Remove(textureSet, atlasRect);
1018     }
1019   }
1020 }
1021
1022 void ImageVisual::ComputeTextureSize()
1023 {
1024   if(mImpl->mRenderer)
1025   {
1026     auto textureSet = mImpl->mRenderer.GetTextures();
1027     if(textureSet && textureSet.GetTextureCount())
1028     {
1029       auto texture = textureSet.GetTexture(0);
1030       if(texture)
1031       {
1032         mTextureSize.x = texture.GetWidth();
1033         mTextureSize.y = texture.GetHeight();
1034         if(textureSet.GetTextureCount() > 1u && mMaskingData && !mMaskingData->mPreappliedMasking && mMaskingData->mCropToMask)
1035         {
1036           Texture maskTexture = textureSet.GetTexture(1);
1037           if(maskTexture)
1038           {
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());
1041           }
1042         }
1043       }
1044     }
1045   }
1046 }
1047
1048 Vector2 ImageVisual::ComputeMaskTextureRatio()
1049 {
1050   Vector2 maskTextureRatio;
1051   if(mImpl->mRenderer)
1052   {
1053     auto textureSet = mImpl->mRenderer.GetTextures();
1054     if(textureSet && textureSet.GetTextureCount())
1055     {
1056       auto texture = textureSet.GetTexture(0);
1057       if(texture)
1058       {
1059         if(textureSet.GetTextureCount() > 1u && mMaskingData && !mMaskingData->mPreappliedMasking && mMaskingData->mCropToMask)
1060         {
1061           Texture maskTexture = textureSet.GetTexture(1);
1062           if(maskTexture)
1063           {
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);
1068           }
1069         }
1070       }
1071     }
1072   }
1073   return maskTextureRatio;
1074 }
1075
1076 Shader ImageVisual::GenerateShader() const
1077 {
1078   Shader shader;
1079
1080   bool       usesWholeTexture  = true;
1081   const bool useStandardShader = !mImpl->mCustomShader;
1082   const bool useNativeImage    = (mTextures && DevelTexture::IsNative(mTextures.GetTexture(0)));
1083
1084   if(useStandardShader)
1085   {
1086     bool requiredAlphaMaskingOnRendering = (mMaskingData && !mMaskingData->mMaskImageLoadingFailed) ? !mMaskingData->mPreappliedMasking : false;
1087     // Create and cache the standard shader
1088     shader = mImageVisualShaderFactory.GetShader(
1089       mFactoryCache,
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));
1098   }
1099   else
1100   {
1101     std::string_view vertexShaderView;
1102     std::string_view fragmentShaderView;
1103
1104     if(mImpl->mCustomShader && !mImpl->mCustomShader->mVertexShader.empty())
1105     {
1106       vertexShaderView = mImpl->mCustomShader->mVertexShader;
1107       usesWholeTexture = false; // Impossible to tell.
1108     }
1109     else
1110     {
1111       vertexShaderView = mImageVisualShaderFactory.GetVertexShaderSource();
1112     }
1113
1114     if(mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty())
1115     {
1116       fragmentShaderView = mImpl->mCustomShader->mFragmentShader;
1117     }
1118     else
1119     {
1120       fragmentShaderView = mImageVisualShaderFactory.GetFragmentShaderSource();
1121     }
1122
1123     // If the texture is native, we may need to change prefix and sampler in
1124     // the fragment shader
1125     if(useNativeImage)
1126     {
1127       bool        modifiedFragmentShader = false;
1128       Texture     nativeTexture          = mTextures.GetTexture(0);
1129       std::string fragmentShaderString   = std::string(fragmentShaderView);
1130
1131       modifiedFragmentShader = DevelTexture::ApplyNativeFragmentShader(nativeTexture, fragmentShaderString);
1132       if(modifiedFragmentShader)
1133       {
1134         fragmentShaderView = fragmentShaderString;
1135       }
1136
1137       // Create shader here cause fragmentShaderString scope issue
1138       shader = Shader::New(vertexShaderView, fragmentShaderView, mImpl->mCustomShader->mHints);
1139     }
1140     else
1141     {
1142       shader = Shader::New(vertexShaderView, fragmentShaderView, mImpl->mCustomShader->mHints);
1143     }
1144   }
1145
1146   if(usesWholeTexture)
1147   {
1148     shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
1149   }
1150
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);
1155
1156   return shader;
1157 }
1158
1159 void ImageVisual::CheckMaskTexture()
1160 {
1161   if(mMaskingData && !mMaskingData->mPreappliedMasking)
1162   {
1163     bool       maskLoadFailed = true;
1164     TextureSet textures       = mImpl->mRenderer.GetTextures();
1165     if(textures && textures.GetTextureCount() >= TEXTURE_COUNT_FOR_GPU_ALPHA_MASK)
1166     {
1167       if(mMaskingData->mCropToMask)
1168       {
1169         mImpl->mRenderer.RegisterProperty(MASK_TEXTURE_RATIO_NAME, ComputeMaskTextureRatio());
1170       }
1171       maskLoadFailed = false;
1172     }
1173
1174     if(mMaskingData->mMaskImageLoadingFailed != maskLoadFailed)
1175     {
1176       mMaskingData->mMaskImageLoadingFailed = maskLoadFailed;
1177       UpdateShader();
1178     }
1179   }
1180 }
1181
1182 } // namespace Internal
1183
1184 } // namespace Toolkit
1185
1186 } // namespace Dali