1 #ifndef DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
2 #define DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
5 * Copyright (c) 2024 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 #include <dali/public-api/math/uint-16-pair.h>
22 #include <dali/public-api/object/ref-object.h>
23 #include <dali/public-api/rendering/geometry.h>
24 #include <dali/public-api/rendering/shader.h>
27 #include <dali-toolkit/internal/texture-manager/texture-manager-impl.h>
28 #include <dali-toolkit/internal/visuals/npatch/npatch-loader.h>
29 #include <dali-toolkit/internal/visuals/svg/svg-loader.h>
30 #include <dali/devel-api/rendering/renderer-devel.h>
40 class ImageAtlasManager;
44 class VectorAnimationManager;
46 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
49 * Caches shaders and geometries. Owned by VisualFactory.
51 class VisualFactoryCache
55 * Type of shader for caching.
60 COLOR_SHADER_ROUNDED_CORNER,
61 COLOR_SHADER_BORDERLINE,
62 COLOR_SHADER_ROUNDED_BORDERLINE,
63 COLOR_SHADER_BLUR_EDGE,
64 COLOR_SHADER_ROUNDED_CORNER_BLUR_EDGE,
66 COLOR_SHADER_CUTOUT_ROUNDED_CORNER,
67 COLOR_SHADER_CUTOUT_BORDERLINE,
68 COLOR_SHADER_CUTOUT_ROUNDED_BORDERLINE,
69 COLOR_SHADER_CUTOUT_BLUR_EDGE,
70 COLOR_SHADER_CUTOUT_ROUNDED_CORNER_BLUR_EDGE,
72 BORDER_SHADER_ANTI_ALIASING,
73 GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
74 GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_CORNER,
75 GRADIENT_SHADER_LINEAR_BOUNDING_BOX_BORDERLINE,
76 GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_BORDERLINE,
77 GRADIENT_SHADER_LINEAR_USER_SPACE,
78 GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_CORNER,
79 GRADIENT_SHADER_LINEAR_USER_SPACE_BORDERLINE,
80 GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_BORDERLINE,
81 GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
82 GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_CORNER,
83 GRADIENT_SHADER_RADIAL_BOUNDING_BOX_BORDERLINE,
84 GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_BORDERLINE,
85 GRADIENT_SHADER_RADIAL_USER_SPACE,
86 GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_CORNER,
87 GRADIENT_SHADER_RADIAL_USER_SPACE_BORDERLINE,
88 GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_BORDERLINE,
90 IMAGE_SHADER_ROUNDED_CORNER,
91 IMAGE_SHADER_BORDERLINE,
92 IMAGE_SHADER_ROUNDED_BORDERLINE,
94 IMAGE_SHADER_ROUNDED_CORNER_MASKING,
95 IMAGE_SHADER_BORDERLINE_MASKING,
96 IMAGE_SHADER_ROUNDED_BORDERLINE_MASKING,
97 IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
98 IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
99 IMAGE_SHADER_YUV_TO_RGB,
100 IMAGE_SHADER_ROUNDED_CORNER_YUV_TO_RGB,
101 IMAGE_SHADER_BORDERLINE_YUV_TO_RGB,
102 IMAGE_SHADER_ROUNDED_BORDERLINE_YUV_TO_RGB,
103 IMAGE_SHADER_YUV_AND_RGB,
104 IMAGE_SHADER_ROUNDED_CORNER_YUV_AND_RGB,
105 IMAGE_SHADER_BORDERLINE_YUV_AND_RGB,
106 IMAGE_SHADER_ROUNDED_BORDERLINE_YUV_AND_RGB,
108 NATIVE_IMAGE_SHADER_ROUNDED_CORNER,
109 NATIVE_IMAGE_SHADER_BORDERLINE,
110 NATIVE_IMAGE_SHADER_ROUNDED_BORDERLINE,
111 NATIVE_IMAGE_SHADER_MASKING,
112 NATIVE_IMAGE_SHADER_ROUNDED_CORNER_MASKING,
113 NATIVE_IMAGE_SHADER_BORDERLINE_MASKING,
114 NATIVE_IMAGE_SHADER_ROUNDED_BORDERLINE_MASKING,
115 NATIVE_IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
116 NATIVE_IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
118 NINE_PATCH_MASK_SHADER,
119 TEXT_SHADER_SINGLE_COLOR_TEXT,
120 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
121 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_OVERLAY,
122 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_OVERLAY,
123 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
124 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
125 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_OVERLAY_AND_EMOJI,
126 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_OVERLAY_AND_EMOJI,
127 TEXT_SHADER_MULTI_COLOR_TEXT,
128 TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
129 TEXT_SHADER_MULTI_COLOR_TEXT_WITH_OVERLAY,
130 TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE_AND_OVERLAY,
131 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
132 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
133 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
134 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
135 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
136 ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
137 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
138 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
139 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
140 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
141 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
142 ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
145 ARC_ROUND_CAP_SHADER,
146 SHADER_TYPE_MAX = ARC_ROUND_CAP_SHADER
150 * Type of geometry for caching.
157 NINE_PATCH_BORDER_GEOMETRY,
159 GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
166 * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
168 VisualFactoryCache(bool preMultiplyOnLoad);
173 ~VisualFactoryCache();
176 * Request geometry of the given type.
177 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
179 Geometry GetGeometry(GeometryType type);
182 * Cache the geometry of the give type.
183 * @param[in] type The geometry type.
184 * @param[in] geometry The geometry for caching.
186 void SaveGeometry(GeometryType type, Geometry geometry);
189 * Request shader of the given type.
190 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
192 Shader GetShader(ShaderType type);
195 * Generate and cache the shader of the give type. The name of shader will be installed to shader.
196 * @param[in] type The shder type.
197 * @param[in] vertexShader The vertex shader code.
198 * @param[in] fragmentShader The fragment shader code.
199 * @return The shader created by given vertex and fragment shader code.
201 Shader GenerateAndSaveShader(ShaderType type, std::string_view vertexShader, std::string_view fragmentShader);
204 * Greate the quad geometry.
205 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
207 static Geometry CreateQuadGeometry();
210 * Create the grid geometry.
211 * @param[in] gridSize The size of the grid.
212 * @return The created grid geometry.
214 static Geometry CreateGridGeometry(Uint16Pair gridSize);
217 * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
219 void SetPreMultiplyOnLoad(bool preMultiply);
222 * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
224 bool GetPreMultiplyOnLoad() const;
227 * @brief Set an image to be used when a visual has failed to correctly render
228 * @param[in] brokenImageUrlList The broken image url list
230 void SetBrokenImageUrl(std::string& defaultBrokenUrl, const std::vector<std::string>& brokenImageUrlList);
233 * @brief Update the broken image Renderer object
234 * @param[in,out] renderer renderer for broken image
235 * @param[in] size the size of actor
236 * @param[in] rendererIsImage True if input renderer use image shader already.
237 * If true, we don't need to create new renderer when broken image is single image.
238 * Most of user experience use normal images. So It can reduce runtime.
240 void UpdateBrokenImageRenderer(Renderer& renderer, const Vector2& size, const bool rendererIsImage = true);
243 * @brief Get whether we support YUV Planes load or not.
245 * @return True if we support to load YUV Planes. False otherwise.
247 bool GetLoadYuvPlanes() const;
251 * Get the image atlas manager.
252 * @return A pointer to the atlas manager
254 ImageAtlasManagerPtr GetAtlasManager();
257 * Get the texture manager
258 * @return A reference to the texture manager
260 TextureManager& GetTextureManager();
263 * Get the N-Patch texture cache.
264 * @return A reference to the N patch loader
266 NPatchLoader& GetNPatchLoader();
269 * Get the Svg texture cache.
270 * @return A reference to the Svg loader
272 SvgLoader& GetSvgLoader();
275 * Get the vector animation manager.
276 * @return A reference to the vector animation manager.
278 VectorAnimationManager& GetVectorAnimationManager();
281 * @brief Finalize vector animation manager.
282 * It will be called when application is terminated.
284 void FinalizeVectorAnimationManager();
288 * Undefined copy constructor.
290 VisualFactoryCache(const VisualFactoryCache&);
293 * Undefined assignment operator.
295 VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
299 * @brief Returns a cached Texture to use when a visual has failed to correctly render
300 * @param[in] brokenIndex The index of broken image
302 * @return The broken image texture.
304 Texture GetBrokenVisualImage(uint32_t brokenIndex);
307 * @brief Gets the Proper broken image index
308 * @param[in] size The size of actor
310 * @return The index of broken image
312 int32_t GetProperBrokenImageIndex(const Vector2& size);
315 * @brief Apply a texture and uniforms
317 * @param[in,out] renderer The renderer for broken image
318 * @param[in] index The index of broken image
320 void ApplyTextureAndUniforms(Renderer& renderer, int index);
323 * @brief Gets a geometry for npatch image
325 * @param[in] index the index of broken image
326 * @return The Geometry for NPatch
328 Geometry GetNPatchGeometry(int index);
331 * @brief Gets the Npatch Shader object
333 * @param[in] index The index of broken image
334 * @return The Shader for NPatch
336 Shader GetNPatchShader(int index);
339 * @brief Returns a broken image type
340 * @param[in] index BrokenImage index
341 * @return The broken image type.
343 VisualUrl::Type GetBrokenImageVisualType(int index);
346 struct BrokenImageInfo
351 npatchId(NPatchData::INVALID_NPATCH_DATA_ID),
363 VisualUrl::Type visualType;
365 NPatchData::NPatchDataId npatchId;
371 Geometry mGeometry[GEOMETRY_TYPE_MAX + 1];
372 Shader mShader[SHADER_TYPE_MAX + 1];
374 bool mLoadYuvPlanes; ///< A global flag to specify if the image should be loaded as yuv planes
376 ImageAtlasManagerPtr mAtlasManager;
377 TextureManager mTextureManager;
378 NPatchLoader mNPatchLoader;
379 SvgLoader mSvgLoader;
381 std::unique_ptr<VectorAnimationManager> mVectorAnimationManager;
382 bool mPreMultiplyOnLoad;
383 std::vector<BrokenImageInfo> mBrokenImageInfoContainer;
384 std::string mDefaultBrokenImageUrl;
385 bool mUseDefaultBrokenImageOnly;
388 } // namespace Internal
390 } // namespace Toolkit
394 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H