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   VisualFactoryCache();
 113
 114   /**
 115    * Request geometry of the given type.
 116    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 117    */
 118   Geometry GetGeometry( GeometryType type );
 119
 120   /**
 121    * Cache the geometry of the give type.
 122    * @param[in] type The geometry type.
 123    * @param[in] geometry The geometry for caching.
 124    */
 125   void SaveGeometry( GeometryType type, Geometry geometry);
 126
 127   /**
 128    * Request shader of the given type.
 129    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 130    */
 131   Shader GetShader( ShaderType type );
 132
 133   /**
 134    * Cache the geometry of the give type.
 135    * @param[in] type The geometry type.
 136    * @param[in] geometry The geometry for caching.
 137    */
 138   void SaveShader( ShaderType type, Shader shader );
 139
 140   /*
 141    * Greate the quad geometry.
 142    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 143    */
 144   static Geometry CreateQuadGeometry();
 145
 146   /**
 147    * Create the grid geometry.
 148    * @param[in] gridSize The size of the grid.
 149    * @return The created grid geometry.
 150    */
 151   static Geometry CreateGridGeometry( Uint16Pair gridSize );
 152
 153   /**
 154    * @brief Returns an image to be used when a visual has failed to correctly render
 155    * @return The broken image handle.
 156    */
 157   static Image GetBrokenVisualImage();
 158
 159 public:
 160   /**
 161    * Get the image atlas manager.
 162    * @return A pointer to the atlas manager
 163    */
 164   ImageAtlasManagerPtr GetAtlasManager();
 165
 166   /**
 167    * Get the texture manager
 168    * @return A reference to the texture manager
 169    */
 170   TextureManager& GetTextureManager();
 171
 172   /**
 173    * Get the N-Patch texture cache.
 174    * @return A reference to the N patch loader
 175    */
 176   NPatchLoader& GetNPatchLoader();
 177
 178   /**
 179    * Get the SVG rasterization thread.
 180    * @return A raw pointer pointing to the SVG rasterization thread.
 181    */
 182   SvgRasterizeThread* GetSVGRasterizationThread();
 183
 184 private: // for svg rasterization thread
 185
 186   /**
 187    * Applies the rasterized image to material
 188    */
 189   void ApplyRasterizedSVGToSampler();
 190
 191 protected:
 192
 193   /**
 194    * A reference counted object may only be deleted by calling Unreference()
 195    */
 196   virtual ~VisualFactoryCache();
 197
 198   /**
 199    * Undefined copy constructor.
 200    */
 201   VisualFactoryCache(const VisualFactoryCache&);
 202
 203   /**
 204    * Undefined assignment operator.
 205    */
 206   VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
 207
 208 private:
 209   Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
 210   Shader mShader[SHADER_TYPE_MAX+1];
 211
 212   ImageAtlasManagerPtr mAtlasManager;
 213   TextureManager       mTextureManager;
 214   NPatchLoader         mNPatchLoader;
 215   SvgRasterizeThread*  mSvgRasterizeThread;
 216 };
 217
 218 } // namespace Internal
 219
 220 } // namespace Toolkit
 221
 222 } // namespace Dali
 223
 224 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H