1 #ifndef DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
2 #define DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
5 * Copyright (c) 2022 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/public-api/math/uint-16-pair.h>
23 #include <dali/public-api/object/ref-object.h>
24 #include <dali/public-api/rendering/geometry.h>
25 #include <dali/public-api/rendering/shader.h>
28 #include <dali-toolkit/internal/texture-manager/texture-manager-impl.h>
29 #include <dali-toolkit/internal/visuals/npatch-loader.h>
30 #include <dali-toolkit/internal/visuals/svg/svg-rasterize-thread.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,
94 NATIVE_IMAGE_SHADER_ROUNDED_CORNER,
95 NATIVE_IMAGE_SHADER_BORDERLINE,
96 NATIVE_IMAGE_SHADER_ROUNDED_BORDERLINE,
97 NATIVE_IMAGE_SHADER_MASKING,
98 NATIVE_IMAGE_SHADER_ROUNDED_CORNER_MASKING,
99 NATIVE_IMAGE_SHADER_BORDERLINE_MASKING,
100 NATIVE_IMAGE_SHADER_ROUNDED_BORDERLINE_MASKING,
102 NINE_PATCH_MASK_SHADER,
103 TEXT_SHADER_MULTI_COLOR_TEXT,
104 TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
105 TEXT_SHADER_SINGLE_COLOR_TEXT,
106 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
107 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
108 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
109 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
110 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
111 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
112 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
113 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
114 ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
115 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
116 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
117 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
118 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
119 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
120 ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
123 ARC_ROUND_CAP_SHADER,
124 SHADER_TYPE_MAX = ARC_ROUND_CAP_SHADER
128 * Type of geometry for caching.
135 NINE_PATCH_BORDER_GEOMETRY,
137 GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
144 * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
146 VisualFactoryCache(bool preMultiplyOnLoad);
151 ~VisualFactoryCache();
154 * Request geometry of the given type.
155 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
157 Geometry GetGeometry(GeometryType type);
160 * Cache the geometry of the give type.
161 * @param[in] type The geometry type.
162 * @param[in] geometry The geometry for caching.
164 void SaveGeometry(GeometryType type, Geometry geometry);
167 * Request shader of the given type.
168 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
170 Shader GetShader(ShaderType type);
173 * Cache the geometry of the give type.
174 * @param[in] type The geometry type.
175 * @param[in] geometry The geometry for caching.
177 void SaveShader(ShaderType type, Shader shader);
180 * Greate the quad geometry.
181 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
183 static Geometry CreateQuadGeometry();
186 * Create the grid geometry.
187 * @param[in] gridSize The size of the grid.
188 * @return The created grid geometry.
190 static Geometry CreateGridGeometry(Uint16Pair gridSize);
193 * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
195 void SetPreMultiplyOnLoad(bool preMultiply);
198 * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
200 bool GetPreMultiplyOnLoad();
203 * @brief Set an image to be used when a visual has failed to correctly render
204 * @param[in] brokenImageUrlList The broken image url list
206 void SetBrokenImageUrl(std::string& defaultBrokenUrl, const std::vector<std::string>& brokenImageUrlList);
209 * @brief Update the broken image Renderer object
210 * @param[in,out] renderer renderer for broken image
211 * @param[in] size the size of actor
212 * @param[in] rendererIsImage True if input renderer use image shader already.
213 * If true, we don't need to create new renderer when broken image is single image.
214 * Most of user experience use normal images. So It can reduce runtime.
216 void UpdateBrokenImageRenderer(Renderer& renderer, const Vector2& size, const bool& rendererIsImage = true);
220 * Get the image atlas manager.
221 * @return A pointer to the atlas manager
223 ImageAtlasManagerPtr GetAtlasManager();
226 * Get the texture manager
227 * @return A reference to the texture manager
229 TextureManager& GetTextureManager();
232 * Get the N-Patch texture cache.
233 * @return A reference to the N patch loader
235 NPatchLoader& GetNPatchLoader();
238 * Get the SVG rasterization thread.
239 * @return A raw pointer pointing to the SVG rasterization thread.
241 SvgRasterizeThread* GetSVGRasterizationThread();
244 * Get the vector animation manager.
245 * @return A reference to the vector animation manager.
247 VectorAnimationManager& GetVectorAnimationManager();
251 * Undefined copy constructor.
253 VisualFactoryCache(const VisualFactoryCache&);
256 * Undefined assignment operator.
258 VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
262 * @brief Returns a cached Texture to use when a visual has failed to correctly render
263 * @param[in] brokenIndex The index of broken image
265 * @return The broken image texture.
267 Texture GetBrokenVisualImage(uint32_t brokenIndex);
270 * @brief Gets the Proper broken image index
271 * @param[in] size The size of actor
273 * @return The index of broken image
275 int32_t GetProperBrokenImageIndex(const Vector2& size);
278 * @brief Apply a texture and uniforms
280 * @param[in,out] renderer The renderer for broken image
281 * @param[in] index The index of broken image
283 void ApplyTextureAndUniforms(Renderer& renderer, int index);
286 * @brief Gets a geometry for npatch image
288 * @param[in] index the index of broken image
289 * @return The Geometry for NPatch
291 Geometry GetNPatchGeometry(int index);
294 * @brief Gets the Npatch Shader object
296 * @param[in] index The index of broken image
297 * @return The Shader for NPatch
299 Shader GetNPatchShader(int index);
302 * @brief Returns a broken image type
303 * @param[in] index BrokenImage index
304 * @return The broken image type.
306 VisualUrl::Type GetBrokenImageVisualType(int index);
309 struct BrokenImageInfo
314 npatchId(NPatchData::INVALID_NPATCH_DATA_ID),
326 VisualUrl::Type visualType;
328 NPatchData::NPatchDataId npatchId;
334 Geometry mGeometry[GEOMETRY_TYPE_MAX + 1];
335 Shader mShader[SHADER_TYPE_MAX + 1];
337 ImageAtlasManagerPtr mAtlasManager;
338 TextureManager mTextureManager;
339 NPatchLoader mNPatchLoader;
341 SvgRasterizeThread* mSvgRasterizeThread;
342 std::unique_ptr<VectorAnimationManager> mVectorAnimationManager;
343 bool mPreMultiplyOnLoad;
344 std::vector<BrokenImageInfo> mBrokenImageInfoContainer;
345 std::string mDefaultBrokenImageUrl;
346 bool mUseDefaultBrokenImageOnly;
349 } // namespace Internal
351 } // namespace Toolkit
355 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H