birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Generalize comments pertaining to light data and consolidate inline

Browse Source 
header

Signed-off-by: Jeremy Ong <jcong@amazon.com>
This commit is contained in:
Jeremy Ong
2021-07-28 12:30:06 -06:00
parent bb782e83b4
commit e1ce742f14
3 changed files with 120 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Gems/Atom/Feature/Common/Code/Include/Atom/Feature/Utils/IndexedDataVector.h
+120 -8
View File
@@ -15,11 +15,15 @@ namespace AZ
{
namespace Render
{
// Growable vector that leverages indirection to support erasure of elements while maintaining
// resident data in a densely packed region of memory. Useful as a backing store for growable
// buffers intended to be uploaded to the GPU for example.
template <typename DataType, typename IndexType = uint16_t>
class IndexedDataVector
{
public:
IndexedDataVector();
explicit IndexedDataVector(size_t initialReservedSize);
~IndexedDataVector() = default;
static constexpr IndexType NoFreeSlot = std::numeric_limits<IndexType>::max();
@@ -39,17 +43,125 @@ namespace AZ
IndexType GetRawIndex(IndexType index) const;
private:
constexpr static size_t InitialReservedSize = 128;
static constexpr size_t InitialReservedCount = 128;
// stores the index of data vector for respective light, it also include a linked list to flag the free slots
// Stores data indices and an embedded free list
AZStd::vector<IndexType> m_indices;
// stores the index of index vector for respective light
// Stores the indirection index
AZStd::vector<IndexType> m_dataToIndices;
// stores light data
AZStd::vector<DataType> m_data;
};
#include "IndexedDataVector.inl"
}
}
template<typename DataType, typename IndexType>
inline IndexedDataVector<DataType, IndexType>::IndexedDataVector()
: IndexedDataVector(InitialReservedSize)
{
}
template<typename DataType, typename IndexType>
inline IndexedDataVector<DataType, IndexType>::IndexedDataVector(size_t initialReservedSize)
{
m_dataToIndices.reserve(initialReservedSize);
m_indices.reserve(initialReservedSize);
m_data.reserve(initialReservedSize);
}
template<typename DataType, typename IndexType>
inline void IndexedDataVector<DataType, IndexType>::Clear()
{
m_dataToIndices.clear();
m_indices.clear();
m_data.clear();
m_firstFreeSlot = NoFreeSlot;
}
template<typename DataType, typename IndexType>
inline IndexType IndexedDataVector<DataType, IndexType>::GetFreeSlotIndex()
{
IndexType freeSlotIndex = static_cast<IndexType>(m_indices.size());
if (freeSlotIndex == NoFreeSlot)
{
// the vector is full
return NoFreeSlot;
}
if (m_firstFreeSlot == NoFreeSlot)
{
// If there's no free slot, add on to the end.
m_indices.push_back(freeSlotIndex);
}
else
{
// Fill the free slot. m_indices uses it's empty slots to store a linked list (via indices) to other empty slots.
freeSlotIndex = m_firstFreeSlot;
m_firstFreeSlot = m_indices.at(m_firstFreeSlot);
m_indices.at(freeSlotIndex) = static_cast<IndexType>(m_data.size());
}
// The data itself is always packed and m_indices points at it, so push a new entry to the back.
m_data.push_back(DataType());
m_dataToIndices.push_back(freeSlotIndex);
return freeSlotIndex;
}
template<typename DataType, typename IndexType>
inline void IndexedDataVector<DataType, IndexType>::RemoveIndex(IndexType index)
{
IndexType dataIndex = m_indices.at(index);
// Copy the back light on top of this one.
m_data.at(dataIndex) = m_data.back();
m_dataToIndices.at(dataIndex) = m_dataToIndices.back();
// Update the index of the moved light
m_indices.at(m_dataToIndices.at(dataIndex)) = dataIndex;
// Pop the back
m_data.pop_back();
m_dataToIndices.pop_back();
// Use free slot to link to next free slot
m_indices.at(index) = m_firstFreeSlot;
m_firstFreeSlot = index;
}
template<typename DataType, typename IndexType>
inline DataType& IndexedDataVector<DataType, IndexType>::GetData(IndexType index)
{
return m_data.at(m_indices.at(index));
}
template<typename DataType, typename IndexType>
inline const DataType& IndexedDataVector<DataType, IndexType>::GetData(IndexType index) const
{
return m_data.at(m_indices.at(index));
}
template<typename DataType, typename IndexType>
inline size_t IndexedDataVector<DataType, IndexType>::GetDataCount() const
{
return m_data.size();
}
template<typename DataType, typename IndexType>
inline AZStd::vector<DataType>& IndexedDataVector<DataType, IndexType>::GetDataVector()
{
return m_data;
}
template<typename DataType, typename IndexType>
inline const AZStd::vector<DataType>& IndexedDataVector<DataType, IndexType>::GetDataVector() const
{
return m_data;
}
template<typename DataType, typename IndexType>
IndexType IndexedDataVector<DataType, IndexType>::GetRawIndex(IndexType index) const
{
return m_indices.at(index);
}
} // namespace Render
} // namespace AZ
Gems/Atom/Feature/Common/Code/Include/Atom/Feature/Utils/IndexedDataVector.inl
-113
View File
@@ -1,113 +0,0 @@
/*
* Copyright (c) Contributors to the Open 3D Engine Project.
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
*
* SPDX-License-Identifier: Apache-2.0 OR MIT
*
*/
template<typename DataType, typename IndexType>
inline IndexedDataVector<DataType,IndexType>::IndexedDataVector()
{
m_dataToIndices.reserve(InitialReservedCount);
m_indices.reserve(InitialReservedCount);
m_data.reserve(InitialReservedCount);
}
template<typename DataType, typename IndexType>
inline void IndexedDataVector<DataType, IndexType>::Clear()
{
m_dataToIndices.clear();
m_indices.clear();
m_data.clear();
m_firstFreeSlot = NoFreeSlot;
}
template<typename DataType, typename IndexType>
inline IndexType IndexedDataVector<DataType, IndexType>::GetFreeSlotIndex()
{
IndexType freeSlotIndex = static_cast<IndexType>(m_indices.size());
if (freeSlotIndex == NoFreeSlot)
{
// the vector is full
return NoFreeSlot;
}
if (m_firstFreeSlot == NoFreeSlot)
{
// If there's no free slot, add on to the end.
m_indices.push_back(freeSlotIndex);
}
else
{
// Fill the free slot. m_indices uses it's empty slots to store a linked list (via indices) to other empty slots.
freeSlotIndex = m_firstFreeSlot;
m_firstFreeSlot = m_indices.at(m_firstFreeSlot);
m_indices.at(freeSlotIndex) = static_cast<IndexType>(m_data.size());
}
// The data itself is always packed and m_indices points at it, so push a new entry to the back.
m_data.push_back(DataType());
m_dataToIndices.push_back(freeSlotIndex);
return freeSlotIndex;
}
template<typename DataType, typename IndexType>
inline void IndexedDataVector<DataType, IndexType>::RemoveIndex(IndexType index)
{
IndexType dataIndex = m_indices.at(index);
// Copy the back light on top of this one.
m_data.at(dataIndex) = m_data.back();
m_dataToIndices.at(dataIndex) = m_dataToIndices.back();
// Update the index of the moved light
m_indices.at(m_dataToIndices.at(dataIndex)) = dataIndex;
// Pop the back
m_data.pop_back();
m_dataToIndices.pop_back();
// Use free slot to link to next free slot
m_indices.at(index) = m_firstFreeSlot;
m_firstFreeSlot = index;
}
template<typename DataType, typename IndexType>
inline DataType& IndexedDataVector<DataType, IndexType>::GetData(IndexType index)
{
return m_data.at(m_indices.at(index));
}
template<typename DataType, typename IndexType>
inline const DataType& IndexedDataVector<DataType, IndexType>::GetData(IndexType index) const
{
return m_data.at(m_indices.at(index));
}
template<typename DataType, typename IndexType>
inline size_t IndexedDataVector<DataType, IndexType>::GetDataCount() const
{
return m_data.size();
}
template<typename DataType, typename IndexType>
inline AZStd::vector<DataType>& IndexedDataVector<DataType, IndexType>::GetDataVector()
{
return m_data;
}
template<typename DataType, typename IndexType>
inline const AZStd::vector<DataType>& IndexedDataVector<DataType, IndexType>::GetDataVector() const
{
return m_data;
}
template <typename DataType, typename IndexType>
IndexType IndexedDataVector<DataType, IndexType>::GetRawIndex(IndexType index) const
{
return m_indices.at(index);
}
Gems/Atom/Feature/Common/Code/atom_feature_common_files.cmake
-1
View File
@@ -38,7 +38,6 @@ set(FILES
Include/Atom/Feature/Utils/FrameCaptureBus.h
Include/Atom/Feature/Utils/GpuBufferHandler.h
Include/Atom/Feature/Utils/IndexedDataVector.h
Include/Atom/Feature/Utils/IndexedDataVector.inl
Include/Atom/Feature/Utils/MultiIndexedDataVector.h
Include/Atom/Feature/Utils/MultiSparseVector.h
Include/Atom/Feature/Utils/ProfilingCaptureBus.h