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_BLUR_EDGE,
62 BORDER_SHADER_ANTI_ALIASING,
63 GRADIENT_SHADER_LINEAR_USER_SPACE,
64 GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
65 GRADIENT_SHADER_RADIAL_USER_SPACE,
66 GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
67 GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_CORNER,
68 GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_CORNER,
69 GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_CORNER,
70 GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_CORNER,
72 IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
73 IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
74 IMAGE_SHADER_ROUNDED_CORNER,
76 NINE_PATCH_MASK_SHADER,
77 TEXT_SHADER_MULTI_COLOR_TEXT,
78 TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
79 TEXT_SHADER_SINGLE_COLOR_TEXT,
80 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
81 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
82 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
83 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
84 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
85 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
86 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
87 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
88 ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
89 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
90 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
91 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
92 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
93 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
94 ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
98 SHADER_TYPE_MAX = ARC_ROUND_CAP_SHADER
102 * Type of geometry for caching.
109 NINE_PATCH_BORDER_GEOMETRY,
111 GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
118 * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
120 VisualFactoryCache(bool preMultiplyOnLoad);
125 ~VisualFactoryCache();
128 * Request geometry of the given type.
129 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
131 Geometry GetGeometry(GeometryType type);
134 * Cache the geometry of the give type.
135 * @param[in] type The geometry type.
136 * @param[in] geometry The geometry for caching.
138 void SaveGeometry(GeometryType type, Geometry geometry);
141 * Request shader of the given type.
142 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
144 Shader GetShader(ShaderType 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 SaveShader(ShaderType type, Shader shader);
154 * Greate the quad geometry.
155 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
157 static Geometry CreateQuadGeometry();
160 * Create the grid geometry.
161 * @param[in] gridSize The size of the grid.
162 * @return The created grid geometry.
164 static Geometry CreateGridGeometry(Uint16Pair gridSize);
167 * @brief Returns a new Texture to use when a visual has failed to correctly render
168 * @return The broken image texture.
170 Texture GetBrokenVisualImage();
173 * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
175 void SetPreMultiplyOnLoad(bool preMultiply);
178 * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
180 bool GetPreMultiplyOnLoad();
183 * @brief Set an image to be used when a visual has failed to correctly render
184 * @param[in] brokenImageUrl The broken image url.
186 void SetBrokenImageUrl(const std::string& brokenImageUrl);
190 * Get the image atlas manager.
191 * @return A pointer to the atlas manager
193 ImageAtlasManagerPtr GetAtlasManager();
196 * Get the texture manager
197 * @return A reference to the texture manager
199 TextureManager& GetTextureManager();
202 * Get the N-Patch texture cache.
203 * @return A reference to the N patch loader
205 NPatchLoader& GetNPatchLoader();
208 * Get the SVG rasterization thread.
209 * @return A raw pointer pointing to the SVG rasterization thread.
211 SvgRasterizeThread* GetSVGRasterizationThread();
214 * Get the vector animation manager.
215 * @return A reference to the vector animation manager.
217 VectorAnimationManager& GetVectorAnimationManager();
221 * Undefined copy constructor.
223 VisualFactoryCache(const VisualFactoryCache&);
226 * Undefined assignment operator.
228 VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
231 Geometry mGeometry[GEOMETRY_TYPE_MAX + 1];
232 Shader mShader[SHADER_TYPE_MAX + 1];
234 ImageAtlasManagerPtr mAtlasManager;
235 TextureManager mTextureManager;
236 NPatchLoader mNPatchLoader;
237 Texture mBrokenImageTexture;
238 SvgRasterizeThread* mSvgRasterizeThread;
239 std::unique_ptr<VectorAnimationManager> mVectorAnimationManager;
240 std::string mBrokenImageUrl;
241 bool mPreMultiplyOnLoad;
244 } // namespace Internal
246 } // namespace Toolkit
250 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H