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