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 "svg/svg-rasterize-thread.h"
24 #include <dali/public-api/math/uint-16-pair.h>
25 #include <dali/public-api/object/ref-object.h>
26 #include <dali/public-api/rendering/geometry.h>
27 #include <dali/public-api/rendering/renderer.h>
28 #include <dali/public-api/rendering/shader.h>
29 #include <dali/devel-api/common/owner-container.h>
30 #include <dali/devel-api/object/weak-handle.h>
43 * Caches shaders and geometries. Owned by VisualFactory.
45 class VisualFactoryCache : public RefObject
50 * Type of shader for caching.
56 BORDER_SHADER_ANTI_ALIASING,
57 GRADIENT_SHADER_LINEAR_USER_SPACE,
58 GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
59 GRADIENT_SHADER_RADIAL_USER_SPACE,
60 GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
65 SHADER_TYPE_MAX = SVG_SHADER
69 * Type of geometry for caching.
76 NINE_PATCH_BORDER_GEOMETRY,
77 GEOMETRY_TYPE_MAX = NINE_PATCH_BORDER_GEOMETRY
88 * Request geometry of the given type.
89 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
91 Geometry GetGeometry( GeometryType type );
94 * Cache the geometry of the give type.
95 * @param[in] type The geometry type.
96 * @param[in] geometry The geometry for caching.
98 void SaveGeometry( GeometryType type, Geometry geometry);
101 * Request shader of the given type.
102 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
104 Shader GetShader( ShaderType type );
107 * Cache the geometry of the give type.
108 * @param[in] type The geometry type.
109 * @param[in] geometry The geometry for caching.
111 void SaveShader( ShaderType type, Shader shader );
114 * Greate the quad geometry.
115 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
117 static Geometry CreateQuadGeometry();
120 * Create the grid geometry.
121 * @param[in] gridSize The size of the grid.
122 * @return The created grid geometry.
124 static Geometry CreateGridGeometry( Uint16Pair gridSize );
127 * Create the batchable geometry
128 * @param[in] texCoords The texture atlas rect coordinates
129 * @return The created batchable geometry
131 static Geometry CreateBatchQuadGeometry( Vector4 texCoords );
136 * @brief Request renderer from the url
138 * @return The cached renderer if exist in the cache. Otherwise an empty handle is returned.
140 Renderer GetRenderer( const std::string& key ) const;
143 * @brief Cache the renderer based on the given key.
145 * If the key already exists in the cache, then the cache will save an additional renderer to the cache.
146 * RemoveRenderer will then need to be called twice to remove both items from the cache.
148 * @param[in] key The key to use for caching
149 * @param[in] renderer The Renderer to be cached
151 void SaveRenderer( const std::string& key, Renderer& renderer );
154 * @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
156 * @param[in] key The key used for caching
158 * @return True if the renderer is no longer used anywhere, false otherwise
160 bool CleanRendererCache( const std::string& key );
163 * @brief Cache the debug renderer
165 void CacheDebugRenderer( Renderer& renderer );
168 * @brief Request the debug renderer;
170 Renderer GetDebugRenderer();
173 * Get the SVG rasterization thread.
174 * @return A pointer pointing to the SVG rasterization thread.
176 SvgRasterizeThread* GetSVGRasterizationThread();
178 private: // for svg rasterization thread
181 * Applies the rasterized image to material
183 void ApplyRasterizedSVGToSampler();
188 * A reference counted object may only be deleted by calling Unreference()
190 virtual ~VisualFactoryCache();
193 * Undefined copy constructor.
195 VisualFactoryCache(const VisualFactoryCache&);
198 * Undefined assignment operator.
200 VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
203 struct CachedRenderer
206 WeakHandle< Renderer > mRenderer;
208 CachedRenderer( const std::string& key, Renderer& renderer )
214 typedef Dali::Vector< std::size_t > HashVector;
215 typedef Dali::OwnerContainer< const CachedRenderer* > CachedRenderers;
218 * @brief Finds the first index into the cached visuals from the url
220 * @return Returns the first index into the cached renderer from the url if it exists in the cache, otherwise returns -1
222 int FindRenderer( const std::string& key ) const;
225 Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
226 Shader mShader[SHADER_TYPE_MAX+1];
228 HashVector mRendererHashes;
229 CachedRenderers mRenderers;
231 Renderer mDebugRenderer;
233 SvgRasterizeThread* mSvgRasterizeThread;
236 } // namespace Internal
238 } // namespace Toolkit
242 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H