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 // INTERNAL INCLUDES
  21 #include "svg/svg-rasterize-thread.h"
  22
  23 // EXTERNAL INCLUDES
  24 #include <dali/public-api/object/ref-object.h>
  25 #include <dali/devel-api/rendering/geometry.h>
  26 #include <dali/devel-api/rendering/shader.h>
  27 #include <dali/devel-api/rendering/renderer.h>
  28 #include <dali/devel-api/common/owner-container.h>
  29 #include <dali/devel-api/object/weak-handle.h>
  30
  31
  32 namespace Dali
  33 {
  34
  35 namespace Toolkit
  36 {
  37
  38 namespace Internal
  39 {
  40
  41 /**
  42  * Caches shaders and geometries. Owned by RenderFactory.
  43  */
  44 class RendererFactoryCache : public RefObject
  45 {
  46 public:
  47
  48   /**
  49    * Type of shader for caching.
  50    */
  51   enum ShaderType
  52   {
  53     COLOR_SHADER,
  54     BORDER_SHADER,
  55     BORDER_SHADER_ANTI_ALIASING,
  56     GRADIENT_SHADER_LINEAR_USER_SPACE,
  57     GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
  58     GRADIENT_SHADER_RADIAL_USER_SPACE,
  59     GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
  60     IMAGE_SHADER,
  61     NINE_PATCH_SHADER,
  62     SVG_SHADER,
  63     SHADER_TYPE_MAX = SVG_SHADER
  64   };
  65
  66   /**
  67    * Type of geometry for caching.
  68    */
  69   enum GeometryType
  70   {
  71     QUAD_GEOMETRY,
  72     BORDER_GEOMETRY,
  73     NINE_PATCH_GEOMETRY,
  74     NINE_PATCH_BORDER_GEOMETRY,
  75     GEOMETRY_TYPE_MAX = NINE_PATCH_BORDER_GEOMETRY
  76   };
  77
  78 public:
  79
  80   /**
  81    * @brief Constructor
  82    */
  83   RendererFactoryCache();
  84
  85   /**
  86    * Request geometry of the given type.
  87    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
  88    */
  89   Geometry GetGeometry( GeometryType type );
  90
  91   /**
  92    * Cache the geometry of the give type.
  93    * @param[in] type The geometry type.
  94    * @param[in] geometry The geometry for caching.
  95    */
  96   void SaveGeometry( GeometryType type, Geometry geometry);
  97
  98   /**
  99    * Request shader of the given type.
 100    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 101    */
 102   Shader GetShader( ShaderType type );
 103
 104   /**
 105    * Cache the geometry of the give type.
 106    * @param[in] type The geometry type.
 107    * @param[in] geometry The geometry for caching.
 108    */
 109   void SaveShader( ShaderType type, Shader shader );
 110
 111   /*
 112    * Greate the quad geometry.
 113    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 114    */
 115   static Geometry CreateQuadGeometry();
 116
 117 public:
 118
 119   /**
 120    * @brief Request renderer from the url
 121    *
 122    * @return The cached renderer if exist in the cache. Otherwise an empty handle is returned.
 123    */
 124   Renderer GetRenderer( const std::string& key ) const;
 125
 126   /**
 127    * @brief Cache the renderer based on the given key.
 128    *
 129    * If the key already exists in the cache, then the cache will save an additional renderer to the cache.
 130    * RemoveRenderer will then need to be called twice to remove both items from the cache.
 131    *
 132    * @param[in] key The key to use for caching
 133    * @param[in] renderer The Renderer to be cached
 134    */
 135   void SaveRenderer( const std::string& key, Renderer& renderer );
 136
 137   /**
 138    * @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    *
 140    * @param[in] key The key used for caching
 141    *
 142    * @return True if the renderer is no longer used anywhere, false otherwise
 143    */
 144   bool CleanRendererCache( const std::string& key );
 145
 146   /**
 147    * @brief Cache the debug renderer
 148    */
 149   void CacheDebugRenderer( Renderer& renderer );
 150
 151   /**
 152    * @brief Request the debug renderer;
 153    */
 154   Renderer GetDebugRenderer();
 155
 156   /**
 157    * Get the SVG rasterization thread.
 158    * @return A pointer pointing to the SVG rasterization thread.
 159    */
 160   SvgRasterizeThread* GetSVGRasterizationThread();
 161
 162 private: // for svg rasterization thread
 163
 164   /**
 165    * Applies the rasterized image to material
 166    */
 167   void ApplyRasterizedSVGToSampler();
 168
 169 protected:
 170
 171   /**
 172    * A reference counted object may only be deleted by calling Unreference()
 173    */
 174   virtual ~RendererFactoryCache();
 175
 176   /**
 177    * Undefined copy constructor.
 178    */
 179   RendererFactoryCache(const RendererFactoryCache&);
 180
 181   /**
 182    * Undefined assignment operator.
 183    */
 184   RendererFactoryCache& operator=(const RendererFactoryCache& rhs);
 185
 186 private:
 187   struct CachedRenderer
 188   {
 189     std::string mKey;
 190     WeakHandle< Renderer > mRenderer;
 191
 192     CachedRenderer( const std::string& key, Renderer& renderer )
 193     : mKey( key ),
 194       mRenderer( renderer)
 195     {}
 196   };
 197
 198   typedef Dali::Vector< std::size_t > HashVector;
 199   typedef Dali::OwnerContainer< const CachedRenderer* > CachedRenderers;
 200
 201   /**
 202    * @brief Finds the first index into the cached renderers from the url
 203    *
 204    * @return Returns the first index into the cached renderer from the url if it exists in the cache, otherwise returns -1
 205    */
 206   int FindRenderer( const std::string& key ) const;
 207
 208 private:
 209   Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
 210   Shader mShader[SHADER_TYPE_MAX+1];
 211
 212   HashVector mRendererHashes;
 213   CachedRenderers mRenderers;
 214
 215   Renderer mDebugRenderer;
 216
 217   SvgRasterizeThread*  mSvgRasterizeThread;
 218 };
 219
 220 } // namespace Internal
 221
 222 } // namespace Toolkit
 223
 224 } // namespace Dali
 225
 226 #endif /*__DALI_TOOLKIT_RENDERER_FACTORY_CACHE_H__ */