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