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) 2022 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/devel-api/common/owner-container.h>
  22 #include <dali/public-api/math/uint-16-pair.h>
  23 #include <dali/public-api/object/ref-object.h>
  24 #include <dali/public-api/rendering/geometry.h>
  25 #include <dali/public-api/rendering/shader.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/internal/texture-manager/texture-manager-impl.h>
  29 #include <dali-toolkit/internal/visuals/npatch-loader.h>
  30 #include <dali-toolkit/internal/visuals/svg/svg-rasterize-thread.h>
  31 #include <dali/devel-api/rendering/renderer-devel.h>
  32
  33 namespace Dali
  34 {
  35 class Texture;
  36
  37 namespace Toolkit
  38 {
  39 namespace Internal
  40 {
  41 class ImageAtlasManager;
  42 class NPatchLoader;
  43 class TextureManager;
  44 class VectorAnimationManager;
  45
  46 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
  47
  48 /**
  49  * Caches shaders and geometries. Owned by VisualFactory.
  50  */
  51 class VisualFactoryCache
  52 {
  53 public:
  54   /**
  55    * Type of shader for caching.
  56    */
  57   enum ShaderType
  58   {
  59     COLOR_SHADER,
  60     COLOR_SHADER_ROUNDED_CORNER,
  61     COLOR_SHADER_BORDERLINE,
  62     COLOR_SHADER_ROUNDED_BORDERLINE,
  63     COLOR_SHADER_BLUR_EDGE,
  64     COLOR_SHADER_ROUNDED_CORNER_BLUR_EDGE,
  65     BORDER_SHADER,
  66     BORDER_SHADER_ANTI_ALIASING,
  67     GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
  68     GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_CORNER,
  69     GRADIENT_SHADER_LINEAR_BOUNDING_BOX_BORDERLINE,
  70     GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_BORDERLINE,
  71     GRADIENT_SHADER_LINEAR_USER_SPACE,
  72     GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_CORNER,
  73     GRADIENT_SHADER_LINEAR_USER_SPACE_BORDERLINE,
  74     GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_BORDERLINE,
  75     GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
  76     GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_CORNER,
  77     GRADIENT_SHADER_RADIAL_BOUNDING_BOX_BORDERLINE,
  78     GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_BORDERLINE,
  79     GRADIENT_SHADER_RADIAL_USER_SPACE,
  80     GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_CORNER,
  81     GRADIENT_SHADER_RADIAL_USER_SPACE_BORDERLINE,
  82     GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_BORDERLINE,
  83     IMAGE_SHADER,
  84     IMAGE_SHADER_ROUNDED_CORNER,
  85     IMAGE_SHADER_BORDERLINE,
  86     IMAGE_SHADER_ROUNDED_BORDERLINE,
  87     IMAGE_SHADER_MASKING,
  88     IMAGE_SHADER_ROUNDED_CORNER_MASKING,
  89     IMAGE_SHADER_BORDERLINE_MASKING,
  90     IMAGE_SHADER_ROUNDED_BORDERLINE_MASKING,
  91     IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
  92     IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
  93     IMAGE_SHADER_YUV_TO_RGB,
  94     IMAGE_SHADER_ROUNDED_CORNER_YUV_TO_RGB,
  95     IMAGE_SHADER_BORDERLINE_YUV_TO_RGB,
  96     IMAGE_SHADER_ROUNDED_BORDERLINE_YUV_TO_RGB,
  97     NATIVE_IMAGE_SHADER,
  98     NATIVE_IMAGE_SHADER_ROUNDED_CORNER,
  99     NATIVE_IMAGE_SHADER_BORDERLINE,
 100     NATIVE_IMAGE_SHADER_ROUNDED_BORDERLINE,
 101     NATIVE_IMAGE_SHADER_MASKING,
 102     NATIVE_IMAGE_SHADER_ROUNDED_CORNER_MASKING,
 103     NATIVE_IMAGE_SHADER_BORDERLINE_MASKING,
 104     NATIVE_IMAGE_SHADER_ROUNDED_BORDERLINE_MASKING,
 105     NINE_PATCH_SHADER,
 106     NINE_PATCH_MASK_SHADER,
 107     TEXT_SHADER_MULTI_COLOR_TEXT,
 108     TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
 109     TEXT_SHADER_SINGLE_COLOR_TEXT,
 110     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
 111     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
 112     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
 113     ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
 114     ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
 115     ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
 116     ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
 117     ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
 118     ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
 119     ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
 120     ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
 121     ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
 122     ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
 123     ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
 124     ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
 125     WIREFRAME_SHADER,
 126     ARC_BUTT_CAP_SHADER,
 127     ARC_ROUND_CAP_SHADER,
 128     SHADER_TYPE_MAX = ARC_ROUND_CAP_SHADER
 129   };
 130
 131   /**
 132    * Type of geometry for caching.
 133    */
 134   enum GeometryType
 135   {
 136     QUAD_GEOMETRY,
 137     BORDER_GEOMETRY,
 138     NINE_PATCH_GEOMETRY,
 139     NINE_PATCH_BORDER_GEOMETRY,
 140     WIREFRAME_GEOMETRY,
 141     GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
 142   };
 143
 144 public:
 145   /**
 146    * @brief Constructor
 147    *
 148    * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
 149    */
 150   VisualFactoryCache(bool preMultiplyOnLoad);
 151
 152   /**
 153    * @brief Destructor
 154    */
 155   ~VisualFactoryCache();
 156
 157   /**
 158    * Request geometry of the given type.
 159    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 160    */
 161   Geometry GetGeometry(GeometryType type);
 162
 163   /**
 164    * Cache the geometry of the give type.
 165    * @param[in] type The geometry type.
 166    * @param[in] geometry The geometry for caching.
 167    */
 168   void SaveGeometry(GeometryType type, Geometry geometry);
 169
 170   /**
 171    * Request shader of the given type.
 172    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 173    */
 174   Shader GetShader(ShaderType type);
 175
 176   /**
 177    * Cache the geometry of the give type.
 178    * @param[in] type The geometry type.
 179    * @param[in] geometry The geometry for caching.
 180    */
 181   void SaveShader(ShaderType type, Shader shader);
 182
 183   /*
 184    * Greate the quad geometry.
 185    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 186    */
 187   static Geometry CreateQuadGeometry();
 188
 189   /**
 190    * Create the grid geometry.
 191    * @param[in] gridSize The size of the grid.
 192    * @return The created grid geometry.
 193    */
 194   static Geometry CreateGridGeometry(Uint16Pair gridSize);
 195
 196   /**
 197    * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
 198    */
 199   void SetPreMultiplyOnLoad(bool preMultiply);
 200
 201   /**
 202    * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
 203    */
 204   bool GetPreMultiplyOnLoad();
 205
 206   /**
 207    * @brief Set an image to be used when a visual has failed to correctly render
 208    * @param[in] brokenImageUrlList The broken image url list
 209    */
 210   void SetBrokenImageUrl(std::string& defaultBrokenUrl, const std::vector<std::string>& brokenImageUrlList);
 211
 212   /**
 213    * @brief Update the broken image Renderer object
 214    * @param[in,out] renderer renderer for broken image
 215    * @param[in] size the size of actor
 216    * @param[in] rendererIsImage True if input renderer use image shader already.
 217    *                            If true, we don't need to create new renderer when broken image is single image.
 218    *                            Most of user experience use normal images. So It can reduce runtime.
 219    */
 220   void UpdateBrokenImageRenderer(Renderer& renderer, const Vector2& size, const bool& rendererIsImage = true);
 221
 222 public:
 223   /**
 224    * Get the image atlas manager.
 225    * @return A pointer to the atlas manager
 226    */
 227   ImageAtlasManagerPtr GetAtlasManager();
 228
 229   /**
 230    * Get the texture manager
 231    * @return A reference to the texture manager
 232    */
 233   TextureManager& GetTextureManager();
 234
 235   /**
 236    * Get the N-Patch texture cache.
 237    * @return A reference to the N patch loader
 238    */
 239   NPatchLoader& GetNPatchLoader();
 240
 241   /**
 242    * Get the SVG rasterization manager.
 243    * @return A raw pointer pointing to the SVG rasterization manager.
 244    */
 245   SvgRasterizeManager* GetSVGRasterizationManager();
 246
 247   /**
 248    * Get the vector animation manager.
 249    * @return A reference to the vector animation manager.
 250    */
 251   VectorAnimationManager& GetVectorAnimationManager();
 252
 253 protected:
 254   /**
 255    * Undefined copy constructor.
 256    */
 257   VisualFactoryCache(const VisualFactoryCache&);
 258
 259   /**
 260    * Undefined assignment operator.
 261    */
 262   VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
 263
 264 private:
 265   /**
 266    * @brief Returns a cached Texture to use when a visual has failed to correctly render
 267    * @param[in] brokenIndex The index of broken image
 268    *
 269    * @return The broken image texture.
 270    */
 271   Texture GetBrokenVisualImage(uint32_t brokenIndex);
 272
 273   /**
 274    * @brief Gets the Proper broken image index
 275    * @param[in] size The size of actor
 276    *
 277    * @return The index of broken image
 278    */
 279   int32_t GetProperBrokenImageIndex(const Vector2& size);
 280
 281   /**
 282    * @brief Apply a texture and uniforms
 283    *
 284    * @param[in,out] renderer The renderer for broken image
 285    * @param[in] index The index of broken image
 286    */
 287   void ApplyTextureAndUniforms(Renderer& renderer, int index);
 288
 289   /**
 290    * @brief Gets a geometry for npatch image
 291    *
 292    * @param[in] index the index of broken image
 293    * @return The Geometry for NPatch
 294    */
 295   Geometry GetNPatchGeometry(int index);
 296
 297   /**
 298    * @brief Gets the Npatch Shader object
 299    *
 300    * @param[in] index The index of broken image
 301    * @return The Shader for NPatch
 302    */
 303   Shader GetNPatchShader(int index);
 304
 305   /**
 306    * @brief Returns a broken image type
 307    * @param[in] index BrokenImage index
 308    * @return The broken image type.
 309    */
 310   VisualUrl::Type GetBrokenImageVisualType(int index);
 311
 312 private:
 313   struct BrokenImageInfo
 314   {
 315     BrokenImageInfo()
 316     : visualType(),
 317       url(""),
 318       npatchId(NPatchData::INVALID_NPATCH_DATA_ID),
 319       texture(),
 320       width(0),
 321       height(0)
 322     {
 323     }
 324
 325     ~BrokenImageInfo()
 326     {
 327     }
 328
 329     // Data
 330     VisualUrl::Type          visualType;
 331     std::string              url;
 332     NPatchData::NPatchDataId npatchId;
 333     Texture                  texture;
 334     uint32_t                 width;
 335     uint32_t                 height;
 336   };
 337
 338   Geometry mGeometry[GEOMETRY_TYPE_MAX + 1];
 339   Shader   mShader[SHADER_TYPE_MAX + 1];
 340
 341   ImageAtlasManagerPtr mAtlasManager;
 342   TextureManager       mTextureManager;
 343   NPatchLoader         mNPatchLoader;
 344
 345   std::unique_ptr<SvgRasterizeManager>    mSvgRasterizeManager;
 346   std::unique_ptr<VectorAnimationManager> mVectorAnimationManager;
 347   bool                                    mPreMultiplyOnLoad;
 348   std::vector<BrokenImageInfo>            mBrokenImageInfoContainer;
 349   std::string                             mDefaultBrokenImageUrl;
 350   bool                                    mUseDefaultBrokenImageOnly;
 351 };
 352
 353 } // namespace Internal
 354
 355 } // namespace Toolkit
 356
 357 } // namespace Dali
 358
 359 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H