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) 2017 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
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/internal/visuals/npatch-loader.h>
  29 #include <dali-toolkit/internal/visuals/svg/svg-rasterize-thread.h>
  30 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
  31 #include <dali-toolkit/internal/visuals/animated-vector-image/vector-animation-thread.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41 class ImageAtlasManager;
  42 class NPatchLoader;
  43 class TextureManager;
  44
  45 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
  46
  47
  48 /**
  49  * Caches shaders and geometries. Owned by VisualFactory.
  50  */
  51 class VisualFactoryCache
  52 {
  53 public:
  54
  55   /**
  56    * Type of shader for caching.
  57    */
  58   enum ShaderType
  59   {
  60     COLOR_SHADER,
  61     BORDER_SHADER,
  62     BORDER_SHADER_ANTI_ALIASING,
  63     GRADIENT_SHADER_LINEAR_USER_SPACE,
  64     GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
  65     GRADIENT_SHADER_RADIAL_USER_SPACE,
  66     GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
  67     IMAGE_SHADER,
  68     IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
  69     IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
  70     NINE_PATCH_SHADER,
  71     NINE_PATCH_MASK_SHADER,
  72     TEXT_SHADER_MULTI_COLOR_TEXT,
  73     TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
  74     TEXT_SHADER_SINGLE_COLOR_TEXT,
  75     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
  76     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
  77     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
  78     ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
  79     ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
  80     ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
  81     ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
  82     ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
  83     ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
  84     ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
  85     ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
  86     ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
  87     ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
  88     ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
  89     ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
  90     WIREFRAME_SHADER,
  91     SHADER_TYPE_MAX = WIREFRAME_SHADER
  92   };
  93
  94   /**
  95    * Type of geometry for caching.
  96    */
  97   enum GeometryType
  98   {
  99     QUAD_GEOMETRY,
 100     BORDER_GEOMETRY,
 101     NINE_PATCH_GEOMETRY,
 102     NINE_PATCH_BORDER_GEOMETRY,
 103     WIREFRAME_GEOMETRY,
 104     GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
 105   };
 106
 107 public:
 108
 109   /**
 110    * @brief Constructor
 111    *
 112    * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
 113    */
 114   VisualFactoryCache( bool preMultiplyOnLoad );
 115
 116   /**
 117    * @brief Destructor
 118    */
 119   ~VisualFactoryCache();
 120
 121   /**
 122    * Request geometry of the given type.
 123    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 124    */
 125   Geometry GetGeometry( GeometryType type );
 126
 127   /**
 128    * Cache the geometry of the give type.
 129    * @param[in] type The geometry type.
 130    * @param[in] geometry The geometry for caching.
 131    */
 132   void SaveGeometry( GeometryType type, Geometry geometry);
 133
 134   /**
 135    * Request shader of the given type.
 136    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 137    */
 138   Shader GetShader( ShaderType type );
 139
 140   /**
 141    * Cache the geometry of the give type.
 142    * @param[in] type The geometry type.
 143    * @param[in] geometry The geometry for caching.
 144    */
 145   void SaveShader( ShaderType type, Shader shader );
 146
 147   /*
 148    * Greate the quad geometry.
 149    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 150    */
 151   static Geometry CreateQuadGeometry();
 152
 153   /**
 154    * Create the grid geometry.
 155    * @param[in] gridSize The size of the grid.
 156    * @return The created grid geometry.
 157    */
 158   static Geometry CreateGridGeometry( Uint16Pair gridSize );
 159
 160   /**
 161    * @brief Returns an image to be used when a visual has failed to correctly render
 162    * @return The broken image handle.
 163    */
 164   Image GetBrokenVisualImage();
 165
 166   /**
 167    * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
 168    */
 169   void SetPreMultiplyOnLoad( bool preMultiply );
 170
 171   /**
 172    * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
 173    */
 174   bool GetPreMultiplyOnLoad();
 175
 176   /**
 177    * @brief Set an image to be used when a visual has failed to correctly render
 178    * @param[in] brokenImageUrl The broken image url.
 179    */
 180   void SetBrokenImageUrl(const std::string& brokenImageUrl);
 181
 182 public:
 183   /**
 184    * Get the image atlas manager.
 185    * @return A pointer to the atlas manager
 186    */
 187   ImageAtlasManagerPtr GetAtlasManager();
 188
 189   /**
 190    * Get the texture manager
 191    * @return A reference to the texture manager
 192    */
 193   TextureManager& GetTextureManager();
 194
 195   /**
 196    * Get the N-Patch texture cache.
 197    * @return A reference to the N patch loader
 198    */
 199   NPatchLoader& GetNPatchLoader();
 200
 201   /**
 202    * Get the SVG rasterization thread.
 203    * @return A raw pointer pointing to the SVG rasterization thread.
 204    */
 205   SvgRasterizeThread* GetSVGRasterizationThread();
 206
 207   /**
 208    * Get the vector animation thread.
 209    * @return A raw pointer pointing to the vector animation thread.
 210    */
 211   VectorAnimationThread& GetVectorAnimationThread();
 212
 213 private: // for svg rasterization thread
 214
 215   /**
 216    * Applies the rasterized image to material
 217    */
 218   void ApplyRasterizedSVGToSampler();
 219
 220 protected:
 221
 222   /**
 223    * Undefined copy constructor.
 224    */
 225   VisualFactoryCache(const VisualFactoryCache&);
 226
 227   /**
 228    * Undefined assignment operator.
 229    */
 230   VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
 231
 232 private:
 233   Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
 234   Shader mShader[SHADER_TYPE_MAX+1];
 235
 236   ImageAtlasManagerPtr                     mAtlasManager;
 237   TextureManager                           mTextureManager;
 238   NPatchLoader                             mNPatchLoader;
 239   SvgRasterizeThread*                      mSvgRasterizeThread;
 240   std::unique_ptr< VectorAnimationThread > mVectorAnimationThread;
 241   std::string                              mBrokenImageUrl;
 242   bool                                     mPreMultiplyOnLoad;
 243 };
 244
 245 } // namespace Internal
 246
 247 } // namespace Toolkit
 248
 249 } // namespace Dali
 250
 251 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H