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