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,
72 SHADER_TYPE_MAX = SVG_SHADER
76 * Type of geometry for caching.
83 NINE_PATCH_BORDER_GEOMETRY,
84 GEOMETRY_TYPE_MAX = NINE_PATCH_BORDER_GEOMETRY
95 * Request geometry of the given type.
96 * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
98 Geometry GetGeometry( GeometryType type );
101 * Cache the geometry of the give type.
102 * @param[in] type The geometry type.
103 * @param[in] geometry The geometry for caching.
105 void SaveGeometry( GeometryType type, Geometry geometry);
108 * Request shader of the given type.
109 * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
111 Shader GetShader( ShaderType type );
114 * Cache the geometry of the give type.
115 * @param[in] type The geometry type.
116 * @param[in] geometry The geometry for caching.
118 void SaveShader( ShaderType type, Shader shader );
121 * Greate the quad geometry.
122 * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
124 static Geometry CreateQuadGeometry();
127 * Create the grid geometry.
128 * @param[in] gridSize The size of the grid.
129 * @return The created grid geometry.
131 static Geometry CreateGridGeometry( Uint16Pair gridSize );
134 * Create the batchable geometry
135 * @param[in] texCoords The texture atlas rect coordinates
136 * @return The created batchable geometry
138 static Geometry CreateBatchQuadGeometry( Vector4 texCoords );
141 * @brief Returns an image to be used when a visual has failed to correctly render
142 * @return The broken image handle.
144 static Image GetBrokenVisualImage();
149 * @brief Request renderer from the url
151 * @return The cached renderer if exist in the cache. Otherwise an empty handle is returned.
153 Renderer GetRenderer( const std::string& key ) const;
156 * @brief Cache the renderer based on the given key.
158 * If the key already exists in the cache, then the cache will save an additional renderer to the cache.
159 * RemoveRenderer will then need to be called twice to remove both items from the cache.
161 * @param[in] key The key to use for caching
162 * @param[in] renderer The Renderer to be cached
164 void SaveRenderer( const std::string& key, Renderer& renderer );
167 * @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
169 * @param[in] key The key used for caching
171 * @return True if the renderer is no longer used anywhere, false otherwise
173 bool CleanRendererCache( const std::string& key );
176 * @brief Cache the wireframe renderer
178 void CacheWireframeRenderer( Renderer& renderer );
181 * @brief Request the wireframe renderer;
183 Renderer GetWireframeRenderer();
186 * Get the image atlas manager.
187 * @return A pointer to the atlas manager
189 ImageAtlasManagerPtr GetAtlasManager();
192 * Get the N-Patch texture cache.
193 * @return A reference to the N patch loader
195 NPatchLoader& GetNPatchLoader();
198 * Get the SVG rasterization thread.
199 * @return A raw pointer pointing to the SVG rasterization thread.
201 SvgRasterizeThread* GetSVGRasterizationThread();
203 private: // for svg rasterization thread
206 * Applies the rasterized image to material
208 void ApplyRasterizedSVGToSampler();
213 * A reference counted object may only be deleted by calling Unreference()
215 virtual ~VisualFactoryCache();
218 * Undefined copy constructor.
220 VisualFactoryCache(const VisualFactoryCache&);
223 * Undefined assignment operator.
225 VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
228 struct CachedRenderer
231 WeakHandle< Renderer > mRenderer;
233 CachedRenderer( const std::string& key, Renderer& renderer )
239 typedef Dali::Vector< std::size_t > HashVector;
240 typedef Dali::OwnerContainer< const CachedRenderer* > CachedRenderers;
243 * @brief Finds the first index into the cached visuals from the url
245 * @return Returns the first index into the cached renderer from the url if it exists in the cache, otherwise returns -1
247 int FindRenderer( const std::string& key ) const;
250 Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
251 Shader mShader[SHADER_TYPE_MAX+1];
253 HashVector mRendererHashes;
254 CachedRenderers mRenderers;
256 Renderer mWireframeRenderer;
258 ImageAtlasManagerPtr mAtlasManager;
259 NPatchLoader mNPatchLoader;
261 SvgRasterizeThread* mSvgRasterizeThread;
264 } // namespace Internal
266 } // namespace Toolkit
270 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H