1 #ifndef DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
2 #define DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
5 * Copyright (c) 2021 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/visuals/npatch-loader.h>
29 #include <dali-toolkit/internal/visuals/svg/svg-rasterize-thread.h>
30 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
40 class ImageAtlasManager;
43 class VectorAnimationManager;
45 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
48 * Caches shaders and geometries. Owned by VisualFactory.
50 class VisualFactoryCache
54 * Type of shader for caching.
59 COLOR_SHADER_ROUNDED_CORNER,
60 COLOR_SHADER_BORDERLINE,
61 COLOR_SHADER_ROUNDED_BORDERLINE,
62 COLOR_SHADER_BLUR_EDGE,
63 COLOR_SHADER_ROUNDED_CORNER_BLUR_EDGE,
65 BORDER_SHADER_ANTI_ALIASING,
66 GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
67 GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_CORNER,
68 GRADIENT_SHADER_LINEAR_BOUNDING_BOX_BORDERLINE,
69 GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_BORDERLINE,
70 GRADIENT_SHADER_LINEAR_USER_SPACE,
71 GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_CORNER,
72 GRADIENT_SHADER_LINEAR_USER_SPACE_BORDERLINE,
73 GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_BORDERLINE,
74 GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
75 GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_CORNER,
76 GRADIENT_SHADER_RADIAL_BOUNDING_BOX_BORDERLINE,
77 GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_BORDERLINE,
78 GRADIENT_SHADER_RADIAL_USER_SPACE,
79 GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_CORNER,
80 GRADIENT_SHADER_RADIAL_USER_SPACE_BORDERLINE,
81 GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_BORDERLINE,
83 IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
84 IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
85 IMAGE_SHADER_ROUNDED_CORNER,
86 IMAGE_SHADER_BORDERLINE,
87 IMAGE_SHADER_ROUNDED_BORDERLINE,
89 NINE_PATCH_MASK_SHADER,
90 TEXT_SHADER_MULTI_COLOR_TEXT,
91 TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
92 TEXT_SHADER_SINGLE_COLOR_TEXT,
93 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
94 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
95 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
96 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
97 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
98 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
99 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
100 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
101 ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
102 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
103 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
104 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
105 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
106 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
107 ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
110 ARC_ROUND_CAP_SHADER,
111 SHADER_TYPE_MAX = ARC_ROUND_CAP_SHADER
115 * Type of geometry for caching.
122 NINE_PATCH_BORDER_GEOMETRY,
124 GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
131 * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
133 VisualFactoryCache(bool preMultiplyOnLoad);
138 ~VisualFactoryCache();
141 * Request geometry of the given type.
142 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
144 Geometry GetGeometry(GeometryType type);
147 * Cache the geometry of the give type.
148 * @param[in] type The geometry type.
149 * @param[in] geometry The geometry for caching.
151 void SaveGeometry(GeometryType type, Geometry geometry);
154 * Request shader of the given type.
155 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
157 Shader GetShader(ShaderType 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 SaveShader(ShaderType type, Shader shader);
167 * Greate the quad geometry.
168 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
170 static Geometry CreateQuadGeometry();
173 * Create the grid geometry.
174 * @param[in] gridSize The size of the grid.
175 * @return The created grid geometry.
177 static Geometry CreateGridGeometry(Uint16Pair gridSize);
180 * @brief Returns a new Texture to use when a visual has failed to correctly render
181 * @return The broken image texture.
183 Texture GetBrokenVisualImage();
186 * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
188 void SetPreMultiplyOnLoad(bool preMultiply);
191 * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
193 bool GetPreMultiplyOnLoad();
196 * @brief Set an image to be used when a visual has failed to correctly render
197 * @param[in] brokenImageUrl The broken image url.
199 void SetBrokenImageUrl(const std::string& brokenImageUrl);
203 * Get the image atlas manager.
204 * @return A pointer to the atlas manager
206 ImageAtlasManagerPtr GetAtlasManager();
209 * Get the texture manager
210 * @return A reference to the texture manager
212 TextureManager& GetTextureManager();
215 * Get the N-Patch texture cache.
216 * @return A reference to the N patch loader
218 NPatchLoader& GetNPatchLoader();
221 * Get the SVG rasterization thread.
222 * @return A raw pointer pointing to the SVG rasterization thread.
224 SvgRasterizeThread* GetSVGRasterizationThread();
227 * Get the vector animation manager.
228 * @return A reference to the vector animation manager.
230 VectorAnimationManager& GetVectorAnimationManager();
234 * Undefined copy constructor.
236 VisualFactoryCache(const VisualFactoryCache&);
239 * Undefined assignment operator.
241 VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
244 Geometry mGeometry[GEOMETRY_TYPE_MAX + 1];
245 Shader mShader[SHADER_TYPE_MAX + 1];
247 ImageAtlasManagerPtr mAtlasManager;
248 TextureManager mTextureManager;
249 NPatchLoader mNPatchLoader;
250 Texture mBrokenImageTexture;
251 SvgRasterizeThread* mSvgRasterizeThread;
252 std::unique_ptr<VectorAnimationManager> mVectorAnimationManager;
253 std::string mBrokenImageUrl;
254 bool mPreMultiplyOnLoad;
257 } // namespace Internal
259 } // namespace Toolkit
263 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H