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>
31 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-thread.h>
41 class ImageAtlasManager;
45 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
49 * Caches shaders and geometries. Owned by VisualFactory.
51 class VisualFactoryCache
56 * Type of shader for caching.
61 COLOR_SHADER_ROUNDED_CORNER,
62 COLOR_SHADER_BLUR_EDGE,
64 BORDER_SHADER_ANTI_ALIASING,
65 GRADIENT_SHADER_LINEAR_USER_SPACE,
66 GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
67 GRADIENT_SHADER_RADIAL_USER_SPACE,
68 GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
70 IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
71 IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
72 IMAGE_SHADER_ROUNDED_CORNER,
74 NINE_PATCH_MASK_SHADER,
75 TEXT_SHADER_MULTI_COLOR_TEXT,
76 TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
77 TEXT_SHADER_SINGLE_COLOR_TEXT,
78 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
79 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
80 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
81 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
82 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
83 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
84 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
85 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
86 ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
87 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
88 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
89 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
90 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
91 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
92 ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
94 SHADER_TYPE_MAX = WIREFRAME_SHADER
98 * Type of geometry for caching.
105 NINE_PATCH_BORDER_GEOMETRY,
107 GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
115 * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
117 VisualFactoryCache( bool preMultiplyOnLoad );
122 ~VisualFactoryCache();
125 * Request geometry of the given type.
126 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
128 Geometry GetGeometry( GeometryType type );
131 * Cache the geometry of the give type.
132 * @param[in] type The geometry type.
133 * @param[in] geometry The geometry for caching.
135 void SaveGeometry( GeometryType type, Geometry geometry);
138 * Request shader of the given type.
139 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
141 Shader GetShader( ShaderType type );
144 * Cache the geometry of the give type.
145 * @param[in] type The geometry type.
146 * @param[in] geometry The geometry for caching.
148 void SaveShader( ShaderType type, Shader shader );
151 * Greate the quad geometry.
152 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
154 static Geometry CreateQuadGeometry();
157 * Create the grid geometry.
158 * @param[in] gridSize The size of the grid.
159 * @return The created grid geometry.
161 static Geometry CreateGridGeometry( Uint16Pair gridSize );
164 * @brief Returns an image to be used when a visual has failed to correctly render
165 * @return The broken image handle.
167 Image GetBrokenVisualImage();
170 * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
172 void SetPreMultiplyOnLoad( bool preMultiply );
175 * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
177 bool GetPreMultiplyOnLoad();
180 * @brief Set an image to be used when a visual has failed to correctly render
181 * @param[in] brokenImageUrl The broken image url.
183 void SetBrokenImageUrl(const std::string& brokenImageUrl);
187 * Get the image atlas manager.
188 * @return A pointer to the atlas manager
190 ImageAtlasManagerPtr GetAtlasManager();
193 * Get the texture manager
194 * @return A reference to the texture manager
196 TextureManager& GetTextureManager();
199 * Get the N-Patch texture cache.
200 * @return A reference to the N patch loader
202 NPatchLoader& GetNPatchLoader();
205 * Get the SVG rasterization thread.
206 * @return A raw pointer pointing to the SVG rasterization thread.
208 SvgRasterizeThread* GetSVGRasterizationThread();
211 * Get the vector animation thread.
212 * @return A raw pointer pointing to the vector animation thread.
214 VectorAnimationThread& GetVectorAnimationThread();
216 private: // for svg rasterization thread
219 * Applies the rasterized image to material
221 void ApplyRasterizedSVGToSampler();
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 SvgRasterizeThread* mSvgRasterizeThread;
243 std::unique_ptr< VectorAnimationThread > mVectorAnimationThread;
244 std::string mBrokenImageUrl;
245 bool mPreMultiplyOnLoad;
248 } // namespace Internal
250 } // namespace Toolkit
254 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H