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     SHADER_TYPE_MAX = WIREFRAME_SHADER
  94   };
  95
  96   /**
  97    * Type of geometry for caching.
  98    */
  99   enum GeometryType
 100   {
 101     QUAD_GEOMETRY,
 102     BORDER_GEOMETRY,
 103     NINE_PATCH_GEOMETRY,
 104     NINE_PATCH_BORDER_GEOMETRY,
 105     WIREFRAME_GEOMETRY,
 106     GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
 107   };
 108
 109 public:
 110
 111   /**
 112    * @brief Constructor
 113    *
 114    * @param[in] preMultiplyOnLoad True if image visuals should pre-multiply alpha on image load.
 115    */
 116   VisualFactoryCache( bool preMultiplyOnLoad );
 117
 118   /**
 119    * @brief Destructor
 120    */
 121   ~VisualFactoryCache();
 122
 123   /**
 124    * Request geometry of the given type.
 125    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 126    */
 127   Geometry GetGeometry( GeometryType type );
 128
 129   /**
 130    * Cache the geometry of the give type.
 131    * @param[in] type The geometry type.
 132    * @param[in] geometry The geometry for caching.
 133    */
 134   void SaveGeometry( GeometryType type, Geometry geometry);
 135
 136   /**
 137    * Request shader of the given type.
 138    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 139    */
 140   Shader GetShader( ShaderType type );
 141
 142   /**
 143    * Cache the geometry of the give type.
 144    * @param[in] type The geometry type.
 145    * @param[in] geometry The geometry for caching.
 146    */
 147   void SaveShader( ShaderType type, Shader shader );
 148
 149   /*
 150    * Greate the quad geometry.
 151    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 152    */
 153   static Geometry CreateQuadGeometry();
 154
 155   /**
 156    * Create the grid geometry.
 157    * @param[in] gridSize The size of the grid.
 158    * @return The created grid geometry.
 159    */
 160   static Geometry CreateGridGeometry( Uint16Pair gridSize );
 161
 162   /**
 163    * @brief Returns an image to be used when a visual has failed to correctly render
 164    * @return The broken image handle.
 165    */
 166   Image GetBrokenVisualImage();
 167
 168   /**
 169    * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
 170    */
 171   void SetPreMultiplyOnLoad( bool preMultiply );
 172
 173   /**
 174    * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
 175    */
 176   bool GetPreMultiplyOnLoad();
 177
 178   /**
 179    * @brief Set an image to be used when a visual has failed to correctly render
 180    * @param[in] brokenImageUrl The broken image url.
 181    */
 182   void SetBrokenImageUrl(const std::string& brokenImageUrl);
 183
 184 public:
 185   /**
 186    * Get the image atlas manager.
 187    * @return A pointer to the atlas manager
 188    */
 189   ImageAtlasManagerPtr GetAtlasManager();
 190
 191   /**
 192    * Get the texture manager
 193    * @return A reference to the texture manager
 194    */
 195   TextureManager& GetTextureManager();
 196
 197   /**
 198    * Get the N-Patch texture cache.
 199    * @return A reference to the N patch loader
 200    */
 201   NPatchLoader& GetNPatchLoader();
 202
 203   /**
 204    * Get the SVG rasterization thread.
 205    * @return A raw pointer pointing to the SVG rasterization thread.
 206    */
 207   SvgRasterizeThread* GetSVGRasterizationThread();
 208
 209   /**
 210    * Get the vector animation thread.
 211    * @return A raw pointer pointing to the vector animation thread.
 212    */
 213   VectorAnimationThread& GetVectorAnimationThread();
 214
 215 private: // for svg rasterization thread
 216
 217   /**
 218    * Applies the rasterized image to material
 219    */
 220   void ApplyRasterizedSVGToSampler();
 221
 222 protected:
 223
 224   /**
 225    * Undefined copy constructor.
 226    */
 227   VisualFactoryCache(const VisualFactoryCache&);
 228
 229   /**
 230    * Undefined assignment operator.
 231    */
 232   VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
 233
 234 private:
 235   Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
 236   Shader mShader[SHADER_TYPE_MAX+1];
 237
 238   ImageAtlasManagerPtr                     mAtlasManager;
 239   TextureManager                           mTextureManager;
 240   NPatchLoader                             mNPatchLoader;
 241   SvgRasterizeThread*                      mSvgRasterizeThread;
 242   std::unique_ptr< VectorAnimationThread > mVectorAnimationThread;
 243   std::string                              mBrokenImageUrl;
 244   bool                                     mPreMultiplyOnLoad;
 245 };
 246
 247 } // namespace Internal
 248
 249 } // namespace Toolkit
 250
 251 } // namespace Dali
 252
 253 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H