1 #ifndef DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
2 #define DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
5 * Copyright (c) 2017 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,
63 BORDER_SHADER_ANTI_ALIASING,
64 GRADIENT_SHADER_LINEAR_USER_SPACE,
65 GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
66 GRADIENT_SHADER_RADIAL_USER_SPACE,
67 GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
69 IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
70 IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
71 IMAGE_SHADER_ROUNDED_CORNER,
73 NINE_PATCH_MASK_SHADER,
74 TEXT_SHADER_MULTI_COLOR_TEXT,
75 TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
76 TEXT_SHADER_SINGLE_COLOR_TEXT,
77 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
78 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
79 TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
80 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
81 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
82 ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
83 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
84 ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
85 ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
86 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
87 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
88 ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
89 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
90 ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
91 ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
93 SHADER_TYPE_MAX = WIREFRAME_SHADER
97 * Type of geometry for caching.
104 NINE_PATCH_BORDER_GEOMETRY,
106 GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
114 * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
116 VisualFactoryCache( bool preMultiplyOnLoad );
121 ~VisualFactoryCache();
124 * Request geometry of the given type.
125 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
127 Geometry GetGeometry( GeometryType type );
130 * Cache the geometry of the give type.
131 * @param[in] type The geometry type.
132 * @param[in] geometry The geometry for caching.
134 void SaveGeometry( GeometryType type, Geometry geometry);
137 * Request shader of the given type.
138 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
140 Shader GetShader( ShaderType type );
143 * Cache the geometry of the give type.
144 * @param[in] type The geometry type.
145 * @param[in] geometry The geometry for caching.
147 void SaveShader( ShaderType type, Shader shader );
150 * Greate the quad geometry.
151 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
153 static Geometry CreateQuadGeometry();
156 * Create the grid geometry.
157 * @param[in] gridSize The size of the grid.
158 * @return The created grid geometry.
160 static Geometry CreateGridGeometry( Uint16Pair gridSize );
163 * @brief Returns an image to be used when a visual has failed to correctly render
164 * @return The broken image handle.
166 Image GetBrokenVisualImage();
169 * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
171 void SetPreMultiplyOnLoad( bool preMultiply );
174 * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
176 bool GetPreMultiplyOnLoad();
179 * @brief Set an image to be used when a visual has failed to correctly render
180 * @param[in] brokenImageUrl The broken image url.
182 void SetBrokenImageUrl(const std::string& brokenImageUrl);
186 * Get the image atlas manager.
187 * @return A pointer to the atlas manager
189 ImageAtlasManagerPtr GetAtlasManager();
192 * Get the texture manager
193 * @return A reference to the texture manager
195 TextureManager& GetTextureManager();
198 * Get the N-Patch texture cache.
199 * @return A reference to the N patch loader
201 NPatchLoader& GetNPatchLoader();
204 * Get the SVG rasterization thread.
205 * @return A raw pointer pointing to the SVG rasterization thread.
207 SvgRasterizeThread* GetSVGRasterizationThread();
210 * Get the vector animation thread.
211 * @return A raw pointer pointing to the vector animation thread.
213 VectorAnimationThread& GetVectorAnimationThread();
215 private: // for svg rasterization thread
218 * Applies the rasterized image to material
220 void ApplyRasterizedSVGToSampler();
225 * Undefined copy constructor.
227 VisualFactoryCache(const VisualFactoryCache&);
230 * Undefined assignment operator.
232 VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
235 Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
236 Shader mShader[SHADER_TYPE_MAX+1];
238 ImageAtlasManagerPtr mAtlasManager;
239 TextureManager mTextureManager;
240 NPatchLoader mNPatchLoader;
241 SvgRasterizeThread* mSvgRasterizeThread;
242 std::unique_ptr< VectorAnimationThread > mVectorAnimationThread;
243 std::string mBrokenImageUrl;
244 bool mPreMultiplyOnLoad;
247 } // namespace Internal
249 } // namespace Toolkit
253 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H