2 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "npatch-visual.h"
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/integration-api/debug.h>
28 #include <dali-toolkit/devel-api/utility/npatch-helper.h>
29 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
30 #include <dali-toolkit/internal/graphics/builtin-shader-extern-gen.h>
31 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
32 #include <dali-toolkit/internal/visuals/npatch-loader.h>
33 #include <dali-toolkit/internal/visuals/rendering-addon.h>
34 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
35 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
36 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
37 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
38 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
39 #include <dali-toolkit/public-api/visuals/visual-properties.h>
49 const int CUSTOM_PROPERTY_COUNT(5); // fixed(3),stretch,aux
52 /////////////////NPatchVisual////////////////
54 NPatchVisualPtr NPatchVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties)
56 NPatchVisualPtr nPatchVisual(new NPatchVisual(factoryCache, shaderFactory));
57 nPatchVisual->mImageUrl = imageUrl;
58 nPatchVisual->SetProperties(properties);
59 nPatchVisual->Initialize();
63 NPatchVisualPtr NPatchVisual::New(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl)
65 NPatchVisualPtr nPatchVisual(new NPatchVisual(factoryCache, shaderFactory));
66 nPatchVisual->mImageUrl = imageUrl;
67 nPatchVisual->Initialize();
71 void NPatchVisual::LoadImages()
73 TextureManager& textureManager = mFactoryCache.GetTextureManager();
74 bool synchronousLoading = mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
76 if(mId == NPatchData::INVALID_NPATCH_DATA_ID && (mImageUrl.IsLocalResource() || mImageUrl.IsBufferResource()))
78 bool preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader ? true : false;
79 mId = mLoader.Load(textureManager, this, mImageUrl, mBorder, preMultiplyOnLoad, synchronousLoading);
81 const NPatchData* data;
82 if(mLoader.GetNPatchData(mId, data) && data->GetLoadingState() == NPatchData::LoadingState::LOAD_COMPLETE)
84 EnablePreMultipliedAlpha(data->IsPreMultiplied());
88 if(!mAuxiliaryPixelBuffer && mAuxiliaryUrl.IsValid() && (mAuxiliaryUrl.IsLocalResource() || mAuxiliaryUrl.IsBufferResource()))
90 // Load the auxiliary image
91 auto preMultiplyOnLoading = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
92 mAuxiliaryPixelBuffer = textureManager.LoadPixelBuffer(mAuxiliaryUrl, Dali::ImageDimensions(), FittingMode::DEFAULT, SamplingMode::BOX_THEN_LINEAR, synchronousLoading, this, true, preMultiplyOnLoading);
94 // If synchronousLoading is true, we can check the auxiliaryResource's status now.
95 if(synchronousLoading)
97 mAuxiliaryResourceStatus = mAuxiliaryPixelBuffer ? Toolkit::Visual::ResourceStatus::READY : Toolkit::Visual::ResourceStatus::FAILED;
102 void NPatchVisual::GetNaturalSize(Vector2& naturalSize)
107 // load now if not already loaded
108 const NPatchData* data;
109 if(mLoader.GetNPatchData(mId, data) && data->GetLoadingState() != NPatchData::LoadingState::LOADING)
111 naturalSize.x = data->GetCroppedWidth();
112 naturalSize.y = data->GetCroppedHeight();
116 if(mImageUrl.IsValid())
118 ImageDimensions dimensions = Dali::GetOriginalImageSize(mImageUrl.GetUrl());
119 if(dimensions != ImageDimensions(0, 0))
121 naturalSize.x = dimensions.GetWidth();
122 naturalSize.y = dimensions.GetHeight();
127 if(mAuxiliaryPixelBuffer)
129 naturalSize.x = std::max(naturalSize.x, float(mAuxiliaryPixelBuffer.GetWidth()));
130 naturalSize.y = std::max(naturalSize.y, float(mAuxiliaryPixelBuffer.GetHeight()));
134 void NPatchVisual::DoSetProperties(const Property::Map& propertyMap)
136 // URL is already passed in via constructor
138 Property::Value* borderOnlyValue = propertyMap.Find(Toolkit::ImageVisual::Property::BORDER_ONLY, BORDER_ONLY);
141 borderOnlyValue->Get(mBorderOnly);
144 Property::Value* borderValue = propertyMap.Find(Toolkit::ImageVisual::Property::BORDER, BORDER);
145 if(borderValue && !borderValue->Get(mBorder)) // If value exists and is rect, just set mBorder
147 // Not a rect so try vector4
149 if(borderValue->Get(border))
151 mBorder.left = static_cast<int>(border.x);
152 mBorder.right = static_cast<int>(border.y);
153 mBorder.bottom = static_cast<int>(border.z);
154 mBorder.top = static_cast<int>(border.w);
158 Property::Value* auxImage = propertyMap.Find(Toolkit::DevelImageVisual::Property::AUXILIARY_IMAGE, AUXILIARY_IMAGE_NAME);
162 if(auxImage->Get(url))
168 Property::Value* auxImageAlpha = propertyMap.Find(Toolkit::DevelImageVisual::Property::AUXILIARY_IMAGE_ALPHA, AUXILIARY_IMAGE_ALPHA_NAME);
171 auxImageAlpha->Get(mAuxiliaryImageAlpha);
174 Property::Value* synchronousLoading = propertyMap.Find(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, SYNCHRONOUS_LOADING);
175 if(synchronousLoading)
178 synchronousLoading->Get(sync);
181 mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
185 mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
189 Property::Value* releasePolicy = propertyMap.Find(Toolkit::ImageVisual::Property::RELEASE_POLICY, RELEASE_POLICY_NAME);
192 releasePolicy->Get(mReleasePolicy);
196 void NPatchVisual::DoSetOnScene(Actor& actor)
198 // load when first go on stage
201 // Set mPlacementActor now, because some case, LoadImages can use this information in LoadComplete API.
202 // at this case, we try to SetResouce to mPlaceActor twice. so, we should avoid that case.
203 mPlacementActor = actor;
205 const NPatchData* data;
206 if(mImpl->mRenderer && mLoader.GetNPatchData(mId, data) && data->GetLoadingState() != NPatchData::LoadingState::LOADING)
208 // If mAuxiliaryUrl need to be loaded, we should wait it until LoadComplete called.
209 if(!mAuxiliaryUrl.IsValid() || mAuxiliaryResourceStatus != Toolkit::Visual::ResourceStatus::PREPARING)
216 void NPatchVisual::DoSetOffScene(Actor& actor)
218 if((mId != NPatchData::INVALID_NPATCH_DATA_ID) && mReleasePolicy == Toolkit::ImageVisual::ReleasePolicy::DETACHED)
220 mLoader.Remove(mId, this);
221 mImpl->mResourceStatus = Toolkit::Visual::ResourceStatus::PREPARING;
222 mId = NPatchData::INVALID_NPATCH_DATA_ID;
225 actor.RemoveRenderer(mImpl->mRenderer);
226 mPlacementActor.Reset();
229 void NPatchVisual::OnSetTransform()
233 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
237 void NPatchVisual::DoCreatePropertyMap(Property::Map& map) const
240 bool sync = IsSynchronousLoadingRequired();
241 map.Insert(Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, sync);
242 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::N_PATCH);
243 map.Insert(Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl());
244 map.Insert(Toolkit::ImageVisual::Property::BORDER_ONLY, mBorderOnly);
245 map.Insert(Toolkit::ImageVisual::Property::BORDER, mBorder);
246 map.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, mReleasePolicy);
248 if(mAuxiliaryUrl.IsValid())
250 map.Insert(Toolkit::DevelImageVisual::Property::AUXILIARY_IMAGE, mAuxiliaryUrl.GetUrl());
251 map.Insert(Toolkit::DevelImageVisual::Property::AUXILIARY_IMAGE_ALPHA, mAuxiliaryImageAlpha);
255 void NPatchVisual::DoCreateInstancePropertyMap(Property::Map& map) const
257 if(mAuxiliaryUrl.IsValid())
259 map.Insert(Toolkit::DevelImageVisual::Property::AUXILIARY_IMAGE, mAuxiliaryUrl.GetUrl());
260 map.Insert(Toolkit::DevelImageVisual::Property::AUXILIARY_IMAGE_ALPHA, mAuxiliaryImageAlpha);
264 NPatchVisual::NPatchVisual(VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory)
265 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::N_PATCH),
267 mLoader(factoryCache.GetNPatchLoader()),
268 mImageVisualShaderFactory(shaderFactory),
271 mId(NPatchData::INVALID_NPATCH_DATA_ID),
272 mAuxiliaryResourceStatus(Toolkit::Visual::ResourceStatus::PREPARING),
275 mAuxiliaryImageAlpha(0.0f),
276 mReleasePolicy(Toolkit::ImageVisual::ReleasePolicy::DETACHED)
278 EnablePreMultipliedAlpha(mFactoryCache.GetPreMultiplyOnLoad());
281 NPatchVisual::~NPatchVisual()
283 if(Stage::IsInstalled() && (mId != NPatchData::INVALID_NPATCH_DATA_ID) && (mReleasePolicy != Toolkit::ImageVisual::ReleasePolicy::NEVER))
285 mLoader.Remove(mId, this);
286 mId = NPatchData::INVALID_NPATCH_DATA_ID;
290 void NPatchVisual::OnInitialize()
292 // Get basic geometry and shader
293 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
294 Shader shader = mImageVisualShaderFactory.GetShader(
296 ImageVisualShaderFeature::FeatureBuilder());
298 mImpl->mRenderer = VisualRenderer::New(geometry, shader);
299 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
301 //Register transform properties
302 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
305 Geometry NPatchVisual::CreateGeometry()
308 const NPatchData* data;
309 if(mLoader.GetNPatchData(mId, data) && data->GetLoadingState() == NPatchData::LoadingState::LOAD_COMPLETE)
311 if(data->GetStretchPixelsX().Size() == 1 && data->GetStretchPixelsY().Size() == 1)
313 if(DALI_UNLIKELY(mBorderOnly))
315 geometry = GetNinePatchGeometry(VisualFactoryCache::NINE_PATCH_BORDER_GEOMETRY);
319 if(data->GetRenderingMap())
321 uint32_t elementCount[2];
322 geometry = RenderingAddOn::Get().CreateGeometryGrid(data->GetRenderingMap(), Uint16Pair(3, 3), elementCount);
325 RenderingAddOn::Get().SubmitRenderTask(mImpl->mRenderer, data->GetRenderingMap());
330 geometry = GetNinePatchGeometry(VisualFactoryCache::NINE_PATCH_GEOMETRY);
334 else if(data->GetStretchPixelsX().Size() > 0 || data->GetStretchPixelsY().Size() > 0)
336 Uint16Pair gridSize(2 * data->GetStretchPixelsX().Size() + 1, 2 * data->GetStretchPixelsY().Size() + 1);
337 if(!data->GetRenderingMap())
339 geometry = !mBorderOnly ? NPatchHelper::CreateGridGeometry(gridSize) : NPatchHelper::CreateBorderGeometry(gridSize);
343 uint32_t elementCount[2];
344 geometry = !mBorderOnly ? RenderingAddOn::Get().CreateGeometryGrid(data->GetRenderingMap(), gridSize, elementCount) : NPatchHelper::CreateBorderGeometry(gridSize);
347 RenderingAddOn::Get().SubmitRenderTask(mImpl->mRenderer, data->GetRenderingMap());
354 // no N patch data so use default geometry
355 geometry = GetNinePatchGeometry(VisualFactoryCache::NINE_PATCH_GEOMETRY);
360 Shader NPatchVisual::CreateShader()
363 const NPatchData* data;
364 // 0 is either no data (load failed?) or no stretch regions on image
365 // for both cases we use the default shader
366 NPatchUtility::StretchRanges::SizeType xStretchCount = 0;
367 NPatchUtility::StretchRanges::SizeType yStretchCount = 0;
369 auto fragmentShader = mAuxiliaryPixelBuffer ? SHADER_NPATCH_VISUAL_MASK_SHADER_FRAG
370 : SHADER_NPATCH_VISUAL_SHADER_FRAG;
371 auto shaderType = mAuxiliaryPixelBuffer ? VisualFactoryCache::NINE_PATCH_MASK_SHADER
372 : VisualFactoryCache::NINE_PATCH_SHADER;
374 // ask loader for the regions
375 if(mLoader.GetNPatchData(mId, data))
377 xStretchCount = data->GetStretchPixelsX().Count();
378 yStretchCount = data->GetStretchPixelsY().Count();
381 if(DALI_LIKELY(!mImpl->mCustomShader))
383 if(DALI_LIKELY((xStretchCount == 1 && yStretchCount == 1) ||
384 (xStretchCount == 0 && yStretchCount == 0)))
386 shader = mFactoryCache.GetShader(shaderType);
387 if(DALI_UNLIKELY(!shader))
389 shader = Shader::New(SHADER_NPATCH_VISUAL_3X3_SHADER_VERT, fragmentShader);
390 // Only cache vanilla 9 patch shaders
391 mFactoryCache.SaveShader(shaderType, shader);
394 else if(xStretchCount > 0 || yStretchCount > 0)
396 std::stringstream vertexShader;
397 vertexShader << "#define FACTOR_SIZE_X " << xStretchCount + 2 << "\n"
398 << "#define FACTOR_SIZE_Y " << yStretchCount + 2 << "\n"
399 << SHADER_NPATCH_VISUAL_SHADER_VERT;
401 shader = Shader::New(vertexShader.str(), fragmentShader);
406 Dali::Shader::Hint::Value hints = Dali::Shader::Hint::NONE;
408 if(!mImpl->mCustomShader->mFragmentShader.empty())
410 fragmentShader = mImpl->mCustomShader->mFragmentShader.c_str();
412 hints = mImpl->mCustomShader->mHints;
414 /* Apply Custom Vertex Shader only if image is 9-patch */
415 if((xStretchCount == 1 && yStretchCount == 1) ||
416 (xStretchCount == 0 && yStretchCount == 0))
418 const char* vertexShader = SHADER_NPATCH_VISUAL_3X3_SHADER_VERT.data();
420 if(!mImpl->mCustomShader->mVertexShader.empty())
422 vertexShader = mImpl->mCustomShader->mVertexShader.c_str();
424 shader = Shader::New(vertexShader, fragmentShader, hints);
426 else if(xStretchCount > 0 || yStretchCount > 0)
428 std::stringstream vertexShader;
429 vertexShader << "#define FACTOR_SIZE_X " << xStretchCount + 2 << "\n"
430 << "#define FACTOR_SIZE_Y " << yStretchCount + 2 << "\n"
431 << SHADER_NPATCH_VISUAL_SHADER_VERT;
433 shader = Shader::New(vertexShader.str(), fragmentShader, hints);
440 void NPatchVisual::ApplyTextureAndUniforms()
442 const NPatchData* data;
443 TextureSet textureSet;
445 if(mLoader.GetNPatchData(mId, data) && data->GetLoadingState() == NPatchData::LoadingState::LOAD_COMPLETE)
447 textureSet = data->GetTextures();
448 NPatchHelper::ApplyTextureAndUniforms(mImpl->mRenderer, data);
450 if(mAuxiliaryPixelBuffer)
452 // If the auxiliary image is smaller than the un-stretched NPatch, use CPU resizing to enlarge it to the
453 // same size as the unstretched NPatch. This will give slightly higher quality results than just relying
454 // on GL interpolation alone.
455 if(mAuxiliaryPixelBuffer.GetWidth() < data->GetCroppedWidth() &&
456 mAuxiliaryPixelBuffer.GetHeight() < data->GetCroppedHeight())
458 mAuxiliaryPixelBuffer.Resize(data->GetCroppedWidth(), data->GetCroppedHeight());
461 // Note, this resets mAuxiliaryPixelBuffer handle
462 auto auxiliaryPixelData = Devel::PixelBuffer::Convert(mAuxiliaryPixelBuffer);
464 auto texture = Texture::New(TextureType::TEXTURE_2D,
465 auxiliaryPixelData.GetPixelFormat(),
466 auxiliaryPixelData.GetWidth(),
467 auxiliaryPixelData.GetHeight());
468 texture.Upload(auxiliaryPixelData);
470 // TODO : This code exist due to the texture cache manager hold TextureSet, not Texture.
471 // If we call textureSet.SetTexture(1, texture) directly, the cached TextureSet also be changed.
472 // We should make pass utc-Dali-VisualFactory.cpp UtcDaliNPatchVisualAuxiliaryImage02().
473 TextureSet tempTextureSet = TextureSet::New();
474 tempTextureSet.SetTexture(0, textureSet.GetTexture(0));
475 tempTextureSet.SetTexture(1, texture);
476 textureSet = tempTextureSet;
478 mImpl->mRenderer.RegisterProperty(DevelImageVisual::Property::AUXILIARY_IMAGE_ALPHA,
479 AUXILIARY_IMAGE_ALPHA_NAME,
480 mAuxiliaryImageAlpha);
482 mImpl->mRenderer.SetTextures(textureSet);
486 DALI_LOG_ERROR("The N patch image '%s' is not a valid N patch image\n", mImageUrl.GetUrl().c_str());
487 Actor actor = mPlacementActor.GetHandle();
488 Vector2 imageSize = Vector2::ZERO;
491 imageSize = actor.GetProperty(Actor::Property::SIZE).Get<Vector2>();
493 mFactoryCache.UpdateBrokenImageRenderer(mImpl->mRenderer, imageSize, false);
496 // Register transform properties
497 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
500 Geometry NPatchVisual::GetNinePatchGeometry(VisualFactoryCache::GeometryType subType)
502 Geometry geometry = mFactoryCache.GetGeometry(subType);
505 if(DALI_LIKELY(VisualFactoryCache::NINE_PATCH_GEOMETRY == subType))
507 geometry = NPatchHelper::CreateGridGeometry(Uint16Pair(3, 3));
509 else if(VisualFactoryCache::NINE_PATCH_BORDER_GEOMETRY == subType)
511 geometry = NPatchHelper::CreateBorderGeometry(Uint16Pair(3, 3));
513 mFactoryCache.SaveGeometry(subType, geometry);
518 void NPatchVisual::SetResource()
520 const NPatchData* data;
521 if(mImpl->mRenderer && mLoader.GetNPatchData(mId, data))
523 Geometry geometry = CreateGeometry();
524 Shader shader = CreateShader();
526 mImpl->mRenderer.SetGeometry(geometry);
527 mImpl->mRenderer.SetShader(shader);
529 if(RenderingAddOn::Get().IsValid())
531 RenderingAddOn::Get().SubmitRenderTask(mImpl->mRenderer, data->GetRenderingMap());
533 Actor actor = mPlacementActor.GetHandle();
536 ApplyTextureAndUniforms();
537 actor.AddRenderer(mImpl->mRenderer);
538 mPlacementActor.Reset();
541 // npatch loaded and ready to display
542 if(data->GetLoadingState() != NPatchData::LoadingState::LOAD_COMPLETE)
544 ResourceReady(Toolkit::Visual::ResourceStatus::FAILED);
548 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
553 void NPatchVisual::LoadComplete(bool loadSuccess, TextureInformation textureInformation)
555 if(textureInformation.returnType == TextureUploadObserver::ReturnType::TEXTURE) // For the Url.
557 if(textureInformation.textureId != TextureManager::INVALID_TEXTURE_ID)
559 if(mId == NPatchData::INVALID_NPATCH_DATA_ID)
561 // Special case when mLoader.Load call LoadComplete function before mId setup.
562 // We can overwrite mId.
563 mId = static_cast<NPatchData::NPatchDataId>(textureInformation.textureId);
568 EnablePreMultipliedAlpha(textureInformation.preMultiplied);
571 else // For the AuxiliaryUrl : ReturnType::PIXEL_BUFFER
573 if(loadSuccess && textureInformation.url == mAuxiliaryUrl.GetUrl())
575 mAuxiliaryPixelBuffer = textureInformation.pixelBuffer;
576 mAuxiliaryResourceStatus = Toolkit::Visual::ResourceStatus::READY;
580 mAuxiliaryResourceStatus = Toolkit::Visual::ResourceStatus::FAILED;
583 // If auxiliaryUrl didn't required OR auxiliaryUrl load done.
584 if(!mAuxiliaryUrl.IsValid() || mAuxiliaryResourceStatus != Toolkit::Visual::ResourceStatus::PREPARING)
586 const NPatchData* data;
587 // and.. If Url loading done.
588 if(mImpl->mRenderer && mLoader.GetNPatchData(mId, data) && data->GetLoadingState() != NPatchData::LoadingState::LOADING)
595 } // namespace Internal
597 } // namespace Toolkit