1 #ifndef __DALI_TOOLKIT_RENDERER_FACTORY_CACHE_H__
2 #define __DALI_TOOLKIT_RENDERER_FACTORY_CACHE_H__
5 * Copyright (c) 2015 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.
23 #include <dali/public-api/object/ref-object.h>
24 #include <dali/devel-api/rendering/geometry.h>
25 #include <dali/devel-api/rendering/shader.h>
26 #include <dali/devel-api/rendering/renderer.h>
27 #include <dali/devel-api/common/owner-container.h>
28 #include <dali/devel-api/object/weak-handle.h>
41 * Caches shaders and geometries. Owned by RenderFactory.
43 class RendererFactoryCache : public RefObject
48 * Type of shader for caching.
54 GRADIENT_SHADER_LINEAR_USER_SPACE,
55 GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
56 GRADIENT_SHADER_RADIAL_USER_SPACE,
57 GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
61 SHADER_TYPE_MAX = SVG_SHADER
65 * Type of geometry for caching.
72 NINE_PATCH_BORDER_GEOMETRY,
73 GEOMETRY_TYPE_MAX = NINE_PATCH_BORDER_GEOMETRY
81 RendererFactoryCache();
84 * Request geometry of the given type.
85 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
87 Geometry GetGeometry( GeometryType type );
90 * Cache the geometry of the give type.
91 * @param[in] type The geometry type.
92 * @param[in] geometry The geometry for caching.
94 void SaveGeometry( GeometryType type, Geometry geometry);
97 * Request shader of the given type.
98 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
100 Shader GetShader( ShaderType 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 SaveShader( ShaderType type, Shader shader );
110 * Greate the quad geometry.
111 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
113 static Geometry CreateQuadGeometry();
118 * @brief Request renderer from the url
120 * @return The cached renderer if exist in the cache. Otherwise an empty handle is returned.
122 Renderer GetRenderer( const std::string& key ) const;
125 * @brief Cache the renderer based on the given key.
127 * If the key already exists in the cache, then the cache will save an additional renderer to the cache.
128 * RemoveRenderer will then need to be called twice to remove both items from the cache.
130 * @param[in] key The key to use for caching
131 * @param[in] renderer The Renderer to be cached
133 void SaveRenderer( const std::string& key, Renderer& renderer );
136 * @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
138 * @param[in] key The key used for caching
140 void CleanRendererCache( const std::string& key );
145 * A reference counted object may only be deleted by calling Unreference()
147 virtual ~RendererFactoryCache();
150 * Undefined copy constructor.
152 RendererFactoryCache(const RendererFactoryCache&);
155 * Undefined assignment operator.
157 RendererFactoryCache& operator=(const RendererFactoryCache& rhs);
160 struct CachedRenderer
163 WeakHandle< Renderer > mRenderer;
165 CachedRenderer( const std::string& key, Renderer& renderer )
171 typedef Dali::Vector< std::size_t > HashVector;
172 typedef Dali::OwnerContainer< const CachedRenderer* > CachedRenderers;
175 * @brief Finds the first index into the cached renderers from the url
177 * @return Returns the first index into the cached renderer from the url if it exists in the cache, otherwise returns -1
179 int FindRenderer( const std::string& key ) const;
182 // ToDo: test whether using the WeakHandle could improve the performance
183 // With WeakHandle, the resource would be released automatically when no control is using it
185 Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
186 Shader mShader[SHADER_TYPE_MAX+1];
188 HashVector mRendererHashes;
189 CachedRenderers mRenderers;
192 } // namespace Internal
194 } // namespace Toolkit
198 #endif /*__DALI_TOOLKIT_RENDERER_FACTORY_CACHE_H__ */