KisOpenGLBufferCircularStorage Class Reference

#include <KisOpenGLBufferCircularStorage.h>

Inheritance diagram for KisOpenGLBufferCircularStorage:

Classes
struct	BufferBinder

Public Member Functions
void	allocate (int numBuffers, int bufferSize)
void	allocateMoreBuffers ()
QOpenGLBuffer *	getNextBuffer ()
bool	isValid () const
	KisOpenGLBufferCircularStorage ()
	KisOpenGLBufferCircularStorage (const KisOpenGLBufferCircularStorage &)=delete
	KisOpenGLBufferCircularStorage (KisOpenGLBufferCircularStorage &&)=delete
	KisOpenGLBufferCircularStorage (QOpenGLBuffer::Type type)
KisOpenGLBufferCircularStorage &	operator= (const KisOpenGLBufferCircularStorage &)=delete
KisOpenGLBufferCircularStorage &	operator= (KisOpenGLBufferCircularStorage &&)=delete
void	reset ()
int	size () const
	~KisOpenGLBufferCircularStorage ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Attributes
std::vector< QOpenGLBuffer >	buffers
int	bufferSize = 0
decltype(buffers) ::size_type	nextBuffer = 0
QOpenGLBuffer::Type	type = QOpenGLBuffer::QOpenGLBuffer::VertexBuffer
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Private Member Functions
void	addBuffersImpl (size_t buffersToAdd, int bufferSize)

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

A simple storage class that owns a fixed amount of QOpenGLBuffer objects and returns them sequentially. Using multiple distinct buffers lets us avoid blocks

Definition at line 34 of file KisOpenGLBufferCircularStorage.cpp.

Constructor & Destructor Documentation

KisOpenGLBufferCircularStorage() [1/4]

KisOpenGLBufferCircularStorage::KisOpenGLBufferCircularStorage

(

)

Definition at line 43 of file KisOpenGLBufferCircularStorage.cpp.

    : KisOpenGLBufferCircularStorage(QOpenGLBuffer::VertexBuffer)
{
}

KisOpenGLBufferCircularStorage() [2/4]

KisOpenGLBufferCircularStorage::KisOpenGLBufferCircularStorage

(

QOpenGLBuffer::Type

type

)

Definition at line 48 of file KisOpenGLBufferCircularStorage.cpp.

    : m_d(new Private)
{
    m_d->type = type;
}

References m_d, and type.

~KisOpenGLBufferCircularStorage()

KisOpenGLBufferCircularStorage::~KisOpenGLBufferCircularStorage ( )

default

KisOpenGLBufferCircularStorage() [3/4]

KisOpenGLBufferCircularStorage::KisOpenGLBufferCircularStorage ( const KisOpenGLBufferCircularStorage & )

delete

KisOpenGLBufferCircularStorage() [4/4]

KisOpenGLBufferCircularStorage::KisOpenGLBufferCircularStorage ( KisOpenGLBufferCircularStorage && )

delete

Member Function Documentation

addBuffersImpl()

void KisOpenGLBufferCircularStorage::addBuffersImpl ( size_t buffersToAdd, int bufferSize )

private

Definition at line 119 of file KisOpenGLBufferCircularStorage.cpp.

{
    m_d->bufferSize = bufferSize;
 
    const size_t newSize = qMax(m_d->buffers.size() + buffersToAdd, nextPowerOfTwo(m_d->buffers.size()));
 
    if (m_d->buffers.capacity() < newSize)
        m_d->buffers.reserve(newSize);
 
    // overflow check for size()
    KIS_ASSERT(m_d->buffers.size() <= std::numeric_limits<int>::max());
 
    for (size_t i = 0; i < buffersToAdd; i++) {
        m_d->buffers.emplace_back(m_d->type);
 
        QOpenGLBuffer &buf = m_d->buffers.back();
 
        buf.create();
        buf.setUsagePattern(QOpenGLBuffer::DynamicDraw);
        buf.bind();
        buf.allocate(m_d->bufferSize);
        buf.release();
    }
}

References bufferSize, KIS_ASSERT, m_d, and nextPowerOfTwo().

allocate()

void KisOpenGLBufferCircularStorage::allocate	(	int	numBuffers,
		int	bufferSize )

Definition at line 56 of file KisOpenGLBufferCircularStorage.cpp.

{
    reset();
    KIS_ASSERT(numBuffers > 0);
    KIS_ASSERT(bufferSize > 0);
    addBuffersImpl(static_cast<size_t>(numBuffers), bufferSize);
}

References addBuffersImpl(), bufferSize, KIS_ASSERT, and reset().

allocateMoreBuffers()

void KisOpenGLBufferCircularStorage::allocateMoreBuffers

(

)

Definition at line 90 of file KisOpenGLBufferCircularStorage.cpp.

{
    const size_t numBuffers = nextPowerOfTwo(m_d->buffers.size());
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(!m_d->buffers.empty());
 
    auto begin = m_d->buffers.begin();
    auto middle = [&]() {
        using value_type = typename decltype(m_d->buffers)::difference_type;
        const value_type maxIndex = std::numeric_limits<value_type>::max();
 
        if (m_d->nextBuffer <= std::numeric_limits<value_type>::max()) {
            return std::next(begin, value_type(m_d->nextBuffer));
        } else {
            auto midpoint = std::next(begin, std::numeric_limits<value_type>::max());
            return std::next(midpoint, value_type(m_d->nextBuffer - maxIndex));
        }
    }();
    auto end = m_d->buffers.end();
 
    std::rotate(begin, middle, end);
 
    m_d->nextBuffer = m_d->buffers.size();
 
    const size_t buffersToAdd = numBuffers - m_d->buffers.size();
 
    addBuffersImpl(buffersToAdd, m_d->bufferSize);
}

References addBuffersImpl(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, and nextPowerOfTwo().

getNextBuffer()

QOpenGLBuffer * KisOpenGLBufferCircularStorage::getNextBuffer

(

)

Definition at line 64 of file KisOpenGLBufferCircularStorage.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(isValid(), 0);
 
    QOpenGLBuffer *buffer = &m_d->buffers[m_d->nextBuffer];
    m_d->nextBuffer = (m_d->nextBuffer + 1) % m_d->buffers.size();
    return buffer;
}

References isValid(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, and m_d.

isValid()

bool KisOpenGLBufferCircularStorage::isValid

(

)

const

Definition at line 73 of file KisOpenGLBufferCircularStorage.cpp.

{
    return !m_d->buffers.empty();
}

References m_d.

operator=() [1/2]

KisOpenGLBufferCircularStorage & KisOpenGLBufferCircularStorage::operator= ( const KisOpenGLBufferCircularStorage & )

delete

operator=() [2/2]

KisOpenGLBufferCircularStorage & KisOpenGLBufferCircularStorage::operator= ( KisOpenGLBufferCircularStorage && )

delete

reset()

void KisOpenGLBufferCircularStorage::reset

(

)

Definition at line 83 of file KisOpenGLBufferCircularStorage.cpp.

{
    m_d->buffers.clear();
    m_d->nextBuffer = 0;
    m_d->bufferSize = 0;
}

References m_d.

size()

int KisOpenGLBufferCircularStorage::size

(

)

const

Definition at line 78 of file KisOpenGLBufferCircularStorage.cpp.

{
    return static_cast<int>(m_d->buffers.size());
}

References m_d.

Member Data Documentation

buffers

std::vector<QOpenGLBuffer> KisOpenGLBufferCircularStorage::buffers

Definition at line 36 of file KisOpenGLBufferCircularStorage.cpp.

bufferSize

int KisOpenGLBufferCircularStorage::bufferSize = 0

Definition at line 38 of file KisOpenGLBufferCircularStorage.cpp.

m_d

const QScopedPointer<Private> KisOpenGLBufferCircularStorage::m_d

private

Definition at line 68 of file KisOpenGLBufferCircularStorage.h.

nextBuffer

decltype(buffers) ::size_type KisOpenGLBufferCircularStorage::nextBuffer = 0

Definition at line 37 of file KisOpenGLBufferCircularStorage.cpp.

type

QOpenGLBuffer::Type KisOpenGLBufferCircularStorage::type = QOpenGLBuffer::QOpenGLBuffer::VertexBuffer

Definition at line 39 of file KisOpenGLBufferCircularStorage.cpp.

---

The documentation for this class was generated from the following files:

• libs/ui/opengl/KisOpenGLBufferCircularStorage.cpp
• libs/ui/opengl/KisOpenGLBufferCircularStorage.h