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       int32_t desiredWidth = 0;
 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       int32_t desiredHeight = 0;
 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         else
 529         {
 530           imageSize = mPlacementActorSize;
 531         }
 532
 533         mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 534         Texture brokenImage = mImpl->mRenderer.GetTextures().GetTexture(0);
 535         naturalSize.x       = brokenImage.GetWidth();
 536         naturalSize.y       = brokenImage.GetWidth();
 537       }
 538       return;
 539     }
 540   }
 541   naturalSize = Vector2::ZERO;
 542 }
 543
 544 void ImageVisual::OnInitialize()
 545 {
 546   Geometry geometry;
 547
 548   // Get the geometry
 549   if(mImpl->mCustomShader)
 550   {
 551     geometry = CreateGeometry(mFactoryCache, mImpl->mCustomShader->mGridSize);
 552   }
 553   else // Get any geometry associated with the texture
 554   {
 555     TextureManager& textureManager = mFactoryCache.GetTextureManager();
 556
 557     uint32_t firstElementCount{0u};
 558     uint32_t secondElementCount{0u};
 559     geometry = textureManager.GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
 560
 561     if(!firstElementCount && !secondElementCount) // Otherwise use quad
 562     {
 563       geometry = CreateGeometry(mFactoryCache, ImageDimensions(1, 1));
 564     }
 565   }
 566
 567   // Increase reference count of External Resources :
 568   // EncodedImageBuffer or ExternalTextures.
 569   // Reference count will be decreased at destructor of the visual.
 570   if(mImageUrl.IsValid() && (mImageUrl.IsBufferResource() || mImageUrl.GetProtocolType() == VisualUrl::TEXTURE))
 571   {
 572     TextureManager& textureManager = mFactoryCache.GetTextureManager();
 573     textureManager.UseExternalResource(mImageUrl.GetUrl());
 574   }
 575
 576   Shader shader = GenerateShader();
 577
 578   // Create the renderer
 579   mImpl->mRenderer = DecoratedVisualRenderer::New(geometry, shader);
 580   mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
 581
 582   //Register transform properties
 583   mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 584
 585   EnablePreMultipliedAlpha(IsPreMultipliedAlphaEnabled());
 586
 587   if(mMaskingData)
 588   {
 589     mImpl->mRenderer.RegisterProperty(CROP_TO_MASK_NAME, static_cast<float>(mMaskingData->mCropToMask));
 590   }
 591 }
 592
 593 void ImageVisual::LoadTexture(bool& atlasing, Vector4& atlasRect, TextureSet& textures, bool orientationCorrection, TextureManager::ReloadPolicy forceReload)
 594 {
 595   TextureManager& textureManager = mFactoryCache.GetTextureManager();
 596
 597   ImageAtlasManagerPtr atlasManager        = nullptr;
 598   AtlasUploadObserver* atlasUploadObserver = nullptr;
 599   auto                 textureObserver     = this;
 600
 601   if(atlasing)
 602   {
 603     atlasManager        = mFactoryCache.GetAtlasManager();
 604     atlasUploadObserver = this;
 605   }
 606
 607   auto preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader
 608                              ? TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD
 609                              : TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
 610
 611   bool synchronousLoading = IsSynchronousLoadingRequired();
 612   bool loadingStatus;
 613
 614   textures = textureManager.LoadTexture(mImageUrl, mDesiredSize, mFittingMode, mSamplingMode, mMaskingData, synchronousLoading, mTextureId, atlasRect, mAtlasRectSize, atlasing, loadingStatus, textureObserver, atlasUploadObserver, atlasManager, mOrientationCorrection, forceReload, preMultiplyOnLoad);
 615
 616   if(textures)
 617   {
 618     if(loadingStatus)
 619     {
 620       mLoadState = TextureManager::LoadState::LOADING;
 621     }
 622     else
 623     {
 624       mLoadState = TextureManager::LoadState::LOAD_FINISHED;
 625     }
 626
 627     EnablePreMultipliedAlpha(preMultiplyOnLoad == TextureManager::MultiplyOnLoad::MULTIPLY_ON_LOAD);
 628     if(!atlasing)
 629     {
 630       Sampler sampler = Sampler::New();
 631       sampler.SetWrapMode(mWrapModeU, mWrapModeV);
 632       textures.SetSampler(0u, sampler);
 633     }
 634   }
 635   else if(synchronousLoading)
 636   {
 637     // Synchronous loading is failed
 638     mLoadState = TextureManager::LoadState::LOAD_FAILED;
 639   }
 640
 641   if(atlasing) // Flag needs to be set before creating renderer
 642   {
 643     mImpl->mFlags |= Visual::Base::Impl::IS_ATLASING_APPLIED;
 644   }
 645   else
 646   {
 647     mImpl->mFlags &= ~Visual::Base::Impl::IS_ATLASING_APPLIED;
 648   }
 649 }
 650
 651 bool ImageVisual::AttemptAtlasing()
 652 {
 653   return (!mImpl->mCustomShader && (mImageUrl.IsLocalResource() || mImageUrl.IsBufferResource()) && mAttemptAtlasing);
 654 }
 655
 656 void ImageVisual::InitializeRenderer()
 657 {
 658   auto attemptAtlasing = AttemptAtlasing();
 659
 660   // Load Texture if mTextures is empty.
 661   // mTextures is already set, the mTexture can be used to create Renderer.
 662   // There are two cases mTextures is empty.
 663   // 1. mTextureId == TextureManager::INVALID_TEXTURE_ID
 664   //  - Visual is on stage with LoadPolicy::ATTACHED
 665   // 2. mTextureId != TextureManager::INVALID_TEXTURE_ID
 666   //  - If ReleasePolicy is DESTROYED, InitializeRenderer called every on stage called.
 667   //  - Then every resources those contained in Visual are Reset but mTextureId is remained when the Off stage time,
 668   //  - So, mTextures needed to be get from texture manager to created resources like mImpl->mRenderer.
 669   if(!mTextures)
 670   {
 671     if(mTextureId == TextureManager::INVALID_TEXTURE_ID)
 672     {
 673       LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::CACHED);
 674     }
 675     else
 676     {
 677       mTextures = mFactoryCache.GetTextureManager().GetTextureSet(mTextureId);
 678       if(!(mImpl->mFlags & Visual::Base::Impl::IS_ATLASING_APPLIED) && mTextures)
 679       {
 680         Sampler sampler = Sampler::New();
 681         sampler.SetWrapMode(mWrapModeU, mWrapModeV);
 682         mTextures.SetSampler(0u, sampler);
 683       }
 684     }
 685   }
 686
 687   if(mTextures)
 688   {
 689     mImpl->mRenderer.SetTextures(mTextures);
 690     ComputeTextureSize();
 691     CheckMaskTexture();
 692
 693     bool needToUpdateShader = DevelTexture::IsNative(mTextures.GetTexture(0));
 694
 695     if(mTextures.GetTextureCount() == 3)
 696     {
 697       if(mTextures.GetTexture(0).GetPixelFormat() == Pixel::L8 && mTextures.GetTexture(1).GetPixelFormat() == Pixel::CHROMINANCE_U && mTextures.GetTexture(2).GetPixelFormat() == Pixel::CHROMINANCE_V)
 698       {
 699         mNeedYuvToRgb      = true;
 700         needToUpdateShader = true;
 701       }
 702     }
 703
 704     if(needToUpdateShader)
 705     {
 706       UpdateShader();
 707     }
 708     mTextures.Reset(); // Visual should not keep a handle to the texture after this point.
 709   }
 710
 711   if(attemptAtlasing) // the texture is packed inside atlas
 712   {
 713     mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
 714
 715     bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
 716
 717     if(!defaultWrapMode) // custom wrap mode
 718     {
 719       Vector2 wrapMode(mWrapModeU - WrapMode::CLAMP_TO_EDGE, mWrapModeV - WrapMode::CLAMP_TO_EDGE);
 720       wrapMode.Clamp(Vector2::ZERO, Vector2(2.f, 2.f));
 721       mImpl->mRenderer.RegisterProperty(WRAP_MODE_UNIFORM_NAME, wrapMode);
 722     }
 723   }
 724 }
 725
 726 void ImageVisual::DoSetOnScene(Actor& actor)
 727 {
 728   if(mImageUrl.IsValid())
 729   {
 730     InitializeRenderer();
 731   }
 732
 733   if(!mImpl->mRenderer)
 734   {
 735     return;
 736   }
 737
 738   mPlacementActor = actor;
 739   // Search the Actor tree to find if Layer UI behaviour set.
 740   Layer layer = actor.GetLayer();
 741   if(layer && layer.GetProperty<Layer::Behavior>(Layer::Property::BEHAVIOR) == Layer::LAYER_3D)
 742   {
 743     // Layer 3D set, do not align pixels
 744     mImpl->mRenderer.RegisterProperty(PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF);
 745   }
 746
 747   if(mPixelArea != FULL_TEXTURE_RECT)
 748   {
 749     mImpl->mRenderer.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, mPixelArea);
 750   }
 751
 752   if(mLoadState == TextureManager::LoadState::LOAD_FINISHED)
 753   {
 754     actor.AddRenderer(mImpl->mRenderer);
 755     mPlacementActor.Reset();
 756
 757     // Image loaded and ready to display
 758     ResourceReady(Toolkit::Visual::ResourceStatus::READY);
 759   }
 760   else if(mLoadState == TextureManager::LoadState::LOAD_FAILED)
 761   {
 762     Vector2 imageSize = Vector2::ZERO;
 763     if(actor)
 764     {
 765       imageSize  = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 766       mPlacementActorSize = imageSize;
 767     }
 768
 769     mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 770     actor.AddRenderer(mImpl->mRenderer);
 771     mPlacementActor.Reset();
 772
 773     ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
 774   }
 775 }
 776
 777 void ImageVisual::DoSetOffScene(Actor& actor)
 778 {
 779   // Visual::Base::SetOffScene only calls DoSetOffScene if mRenderer exists (is on onstage)
 780
 781   // Image release is dependent on the ReleasePolicy, renderer is removed.
 782   actor.RemoveRenderer(mImpl->mRenderer);
 783   if(mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
 784   {
 785     RemoveTexture(); // If INVALID_TEXTURE_ID then removal will be attempted on atlas
 786     mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
 787
 788     TextureSet textureSet = TextureSet::New();
 789     mImpl->mRenderer.SetTextures(textureSet);
 790     ComputeTextureSize();
 791
 792     mLoadState = TextureManager::LoadState::NOT_STARTED;
 793   }
 794
 795   mPlacementActor.Reset();
 796 }
 797
 798 void ImageVisual::DoCreatePropertyMap(Property::Map& map) const
 799 {
 800   map.Clear();
 801   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
 802
 803   bool sync = IsSynchronousLoadingRequired();
 804   map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync);
 805   if(mImageUrl.IsValid())
 806   {
 807     map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
 808     map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
 809     map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
 810   }
 811
 812   map.Insert(Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode);
 813   map.Insert(Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode);
 814
 815   map.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea);
 816   map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU);
 817   map.Insert(Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV);
 818
 819   map.Insert(Toolkit::ImageVisual::Property::ATLASING, mAttemptAtlasing);
 820
 821   if(mMaskingData != NULL)
 822   {
 823     map.Insert(Toolkit::ImageVisual::Property::ALPHA_MASK_URL, mMaskingData->mAlphaMaskUrl.GetUrl());
 824     map.Insert(Toolkit::ImageVisual::Property::MASK_CONTENT_SCALE, mMaskingData->mContentScaleFactor);
 825     map.Insert(Toolkit::ImageVisual::Property::CROP_TO_MASK, mMaskingData->mCropToMask);
 826     map.Insert(Toolkit::DevelImageVisual::Property::MASKING_TYPE, mMaskingData->mPreappliedMasking ? DevelImageVisual::MaskingType::MASKING_ON_LOADING : DevelImageVisual::MaskingType::MASKING_ON_RENDERING);
 827   }
 828
 829   map.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, mLoadPolicy);
 830   map.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy);
 831   map.Insert(Toolkit::ImageVisual::Property::ORIENTATION_CORRECTION, mOrientationCorrection);
 832 }
 833
 834 void ImageVisual::DoCreateInstancePropertyMap(Property::Map& map) const
 835 {
 836   map.Clear();
 837   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
 838   if(mImageUrl.IsValid())
 839   {
 840     map.Insert(Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth());
 841     map.Insert(Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight());
 842   }
 843 }
 844
 845 void ImageVisual::OnDoAction(const Dali::Property::Index actionId, const Dali::Property::Value& attributes)
 846 {
 847   // Check if action is valid for this visual type and perform action if possible
 848
 849   switch(actionId)
 850   {
 851     case DevelImageVisual::Action::RELOAD:
 852     {
 853       auto attemptAtlasing = AttemptAtlasing();
 854       LoadTexture(attemptAtlasing, mAtlasRect, mTextures, mOrientationCorrection, TextureManager::ReloadPolicy::FORCED);
 855       break;
 856     }
 857   }
 858 }
 859
 860 void ImageVisual::OnSetTransform()
 861 {
 862   if(mImpl->mRenderer)
 863   {
 864     mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 865   }
 866 }
 867
 868 void ImageVisual::UpdateShader()
 869 {
 870   if(mImpl->mRenderer)
 871   {
 872     Shader shader = GenerateShader();
 873     mImpl->mRenderer.SetShader(shader);
 874   }
 875 }
 876
 877 // From existing atlas manager
 878 void ImageVisual::UploadCompleted()
 879 {
 880   // Texture has been uploaded. If weak handle is holding a placement actor,
 881   // it is the time to add the renderer to actor.
 882   Actor actor = mPlacementActor.GetHandle();
 883   if(actor)
 884   {
 885     mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
 886     actor.AddRenderer(mImpl->mRenderer);
 887     // reset the weak handle so that the renderer only get added to actor once
 888     mPlacementActor.Reset();
 889   }
 890
 891   // Image loaded
 892   ResourceReady(Toolkit::Visual::ResourceStatus::READY);
 893   mLoadState = TextureManager::LoadState::LOAD_FINISHED;
 894 }
 895
 896 // From Texture Manager
 897 void ImageVisual::LoadComplete(bool loadingSuccess, TextureInformation textureInformation)
 898 {
 899   Toolkit::Visual::ResourceStatus resourceStatus;
 900   if(mImpl->mRenderer)
 901   {
 902     if(textureInformation.useAtlasing)
 903     {
 904       mImpl->mRenderer.RegisterProperty(ATLAS_RECT_UNIFORM_NAME, mAtlasRect);
 905     }
 906
 907     EnablePreMultipliedAlpha(textureInformation.preMultiplied);
 908
 909     Actor actor = mPlacementActor.GetHandle();
 910     if(!loadingSuccess)
 911     {
 912       Vector2 imageSize = Vector2::ZERO;
 913       if(actor)
 914       {
 915         imageSize  = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
 916         mPlacementActorSize = imageSize;
 917       }
 918       else
 919       {
 920         imageSize = mPlacementActorSize;
 921       }
 922
 923       mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize);
 924       textureInformation.textureSet = mImpl->mRenderer.GetTextures();
 925     }
 926     else
 927     {
 928       if(!textureInformation.useAtlasing)
 929       {
 930         Sampler sampler = Sampler::New();
 931         sampler.SetWrapMode(mWrapModeU, mWrapModeV);
 932         textureInformation.textureSet.SetSampler(0u, sampler);
 933       }
 934
 935       mImpl->mRenderer.SetTextures(textureInformation.textureSet);
 936       ComputeTextureSize();
 937       CheckMaskTexture();
 938
 939       if(textureInformation.textureSet.GetTextureCount() == 3)
 940       {
 941         if(textureInformation.textureSet.GetTexture(0).GetPixelFormat() == Pixel::L8 && textureInformation.textureSet.GetTexture(1).GetPixelFormat() == Pixel::CHROMINANCE_U && textureInformation.textureSet.GetTexture(2).GetPixelFormat() == Pixel::CHROMINANCE_V)
 942         {
 943           mNeedYuvToRgb = true;
 944           UpdateShader();
 945         }
 946       }
 947     }
 948
 949     if(actor)
 950     {
 951       actor.AddRenderer(mImpl->mRenderer);
 952       // reset the weak handle so that the renderer only get added to actor once
 953       mPlacementActor.Reset();
 954     }
 955   }
 956
 957   // Storing TextureSet needed when renderer staged.
 958   if(!mImpl->mRenderer)
 959   {
 960     mTextures = textureInformation.textureSet;
 961   }
 962
 963   // Image loaded, set status regardless of staged status.
 964   if(loadingSuccess)
 965   {
 966     resourceStatus = Toolkit::Visual::ResourceStatus::READY;
 967     mLoadState     = TextureManager::LoadState::LOAD_FINISHED;
 968   }
 969   else
 970   {
 971     resourceStatus = Toolkit::Visual::ResourceStatus::FAILED;
 972     mLoadState     = TextureManager::LoadState::LOAD_FAILED;
 973   }
 974
 975   // use geometry if needed
 976   if(loadingSuccess)
 977   {
 978     uint32_t firstElementCount{0u};
 979     uint32_t secondElementCount{0u};
 980     auto     geometry = mFactoryCache.GetTextureManager().GetRenderGeometry(mTextureId, firstElementCount, secondElementCount);
 981     if(mImpl->mRenderer && geometry)
 982     {
 983       mImpl->mRenderer.SetGeometry(geometry);
 984       Dali::DevelRenderer::DrawCommand drawCommand{};
 985       drawCommand.drawType = DevelRenderer::DrawType::INDEXED;
 986
 987       if(firstElementCount)
 988       {
 989         drawCommand.firstIndex   = 0;
 990         drawCommand.elementCount = firstElementCount;
 991         drawCommand.queue        = DevelRenderer::RENDER_QUEUE_OPAQUE;
 992         DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
 993       }
 994
 995       if(secondElementCount)
 996       {
 997         drawCommand.firstIndex   = firstElementCount;
 998         drawCommand.elementCount = secondElementCount;
 999         drawCommand.queue        = DevelRenderer::RENDER_QUEUE_TRANSPARENT;
1000         DevelRenderer::AddDrawCommand(mImpl->mRenderer, drawCommand);
1001       }
1002     }
1003   }
1004
1005   // Signal to observers ( control ) that resources are ready. Must be all resources.
1006   ResourceReady(resourceStatus);
1007 }
1008
1009 void ImageVisual::RemoveTexture()
1010 {
1011   if(mTextureId != TextureManager::INVALID_TEXTURE_ID)
1012   {
1013     mFactoryCache.GetTextureManager().Remove(mTextureId, this);
1014     mTextureId = TextureManager::INVALID_TEXTURE_ID;
1015   }
1016   else
1017   {
1018     Vector4         atlasRect(0.f, 0.f, 1.f, 1.f);
1019     Property::Index index = mImpl->mRenderer.GetPropertyIndex(ATLAS_RECT_UNIFORM_NAME);
1020     if(index != Property::INVALID_INDEX)
1021     {
1022       Property::Value atlasRectValue = mImpl->mRenderer.GetProperty(index);
1023       atlasRectValue.Get(atlasRect);
1024     }
1025
1026     TextureSet textureSet = mImpl->mRenderer.GetTextures();
1027
1028     if(index != Property::INVALID_INDEX)
1029     {
1030       mFactoryCache.GetAtlasManager()->Remove(textureSet, atlasRect);
1031     }
1032   }
1033 }
1034
1035 void ImageVisual::ComputeTextureSize()
1036 {
1037   if(mImpl->mRenderer)
1038   {
1039     auto textureSet = mImpl->mRenderer.GetTextures();
1040     if(textureSet && textureSet.GetTextureCount())
1041     {
1042       auto texture = textureSet.GetTexture(0);
1043       if(texture)
1044       {
1045         mTextureSize.x = texture.GetWidth();
1046         mTextureSize.y = texture.GetHeight();
1047         if(textureSet.GetTextureCount() > 1u && mMaskingData && !mMaskingData->mPreappliedMasking && mMaskingData->mCropToMask)
1048         {
1049           Texture maskTexture = textureSet.GetTexture(1);
1050           if(maskTexture)
1051           {
1052             mTextureSize.x = std::min(static_cast<uint32_t>(mTextureSize.x * mMaskingData->mContentScaleFactor), maskTexture.GetWidth());
1053             mTextureSize.y = std::min(static_cast<uint32_t>(mTextureSize.y * mMaskingData->mContentScaleFactor), maskTexture.GetHeight());
1054           }
1055         }
1056       }
1057     }
1058   }
1059 }
1060
1061 Vector2 ImageVisual::ComputeMaskTextureRatio()
1062 {
1063   Vector2 maskTextureRatio;
1064   if(mImpl->mRenderer)
1065   {
1066     auto textureSet = mImpl->mRenderer.GetTextures();
1067     if(textureSet && textureSet.GetTextureCount())
1068     {
1069       auto texture = textureSet.GetTexture(0);
1070       if(texture)
1071       {
1072         if(textureSet.GetTextureCount() > 1u && mMaskingData && !mMaskingData->mPreappliedMasking && mMaskingData->mCropToMask)
1073         {
1074           Texture maskTexture = textureSet.GetTexture(1);
1075           if(maskTexture)
1076           {
1077             float textureWidth  = std::max(static_cast<float>(texture.GetWidth() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
1078             float textureHeight = std::max(static_cast<float>(texture.GetHeight() * mMaskingData->mContentScaleFactor), Dali::Math::MACHINE_EPSILON_1);
1079             maskTextureRatio    = Vector2(std::min(static_cast<float>(maskTexture.GetWidth()), textureWidth) / textureWidth,
1080                                        std::min(static_cast<float>(maskTexture.GetHeight()), textureHeight) / textureHeight);
1081           }
1082         }
1083       }
1084     }
1085   }
1086   return maskTextureRatio;
1087 }
1088
1089 Shader ImageVisual::GenerateShader() const
1090 {
1091   Shader shader;
1092
1093   bool       usesWholeTexture  = true;
1094   const bool useStandardShader = !mImpl->mCustomShader;
1095   const bool useNativeImage    = (mTextures && DevelTexture::IsNative(mTextures.GetTexture(0)));
1096
1097   if(useStandardShader)
1098   {
1099     bool requiredAlphaMaskingOnRendering = (mMaskingData && !mMaskingData->mMaskImageLoadingFailed) ? !mMaskingData->mPreappliedMasking : false;
1100     // Create and cache the standard shader
1101     shader = mImageVisualShaderFactory.GetShader(
1102       mFactoryCache,
1103       ImageVisualShaderFeature::FeatureBuilder()
1104         .EnableTextureAtlas(mImpl->mFlags & Visual::Base::Impl::IS_ATLASING_APPLIED && !useNativeImage)
1105         .ApplyDefaultTextureWrapMode(mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE)
1106         .EnableRoundedCorner(IsRoundedCornerRequired())
1107         .EnableBorderline(IsBorderlineRequired())
1108         .SetTextureForFragmentShaderCheck(useNativeImage ? mTextures.GetTexture(0) : Dali::Texture())
1109         .EnableAlphaMaskingOnRendering(requiredAlphaMaskingOnRendering)
1110         .EnableYuvToRgb(mNeedYuvToRgb));
1111   }
1112   else
1113   {
1114     std::string_view vertexShaderView;
1115     std::string_view fragmentShaderView;
1116
1117     if(mImpl->mCustomShader && !mImpl->mCustomShader->mVertexShader.empty())
1118     {
1119       vertexShaderView = mImpl->mCustomShader->mVertexShader;
1120       usesWholeTexture = false; // Impossible to tell.
1121     }
1122     else
1123     {
1124       vertexShaderView = mImageVisualShaderFactory.GetVertexShaderSource();
1125     }
1126
1127     if(mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty())
1128     {
1129       fragmentShaderView = mImpl->mCustomShader->mFragmentShader;
1130     }
1131     else
1132     {
1133       fragmentShaderView = mImageVisualShaderFactory.GetFragmentShaderSource();
1134     }
1135
1136     // If the texture is native, we may need to change prefix and sampler in
1137     // the fragment shader
1138     if(useNativeImage)
1139     {
1140       bool        modifiedFragmentShader = false;
1141       Texture     nativeTexture          = mTextures.GetTexture(0);
1142       std::string fragmentShaderString   = std::string(fragmentShaderView);
1143
1144       modifiedFragmentShader = DevelTexture::ApplyNativeFragmentShader(nativeTexture, fragmentShaderString);
1145       if(modifiedFragmentShader)
1146       {
1147         fragmentShaderView = fragmentShaderString;
1148       }
1149
1150       // Create shader here cause fragmentShaderString scope issue
1151       shader = Shader::New(vertexShaderView, fragmentShaderView, mImpl->mCustomShader->mHints);
1152     }
1153     else
1154     {
1155       shader = Shader::New(vertexShaderView, fragmentShaderView, mImpl->mCustomShader->mHints);
1156     }
1157   }
1158
1159   if(usesWholeTexture)
1160   {
1161     shader.RegisterProperty(PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT);
1162   }
1163
1164   // Set pixel align off as default.
1165   // ToDo: Pixel align causes issues such as rattling image animation.
1166   // We should trun it off until issues are resolved
1167   shader.RegisterProperty(PIXEL_ALIGNED_UNIFORM_NAME, PIXEL_ALIGN_OFF);
1168
1169   return shader;
1170 }
1171
1172 void ImageVisual::CheckMaskTexture()
1173 {
1174   if(mMaskingData && !mMaskingData->mPreappliedMasking)
1175   {
1176     bool       maskLoadFailed = true;
1177     TextureSet textures       = mImpl->mRenderer.GetTextures();
1178     if(textures && textures.GetTextureCount() >= TEXTURE_COUNT_FOR_GPU_ALPHA_MASK)
1179     {
1180       if(mMaskingData->mCropToMask)
1181       {
1182         mImpl->mRenderer.RegisterProperty(MASK_TEXTURE_RATIO_NAME, ComputeMaskTextureRatio());
1183       }
1184       maskLoadFailed = false;
1185     }
1186
1187     if(mMaskingData->mMaskImageLoadingFailed != maskLoadFailed)
1188     {
1189       mMaskingData->mMaskImageLoadingFailed = maskLoadFailed;
1190       UpdateShader();
1191     }
1192   }
1193 }
1194
1195 } // namespace Internal
1196
1197 } // namespace Toolkit
1198
1199 } // namespace Dali