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,
64 SHADER_TYPE_MAX = SVG_SHADER
68 * Type of geometry for caching.
75 NINE_PATCH_BORDER_GEOMETRY,
76 GEOMETRY_TYPE_MAX = NINE_PATCH_BORDER_GEOMETRY
87 * Request geometry of the given type.
88 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
90 Geometry GetGeometry( GeometryType type );
93 * Cache the geometry of the give type.
94 * @param[in] type The geometry type.
95 * @param[in] geometry The geometry for caching.
97 void SaveGeometry( GeometryType type, Geometry geometry);
100 * Request shader of the given type.
101 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
103 Shader GetShader( ShaderType type );
106 * Cache the geometry of the give type.
107 * @param[in] type The geometry type.
108 * @param[in] geometry The geometry for caching.
110 void SaveShader( ShaderType type, Shader shader );
113 * Greate the quad geometry.
114 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
116 static Geometry CreateQuadGeometry();
119 * Create the grid geometry.
120 * @param[in] gridSize The size of the grid.
121 * @return The created grid geometry.
123 static Geometry CreateGridGeometry( Uint16Pair gridSize );
128 * @brief Request renderer from the url
130 * @return The cached renderer if exist in the cache. Otherwise an empty handle is returned.
132 Renderer GetRenderer( const std::string& key ) const;
135 * @brief Cache the renderer based on the given key.
137 * If the key already exists in the cache, then the cache will save an additional renderer to the cache.
138 * RemoveRenderer will then need to be called twice to remove both items from the cache.
140 * @param[in] key The key to use for caching
141 * @param[in] renderer The Renderer to be cached
143 void SaveRenderer( const std::string& key, Renderer& renderer );
146 * @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
148 * @param[in] key The key used for caching
150 * @return True if the renderer is no longer used anywhere, false otherwise
152 bool CleanRendererCache( const std::string& key );
155 * @brief Cache the debug renderer
157 void CacheDebugRenderer( Renderer& renderer );
160 * @brief Request the debug renderer;
162 Renderer GetDebugRenderer();
165 * Get the SVG rasterization thread.
166 * @return A pointer pointing to the SVG rasterization thread.
168 SvgRasterizeThread* GetSVGRasterizationThread();
170 private: // for svg rasterization thread
173 * Applies the rasterized image to material
175 void ApplyRasterizedSVGToSampler();
180 * A reference counted object may only be deleted by calling Unreference()
182 virtual ~VisualFactoryCache();
185 * Undefined copy constructor.
187 VisualFactoryCache(const VisualFactoryCache&);
190 * Undefined assignment operator.
192 VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
195 struct CachedRenderer
198 WeakHandle< Renderer > mRenderer;
200 CachedRenderer( const std::string& key, Renderer& renderer )
206 typedef Dali::Vector< std::size_t > HashVector;
207 typedef Dali::OwnerContainer< const CachedRenderer* > CachedRenderers;
210 * @brief Finds the first index into the cached visuals from the url
212 * @return Returns the first index into the cached renderer from the url if it exists in the cache, otherwise returns -1
214 int FindRenderer( const std::string& key ) const;
217 Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
218 Shader mShader[SHADER_TYPE_MAX+1];
220 HashVector mRendererHashes;
221 CachedRenderers mRenderers;
223 Renderer mDebugRenderer;
225 SvgRasterizeThread* mSvgRasterizeThread;
228 } // namespace Internal
230 } // namespace Toolkit
234 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H