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_SINGLE_COLOR_TEXT,
 108     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
 109     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_OVERLAY,
 110     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_OVERLAY,
 111     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
 112     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
 113     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_OVERLAY_AND_EMOJI,
 114     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_OVERLAY_AND_EMOJI,
 115     TEXT_SHADER_MULTI_COLOR_TEXT,
 116     TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
 117     TEXT_SHADER_MULTI_COLOR_TEXT_WITH_OVERLAY,
 118     TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE_AND_OVERLAY,
 119     ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
 120     ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
 121     ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
 122     ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
 123     ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
 124     ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
 125     ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
 126     ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
 127     ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
 128     ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
 129     ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
 130     ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
 131     WIREFRAME_SHADER,
 132     ARC_BUTT_CAP_SHADER,
 133     ARC_ROUND_CAP_SHADER,
 134     SHADER_TYPE_MAX = ARC_ROUND_CAP_SHADER
 135   };
 136
 137   /**
 138    * Type of geometry for caching.
 139    */
 140   enum GeometryType
 141   {
 142     QUAD_GEOMETRY,
 143     BORDER_GEOMETRY,
 144     NINE_PATCH_GEOMETRY,
 145     NINE_PATCH_BORDER_GEOMETRY,
 146     WIREFRAME_GEOMETRY,
 147     GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
 148   };
 149
 150 public:
 151   /**
 152    * @brief Constructor
 153    *
 154    * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
 155    */
 156   VisualFactoryCache(bool preMultiplyOnLoad);
 157
 158   /**
 159    * @brief Destructor
 160    */
 161   ~VisualFactoryCache();
 162
 163   /**
 164    * Request geometry of the given type.
 165    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 166    */
 167   Geometry GetGeometry(GeometryType type);
 168
 169   /**
 170    * Cache the geometry of the give type.
 171    * @param[in] type The geometry type.
 172    * @param[in] geometry The geometry for caching.
 173    */
 174   void SaveGeometry(GeometryType type, Geometry geometry);
 175
 176   /**
 177    * Request shader of the given type.
 178    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 179    */
 180   Shader GetShader(ShaderType type);
 181
 182   /**
 183    * Cache the geometry of the give type.
 184    * @param[in] type The geometry type.
 185    * @param[in] geometry The geometry for caching.
 186    */
 187   void SaveShader(ShaderType type, Shader shader);
 188
 189   /*
 190    * Greate the quad geometry.
 191    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 192    */
 193   static Geometry CreateQuadGeometry();
 194
 195   /**
 196    * Create the grid geometry.
 197    * @param[in] gridSize The size of the grid.
 198    * @return The created grid geometry.
 199    */
 200   static Geometry CreateGridGeometry(Uint16Pair gridSize);
 201
 202   /**
 203    * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
 204    */
 205   void SetPreMultiplyOnLoad(bool preMultiply);
 206
 207   /**
 208    * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
 209    */
 210   bool GetPreMultiplyOnLoad();
 211
 212   /**
 213    * @brief Set an image to be used when a visual has failed to correctly render
 214    * @param[in] brokenImageUrlList The broken image url list
 215    */
 216   void SetBrokenImageUrl(std::string& defaultBrokenUrl, const std::vector<std::string>& brokenImageUrlList);
 217
 218   /**
 219    * @brief Update the broken image Renderer object
 220    * @param[in,out] renderer renderer for broken image
 221    * @param[in] size the size of actor
 222    * @param[in] rendererIsImage True if input renderer use image shader already.
 223    *                            If true, we don't need to create new renderer when broken image is single image.
 224    *                            Most of user experience use normal images. So It can reduce runtime.
 225    */
 226   void UpdateBrokenImageRenderer(Renderer& renderer, const Vector2& size, const bool& rendererIsImage = true);
 227
 228 public:
 229   /**
 230    * Get the image atlas manager.
 231    * @return A pointer to the atlas manager
 232    */
 233   ImageAtlasManagerPtr GetAtlasManager();
 234
 235   /**
 236    * Get the texture manager
 237    * @return A reference to the texture manager
 238    */
 239   TextureManager& GetTextureManager();
 240
 241   /**
 242    * Get the N-Patch texture cache.
 243    * @return A reference to the N patch loader
 244    */
 245   NPatchLoader& GetNPatchLoader();
 246
 247   /**
 248    * Get the SVG rasterization manager.
 249    * @return A raw pointer pointing to the SVG rasterization manager.
 250    */
 251   SvgRasterizeManager* GetSVGRasterizationManager();
 252
 253   /**
 254    * Get the vector animation manager.
 255    * @return A reference to the vector animation manager.
 256    */
 257   VectorAnimationManager& GetVectorAnimationManager();
 258
 259 protected:
 260   /**
 261    * Undefined copy constructor.
 262    */
 263   VisualFactoryCache(const VisualFactoryCache&);
 264
 265   /**
 266    * Undefined assignment operator.
 267    */
 268   VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
 269
 270 private:
 271   /**
 272    * @brief Returns a cached Texture to use when a visual has failed to correctly render
 273    * @param[in] brokenIndex The index of broken image
 274    *
 275    * @return The broken image texture.
 276    */
 277   Texture GetBrokenVisualImage(uint32_t brokenIndex);
 278
 279   /**
 280    * @brief Gets the Proper broken image index
 281    * @param[in] size The size of actor
 282    *
 283    * @return The index of broken image
 284    */
 285   int32_t GetProperBrokenImageIndex(const Vector2& size);
 286
 287   /**
 288    * @brief Apply a texture and uniforms
 289    *
 290    * @param[in,out] renderer The renderer for broken image
 291    * @param[in] index The index of broken image
 292    */
 293   void ApplyTextureAndUniforms(Renderer& renderer, int index);
 294
 295   /**
 296    * @brief Gets a geometry for npatch image
 297    *
 298    * @param[in] index the index of broken image
 299    * @return The Geometry for NPatch
 300    */
 301   Geometry GetNPatchGeometry(int index);
 302
 303   /**
 304    * @brief Gets the Npatch Shader object
 305    *
 306    * @param[in] index The index of broken image
 307    * @return The Shader for NPatch
 308    */
 309   Shader GetNPatchShader(int index);
 310
 311   /**
 312    * @brief Returns a broken image type
 313    * @param[in] index BrokenImage index
 314    * @return The broken image type.
 315    */
 316   VisualUrl::Type GetBrokenImageVisualType(int index);
 317
 318 private:
 319   struct BrokenImageInfo
 320   {
 321     BrokenImageInfo()
 322     : visualType(),
 323       url(""),
 324       npatchId(NPatchData::INVALID_NPATCH_DATA_ID),
 325       texture(),
 326       width(0),
 327       height(0)
 328     {
 329     }
 330
 331     ~BrokenImageInfo()
 332     {
 333     }
 334
 335     // Data
 336     VisualUrl::Type          visualType;
 337     std::string              url;
 338     NPatchData::NPatchDataId npatchId;
 339     Texture                  texture;
 340     uint32_t                 width;
 341     uint32_t                 height;
 342   };
 343
 344   Geometry mGeometry[GEOMETRY_TYPE_MAX + 1];
 345   Shader   mShader[SHADER_TYPE_MAX + 1];
 346
 347   ImageAtlasManagerPtr mAtlasManager;
 348   TextureManager       mTextureManager;
 349   NPatchLoader         mNPatchLoader;
 350
 351   std::unique_ptr<SvgRasterizeManager>    mSvgRasterizeManager;
 352   std::unique_ptr<VectorAnimationManager> mVectorAnimationManager;
 353   bool                                    mPreMultiplyOnLoad;
 354   std::vector<BrokenImageInfo>            mBrokenImageInfoContainer;
 355   std::string                             mDefaultBrokenImageUrl;
 356   bool                                    mUseDefaultBrokenImageOnly;
 357 };
 358
 359 } // namespace Internal
 360
 361 } // namespace Toolkit
 362
 363 } // namespace Dali
 364
 365 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H