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/devel-api/common/owner-container.h>
22 #include <dali/integration-api/adaptor-framework/shader-precompiler.h>
23 #include <dali/public-api/math/uint-16-pair.h>
24 #include <dali/public-api/object/ref-object.h>
25 #include <dali/public-api/rendering/geometry.h>
26 #include <dali/public-api/rendering/shader.h>
29 #include <dali-toolkit/internal/texture-manager/texture-manager-impl.h>
30 #include <dali-toolkit/internal/visuals/npatch-loader.h>
31 #include <dali/devel-api/rendering/renderer-devel.h>
41 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 BORDER_SHADER_ANTI_ALIASING,
67 GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
68 GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_CORNER,
69 GRADIENT_SHADER_LINEAR_BOUNDING_BOX_BORDERLINE,
70 GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_BORDERLINE,
71 GRADIENT_SHADER_LINEAR_USER_SPACE,
72 GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_CORNER,
73 GRADIENT_SHADER_LINEAR_USER_SPACE_BORDERLINE,
74 GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_BORDERLINE,
75 GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
76 GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_CORNER,
77 GRADIENT_SHADER_RADIAL_BOUNDING_BOX_BORDERLINE,
78 GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_BORDERLINE,
79 GRADIENT_SHADER_RADIAL_USER_SPACE,
80 GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_CORNER,
81 GRADIENT_SHADER_RADIAL_USER_SPACE_BORDERLINE,
82 GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_BORDERLINE,
84 IMAGE_SHADER_ROUNDED_CORNER,
85 IMAGE_SHADER_BORDERLINE,
86 IMAGE_SHADER_ROUNDED_BORDERLINE,
88 IMAGE_SHADER_ROUNDED_CORNER_MASKING,
89 IMAGE_SHADER_BORDERLINE_MASKING,
90 IMAGE_SHADER_ROUNDED_BORDERLINE_MASKING,
91 IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
92 IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
93 IMAGE_SHADER_YUV_TO_RGB,
94 IMAGE_SHADER_ROUNDED_CORNER_YUV_TO_RGB,
95 IMAGE_SHADER_BORDERLINE_YUV_TO_RGB,
96 IMAGE_SHADER_ROUNDED_BORDERLINE_YUV_TO_RGB,
97 IMAGE_SHADER_YUV_AND_RGB,
98 IMAGE_SHADER_ROUNDED_CORNER_YUV_AND_RGB,
99 IMAGE_SHADER_BORDERLINE_YUV_AND_RGB,
100 IMAGE_SHADER_ROUNDED_BORDERLINE_YUV_AND_RGB,
102 NATIVE_IMAGE_SHADER_ROUNDED_CORNER,
103 NATIVE_IMAGE_SHADER_BORDERLINE,
104 NATIVE_IMAGE_SHADER_ROUNDED_BORDERLINE,
105 NATIVE_IMAGE_SHADER_MASKING,
106 NATIVE_IMAGE_SHADER_ROUNDED_CORNER_MASKING,
107 NATIVE_IMAGE_SHADER_BORDERLINE_MASKING,
108 NATIVE_IMAGE_SHADER_ROUNDED_BORDERLINE_MASKING,
109 NATIVE_IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
110 NATIVE_IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
112 NINE_PATCH_MASK_SHADER,
113 TEXT_SHADER_SINGLE_COLOR_TEXT,
114 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
115 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_OVERLAY,
116 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_OVERLAY,
117 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
118 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
119 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_OVERLAY_AND_EMOJI,
120 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_OVERLAY_AND_EMOJI,
121 TEXT_SHADER_MULTI_COLOR_TEXT,
122 TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
123 TEXT_SHADER_MULTI_COLOR_TEXT_WITH_OVERLAY,
124 TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE_AND_OVERLAY,
125 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
126 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
127 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
128 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
129 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
130 ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
131 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
132 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
133 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
134 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
135 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
136 ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
139 ARC_ROUND_CAP_SHADER,
140 SHADER_TYPE_MAX = ARC_ROUND_CAP_SHADER
144 * Type of geometry for caching.
151 NINE_PATCH_BORDER_GEOMETRY,
153 GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
160 * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
162 VisualFactoryCache(bool preMultiplyOnLoad);
167 ~VisualFactoryCache();
170 * Request geometry of the given type.
171 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
173 Geometry GetGeometry(GeometryType type);
176 * Cache the geometry of the give type.
177 * @param[in] type The geometry type.
178 * @param[in] geometry The geometry for caching.
180 void SaveGeometry(GeometryType type, Geometry geometry);
183 * Request shader of the given type.
184 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
186 Shader GetShader(ShaderType type);
189 * Generate and cache the shader of the give type. The name of shader will be installed to shader.
190 * @param[in] type The shder type.
191 * @param[in] vertexShader The vertex shader code.
192 * @param[in] fragmentShader The fragment shader code.
193 * @return The shader created by given vertex and fragment shader code.
195 Shader GenerateAndSaveShader(ShaderType type, std::string_view vertexShader, std::string_view fragmentShader);
198 * Greate the quad geometry.
199 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
201 static Geometry CreateQuadGeometry();
204 * Create the grid geometry.
205 * @param[in] gridSize The size of the grid.
206 * @return The created grid geometry.
208 static Geometry CreateGridGeometry(Uint16Pair gridSize);
211 * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
213 void SetPreMultiplyOnLoad(bool preMultiply);
216 * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
218 bool GetPreMultiplyOnLoad() const;
221 * @brief Set an image to be used when a visual has failed to correctly render
222 * @param[in] brokenImageUrlList The broken image url list
224 void SetBrokenImageUrl(std::string& defaultBrokenUrl, const std::vector<std::string>& brokenImageUrlList);
227 * @brief Update the broken image Renderer object
228 * @param[in,out] renderer renderer for broken image
229 * @param[in] size the size of actor
230 * @param[in] rendererIsImage True if input renderer use image shader already.
231 * If true, we don't need to create new renderer when broken image is single image.
232 * Most of user experience use normal images. So It can reduce runtime.
234 void UpdateBrokenImageRenderer(Renderer& renderer, const Vector2& size, const bool& rendererIsImage = true);
237 * @brief Get whether we support YUV Planes load or not.
239 * @return True if we support to load YUV Planes. False otherwise.
241 bool GetLoadYuvPlanes() const;
245 * Get the image atlas manager.
246 * @return A pointer to the atlas manager
248 ImageAtlasManagerPtr GetAtlasManager();
251 * Get the texture manager
252 * @return A reference to the texture manager
254 TextureManager& GetTextureManager();
257 * Get the N-Patch texture cache.
258 * @return A reference to the N patch loader
260 NPatchLoader& GetNPatchLoader();
263 * Get the vector animation manager.
264 * @return A reference to the vector animation manager.
266 VectorAnimationManager& GetVectorAnimationManager();
270 * Undefined copy constructor.
272 VisualFactoryCache(const VisualFactoryCache&);
275 * Undefined assignment operator.
277 VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
281 * @brief Returns a cached Texture to use when a visual has failed to correctly render
282 * @param[in] brokenIndex The index of broken image
284 * @return The broken image texture.
286 Texture GetBrokenVisualImage(uint32_t brokenIndex);
289 * @brief Gets the Proper broken image index
290 * @param[in] size The size of actor
292 * @return The index of broken image
294 int32_t GetProperBrokenImageIndex(const Vector2& size);
297 * @brief Apply a texture and uniforms
299 * @param[in,out] renderer The renderer for broken image
300 * @param[in] index The index of broken image
302 void ApplyTextureAndUniforms(Renderer& renderer, int index);
305 * @brief Gets a geometry for npatch image
307 * @param[in] index the index of broken image
308 * @return The Geometry for NPatch
310 Geometry GetNPatchGeometry(int index);
313 * @brief Gets the Npatch Shader object
315 * @param[in] index The index of broken image
316 * @return The Shader for NPatch
318 Shader GetNPatchShader(int index);
321 * @brief Returns a broken image type
322 * @param[in] index BrokenImage index
323 * @return The broken image type.
325 VisualUrl::Type GetBrokenImageVisualType(int index);
328 struct BrokenImageInfo
333 npatchId(NPatchData::INVALID_NPATCH_DATA_ID),
345 VisualUrl::Type visualType;
347 NPatchData::NPatchDataId npatchId;
353 Geometry mGeometry[GEOMETRY_TYPE_MAX + 1];
354 Shader mShader[SHADER_TYPE_MAX + 1];
356 bool mLoadYuvPlanes; ///< A global flag to specify if the image should be loaded as yuv planes
358 ImageAtlasManagerPtr mAtlasManager;
359 TextureManager mTextureManager;
360 NPatchLoader mNPatchLoader;
362 std::unique_ptr<VectorAnimationManager> mVectorAnimationManager;
363 bool mPreMultiplyOnLoad;
364 std::vector<BrokenImageInfo> mBrokenImageInfoContainer;
365 std::string mDefaultBrokenImageUrl;
366 bool mUseDefaultBrokenImageOnly;
369 } // namespace Internal
371 } // namespace Toolkit
375 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H