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) 2017 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/public-api/math/uint-16-pair.h>
  22 #include <dali/public-api/object/ref-object.h>
  23 #include <dali/public-api/rendering/geometry.h>
  24 #include <dali/public-api/rendering/shader.h>
  25 #include <dali/devel-api/common/owner-container.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-toolkit/internal/visuals/animated-vector-image/vector-animation-thread.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41 class ImageAtlasManager;
  42 class NPatchLoader;
  43 class TextureManager;
  44
  45 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
  46
  47
  48 /**
  49  * Caches shaders and geometries. Owned by VisualFactory.
  50  */
  51 class VisualFactoryCache
  52 {
  53 public:
  54
  55   /**
  56    * Type of shader for caching.
  57    */
  58   enum ShaderType
  59   {
  60     COLOR_SHADER,
  61     COLOR_SHADER_ROUNDED_CORNER,
  62     BORDER_SHADER,
  63     BORDER_SHADER_ANTI_ALIASING,
  64     GRADIENT_SHADER_LINEAR_USER_SPACE,
  65     GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
  66     GRADIENT_SHADER_RADIAL_USER_SPACE,
  67     GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
  68     IMAGE_SHADER,
  69     IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
  70     IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
  71     IMAGE_SHADER_ROUNDED_CORNER,
  72     NINE_PATCH_SHADER,
  73     NINE_PATCH_MASK_SHADER,
  74     TEXT_SHADER_MULTI_COLOR_TEXT,
  75     TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE,
  76     TEXT_SHADER_SINGLE_COLOR_TEXT,
  77     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE,
  78     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI,
  79     TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI,
  80     ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REFLECT,
  81     ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_REPEAT,
  82     ANIMATED_GRADIENT_SHADER_LINEAR_BOUNDING_CLAMP,
  83     ANIMATED_GRADIENT_SHADER_LINEAR_USER_REFLECT,
  84     ANIMATED_GRADIENT_SHADER_LINEAR_USER_REPEAT,
  85     ANIMATED_GRADIENT_SHADER_LINEAR_USER_CLAMP,
  86     ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REFLECT,
  87     ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_REPEAT,
  88     ANIMATED_GRADIENT_SHADER_RADIAL_BOUNDING_CLAMP,
  89     ANIMATED_GRADIENT_SHADER_RADIAL_USER_REFLECT,
  90     ANIMATED_GRADIENT_SHADER_RADIAL_USER_REPEAT,
  91     ANIMATED_GRADIENT_SHADER_RADIAL_USER_CLAMP,
  92     WIREFRAME_SHADER,
  93     ARC_BUTT_CAP_SHADER,
  94     ARC_ROUND_CAP_SHADER,
  95     SHADER_TYPE_MAX = ARC_ROUND_CAP_SHADER
  96   };
  97
  98   /**
  99    * Type of geometry for caching.
 100    */
 101   enum GeometryType
 102   {
 103     QUAD_GEOMETRY,
 104     BORDER_GEOMETRY,
 105     NINE_PATCH_GEOMETRY,
 106     NINE_PATCH_BORDER_GEOMETRY,
 107     WIREFRAME_GEOMETRY,
 108     GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
 109   };
 110
 111 public:
 112
 113   /**
 114    * @brief Constructor
 115    *
 116    * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
 117    */
 118   VisualFactoryCache( bool preMultiplyOnLoad );
 119
 120   /**
 121    * @brief Destructor
 122    */
 123   ~VisualFactoryCache();
 124
 125   /**
 126    * Request geometry of the given type.
 127    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 128    */
 129   Geometry GetGeometry( GeometryType type );
 130
 131   /**
 132    * Cache the geometry of the give type.
 133    * @param[in] type The geometry type.
 134    * @param[in] geometry The geometry for caching.
 135    */
 136   void SaveGeometry( GeometryType type, Geometry geometry);
 137
 138   /**
 139    * Request shader of the given type.
 140    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 141    */
 142   Shader GetShader( ShaderType type );
 143
 144   /**
 145    * Cache the geometry of the give type.
 146    * @param[in] type The geometry type.
 147    * @param[in] geometry The geometry for caching.
 148    */
 149   void SaveShader( ShaderType type, Shader shader );
 150
 151   /*
 152    * Greate the quad geometry.
 153    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 154    */
 155   static Geometry CreateQuadGeometry();
 156
 157   /**
 158    * Create the grid geometry.
 159    * @param[in] gridSize The size of the grid.
 160    * @return The created grid geometry.
 161    */
 162   static Geometry CreateGridGeometry( Uint16Pair gridSize );
 163
 164   /**
 165    * @brief Returns an image to be used when a visual has failed to correctly render
 166    * @return The broken image handle.
 167    */
 168   Image GetBrokenVisualImage();
 169
 170   /**
 171    * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
 172    */
 173   void SetPreMultiplyOnLoad( bool preMultiply );
 174
 175   /**
 176    * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
 177    */
 178   bool GetPreMultiplyOnLoad();
 179
 180   /**
 181    * @brief Set an image to be used when a visual has failed to correctly render
 182    * @param[in] brokenImageUrl The broken image url.
 183    */
 184   void SetBrokenImageUrl(const std::string& brokenImageUrl);
 185
 186 public:
 187   /**
 188    * Get the image atlas manager.
 189    * @return A pointer to the atlas manager
 190    */
 191   ImageAtlasManagerPtr GetAtlasManager();
 192
 193   /**
 194    * Get the texture manager
 195    * @return A reference to the texture manager
 196    */
 197   TextureManager& GetTextureManager();
 198
 199   /**
 200    * Get the N-Patch texture cache.
 201    * @return A reference to the N patch loader
 202    */
 203   NPatchLoader& GetNPatchLoader();
 204
 205   /**
 206    * Get the SVG rasterization thread.
 207    * @return A raw pointer pointing to the SVG rasterization thread.
 208    */
 209   SvgRasterizeThread* GetSVGRasterizationThread();
 210
 211   /**
 212    * Get the vector animation thread.
 213    * @return A raw pointer pointing to the vector animation thread.
 214    */
 215   VectorAnimationThread& GetVectorAnimationThread();
 216
 217 private: // for svg rasterization thread
 218
 219   /**
 220    * Applies the rasterized image to material
 221    */
 222   void ApplyRasterizedSVGToSampler();
 223
 224 protected:
 225
 226   /**
 227    * Undefined copy constructor.
 228    */
 229   VisualFactoryCache(const VisualFactoryCache&);
 230
 231   /**
 232    * Undefined assignment operator.
 233    */
 234   VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
 235
 236 private:
 237   Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
 238   Shader mShader[SHADER_TYPE_MAX+1];
 239
 240   ImageAtlasManagerPtr                     mAtlasManager;
 241   TextureManager                           mTextureManager;
 242   NPatchLoader                             mNPatchLoader;
 243   SvgRasterizeThread*                      mSvgRasterizeThread;
 244   std::unique_ptr< VectorAnimationThread > mVectorAnimationThread;
 245   std::string                              mBrokenImageUrl;
 246   bool                                     mPreMultiplyOnLoad;
 247 };
 248
 249 } // namespace Internal
 250
 251 } // namespace Toolkit
 252
 253 } // namespace Dali
 254
 255 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H