2 * Copyright (c) 2023 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.
18 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
21 #include <dali/devel-api/scripting/scripting.h>
22 #include <dali/integration-api/adaptor-framework/adaptor.h>
23 #include <dali/integration-api/debug.h>
24 #include <dali/public-api/object/property-array.h>
25 #include <dali/public-api/object/type-registry-helper.h>
26 #include <dali/public-api/object/type-registry.h>
29 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
30 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
31 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
32 #include <dali-toolkit/internal/graphics/builtin-shader-extern-gen.h>
33 #include <dali-toolkit/internal/visuals/animated-gradient/animated-gradient-visual.h>
34 #include <dali-toolkit/internal/visuals/animated-image/animated-image-visual.h>
35 #include <dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h>
36 #include <dali-toolkit/internal/visuals/arc/arc-visual.h>
37 #include <dali-toolkit/internal/visuals/border/border-visual.h>
38 #include <dali-toolkit/internal/visuals/color/color-visual.h>
39 #include <dali-toolkit/internal/visuals/gradient/gradient-visual.h>
40 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
41 #include <dali-toolkit/internal/visuals/image/image-visual.h>
42 #include <dali-toolkit/internal/visuals/mesh/mesh-visual.h>
43 #include <dali-toolkit/internal/visuals/npatch/npatch-visual.h>
44 #include <dali-toolkit/internal/visuals/primitive/primitive-visual.h>
45 #include <dali-toolkit/internal/visuals/svg/svg-visual.h>
46 #include <dali-toolkit/internal/visuals/text-visual-shader-factory.h>
47 #include <dali-toolkit/internal/visuals/text/text-visual.h>
48 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
49 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
50 #include <dali-toolkit/internal/visuals/visual-url.h>
51 #include <dali-toolkit/internal/visuals/wireframe/wireframe-visual.h>
52 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
53 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
54 #include <dali-toolkit/public-api/visuals/visual-properties.h>
64 #if defined(DEBUG_ENABLED)
65 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
70 BaseHandle handle = Toolkit::VisualFactory::Get();
75 DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::VisualFactory, Dali::BaseHandle, Create, true)
76 DALI_TYPE_REGISTRATION_END()
77 const char* const BROKEN_IMAGE_FILE_NAME = "broken.png"; ///< The file name of the broken image.
79 static constexpr auto SHADER_TYPE_COUNT = 2u;
80 const std::string_view VertexPredefines[SHADER_TYPE_COUNT]{
81 "", //VisualFactoryCache::COLOR_SHADER
82 "#define IS_REQUIRED_ROUNDED_CORNER\n", //VisualFactoryCache::COLOR_SHADER_ROUNDED_CORNER
84 const std::string_view FragmentPredefines[SHADER_TYPE_COUNT]{
85 "", //VisualFactoryCache::COLOR_SHADER
86 "#define IS_REQUIRED_ROUNDED_CORNER\n", //VisualFactoryCache::COLOR_SHADER_ROUNDED_CORNER
91 VisualFactory::VisualFactory(bool debugEnabled)
93 mImageVisualShaderFactory(),
94 mTextVisualShaderFactory(),
96 mIdleCallback(nullptr),
97 mDebugEnabled(debugEnabled),
98 mPreMultiplyOnLoad(true)
102 VisualFactory::~VisualFactory()
104 if(mIdleCallback && Adaptor::IsAvailable())
106 // Removes the callback from the callback manager in case the control is destroyed before the callback is executed.
107 Adaptor::Get().RemoveIdle(mIdleCallback);
108 mIdleCallback = nullptr;
112 void VisualFactory::OnStyleChangedSignal(Toolkit::StyleManager styleManager, StyleChange::Type type)
114 if(type == StyleChange::THEME_CHANGE)
116 SetBrokenImageUrl(styleManager);
120 void VisualFactory::OnBrokenImageChangedSignal(Toolkit::StyleManager styleManager)
122 SetBrokenImageUrl(styleManager);
125 Toolkit::Visual::Base VisualFactory::CreateVisual(const Property::Map& propertyMap)
127 Visual::BasePtr visualPtr;
129 Property::Value* typeValue = propertyMap.Find(Toolkit::Visual::Property::TYPE, VISUAL_TYPE);
130 Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
133 Scripting::GetEnumerationProperty(*typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType);
138 case Toolkit::Visual::BORDER:
140 visualPtr = BorderVisual::New(GetFactoryCache(), propertyMap);
144 case Toolkit::Visual::COLOR:
146 visualPtr = ColorVisual::New(GetFactoryCache(), propertyMap);
150 case Toolkit::Visual::GRADIENT:
152 visualPtr = GradientVisual::New(GetFactoryCache(), propertyMap);
156 case Toolkit::Visual::IMAGE:
158 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
159 std::string imageUrl;
162 if(imageURLValue->Get(imageUrl))
164 if(!imageUrl.empty())
166 VisualUrl visualUrl(imageUrl);
168 switch(visualUrl.GetType())
170 case VisualUrl::N_PATCH:
172 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
178 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
182 case VisualUrl::WEBP:
184 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
187 case VisualUrl::JSON:
189 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
192 case VisualUrl::REGULAR_IMAGE:
194 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
202 Property::Array* array = imageURLValue->GetArray();
203 if(array && array->Count() > 0)
205 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
212 case Toolkit::Visual::MESH:
214 visualPtr = MeshVisual::New(GetFactoryCache(), propertyMap);
218 case Toolkit::Visual::PRIMITIVE:
220 visualPtr = PrimitiveVisual::New(GetFactoryCache(), propertyMap);
224 case Toolkit::Visual::WIREFRAME:
226 visualPtr = WireframeVisual::New(GetFactoryCache(), propertyMap);
230 case Toolkit::Visual::TEXT:
232 visualPtr = TextVisual::New(GetFactoryCache(), GetTextVisualShaderFactory(), propertyMap);
236 case Toolkit::Visual::N_PATCH:
238 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
239 std::string imageUrl;
240 if(imageURLValue && imageURLValue->Get(imageUrl))
242 if(!imageUrl.empty())
244 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
250 case Toolkit::Visual::SVG:
252 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
253 std::string imageUrl;
254 if(imageURLValue && imageURLValue->Get(imageUrl))
256 if(!imageUrl.empty())
258 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
264 case Toolkit::Visual::ANIMATED_IMAGE:
266 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
267 std::string imageUrl;
270 if(imageURLValue->Get(imageUrl))
272 if(!imageUrl.empty())
274 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
279 Property::Array* array = imageURLValue->GetArray();
280 if(array && array->Count() > 0)
282 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
289 case Toolkit::DevelVisual::ANIMATED_GRADIENT:
291 visualPtr = AnimatedGradientVisual::New(GetFactoryCache(), propertyMap);
295 case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
297 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
298 std::string imageUrl;
299 if(imageURLValue && imageURLValue->Get(imageUrl))
301 if(!imageUrl.empty())
303 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
309 case Toolkit::DevelVisual::ARC:
311 visualPtr = ArcVisual::New(GetFactoryCache(), propertyMap);
316 DALI_LOG_INFO(gLogFilter, Debug::Concise, "VisualFactory::CreateVisual( VisualType:%s %s%s)\n", Scripting::GetEnumerationName<Toolkit::DevelVisual::Type>(visualType, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT), (visualType == Toolkit::DevelVisual::IMAGE) ? "url:" : "", (visualType == Toolkit::DevelVisual::IMAGE) ? (([&]() {
317 // Return URL if present in PropertyMap else return "not found message"
318 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
319 return (imageURLValue) ? imageURLValue->Get<std::string>().c_str() : "url not found in PropertyMap";
325 DALI_LOG_ERROR("VisualType unknown\n");
328 if(mDebugEnabled && visualType != Toolkit::DevelVisual::WIREFRAME)
330 //Create a WireframeVisual if we have debug enabled
331 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap);
334 return Toolkit::Visual::Base(visualPtr.Get());
337 Toolkit::Visual::Base VisualFactory::CreateVisual(const std::string& url, ImageDimensions size)
339 Visual::BasePtr visualPtr;
343 // first resolve url type to know which visual to create
344 VisualUrl visualUrl(url);
345 switch(visualUrl.GetType())
347 case VisualUrl::N_PATCH:
349 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
355 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
359 case VisualUrl::WEBP:
361 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
364 case VisualUrl::JSON:
366 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
369 case VisualUrl::REGULAR_IMAGE:
371 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
379 //Create a WireframeVisual if we have debug enabled
380 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr);
383 return Toolkit::Visual::Base(visualPtr.Get());
386 void VisualFactory::SetPreMultiplyOnLoad(bool preMultiply)
388 if(mPreMultiplyOnLoad != preMultiply)
390 GetFactoryCache().SetPreMultiplyOnLoad(preMultiply);
392 mPreMultiplyOnLoad = preMultiply;
395 bool VisualFactory::GetPreMultiplyOnLoad() const
397 return mPreMultiplyOnLoad;
400 void VisualFactory::DiscardVisual(Toolkit::Visual::Base visual)
402 mDiscardedVisuals.emplace_back(visual);
404 RegisterDiscardCallback();
407 void VisualFactory::UsePreCompiledShader()
409 if(mPrecompiledShaderRequested)
413 mPrecompiledShaderRequested = true;
415 Integration::ShaderPrecompiler::Get().Enable();
418 std::vector<RawShaderData> rawShaderList;
419 RawShaderData imageShaderData;
420 GetImageVisualShaderFactory().GetPrecompiledShader(imageShaderData);
421 rawShaderList.push_back(imageShaderData);
424 RawShaderData textShaderData;
425 GetTextVisualShaderFactory().GetPrecompiledShader(textShaderData);
426 rawShaderList.push_back(textShaderData);
429 RawShaderData colorShaderData;
430 GetPrecompiledShader(colorShaderData);
431 rawShaderList.push_back(colorShaderData);
434 Integration::ShaderPrecompiler::Get().SavePrecomipleShaderList(rawShaderList);
437 Internal::TextureManager& VisualFactory::GetTextureManager()
439 return GetFactoryCache().GetTextureManager();
442 void VisualFactory::SetBrokenImageUrl(Toolkit::StyleManager& styleManager)
444 const std::string imageDirPath = AssetManager::GetDaliImagePath();
445 std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
446 std::vector<std::string> customBrokenImageUrlList;
450 customBrokenImageUrlList = Toolkit::DevelStyleManager::GetBrokenImageUrlList(styleManager);
451 const auto brokenImageUrlValue = Toolkit::DevelStyleManager::GetConfigurations(styleManager).Find("brokenImageUrl", Property::Type::STRING);
452 if(brokenImageUrlValue)
454 brokenImageUrlValue->Get(brokenImageUrl);
459 mFactoryCache->SetBrokenImageUrl(brokenImageUrl, customBrokenImageUrlList);
462 void VisualFactory::GetPrecompiledShader(RawShaderData& shaders)
464 std::vector<std::string_view> vertexPrefix;
465 std::vector<std::string_view> fragmentPrefix;
467 shaders.shaderCount = 0;
468 for(int i = 0; i < SHADER_TYPE_COUNT; ++i)
470 vertexPrefix.push_back(VertexPredefines[i]);
471 fragmentPrefix.push_back(FragmentPredefines[i]);
475 shaders.vertexPrefix = vertexPrefix;
476 shaders.fragmentPrefix = fragmentPrefix;
477 shaders.vertexShader = SHADER_COLOR_VISUAL_SHADER_VERT;
478 shaders.fragmentShader = SHADER_COLOR_VISUAL_SHADER_FRAG;
479 shaders.shaderCount = shaderCount;
482 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
486 mFactoryCache = std::unique_ptr<VisualFactoryCache>(new VisualFactoryCache(mPreMultiplyOnLoad));
487 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
490 styleManager.StyleChangedSignal().Connect(mSlotDelegate, &VisualFactory::OnStyleChangedSignal);
491 Toolkit::DevelStyleManager::BrokenImageChangedSignal(styleManager).Connect(mSlotDelegate, &VisualFactory::OnBrokenImageChangedSignal);
493 SetBrokenImageUrl(styleManager);
496 //UsePreCompiledShader(); // Call forcelly
498 return *mFactoryCache;
501 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
503 if(!mImageVisualShaderFactory)
505 mImageVisualShaderFactory = std::unique_ptr<ImageVisualShaderFactory>(new ImageVisualShaderFactory());
507 return *mImageVisualShaderFactory;
510 TextVisualShaderFactory& VisualFactory::GetTextVisualShaderFactory()
512 if(!mTextVisualShaderFactory)
514 mTextVisualShaderFactory = std::unique_ptr<TextVisualShaderFactory>(new TextVisualShaderFactory());
516 return *mTextVisualShaderFactory;
519 void VisualFactory::OnDiscardCallback()
521 mIdleCallback = nullptr;
523 // Discard visual now.
524 mDiscardedVisuals.clear();
527 void VisualFactory::RegisterDiscardCallback()
529 if(!mIdleCallback && Adaptor::IsAvailable())
531 // The callback manager takes the ownership of the callback object.
532 mIdleCallback = MakeCallback(this, &VisualFactory::OnDiscardCallback);
534 Adaptor& adaptor = Adaptor::Get();
536 if(!adaptor.AddIdle(mIdleCallback, false))
538 // Fail to add idle. (Maybe adaptor is paused.)
539 mIdleCallback = nullptr;
544 } // namespace Internal
546 } // namespace Toolkit