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