1 #ifndef DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
2 #define DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
5 * Copyright (c) 2020 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>
25 #include <dali/devel-api/common/owner-container.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>
41 class ImageAtlasManager;
44 class VectorAnimationManager;
46 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
50 * Caches shaders and geometries. Owned by VisualFactory.
52 class VisualFactoryCache
57 * Type of shader for caching.
62 COLOR_SHADER_ROUNDED_CORNER,
63 COLOR_SHADER_BLUR_EDGE,
65 BORDER_SHADER_ANTI_ALIASING,
66 GRADIENT_SHADER_LINEAR_USER_SPACE,
67 GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
68 GRADIENT_SHADER_RADIAL_USER_SPACE,
69 GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
70 GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_CORNER,
71 GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_CORNER,
72 GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_CORNER,
73 GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_CORNER,
75 IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
76 IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
77 IMAGE_SHADER_ROUNDED_CORNER,
79 NINE_PATCH_MASK_SHADER,
80 TEXT_SHADER_MULTI_COLOR_TEXT,
81 TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
82 TEXT_SHADER_SINGLE_COLOR_TEXT,
83 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
84 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
85 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
86 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
87 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
88 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
89 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
90 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
91 ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
92 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
93 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
94 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
95 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
96 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
97 ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
100 ARC_ROUND_CAP_SHADER,
101 SHADER_TYPE_MAX = ARC_ROUND_CAP_SHADER
105 * Type of geometry for caching.
112 NINE_PATCH_BORDER_GEOMETRY,
114 GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
122 * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
124 VisualFactoryCache( bool preMultiplyOnLoad );
129 ~VisualFactoryCache();
132 * Request geometry of the given type.
133 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
135 Geometry GetGeometry( GeometryType type );
138 * Cache the geometry of the give type.
139 * @param[in] type The geometry type.
140 * @param[in] geometry The geometry for caching.
142 void SaveGeometry( GeometryType type, Geometry geometry);
145 * Request shader of the given type.
146 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
148 Shader GetShader( ShaderType type );
151 * Cache the geometry of the give type.
152 * @param[in] type The geometry type.
153 * @param[in] geometry The geometry for caching.
155 void SaveShader( ShaderType type, Shader shader );
158 * Greate the quad geometry.
159 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
161 static Geometry CreateQuadGeometry();
164 * Create the grid geometry.
165 * @param[in] gridSize The size of the grid.
166 * @return The created grid geometry.
168 static Geometry CreateGridGeometry( Uint16Pair gridSize );
171 * @brief Returns a new Texture to use when a visual has failed to correctly render
172 * @return The broken image texture.
174 Texture GetBrokenVisualImage();
177 * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
179 void SetPreMultiplyOnLoad( bool preMultiply );
182 * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
184 bool GetPreMultiplyOnLoad();
187 * @brief Set an image to be used when a visual has failed to correctly render
188 * @param[in] brokenImageUrl The broken image url.
190 void SetBrokenImageUrl(const std::string& brokenImageUrl);
194 * Get the image atlas manager.
195 * @return A pointer to the atlas manager
197 ImageAtlasManagerPtr GetAtlasManager();
200 * Get the texture manager
201 * @return A reference to the texture manager
203 TextureManager& GetTextureManager();
206 * Get the N-Patch texture cache.
207 * @return A reference to the N patch loader
209 NPatchLoader& GetNPatchLoader();
212 * Get the SVG rasterization thread.
213 * @return A raw pointer pointing to the SVG rasterization thread.
215 SvgRasterizeThread* GetSVGRasterizationThread();
218 * Get the vector animation manager.
219 * @return A reference to the vector animation manager.
221 VectorAnimationManager& GetVectorAnimationManager();
226 * Undefined copy constructor.
228 VisualFactoryCache(const VisualFactoryCache&);
231 * Undefined assignment operator.
233 VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
236 Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
237 Shader mShader[SHADER_TYPE_MAX+1];
239 ImageAtlasManagerPtr mAtlasManager;
240 TextureManager mTextureManager;
241 NPatchLoader mNPatchLoader;
242 Texture mBrokenImageTexture;
243 SvgRasterizeThread* mSvgRasterizeThread;
244 std::unique_ptr< VectorAnimationManager > mVectorAnimationManager;
245 std::string mBrokenImageUrl;
246 bool mPreMultiplyOnLoad;
249 } // namespace Internal
251 } // namespace Toolkit
255 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H