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