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