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/shader.h>
  25 #include <dali/devel-api/common/owner-container.h>
  26 #include <dali/devel-api/object/weak-handle.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/internal/visuals/npatch-loader.h>
  30 #include <dali-toolkit/internal/visuals/svg/svg-rasterize-thread.h>
  31
  32 namespace Dali
  33 {
  34
  35 namespace Toolkit
  36 {
  37
  38 namespace Internal
  39 {
  40
  41 class ImageAtlasManager;
  42 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
  43
  44 class NPatchLoader;
  45
  46 /**
  47  * Caches shaders and geometries. Owned by VisualFactory.
  48  */
  49 class VisualFactoryCache : public RefObject
  50 {
  51 public:
  52
  53   /**
  54    * Type of shader for caching.
  55    */
  56   enum ShaderType
  57   {
  58     COLOR_SHADER,
  59     BORDER_SHADER,
  60     BORDER_SHADER_ANTI_ALIASING,
  61     GRADIENT_SHADER_LINEAR_USER_SPACE,
  62     GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
  63     GRADIENT_SHADER_RADIAL_USER_SPACE,
  64     GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
  65     IMAGE_SHADER,
  66     IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
  67     IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
  68     NINE_PATCH_SHADER,
  69     SVG_SHADER,
  70     TEXT_SHADER,
  71     WIREFRAME_SHADER,
  72     SHADER_TYPE_MAX = WIREFRAME_SHADER
  73   };
  74
  75   /**
  76    * Type of geometry for caching.
  77    */
  78   enum GeometryType
  79   {
  80     QUAD_GEOMETRY,
  81     BORDER_GEOMETRY,
  82     NINE_PATCH_GEOMETRY,
  83     NINE_PATCH_BORDER_GEOMETRY,
  84     WIREFRAME_GEOMETRY,
  85     GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
  86   };
  87
  88 public:
  89
  90   /**
  91    * @brief Constructor
  92    */
  93   VisualFactoryCache();
  94
  95   /**
  96    * Request geometry of the given type.
  97    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
  98    */
  99   Geometry GetGeometry( GeometryType type );
 100
 101   /**
 102    * Cache the geometry of the give type.
 103    * @param[in] type The geometry type.
 104    * @param[in] geometry The geometry for caching.
 105    */
 106   void SaveGeometry( GeometryType type, Geometry geometry);
 107
 108   /**
 109    * Request shader of the given type.
 110    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 111    */
 112   Shader GetShader( ShaderType type );
 113
 114   /**
 115    * Cache the geometry of the give type.
 116    * @param[in] type The geometry type.
 117    * @param[in] geometry The geometry for caching.
 118    */
 119   void SaveShader( ShaderType type, Shader shader );
 120
 121   /*
 122    * Greate the quad geometry.
 123    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 124    */
 125   static Geometry CreateQuadGeometry();
 126
 127   /**
 128    * Create the grid geometry.
 129    * @param[in] gridSize The size of the grid.
 130    * @return The created grid geometry.
 131    */
 132   static Geometry CreateGridGeometry( Uint16Pair gridSize );
 133
 134   /**
 135    * @brief Returns an image to be used when a visual has failed to correctly render
 136    * @return The broken image handle.
 137    */
 138   static Image GetBrokenVisualImage();
 139
 140 public:
 141   /**
 142    * Get the image atlas manager.
 143    * @return A pointer to the atlas manager
 144    */
 145   ImageAtlasManagerPtr GetAtlasManager();
 146
 147   /**
 148    * Get the N-Patch texture cache.
 149    * @return A reference to the N patch loader
 150    */
 151   NPatchLoader& GetNPatchLoader();
 152
 153   /**
 154    * Get the SVG rasterization thread.
 155    * @return A raw pointer pointing to the SVG rasterization thread.
 156    */
 157   SvgRasterizeThread* GetSVGRasterizationThread();
 158
 159 private: // for svg rasterization thread
 160
 161   /**
 162    * Applies the rasterized image to material
 163    */
 164   void ApplyRasterizedSVGToSampler();
 165
 166 protected:
 167
 168   /**
 169    * A reference counted object may only be deleted by calling Unreference()
 170    */
 171   virtual ~VisualFactoryCache();
 172
 173   /**
 174    * Undefined copy constructor.
 175    */
 176   VisualFactoryCache(const VisualFactoryCache&);
 177
 178   /**
 179    * Undefined assignment operator.
 180    */
 181   VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
 182
 183 private:
 184   Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
 185   Shader mShader[SHADER_TYPE_MAX+1];
 186
 187   ImageAtlasManagerPtr mAtlasManager;
 188   NPatchLoader mNPatchLoader;
 189
 190   SvgRasterizeThread*  mSvgRasterizeThread;
 191 };
 192
 193 } // namespace Internal
 194
 195 } // namespace Toolkit
 196
 197 } // namespace Dali
 198
 199 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H