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