1 #ifndef DALI_INTERNAL_SCENE_GRAPH_UNIFORM_MAP_H
2 #define DALI_INTERNAL_SCENE_GRAPH_UNIFORM_MAP_H
5 * Copyright (c) 2022 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
43 using Hash = unsigned long;
48 UniformPropertyMapping(ConstString theUniformName, const PropertyInputImpl* thePropertyPtr)
49 : propertyPtr(thePropertyPtr),
50 uniformName(theUniformName),
52 uniformNameHashNoArray(0u),
55 // Look for array index closing bracket
56 auto nameStringView = theUniformName.GetStringView();
57 auto pos = nameStringView.rfind("]");
59 // If found, extract the array index and store it, if it's an element in an array of basic types.
60 if(pos != std::string::npos)
62 auto pos0 = theUniformName.GetStringView().rfind("[", pos);
63 if(pos == nameStringView.length() - 1) // if element is in struct, don't set array index.
65 arrayIndex = atoi(theUniformName.GetCString() + pos0 + 1);
67 // Calculate hash from name without array index
68 uniformNameHashNoArray = Dali::CalculateHash(theUniformName.GetStringView().substr(0, pos0).data(), '[');
70 uniformName = theUniformName;
71 uniformNameHash = Dali::CalculateHash(theUniformName.GetCString());
74 UniformPropertyMapping() = default;
76 const PropertyInputImpl* propertyPtr{nullptr};
77 ConstString uniformName{};
78 Hash uniformNameHash{0u};
79 Hash uniformNameHashNoArray{0u};
80 int32_t arrayIndex{0u};
84 * The UniformMap class is used to map uniform names to property values. It is available
85 * in all of the classes responsible for rendering:
86 * Actor, Renderer, Geometry, TextureSet, Shader.
88 * It can be observed for changes to the mapping table.
93 using SizeType = uint32_t;
99 * Inform observer that uniform mappings have been changed
102 virtual void UniformMappingsChanged(const UniformMap& mappings) = 0;
106 * Virtual destructor, no deletion through this interface
108 virtual ~Observer() = default;
112 * Add an observer that watches for changes in the mappings
114 void AddObserver(Observer& observer);
119 void RemoveObserver(Observer& observer);
122 * Add a map to the mappings table.
124 void Add(UniformPropertyMapping map);
127 * Remove a map from the mappings table
129 void Remove(ConstString uniformName);
132 * Find a property given the uniform name.
133 * @return The address of the property if it's in the map, or NULL otherwise.
135 const PropertyInputImpl* Find(ConstString uniformName);
138 * Get the count of uniforms in the map
139 * @return The number of uniform mappings
141 SizeType Count() const;
144 * @pre index must be in the range 0 :: Count()-1
145 * @param[in] index The index of the element to fetch
146 * @return reference to the element in the map
148 const UniformPropertyMapping& operator[](SizeType index) const;
152 * Helper to call the observers when the mappings have changed
154 void MappingChanged();
157 using UniformMapContainer = Dali::Vector<UniformPropertyMapping>;
158 using UniformMapIter = UniformMapContainer::Iterator;
159 using Observers = Dali::Vector<Observer*>;
160 using ObserversIter = Observers::Iterator;
162 UniformMapContainer mUniformMaps; // Owner container of uniform maps
164 Observers mObservers;
167 } // namespace SceneGraph
168 } // namespace Internal
171 #endif // DALI_INTERNAL_SCENE_GRAPH_UNIFORM_MAP_H