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