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