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