1 #ifndef DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
2 #define DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
5 * Copyright (c) 2016 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/renderer.h>
25 #include <dali/public-api/rendering/shader.h>
26 #include <dali/devel-api/common/owner-container.h>
27 #include <dali/devel-api/object/weak-handle.h>
30 #include <dali-toolkit/internal/visuals/npatch-loader.h>
31 #include <dali-toolkit/internal/visuals/svg/svg-rasterize-thread.h>
42 class ImageAtlasManager;
43 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
48 * Caches shaders and geometries. Owned by VisualFactory.
50 class VisualFactoryCache : public RefObject
55 * Type of shader for caching.
61 BORDER_SHADER_ANTI_ALIASING,
62 GRADIENT_SHADER_LINEAR_USER_SPACE,
63 GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
64 GRADIENT_SHADER_RADIAL_USER_SPACE,
65 GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
68 IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
69 IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
73 SHADER_TYPE_MAX = WIREFRAME_SHADER
77 * Type of geometry for caching.
84 NINE_PATCH_BORDER_GEOMETRY,
86 GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
97 * Request geometry of the given type.
98 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
100 Geometry GetGeometry( GeometryType type );
103 * Cache the geometry of the give type.
104 * @param[in] type The geometry type.
105 * @param[in] geometry The geometry for caching.
107 void SaveGeometry( GeometryType type, Geometry geometry);
110 * Request shader of the given type.
111 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
113 Shader GetShader( ShaderType type );
116 * Cache the geometry of the give type.
117 * @param[in] type The geometry type.
118 * @param[in] geometry The geometry for caching.
120 void SaveShader( ShaderType type, Shader shader );
123 * Greate the quad geometry.
124 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
126 static Geometry CreateQuadGeometry();
129 * Create the grid geometry.
130 * @param[in] gridSize The size of the grid.
131 * @return The created grid geometry.
133 static Geometry CreateGridGeometry( Uint16Pair gridSize );
136 * Create the batchable geometry
137 * @param[in] texCoords The texture atlas rect coordinates
138 * @return The created batchable geometry
140 static Geometry CreateBatchQuadGeometry( Vector4 texCoords );
143 * @brief Returns an image to be used when a visual has failed to correctly render
144 * @return The broken image handle.
146 static Image GetBrokenVisualImage();
151 * @brief Request renderer from the url
153 * @return The cached renderer if exist in the cache. Otherwise an empty handle is returned.
155 Renderer GetRenderer( const std::string& key ) const;
158 * @brief Cache the renderer based on the given key.
160 * If the key already exists in the cache, then the cache will save an additional renderer to the cache.
161 * RemoveRenderer will then need to be called twice to remove both items from the cache.
163 * @param[in] key The key to use for caching
164 * @param[in] renderer The Renderer to be cached
166 void SaveRenderer( const std::string& key, Renderer& renderer );
169 * @brief Cleans the renderer cache by removing the renderer from the cache based on the given key if there are no longer any references to it
171 * @param[in] key The key used for caching
173 * @return True if the renderer is no longer used anywhere, false otherwise
175 bool CleanRendererCache( const std::string& key );
178 * Get the image atlas manager.
179 * @return A pointer to the atlas manager
181 ImageAtlasManagerPtr GetAtlasManager();
184 * Get the N-Patch texture cache.
185 * @return A reference to the N patch loader
187 NPatchLoader& GetNPatchLoader();
190 * Get the SVG rasterization thread.
191 * @return A raw pointer pointing to the SVG rasterization thread.
193 SvgRasterizeThread* GetSVGRasterizationThread();
195 private: // for svg rasterization thread
198 * Applies the rasterized image to material
200 void ApplyRasterizedSVGToSampler();
205 * A reference counted object may only be deleted by calling Unreference()
207 virtual ~VisualFactoryCache();
210 * Undefined copy constructor.
212 VisualFactoryCache(const VisualFactoryCache&);
215 * Undefined assignment operator.
217 VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
220 struct CachedRenderer
223 WeakHandle< Renderer > mRenderer;
225 CachedRenderer( const std::string& key, Renderer& renderer )
231 typedef Dali::Vector< std::size_t > HashVector;
232 typedef Dali::OwnerContainer< const CachedRenderer* > CachedRenderers;
235 * @brief Finds the first index into the cached visuals from the url
237 * @return Returns the first index into the cached renderer from the url if it exists in the cache, otherwise returns -1
239 int FindRenderer( const std::string& key ) const;
242 Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
243 Shader mShader[SHADER_TYPE_MAX+1];
245 HashVector mRendererHashes;
246 CachedRenderers mRenderers;
248 Renderer mWireframeRenderer;
250 ImageAtlasManagerPtr mAtlasManager;
251 NPatchLoader mNPatchLoader;
253 SvgRasterizeThread* mSvgRasterizeThread;
256 } // namespace Internal
258 } // namespace Toolkit
262 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H