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