dali-toolkit/internal/controls/renderers/renderer-factory-cache.h

   1 #ifndef __DALI_TOOLKIT_RENDERER_FACTORY_CACHE_H__
   2 #define __DALI_TOOLKIT_RENDERER_FACTORY_CACHE_H__
   3
   4 /*
   5  * Copyright (c) 2015 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/object/ref-object.h>
  22 #include <dali/devel-api/rendering/geometry.h>
  23 #include <dali/devel-api/rendering/shader.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Toolkit
  29 {
  30
  31 namespace Internal
  32 {
  33
  34 /**
  35  * Caches shaders and geometries. Owned by RenderFactory.
  36  */
  37 class RendererFactoryCache : public RefObject
  38 {
  39 public:
  40
  41   /**
  42    * Type of shader for caching.
  43    */
  44   enum ShaderType
  45   {
  46     COLOR_SHADER,
  47     BORDER_SHADER,
  48     GRADIENT_SHADER_LINEAR,
  49     GRADIENT_SHADER_RADIAL,
  50     IMAGE_SHADER,
  51     NINE_PATCH_SHADER,
  52     SVG_SHADER,
  53     SHADER_TYPE_MAX = SVG_SHADER
  54   };
  55
  56   /**
  57    * Type of geometry for caching.
  58    */
  59   enum GeometryType
  60   {
  61     QUAD_GEOMETRY,
  62     BORDER_GEOMETRY,
  63     NINE_PATCH_GEOMETRY,
  64     NINE_PATCH_BORDER_GEOMETRY,
  65     GEOMETRY_TYPE_MAX = NINE_PATCH_BORDER_GEOMETRY
  66   };
  67
  68 public:
  69
  70   /**
  71    * @brief Constructor
  72    */
  73   RendererFactoryCache();
  74
  75   /**
  76    * Request geometry of the given type.
  77    * @return The geometry of the required type if it exist in the cache. Otherwise, an empty handle is returned.
  78    */
  79   Geometry GetGeometry( GeometryType type );
  80
  81   /**
  82    * Cache the geometry of the give type.
  83    * @param[in] type The geometry type.
  84    * @param[in] geometry The geometry for caching.
  85    */
  86   void SaveGeometry( GeometryType type, Geometry geometry);
  87
  88   /**
  89    * Request shader of the given type.
  90    * @return The shader of the required type if it exist in the cache. Otherwise, an empty handle is returned.
  91    */
  92   Shader GetShader( ShaderType type );
  93
  94   /**
  95    * Cache the geometry of the give type.
  96    * @param[in] type The geometry type.
  97    * @param[in] geometry The geometry for caching.
  98    */
  99   void SaveShader( ShaderType type, Shader shader );
 100
 101   /*
 102    * Greate the quad geometry.
 103    * Quad geometry is shared by multiple kind of Renderer, so implement it in the factory-cache.
 104    */
 105   static Geometry CreateQuadGeometry();
 106
 107 protected:
 108
 109   /**
 110    * A reference counted object may only be deleted by calling Unreference()
 111    */
 112   virtual ~RendererFactoryCache();
 113
 114   /**
 115    * Undefined copy constructor.
 116    */
 117   RendererFactoryCache(const RendererFactoryCache&);
 118
 119   /**
 120    * Undefined assignment operator.
 121    */
 122   RendererFactoryCache& operator=(const RendererFactoryCache& rhs);
 123
 124 private:
 125
 126   // ToDo: test whether using the WeakHandle could improve the performance
 127   //       With WeakHandle, the resource would be released automatically when no control is using it
 128
 129   Geometry mGeometry[GEOMETRY_TYPE_MAX+1];
 130   Shader mShader[SHADER_TYPE_MAX+1];
 131 };
 132
 133 } // namespace Internal
 134
 135 } // namespace Toolkit
 136
 137 } // namespace Dali
 138
 139 #endif /*__DALI_TOOLKIT_RENDERER_FACTORY_CACHE_H__ */