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 #include <dali/devel-api/object/weak-handle.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/internal/visuals/npatch-loader.h>
  30 #include <dali-toolkit/internal/visuals/svg/svg-rasterize-thread.h>
  31 #include <dali-toolkit/internal/visuals/texture-manager-impl.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 : public RefObject
  52 {
  53 public:
  54
  55   /**
  56    * Type of shader for caching.
  57    */
  58   enum ShaderType
  59   {
  60     COLOR_SHADER,
  61     BORDER_SHADER,
  62     BORDER_SHADER_ANTI_ALIASING,
  63     GRADIENT_SHADER_LINEAR_USER_SPACE,
  64     GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
  65     GRADIENT_SHADER_RADIAL_USER_SPACE,
  66     GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
  67     IMAGE_SHADER,
  68     IMAGE_SHADER_ATLAS_DEFAULT_WRAP,
  69     IMAGE_SHADER_ATLAS_CUSTOM_WRAP,
  70     NINE_PATCH_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     WIREFRAME_SHADER,
  79     SHADER_TYPE_MAX = WIREFRAME_SHADER
  80   };
  81
  82   /**
  83    * Type of geometry for caching.
  84    */
  85   enum GeometryType
  86   {
  87     QUAD_GEOMETRY,
  88     BORDER_GEOMETRY,
  89     NINE_PATCH_GEOMETRY,
  90     NINE_PATCH_BORDER_GEOMETRY,
  91     WIREFRAME_GEOMETRY,
  92     GEOMETRY_TYPE_MAX = WIREFRAME_GEOMETRY
  93   };
  94
  95 public:
  96
  97   /**
  98    * @brief Constructor
  99    */
 100   VisualFactoryCache();
 101
 102   /**
 103    * Request geometry of the given type.
 104    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 105    */
 106   Geometry GetGeometry( GeometryType type );
 107
 108   /**
 109    * Cache the geometry of the give type.
 110    * @param[in] type The geometry type.
 111    * @param[in] geometry The geometry for caching.
 112    */
 113   void SaveGeometry( GeometryType type, Geometry geometry);
 114
 115   /**
 116    * Request shader of the given type.
 117    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
 118    */
 119   Shader GetShader( ShaderType type );
 120
 121   /**
 122    * Cache the geometry of the give type.
 123    * @param[in] type The geometry type.
 124    * @param[in] geometry The geometry for caching.
 125    */
 126   void SaveShader( ShaderType type, Shader shader );
 127
 128   /*
 129    * Greate the quad geometry.
 130    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 131    */
 132   static Geometry CreateQuadGeometry();
 133
 134   /**
 135    * Create the grid geometry.
 136    * @param[in] gridSize The size of the grid.
 137    * @return The created grid geometry.
 138    */
 139   static Geometry CreateGridGeometry( Uint16Pair gridSize );
 140
 141   /**
 142    * @brief Returns an image to be used when a visual has failed to correctly render
 143    * @return The broken image handle.
 144    */
 145   static Image GetBrokenVisualImage();
 146
 147 public:
 148   /**
 149    * Get the image atlas manager.
 150    * @return A pointer to the atlas manager
 151    */
 152   ImageAtlasManagerPtr GetAtlasManager();
 153
 154   /**
 155    * Get the texture manager
 156    * @return A reference to the texture manager
 157    */
 158   TextureManager& GetTextureManager();
 159
 160   /**
 161    * Get the N-Patch texture cache.
 162    * @return A reference to the N patch loader
 163    */
 164   NPatchLoader& GetNPatchLoader();
 165
 166   /**
 167    * Get the SVG rasterization thread.
 168    * @return A raw pointer pointing to the SVG rasterization thread.
 169    */
 170   SvgRasterizeThread* GetSVGRasterizationThread();
 171
 172 private: // for svg rasterization thread
 173
 174   /**
 175    * Applies the rasterized image to material
 176    */
 177   void ApplyRasterizedSVGToSampler();
 178
 179 protected:
 180
 181   /**
 182    * A reference counted object may only be deleted by calling Unreference()
 183    */
 184   virtual ~VisualFactoryCache();
 185
 186   /**
 187    * Undefined copy constructor.
 188    */
 189   VisualFactoryCache(const VisualFactoryCache&);
 190
 191   /**
 192    * Undefined assignment operator.
 193    */
 194   VisualFactoryCache& operator=(const VisualFactoryCache& rhs);
 195
 196 private:
 197   Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
 198   Shader mShader[SHADER_TYPE_MAX+1];
 199
 200   ImageAtlasManagerPtr mAtlasManager;
 201   TextureManager       mTextureManager;
 202   NPatchLoader         mNPatchLoader;
 203   SvgRasterizeThread*  mSvgRasterizeThread;
 204 };
 205
 206 } // namespace Internal
 207
 208 } // namespace Toolkit
 209
 210 } // namespace Dali
 211
 212 #endif // DALI_TOOLKIT_VISUAL_FACTORY_CACHE_H