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