CircularBuffer.hpp

Go to the documentation of this file.

#pragma once

#include "FlingTypes.h"

namespace Fling
{
   
    template<typename T, size_t t_Size>
    class CircularBuffer
    {
    public:
        
        CircularBuffer();

        ~CircularBuffer() = default;

        T* GetItem();

    private:
       
        const UINT32 m_BufferSize;
        
        T m_Buffer [t_Size];

        UINT32 m_AllocatedIndex = 0;
    };

    template<typename T, size_t t_Size>
    inline CircularBuffer<T, t_Size>::CircularBuffer()
        : m_BufferSize(t_Size)
        , m_AllocatedIndex(0)
        , m_Buffer{}
    {
        static_assert((t_Size != 0 && (t_Size & (t_Size-1)) == 0), "CircularBuffer::t_Size must be a power of 2!");
    }

    template<typename T, size_t t_Size>
    inline T* CircularBuffer<T, t_Size>::GetItem()
    {
        const uint32_t index = m_AllocatedIndex++;
        // This bit shifting is the same as the % operator
        // @see https://blog.molecular-matters.com/2015/09/08/job-system-2-0-lock-free-work-stealing-part-2-a-specialized-allocator/
        // for more about that
        return &(m_Buffer[(index - 1u) & (m_BufferSize - 1u)]);
    }
}   // namespace Fling