1 #ifndef DALI_INTERNAL_SCENE_GRAPH_UNIFORM_MAP_H
2 #define DALI_INTERNAL_SCENE_GRAPH_UNIFORM_MAP_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include <cstdint> // uint32_t
25 #include <dali/devel-api/common/hash.h>
26 #include <dali/devel-api/common/owner-container.h>
27 #include <dali/internal/common/const-string.h>
33 class PropertyInputImpl;
38 * The uniform map is used to map a uniform name to a property value.
40 class UniformPropertyMapping
46 UniformPropertyMapping(ConstString theUniformName, const PropertyInputImpl* thePropertyPtr)
47 : propertyPtr(thePropertyPtr),
48 uniformName(theUniformName)
52 UniformPropertyMapping() = default;
54 const PropertyInputImpl* propertyPtr{nullptr};
55 ConstString uniformName;
59 * The UniformMap class is used to map uniform names to property values. It is available
60 * in all of the classes responsible for rendering:
61 * Actor, Renderer, Geometry, TextureSet, Shader.
63 * It can be observed for changes to the mapping table.
68 using SizeType = uint32_t;
74 * Inform observer that uniform mappings have been changed
77 virtual void UniformMappingsChanged(const UniformMap& mappings) = 0;
81 * Virtual destructor, no deletion through this interface
83 virtual ~Observer() = default;
87 * Add an observer that watches for changes in the mappings
89 void AddObserver(Observer& observer);
94 void RemoveObserver(Observer& observer);
97 * Add a map to the mappings table.
99 void Add(UniformPropertyMapping map);
102 * Remove a map from the mappings table
104 void Remove(ConstString uniformName);
107 * Find a property given the uniform name.
108 * @return The address of the property if it's in the map, or NULL otherwise.
110 const PropertyInputImpl* Find(ConstString uniformName);
113 * Get the count of uniforms in the map
114 * @return The number of uniform mappings
116 SizeType Count() const;
119 * @pre index must be in the range 0 :: Count()-1
120 * @param[in] index The index of the element to fetch
121 * @return reference to the element in the map
123 const UniformPropertyMapping& operator[](SizeType index) const;
127 * Helper to call the observers when the mappings have changed
129 void MappingChanged();
132 using UniformMapContainer = Dali::Vector<UniformPropertyMapping>;
133 using UniformMapIter = UniformMapContainer::Iterator;
134 using Observers = Dali::Vector<Observer*>;
135 using ObserversIter = Observers::Iterator;
137 UniformMapContainer mUniformMaps; // Owner container of uniform maps
139 Observers mObservers;
142 } // namespace SceneGraph
143 } // namespace Internal
146 #endif // DALI_INTERNAL_SCENE_GRAPH_UNIFORM_MAP_H