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 BORDER_SHADER_ANTI_ALIASING,
55 GRADIENT_SHADER_LINEAR_USER_SPACE,
56 GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
57 GRADIENT_SHADER_RADIAL_USER_SPACE,
58 GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
62 SHADER_TYPE_MAX = SVG_SHADER
66 * Type of geometry for caching.
73 NINE_PATCH_BORDER_GEOMETRY,
74 GEOMETRY_TYPE_MAX = NINE_PATCH_BORDER_GEOMETRY
82 RendererFactoryCache();
85 * Request geometry of the given type.
86 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
88 Geometry GetGeometry( GeometryType type );
91 * Cache the geometry of the give type.
92 * @param[in] type The geometry type.
93 * @param[in] geometry The geometry for caching.
95 void SaveGeometry( GeometryType type, Geometry geometry);
98 * Request shader of the given type.
99 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
101 Shader GetShader( ShaderType type );
104 * Cache the geometry of the give type.
105 * @param[in] type The geometry type.
106 * @param[in] geometry The geometry for caching.
108 void SaveShader( ShaderType type, Shader shader );
111 * Greate the quad geometry.
112 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
114 static Geometry CreateQuadGeometry();
119 * @brief Request renderer from the url
121 * @return The cached renderer if exist in the cache. Otherwise an empty handle is returned.
123 Renderer GetRenderer( const std::string& key ) const;
126 * @brief Cache the renderer based on the given key.
128 * If the key already exists in the cache, then the cache will save an additional renderer to the cache.
129 * RemoveRenderer will then need to be called twice to remove both items from the cache.
131 * @param[in] key The key to use for caching
132 * @param[in] renderer The Renderer to be cached
134 void SaveRenderer( const std::string& key, Renderer& renderer );
137 * @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
139 * @param[in] key The key used for caching
141 * @return True if the renderer is no longer used anywhere, false otherwise
143 bool CleanRendererCache( const std::string& key );
146 * @brief Cache the debug renderer
148 void CacheDebugRenderer( Renderer& renderer );
151 * @brief Request the debug renderer;
153 Renderer GetDebugRenderer();
158 * A reference counted object may only be deleted by calling Unreference()
160 virtual ~RendererFactoryCache();
163 * Undefined copy constructor.
165 RendererFactoryCache(const RendererFactoryCache&);
168 * Undefined assignment operator.
170 RendererFactoryCache& operator=(const RendererFactoryCache& rhs);
173 struct CachedRenderer
176 WeakHandle< Renderer > mRenderer;
178 CachedRenderer( const std::string& key, Renderer& renderer )
184 typedef Dali::Vector< std::size_t > HashVector;
185 typedef Dali::OwnerContainer< const CachedRenderer* > CachedRenderers;
188 * @brief Finds the first index into the cached renderers from the url
190 * @return Returns the first index into the cached renderer from the url if it exists in the cache, otherwise returns -1
192 int FindRenderer( const std::string& key ) const;
195 // ToDo: test whether using the WeakHandle could improve the performance
196 // With WeakHandle, the resource would be released automatically when no control is using it
198 Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
199 Shader mShader[SHADER_TYPE_MAX+1];
201 HashVector mRendererHashes;
202 CachedRenderers mRenderers;
204 Renderer mDebugRenderer;
207 } // namespace Internal
209 } // namespace Toolkit
213 #endif /*__DALI_TOOLKIT_RENDERER_FACTORY_CACHE_H__ */