Class to store VERTEX instances with caching. More...

#include <cached_container.h>

Inheritance diagram for KIGFX::CACHED_CONTAINER:

Public Member Functions
	CACHED_CONTAINER (unsigned int aSize=DEFAULT_SIZE)

virtual	~CACHED_CONTAINER ()

bool	IsCached () const override
	Return true if the container caches vertex data in RAM or video memory.

virtual void	SetItem (VERTEX_ITEM *aItem) override
	Set the item for the further actions.

virtual void	FinishItem () override
	Clean up after adding an item.

virtual VERTEX *	Allocate (unsigned int aSize) override
	Return allocated space for the requested number of vertices associated with the current item (set with SetItem()).

virtual void	Delete (VERTEX_ITEM *aItem) override
	Erase the data related to an item.

virtual void	Clear () override
	Remove all data stored in the container and restores its original state.

virtual unsigned int	GetBufferHandle () const =0
	Return handle to the vertex buffer.

virtual bool	IsMapped () const =0
	Return true if vertex buffer is currently mapped.

virtual void	Map () override=0
	Prepare the container for vertices updates.

virtual void	Unmap () override=0
	Finish the vertices updates stage.

virtual unsigned int	AllItemsSize () const

virtual void	Abandon ()
	Give up ownership of any GL objects without deleting them.

VERTEX *	GetAllVertices () const
	Return pointer to the vertices stored in the container.

virtual VERTEX *	GetVertices (unsigned int aOffset) const
	Return vertices stored at the specific offset.

virtual unsigned int	GetSize () const
	Return amount of vertices currently stored in the container.

bool	IsDirty () const
	Return information about the container cache state.

void	SetDirty ()
	Set the dirty flag, so vertices in the container are going to be reuploaded to the GPU on the next frame.

void	ClearDirty ()
	Clear the dirty flag to prevent reuploading vertices to the GPU memory.

Static Public Member Functions
static VERTEX_CONTAINER *	MakeContainer (bool aCached)
	Return a pointer to a new container of an appropriate type.

Protected Types
typedef std::pair< unsigned int, unsigned int >	CHUNK
	Maps size of free memory chunks to their offsets.

typedef std::multimap< unsigned int, unsigned int >	FREE_CHUNK_MAP

Protected Member Functions
bool	reallocate (unsigned int aSize)
	Resize the chunk that stores the current item to the given size.

virtual bool	defragmentResize (unsigned int aNewSize)=0
	Remove empty spaces between chunks and optionally resizes the container.

void	defragment (VERTEX *aTarget)
	Transfer all stored data to a new buffer, removing empty spaces between the data chunks in the container.

void	mergeFreeChunks ()
	Look for consecutive free memory chunks and merges them, decreasing fragmentation of memory.

int	getChunkSize (const CHUNK &aChunk) const
	Return the size of a chunk.

unsigned int	getChunkOffset (const CHUNK &aChunk) const
	Return the offset of a chunk.

void	addFreeChunk (unsigned int aOffset, unsigned int aSize)
	Add a chunk marked as a free space.

unsigned int	usedSpace () const
	Return size of the used memory space.

Protected Attributes
FREE_CHUNK_MAP	m_freeChunks
	Store size & offset of free chunks.

std::set< VERTEX_ITEM * >	m_items
	Stored VERTEX_ITEMs.

VERTEX_ITEM *	m_item
	Currently modified item.

unsigned int	m_chunkSize
	Properties of currently modified chunk & item.

unsigned int	m_chunkOffset

unsigned int	m_maxIndex
	Maximal vertex index number stored in the container.

unsigned int	m_freeSpace
	Free space left in the container, expressed in vertices.

unsigned int	m_currentSize
	Current container size, expressed in vertices.

unsigned int	m_initialSize
	Store the initial size, so it can be resized to this on Clear()

VERTEX *	m_vertices
	Actual storage memory.

bool	m_failed

bool	m_dirty

Static Protected Attributes
static constexpr unsigned int	DEFAULT_SIZE = 1048576
	Default initial size of a container (expressed in vertices)

Private Member Functions
void	showFreeChunks ()
	Debug & test functions.

void	showUsedChunks ()

void	test ()

Detailed Description

Class to store VERTEX instances with caching.

It associates VERTEX objects and with VERTEX_ITEMs. Caching vertices data in the memory and a enables fast reuse of that data.

Definition at line 42 of file cached_container.h.

Member Typedef Documentation

◆ CHUNK

typedef std::pair<unsigned int, unsigned int> KIGFX::CACHED_CONTAINER::CHUNK

protected

Maps size of free memory chunks to their offsets.

Definition at line 97 of file cached_container.h.

◆ FREE_CHUNK_MAP

typedef std::multimap<unsigned int, unsigned int> KIGFX::CACHED_CONTAINER::FREE_CHUNK_MAP

protected

Definition at line 98 of file cached_container.h.

Constructor & Destructor Documentation

◆ CACHED_CONTAINER()

CACHED_CONTAINER::CACHED_CONTAINER ( unsigned int aSize = DEFAULT_SIZE )

Definition at line 50 of file cached_container.cpp.

References m_chunkOffset, m_chunkSize, m_freeChunks, m_item, m_maxIndex, and KIGFX::VERTEX_CONTAINER::VERTEX_CONTAINER().

Referenced by KIGFX::CACHED_CONTAINER_GPU::CACHED_CONTAINER_GPU(), and KIGFX::CACHED_CONTAINER_RAM::CACHED_CONTAINER_RAM().

◆ ~CACHED_CONTAINER()

virtual KIGFX::CACHED_CONTAINER::~CACHED_CONTAINER ( )

inlinevirtual

Definition at line 46 of file cached_container.h.

Member Function Documentation

◆ Abandon()

virtual void KIGFX::VERTEX_CONTAINER::Abandon ( )

inlinevirtualinherited

Give up ownership of any GL objects without deleting them.

Used when the owning context can no longer be made current, so a delete would be executed against whichever context is, possibly one from another share group. The names are released when the owning context is destroyed.

Reimplemented in KIGFX::CACHED_CONTAINER_GPU.

Definition at line 61 of file vertex_container.h.

◆ addFreeChunk()

void CACHED_CONTAINER::addFreeChunk	(	unsigned int	aOffset,
		unsigned int	aSize )

protected

Add a chunk marked as a free space.

Definition at line 403 of file cached_container.cpp.

References KIGFX::VERTEX_CONTAINER::m_currentSize, m_freeChunks, and KIGFX::VERTEX_CONTAINER::m_freeSpace.

Referenced by Delete(), FinishItem(), and reallocate().

◆ AllItemsSize()

virtual unsigned int KIGFX::CACHED_CONTAINER::AllItemsSize ( ) const

inlinevirtual

Reimplemented in KIGFX::CACHED_CONTAINER_GPU.

Definition at line 93 of file cached_container.h.

Referenced by KIGFX::GPU_CACHED_MANAGER::EndDrawing().

◆ Allocate()

VERTEX * CACHED_CONTAINER::Allocate ( unsigned int aSize )

overridevirtual

Return allocated space for the requested number of vertices associated with the current item (set with SetItem()).

The allocated space is added at the end of the chunk used by the current item and may serve to store new vertices.

Parameters

aSize is the number of vertices to be allocated.

Returns: Pointer to the allocated space.

Exceptions

bad_alloc exception if allocation fails.

Implements KIGFX::VERTEX_CONTAINER.

Definition at line 108 of file cached_container.cpp.

References IsMapped(), m_chunkOffset, m_chunkSize, KIGFX::VERTEX_CONTAINER::m_dirty, KIGFX::VERTEX_CONTAINER::m_failed, m_item, KIGFX::VERTEX_CONTAINER::m_vertices, reallocate(), showFreeChunks(), showUsedChunks(), and test().

◆ Clear()

void CACHED_CONTAINER::Clear ( )

overridevirtual

Remove all data stored in the container and restores its original state.

Implements KIGFX::VERTEX_CONTAINER.

Definition at line 198 of file cached_container.cpp.

References KIGFX::VERTEX_CONTAINER::m_currentSize, KIGFX::VERTEX_CONTAINER::m_failed, m_freeChunks, KIGFX::VERTEX_CONTAINER::m_freeSpace, m_items, and m_maxIndex.

◆ ClearDirty()

void KIGFX::VERTEX_CONTAINER::ClearDirty ( )

inlineinherited

Clear the dirty flag to prevent reuploading vertices to the GPU memory.

Definition at line 157 of file vertex_container.h.

References m_dirty.

Referenced by KIGFX::GPU_CACHED_MANAGER::EndDrawing().

◆ defragment()

void CACHED_CONTAINER::defragment ( VERTEX * aTarget )

protected

Transfer all stored data to a new buffer, removing empty spaces between the data chunks in the container.

Parameters

aTarget is the destination for the defragmented data.

Definition at line 288 of file cached_container.cpp.

References m_chunkOffset, m_item, m_items, m_maxIndex, KIGFX::VERTEX_CONTAINER::m_vertices, KIGFX::VERTEX_CONTAINER::usedSpace(), and KIGFX::VERTEX_SIZE.

Referenced by KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy(), and KIGFX::CACHED_CONTAINER_GPU::defragmentResizeStaged().

◆ defragmentResize()

virtual bool KIGFX::CACHED_CONTAINER::defragmentResize ( unsigned int aNewSize )

protectedpure virtual

Remove empty spaces between chunks and optionally resizes the container.

After the operation there is continuous space for storing vertices at the end of the container.

Parameters

aNewSize is the new size of container, expressed in number of vertices.

Returns: false in case of failure (e.g. memory shortage).

Implemented in KIGFX::CACHED_CONTAINER_GPU, and KIGFX::CACHED_CONTAINER_RAM.

Referenced by Delete(), and reallocate().

◆ Delete()

void CACHED_CONTAINER::Delete ( VERTEX_ITEM * aItem )

overridevirtual

Erase the data related to an item.

Parameters

aItem is the item to be erased.

Implements KIGFX::VERTEX_CONTAINER.

Definition at line 157 of file cached_container.cpp.

References addFreeChunk(), defragmentResize(), KIGFX::VERTEX_ITEM::GetOffset(), KIGFX::VERTEX_ITEM::GetSize(), KIGFX::VERTEX_CONTAINER::m_currentSize, KIGFX::VERTEX_CONTAINER::m_freeSpace, KIGFX::VERTEX_CONTAINER::m_initialSize, m_items, KIGFX::VERTEX_ITEM::setSize(), and test().

◆ FinishItem()

void CACHED_CONTAINER::FinishItem ( )

overridevirtual

Clean up after adding an item.

Reimplemented from KIGFX::VERTEX_CONTAINER.

Definition at line 75 of file cached_container.cpp.

References addFreeChunk(), m_chunkOffset, m_chunkSize, m_item, m_items, m_maxIndex, and test().

◆ GetAllVertices()

VERTEX * KIGFX::VERTEX_CONTAINER::GetAllVertices ( ) const

inlineinherited

Return pointer to the vertices stored in the container.

Definition at line 112 of file vertex_container.h.

References m_vertices.

◆ GetBufferHandle()

virtual unsigned int KIGFX::CACHED_CONTAINER::GetBufferHandle ( ) const

pure virtual

Return handle to the vertex buffer.

It might be negative if the buffer is not initialized.

Implemented in KIGFX::CACHED_CONTAINER_GPU, and KIGFX::CACHED_CONTAINER_RAM.

Referenced by KIGFX::GPU_CACHED_MANAGER::EndDrawing().

◆ getChunkOffset()

unsigned int KIGFX::CACHED_CONTAINER::getChunkOffset ( const CHUNK & aChunk ) const

inlineprotected

Return the offset of a chunk.

Parameters

aChunk is the chunk.

Definition at line 150 of file cached_container.h.

Referenced by reallocate().

◆ getChunkSize()

int KIGFX::CACHED_CONTAINER::getChunkSize ( const CHUNK & aChunk ) const

inlineprotected

Return the size of a chunk.

Parameters

aChunk is the chunk.

Definition at line 140 of file cached_container.h.

Referenced by reallocate(), and test().

◆ GetSize()

virtual unsigned int KIGFX::VERTEX_CONTAINER::GetSize ( ) const

inlinevirtualinherited

Return amount of vertices currently stored in the container.

Reimplemented in KIGFX::NONCACHED_CONTAINER.

Definition at line 130 of file vertex_container.h.

References m_currentSize.

◆ GetVertices()

virtual VERTEX * KIGFX::VERTEX_CONTAINER::GetVertices ( unsigned int aOffset ) const

inlinevirtualinherited

Return vertices stored at the specific offset.

Parameters

aOffset is the offset.

Definition at line 122 of file vertex_container.h.

References m_vertices.

◆ IsCached()

bool KIGFX::CACHED_CONTAINER::IsCached ( ) const

inlineoverridevirtual

Return true if the container caches vertex data in RAM or video memory.

Otherwise it is a single batch draw which is later discarded.

Implements KIGFX::VERTEX_CONTAINER.

Definition at line 48 of file cached_container.h.

◆ IsDirty()

bool KIGFX::VERTEX_CONTAINER::IsDirty ( ) const

inlineinherited

Return information about the container cache state.

Returns: True in case the vertices have to be reuploaded.

Definition at line 140 of file vertex_container.h.

References m_dirty.

◆ IsMapped()

virtual bool KIGFX::CACHED_CONTAINER::IsMapped ( ) const

pure virtual

Return true if vertex buffer is currently mapped.

Implemented in KIGFX::CACHED_CONTAINER_GPU, and KIGFX::CACHED_CONTAINER_RAM.

Referenced by Allocate(), KIGFX::GPU_CACHED_MANAGER::EndDrawing(), and reallocate().

◆ MakeContainer()

VERTEX_CONTAINER * VERTEX_CONTAINER::MakeContainer ( bool aCached )

staticinherited

Return a pointer to a new container of an appropriate type.

Definition at line 38 of file vertex_container.cpp.

References VERTEX_CONTAINER().

Referenced by KIGFX::VERTEX_MANAGER::VERTEX_MANAGER().

◆ Map()

virtual void KIGFX::CACHED_CONTAINER::Map ( )

overridepure virtual

Prepare the container for vertices updates.

Reimplemented from KIGFX::VERTEX_CONTAINER.

Implemented in KIGFX::CACHED_CONTAINER_GPU, and KIGFX::CACHED_CONTAINER_RAM.

◆ mergeFreeChunks()

void CACHED_CONTAINER::mergeFreeChunks ( )

protected

Look for consecutive free memory chunks and merges them, decreasing fragmentation of memory.

Definition at line 348 of file cached_container.cpp.

References m_freeChunks, and test().

◆ reallocate()

bool CACHED_CONTAINER::reallocate ( unsigned int aSize )

protected

Resize the chunk that stores the current item to the given size.

The current item has its offset adjusted after the call, and the new chunk parameters are stored in m_chunkOffset and m_chunkSize.

Parameters

aSize is the requested chunk size.

Returns: true in case of success, false otherwise.

Definition at line 217 of file cached_container.cpp.

References addFreeChunk(), defragmentResize(), getChunkOffset(), getChunkSize(), IsMapped(), m_chunkOffset, m_chunkSize, KIGFX::VERTEX_CONTAINER::m_currentSize, m_freeChunks, KIGFX::VERTEX_CONTAINER::m_freeSpace, m_item, KIGFX::VERTEX_CONTAINER::m_vertices, result, and KIGFX::VERTEX_SIZE.

Referenced by Allocate().

◆ SetDirty()

void KIGFX::VERTEX_CONTAINER::SetDirty ( )

inlineinherited

Set the dirty flag, so vertices in the container are going to be reuploaded to the GPU on the next frame.

Definition at line 149 of file vertex_container.h.

References m_dirty.

◆ SetItem()

void CACHED_CONTAINER::SetItem ( VERTEX_ITEM * aItem )

overridevirtual

Set the item for the further actions.

Parameters

aItem is the item or NULL in case of finishing the item.

Implements KIGFX::VERTEX_CONTAINER.

Definition at line 62 of file cached_container.cpp.

References KIGFX::VERTEX_ITEM::GetOffset(), KIGFX::VERTEX_ITEM::GetSize(), m_chunkOffset, m_chunkSize, and m_item.

◆ showFreeChunks()

void CACHED_CONTAINER::showFreeChunks ( )

private

Debug & test functions.

Definition at line 413 of file cached_container.cpp.

Referenced by Allocate().

◆ showUsedChunks()

void CACHED_CONTAINER::showUsedChunks ( )

private

Definition at line 418 of file cached_container.cpp.

Referenced by Allocate().

◆ test()

void CACHED_CONTAINER::test ( )

private

Definition at line 423 of file cached_container.cpp.

References getChunkSize(), m_chunkSize, KIGFX::VERTEX_CONTAINER::m_currentSize, m_freeChunks, KIGFX::VERTEX_CONTAINER::m_freeSpace, m_item, and m_items.

Referenced by Allocate(), Delete(), FinishItem(), and mergeFreeChunks().

◆ Unmap()

virtual void KIGFX::CACHED_CONTAINER::Unmap ( )

overridepure virtual

Finish the vertices updates stage.

Reimplemented from KIGFX::VERTEX_CONTAINER.

Implemented in KIGFX::CACHED_CONTAINER_GPU, and KIGFX::CACHED_CONTAINER_RAM.

Referenced by KIGFX::GPU_CACHED_MANAGER::EndDrawing().

◆ usedSpace()

unsigned int KIGFX::VERTEX_CONTAINER::usedSpace ( ) const

inlineprotectedinherited

Return size of the used memory space.

Returns: Size of the used memory space (expressed as a number of vertices).

Definition at line 170 of file vertex_container.h.

References m_currentSize, and m_freeSpace.

Referenced by KIGFX::CACHED_CONTAINER::defragment(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy(), and KIGFX::CACHED_CONTAINER_GPU::defragmentResizeStaged().

Member Data Documentation

◆ DEFAULT_SIZE

unsigned int KIGFX::VERTEX_CONTAINER::DEFAULT_SIZE = 1048576

staticconstexprprotectedinherited

Default initial size of a container (expressed in vertices)

Definition at line 192 of file vertex_container.h.

◆ m_chunkOffset

unsigned int KIGFX::CACHED_CONTAINER::m_chunkOffset

protected

Definition at line 167 of file cached_container.h.

Referenced by Allocate(), CACHED_CONTAINER(), defragment(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), FinishItem(), reallocate(), and SetItem().

◆ m_chunkSize

unsigned int KIGFX::CACHED_CONTAINER::m_chunkSize

protected

Properties of currently modified chunk & item.

Definition at line 166 of file cached_container.h.

Referenced by Allocate(), CACHED_CONTAINER(), FinishItem(), reallocate(), SetItem(), and test().

◆ m_currentSize

unsigned int KIGFX::VERTEX_CONTAINER::m_currentSize

protectedinherited

Current container size, expressed in vertices.

Definition at line 179 of file vertex_container.h.

◆ m_dirty

bool KIGFX::VERTEX_CONTAINER::m_dirty

protectedinherited

Definition at line 189 of file vertex_container.h.

Referenced by KIGFX::CACHED_CONTAINER::Allocate(), ClearDirty(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), IsDirty(), SetDirty(), KIGFX::CACHED_CONTAINER_RAM::Unmap(), and VERTEX_CONTAINER().

◆ m_failed

bool KIGFX::VERTEX_CONTAINER::m_failed

protectedinherited

Definition at line 188 of file vertex_container.h.

Referenced by KIGFX::CACHED_CONTAINER::Allocate(), KIGFX::CACHED_CONTAINER::Clear(), and VERTEX_CONTAINER().

◆ m_freeChunks

FREE_CHUNK_MAP KIGFX::CACHED_CONTAINER::m_freeChunks

protected

Store size & offset of free chunks.

Definition at line 161 of file cached_container.h.

Referenced by addFreeChunk(), CACHED_CONTAINER(), Clear(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy(), KIGFX::CACHED_CONTAINER_GPU::defragmentResizeStaged(), mergeFreeChunks(), reallocate(), and test().

◆ m_freeSpace

unsigned int KIGFX::VERTEX_CONTAINER::m_freeSpace

protectedinherited

Free space left in the container, expressed in vertices.

Definition at line 176 of file vertex_container.h.

◆ m_initialSize

unsigned int KIGFX::VERTEX_CONTAINER::m_initialSize

protectedinherited

Store the initial size, so it can be resized to this on Clear()

Definition at line 182 of file vertex_container.h.

Referenced by KIGFX::CACHED_CONTAINER::Delete(), and VERTEX_CONTAINER().

◆ m_item

VERTEX_ITEM* KIGFX::CACHED_CONTAINER::m_item

protected

Currently modified item.

Definition at line 163 of file cached_container.h.

Referenced by Allocate(), CACHED_CONTAINER(), defragment(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), FinishItem(), reallocate(), SetItem(), and test().

◆ m_items

std::set<VERTEX_ITEM*> KIGFX::CACHED_CONTAINER::m_items

protected

Stored VERTEX_ITEMs.

Definition at line 162 of file cached_container.h.

Referenced by KIGFX::CACHED_CONTAINER_GPU::AllItemsSize(), Clear(), defragment(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), Delete(), FinishItem(), and test().

◆ m_maxIndex

unsigned int KIGFX::CACHED_CONTAINER::m_maxIndex

protected

Maximal vertex index number stored in the container.

Definition at line 170 of file cached_container.h.

Referenced by CACHED_CONTAINER(), Clear(), defragment(), FinishItem(), and KIGFX::CACHED_CONTAINER_RAM::Unmap().

◆ m_vertices

VERTEX* KIGFX::VERTEX_CONTAINER::m_vertices

protectedinherited

Actual storage memory.

Definition at line 185 of file vertex_container.h.

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ CHUNK

◆ FREE_CHUNK_MAP

Constructor & Destructor Documentation

◆ CACHED_CONTAINER()

◆ ~CACHED_CONTAINER()

Member Function Documentation

◆ Abandon()

◆ addFreeChunk()

◆ AllItemsSize()

◆ Allocate()

◆ Clear()

◆ ClearDirty()

◆ defragment()

◆ defragmentResize()

◆ Delete()

◆ FinishItem()

◆ GetAllVertices()

◆ GetBufferHandle()

◆ getChunkOffset()

◆ getChunkSize()

◆ GetSize()

◆ GetVertices()

◆ IsCached()

◆ IsDirty()

◆ IsMapped()

◆ MakeContainer()

◆ Map()

◆ mergeFreeChunks()

◆ reallocate()

◆ SetDirty()

◆ SetItem()

◆ showFreeChunks()

◆ showUsedChunks()

◆ test()

◆ Unmap()

◆ usedSpace()

Member Data Documentation

◆ DEFAULT_SIZE

◆ m_chunkOffset

◆ m_chunkSize

◆ m_currentSize

◆ m_dirty

◆ m_failed

◆ m_freeChunks

◆ m_freeSpace

◆ m_initialSize

◆ m_item

◆ m_items

◆ m_maxIndex

◆ m_vertices