dali-toolkit/internal/controls/renderers/renderer-factory-cache.h

   1 #ifndef __DALI_TOOLKIT_RENDERER_FACTORY_CACHE_H__
   2 #define __DALI_TOOLKIT_RENDERER_FACTORY_CACHE_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  */
  19
  20 #include <map>
  21
  22 // EXTERNAL INCLUDES
  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>
  29
  30
  31 namespace Dali
  32 {
  33
  34 namespace Toolkit
  35 {
  36
  37 namespace Internal
  38 {
  39
  40 /**
  41  * Caches shaders and geometries. Owned by RenderFactory.
  42  */
  43 class RendererFactoryCache : public RefObject
  44 {
  45 public:
  46
  47   /**
  48    * Type of shader for caching.
  49    */
  50   enum ShaderType
  51   {
  52     COLOR_SHADER,
  53     BORDER_SHADER,
  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,
  59     IMAGE_SHADER,
  60     NINE_PATCH_SHADER,
  61     SVG_SHADER,
  62     SHADER_TYPE_MAX = SVG_SHADER
  63   };
  64
  65   /**
  66    * Type of geometry for caching.
  67    */
  68   enum GeometryType
  69   {
  70     QUAD_GEOMETRY,
  71     BORDER_GEOMETRY,
  72     NINE_PATCH_GEOMETRY,
  73     NINE_PATCH_BORDER_GEOMETRY,
  74     GEOMETRY_TYPE_MAX = NINE_PATCH_BORDER_GEOMETRY
  75   };
  76
  77 public:
  78
  79   /**
  80    * @brief Constructor
  81    */
  82   RendererFactoryCache();
  83
  84   /**
  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.
  87    */
  88   Geometry GetGeometry( GeometryType type );
  89
  90   /**
  91    * Cache the geometry of the give type.
  92    * @param[in] type The geometry type.
  93    * @param[in] geometry The geometry for caching.
  94    */
  95   void SaveGeometry( GeometryType type, Geometry geometry);
  96
  97   /**
  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.
 100    */
 101   Shader GetShader( ShaderType type );
 102
 103   /**
 104    * Cache the geometry of the give type.
 105    * @param[in] type The geometry type.
 106    * @param[in] geometry The geometry for caching.
 107    */
 108   void SaveShader( ShaderType type, Shader shader );
 109
 110   /*
 111    * Greate the quad geometry.
 112    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 113    */
 114   static Geometry CreateQuadGeometry();
 115
 116 public:
 117
 118   /**
 119    * @brief Request renderer from the url
 120    *
 121    * @return The cached renderer if exist in the cache. Otherwise an empty handle is returned.
 122    */
 123   Renderer GetRenderer( const std::string& key ) const;
 124
 125   /**
 126    * @brief Cache the renderer based on the given key.
 127    *
 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.
 130    *
 131    * @param[in] key The key to use for caching
 132    * @param[in] renderer The Renderer to be cached
 133    */
 134   void SaveRenderer( const std::string& key, Renderer& renderer );
 135
 136   /**
 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
 138    *
 139    * @param[in] key The key used for caching
 140    *
 141    * @return True if the renderer is no longer used anywhere, false otherwise
 142    */
 143   bool CleanRendererCache( const std::string& key );
 144
 145   /**
 146    * @brief Cache the debug renderer
 147    */
 148   void CacheDebugRenderer( Renderer& renderer );
 149
 150   /**
 151    * @brief Request the debug renderer;
 152    */
 153   Renderer GetDebugRenderer();
 154
 155 protected:
 156
 157   /**
 158    * A reference counted object may only be deleted by calling Unreference()
 159    */
 160   virtual ~RendererFactoryCache();
 161
 162   /**
 163    * Undefined copy constructor.
 164    */
 165   RendererFactoryCache(const RendererFactoryCache&);
 166
 167   /**
 168    * Undefined assignment operator.
 169    */
 170   RendererFactoryCache& operator=(const RendererFactoryCache& rhs);
 171
 172 private:
 173   struct CachedRenderer
 174   {
 175     std::string mKey;
 176     WeakHandle< Renderer > mRenderer;
 177
 178     CachedRenderer( const std::string& key, Renderer& renderer )
 179     : mKey( key ),
 180       mRenderer( renderer)
 181     {}
 182   };
 183
 184   typedef Dali::Vector< std::size_t > HashVector;
 185   typedef Dali::OwnerContainer< const CachedRenderer* > CachedRenderers;
 186
 187   /**
 188    * @brief Finds the first index into the cached renderers from the url
 189    *
 190    * @return Returns the first index into the cached renderer from the url if it exists in the cache, otherwise returns -1
 191    */
 192   int FindRenderer( const std::string& key ) const;
 193
 194 private:
 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
 197
 198   Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
 199   Shader mShader[SHADER_TYPE_MAX+1];
 200
 201   HashVector mRendererHashes;
 202   CachedRenderers mRenderers;
 203
 204   Renderer mDebugRenderer;
 205 };
 206
 207 } // namespace Internal
 208
 209 } // namespace Toolkit
 210
 211 } // namespace Dali
 212
 213 #endif /*__DALI_TOOLKIT_RENDERER_FACTORY_CACHE_H__ */