dali-toolkit/internal/visuals/visual-factory-cache.h

   1 #ifndef DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
   2 #define DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H
   3
   4 /*
   5  * Copyright (c) 2016 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 // EXTERNAL INCLUDES
  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>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali-toolkit/internal/visuals/npatch-loader.h>
  31 #include <dali-toolkit/internal/visuals/svg/svg-rasterize-thread.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 class ImageAtlasManager;
  43 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
  44
  45 class NPatchLoader;
  46
  47 /**
  48  * Caches shaders and geometries. Owned by VisualFactory.
  49  */
  50 class VisualFactoryCache : public RefObject
  51 {
  52 public:
  53
  54   /**
  55    * Type of shader for caching.
  56    */
  57   enum ShaderType
  58   {
  59     COLOR_SHADER,
  60     BORDER_SHADER,
  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,
  66     IMAGE_SHADER,
  67     IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
  68     IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
  69     NINE_PATCH_SHADER,
  70     SVG_SHADER,
  71     TEXT_SHADER,
  72     WIREFRAME_SHADER,
  73     SHADER_TYPE_MAX = WIREFRAME_SHADER
  74   };
  75
  76   /**
  77    * Type of geometry for caching.
  78    */
  79   enum GeometryType
  80   {
  81     QUAD_GEOMETRY,
  82     BORDER_GEOMETRY,
  83     NINE_PATCH_GEOMETRY,
  84     NINE_PATCH_BORDER_GEOMETRY,
  85     WIREFRAME_GEOMETRY,
  86     GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
  87   };
  88
  89 public:
  90
  91   /**
  92    * @brief Constructor
  93    */
  94   VisualFactoryCache();
  95
  96   /**
  97    * Request geometry of the given type.
  98    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
  99    */
 100   Geometry GetGeometry( GeometryType type );
 101
 102   /**
 103    * Cache the geometry of the give type.
 104    * @param[in] type The geometry type.
 105    * @param[in] geometry The geometry for caching.
 106    */
 107   void SaveGeometry( GeometryType type, Geometry geometry);
 108
 109   /**
 110    * Request shader of the given type.
 111    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 112    */
 113   Shader GetShader( ShaderType type );
 114
 115   /**
 116    * Cache the geometry of the give type.
 117    * @param[in] type The geometry type.
 118    * @param[in] geometry The geometry for caching.
 119    */
 120   void SaveShader( ShaderType type, Shader shader );
 121
 122   /*
 123    * Greate the quad geometry.
 124    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 125    */
 126   static Geometry CreateQuadGeometry();
 127
 128   /**
 129    * Create the grid geometry.
 130    * @param[in] gridSize The size of the grid.
 131    * @return The created grid geometry.
 132    */
 133   static Geometry CreateGridGeometry( Uint16Pair gridSize );
 134
 135   /**
 136    * @brief Returns an image to be used when a visual has failed to correctly render
 137    * @return The broken image handle.
 138    */
 139   static Image GetBrokenVisualImage();
 140
 141 public:
 142
 143   /**
 144    * @brief Request renderer from the url
 145    *
 146    * @return The cached renderer if exist in the cache. Otherwise an empty handle is returned.
 147    */
 148   Renderer GetRenderer( const std::string& key ) const;
 149
 150   /**
 151    * @brief Cache the renderer based on the given key.
 152    *
 153    * If the key already exists in the cache, then the cache will save an additional renderer to the cache.
 154    * RemoveRenderer will then need to be called twice to remove both items from the cache.
 155    *
 156    * @param[in] key The key to use for caching
 157    * @param[in] renderer The Renderer to be cached
 158    */
 159   void SaveRenderer( const std::string& key, Renderer& renderer );
 160
 161   /**
 162    * @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
 163    *
 164    * @param[in] key The key used for caching
 165    *
 166    * @return True if the renderer is no longer used anywhere, false otherwise
 167    */
 168   bool CleanRendererCache( const std::string& key );
 169
 170   /**
 171    * Get the image atlas manager.
 172    * @return A pointer to the atlas manager
 173    */
 174   ImageAtlasManagerPtr GetAtlasManager();
 175
 176   /**
 177    * Get the N-Patch texture cache.
 178    * @return A reference to the N patch loader
 179    */
 180   NPatchLoader& GetNPatchLoader();
 181
 182   /**
 183    * Get the SVG rasterization thread.
 184    * @return A raw pointer pointing to the SVG rasterization thread.
 185    */
 186   SvgRasterizeThread* GetSVGRasterizationThread();
 187
 188 private: // for svg rasterization thread
 189
 190   /**
 191    * Applies the rasterized image to material
 192    */
 193   void ApplyRasterizedSVGToSampler();
 194
 195 protected:
 196
 197   /**
 198    * A reference counted object may only be deleted by calling Unreference()
 199    */
 200   virtual ~VisualFactoryCache();
 201
 202   /**
 203    * Undefined copy constructor.
 204    */
 205   VisualFactoryCache(const VisualFactoryCache&);
 206
 207   /**
 208    * Undefined assignment operator.
 209    */
 210   VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
 211
 212 private:
 213   struct CachedRenderer
 214   {
 215     std::string mKey;
 216     WeakHandle< Renderer > mRenderer;
 217
 218     CachedRenderer( const std::string& key, Renderer& renderer )
 219     : mKey( key ),
 220       mRenderer( renderer)
 221     {}
 222   };
 223
 224   typedef Dali::Vector< std::size_t > HashVector;
 225   typedef Dali::OwnerContainer< const CachedRenderer* > CachedRenderers;
 226
 227   /**
 228    * @brief Finds the first index into the cached visuals from the url
 229    *
 230    * @return Returns the first index into the cached renderer from the url if it exists in the cache, otherwise returns -1
 231    */
 232   int FindRenderer( const std::string& key ) const;
 233
 234 private:
 235   Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
 236   Shader mShader[SHADER_TYPE_MAX+1];
 237
 238   HashVector mRendererHashes;
 239   CachedRenderers mRenderers;
 240
 241   Renderer mWireframeRenderer;
 242
 243   ImageAtlasManagerPtr mAtlasManager;
 244   NPatchLoader mNPatchLoader;
 245
 246   SvgRasterizeThread*  mSvgRasterizeThread;
 247 };
 248
 249 } // namespace Internal
 250
 251 } // namespace Toolkit
 252
 253 } // namespace Dali
 254
 255 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H