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