dali/internal/render/data-providers/uniform-map-data-provider.h

   1 #ifndef DALI_INTERNAL_SCENE_GRAPH_UNIFORM_MAP_DATA_PROVIDER_H
   2 #define DALI_INTERNAL_SCENE_GRAPH_UNIFORM_MAP_DATA_PROVIDER_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 #include <dali/public-api/common/dali-vector.h>
  20 #include <dali/integration-api/resource-declarations.h>
  21 #include <dali/internal/common/buffer-index.h>
  22
  23 namespace Dali
  24 {
  25 namespace Internal
  26 {
  27 namespace SceneGraph
  28 {
  29 class UniformMap;
  30 class UniformPropertyMapping;
  31
  32 typedef Dali::Vector< const UniformPropertyMapping* > CollectedUniformMap;
  33
  34 /**
  35  * This class maps uniform names to property value pointers.
  36  */
  37 class UniformMapDataProvider
  38 {
  39 public:
  40   /**
  41    * Constructor
  42    */
  43   UniformMapDataProvider()
  44   {
  45   }
  46
  47   /**
  48    * Return true if the uniform map has been changed this frame
  49    * Note, this only informs if the uniform mappings have changed,
  50    * not if any actual property value has changed.
  51    *
  52    * @param[in] bufferIndex The buffer index
  53    * @return true if the uniform map has changed
  54    */
  55   virtual bool GetUniformMapChanged( BufferIndex bufferIndex ) const = 0;
  56
  57   /**
  58    * Get the complete map of uniforms to property value addresses
  59    * (The map is double buffered - it can be retrieved through this interface)
  60    *
  61    * @param[in] bufferIndex The bufferIndex
  62    * @return the uniform map
  63    */
  64   virtual const CollectedUniformMap& GetUniformMap( BufferIndex bufferIndex ) const = 0;
  65
  66 protected:
  67   /**
  68    * No deletion through this interface
  69    */
  70   virtual ~UniformMapDataProvider()
  71   {
  72   }
  73 };
  74
  75 } // namespace SceneGraph
  76 } // namespace Internal
  77 } // namespace Dali
  78
  79 #endif // DALI_INTERNAL_SCENE_GRAPH_UNIFORM_MAP_DATA_PROVIDER_H