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
  28 namespace Dali
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 namespace Internal
  35 {
  36
  37 /**
  38  * Caches shaders and geometries. Owned by RenderFactory.
  39  */
  40 class RendererFactoryCache : public RefObject
  41 {
  42 public:
  43
  44   /**
  45    * Type of shader for caching.
  46    */
  47   enum ShaderType
  48   {
  49     COLOR_SHADER,
  50     BORDER_SHADER,
  51     GRADIENT_SHADER_LINEAR_USER_SPACE,
  52     GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
  53     GRADIENT_SHADER_RADIAL_USER_SPACE,
  54     GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
  55     IMAGE_SHADER,
  56     NINE_PATCH_SHADER,
  57     SVG_SHADER,
  58     SHADER_TYPE_MAX = SVG_SHADER
  59   };
  60
  61   /**
  62    * Type of geometry for caching.
  63    */
  64   enum GeometryType
  65   {
  66     QUAD_GEOMETRY,
  67     BORDER_GEOMETRY,
  68     NINE_PATCH_GEOMETRY,
  69     NINE_PATCH_BORDER_GEOMETRY,
  70     GEOMETRY_TYPE_MAX = NINE_PATCH_BORDER_GEOMETRY
  71   };
  72
  73 public:
  74
  75   /**
  76    * @brief Constructor
  77    */
  78   RendererFactoryCache();
  79
  80   /**
  81    * Request geometry of the given type.
  82    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
  83    */
  84   Geometry GetGeometry( GeometryType type );
  85
  86   /**
  87    * Cache the geometry of the give type.
  88    * @param[in] type The geometry type.
  89    * @param[in] geometry The geometry for caching.
  90    */
  91   void SaveGeometry( GeometryType type, Geometry geometry);
  92
  93   /**
  94    * Request shader of the given type.
  95    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
  96    */
  97   Shader GetShader( ShaderType type );
  98
  99   /**
 100    * Cache the geometry of the give type.
 101    * @param[in] type The geometry type.
 102    * @param[in] geometry The geometry for caching.
 103    */
 104   void SaveShader( ShaderType type, Shader shader );
 105
 106   /*
 107    * Greate the quad geometry.
 108    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 109    */
 110   static Geometry CreateQuadGeometry();
 111
 112 public:
 113   struct CachedRenderer : RefObject
 114   {
 115     std::string mKey;
 116     Renderer mRenderer;
 117
 118     CachedRenderer( const std::string& key, const Renderer& renderer )
 119     : mKey( key ),
 120       mRenderer( renderer )
 121     {}
 122   };
 123
 124   typedef IntrusivePtr< CachedRenderer > CachedRendererPtr;
 125
 126   /**
 127    * @brief Request renderer from the url
 128    *
 129    * @return The cached renderer if exist in the cache. Otherwise null is returned.
 130    */
 131   CachedRendererPtr GetRenderer( const std::string& key ) const;
 132
 133   /**
 134    * @brief Cache the renderer based on the given key.
 135    *
 136    * If the key already exists in the cache, then the cache will save an additional renderer to the cache.
 137    * RemoveRenderer will then need to be called twice to remove both items from the cache.
 138    *
 139    * @param[in] key The key to use for caching
 140    * @param[in] renderer The Renderer to be cached
 141    *
 142    * @return The cached renderer stored in the cache
 143    */
 144   CachedRendererPtr SaveRenderer( const std::string& key, Renderer& renderer );
 145
 146   /**
 147    * @brief Removes the renderer from the cache based on the given key
 148    *
 149    * @param[in] key The key used for caching
 150    */
 151   void RemoveRenderer( const std::string& key );
 152
 153 protected:
 154
 155   /**
 156    * A reference counted object may only be deleted by calling Unreference()
 157    */
 158   virtual ~RendererFactoryCache();
 159
 160   /**
 161    * Undefined copy constructor.
 162    */
 163   RendererFactoryCache(const RendererFactoryCache&);
 164
 165   /**
 166    * Undefined assignment operator.
 167    */
 168   RendererFactoryCache& operator=(const RendererFactoryCache& rhs);
 169
 170 private:
 171   typedef Dali::Vector< std::size_t > HashVector;
 172   typedef std::vector< CachedRendererPtr > CachedRenderers;
 173
 174   /**
 175    * @brief Finds the first index into the cached renderers from the url
 176    *
 177    * @return Returns the first index into the cached renderer from the url if it exists in the cache, otherwise returns -1
 178    */
 179   int FindRenderer( const std::string& key ) const;
 180
 181 private:
 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
 184
 185   Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
 186   Shader mShader[SHADER_TYPE_MAX+1];
 187
 188   HashVector mRendererHashes;
 189   CachedRenderers mRenderers;
 190 };
 191
 192 } // namespace Internal
 193
 194 } // namespace Toolkit
 195
 196 } // namespace Dali
 197
 198 #endif /*__DALI_TOOLKIT_RENDERER_FACTORY_CACHE_H__ */