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