KiCad PCB EDA Suite
|
Specialization of CACHED_CONTAINER that stores data in video memory via memory mapping. More...
#include <cached_container_gpu.h>
Public Member Functions | |
CACHED_CONTAINER_GPU (unsigned int aSize=DEFAULT_SIZE) | |
~CACHED_CONTAINER_GPU () | |
unsigned int | GetBufferHandle () const override |
Return handle to the vertex buffer. | |
bool | IsMapped () const override |
Prepare the container for vertices updates. | |
void | Map () override |
Finish the vertices updates stage. | |
void | Unmap () override |
Finish the vertices updates stage. | |
virtual unsigned int | AllItemsSize () const override |
bool | IsCached () const override |
Return true if the container caches vertex data in RAM or video memory. | |
virtual void | SetItem (VERTEX_ITEM *aItem) override |
Clean up after adding an item. | |
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 |
Remove all data stored in the container and restores its original state. | |
virtual void | Clear () override |
Remove all data stored in the container and restores its original state. | |
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 |
typedef std::set< VERTEX_ITEM * > | ITEMS |
List of all the stored items. | |
Protected Member Functions | |
bool | defragmentResize (unsigned int aNewSize) override |
Remove empty spaces between chunks and optionally resizes the container. | |
bool | defragmentResizeMemcpy (unsigned int aNewSize) |
Flag saying if vertex buffer is currently mapped. | |
bool | reallocate (unsigned int aSize) |
Resize the chunk that stores the current item to the given size. | |
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 | |
bool | m_isMapped |
Vertex buffer handle. | |
unsigned int | m_glBufferHandle |
Flag saying whether it is safe to use glCopyBufferSubData. | |
bool | m_useCopyBuffer |
FREE_CHUNK_MAP | m_freeChunks |
Stored VERTEX_ITEMs. | |
ITEMS | m_items |
Currently modified item. | |
VERTEX_ITEM * | m_item |
Properties of currently modified chunk & item. | |
unsigned int | m_chunkSize |
unsigned int | m_chunkOffset |
Maximal vertex index number stored in the container. | |
unsigned int | m_maxIndex |
unsigned int | m_freeSpace |
Current container size, expressed in vertices. | |
unsigned int | m_currentSize |
Store the initial size, so it can be resized to this on Clear() | |
unsigned int | m_initialSize |
Actual storage memory. | |
VERTEX * | m_vertices |
bool | m_failed |
bool | m_dirty |
Default initial size of a container (expressed in vertices) | |
Static Protected Attributes | |
static constexpr unsigned int | DEFAULT_SIZE = 1048576 |
Private Member Functions | |
void | showFreeChunks () |
Debug & test functions. | |
void | showUsedChunks () |
void | test () |
Specialization of CACHED_CONTAINER that stores data in video memory via memory mapping.
Definition at line 38 of file cached_container_gpu.h.
|
protectedinherited |
< Maps size of free memory chunks to their offsets
Definition at line 101 of file cached_container.h.
|
protectedinherited |
Definition at line 102 of file cached_container.h.
|
protectedinherited |
List of all the stored items.
Definition at line 105 of file cached_container.h.
CACHED_CONTAINER_GPU::CACHED_CONTAINER_GPU | ( | unsigned int | aSize = DEFAULT_SIZE | ) |
Definition at line 52 of file cached_container_gpu.cpp.
References KIGFX::CACHED_CONTAINER::CACHED_CONTAINER(), checkGlError(), KI_TRACE, KIGFX::VERTEX_CONTAINER::m_currentSize, m_glBufferHandle, m_isMapped, m_useCopyBuffer, traceGalProfile, and KIGFX::VERTEX_SIZE.
CACHED_CONTAINER_GPU::~CACHED_CONTAINER_GPU | ( | ) |
Definition at line 80 of file cached_container_gpu.cpp.
References m_glBufferHandle, m_isMapped, and Unmap().
|
protectedinherited |
Add a chunk marked as a free space.
Store size & offset of free chunks.
Definition at line 393 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().
|
overridevirtual |
Reimplemented from KIGFX::CACHED_CONTAINER.
Definition at line 301 of file cached_container_gpu.cpp.
References KIGFX::CACHED_CONTAINER::m_items.
Referenced by defragmentResize(), and defragmentResizeMemcpy().
|
overridevirtualinherited |
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.
aSize | is the number of vertices to be allocated. |
bad_alloc | exception if allocation fails. Erase the data related to an item. |
aItem | is the item to be erased. |
Implements KIGFX::VERTEX_CONTAINER.
Definition at line 112 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().
|
overridevirtualinherited |
Remove all data stored in the container and restores its original state.
Implements KIGFX::VERTEX_CONTAINER.
Definition at line 194 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.
|
inlineinherited |
Clear the dirty flag to prevent reuploading vertices to the GPU memory.
Definition at line 152 of file vertex_container.h.
References m_dirty.
Referenced by KIGFX::GPU_CACHED_MANAGER::EndDrawing().
|
protectedinherited |
Transfer all stored data to a new buffer, removing empty spaces between the data chunks in the container.
aTarget | is the destination for the defragmented data. |
Definition at line 277 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(), and KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy().
|
overrideprotectedvirtual |
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.
aNewSize | is the new size of container, expressed in number of vertices. |
Implements KIGFX::CACHED_CONTAINER.
Definition at line 129 of file cached_container_gpu.cpp.
References AllItemsSize(), checkGlError(), defragmentResizeMemcpy(), KIGFX::VERTEX_ITEM::GetOffset(), KIGFX::VERTEX_ITEM::GetSize(), IsMapped(), KI_TRACE, KIGFX::CACHED_CONTAINER::m_chunkOffset, KIGFX::VERTEX_CONTAINER::m_currentSize, KIGFX::CACHED_CONTAINER::m_freeChunks, KIGFX::VERTEX_CONTAINER::m_freeSpace, m_glBufferHandle, m_isMapped, KIGFX::CACHED_CONTAINER::m_item, KIGFX::CACHED_CONTAINER::m_items, m_useCopyBuffer, Map(), PROF_TIMER::msecs(), KIGFX::VERTEX_ITEM::setOffset(), PROF_TIMER::Stop(), traceGalCachedContainerGpu, traceGalProfile, KIGFX::VERTEX_CONTAINER::usedSpace(), and KIGFX::VERTEX_SIZE.
|
protected |
Flag saying if vertex buffer is currently mapped.
Definition at line 233 of file cached_container_gpu.cpp.
References AllItemsSize(), checkGlError(), KIGFX::CACHED_CONTAINER::defragment(), IsMapped(), KI_TRACE, KIGFX::VERTEX_CONTAINER::m_currentSize, KIGFX::CACHED_CONTAINER::m_freeChunks, KIGFX::VERTEX_CONTAINER::m_freeSpace, m_glBufferHandle, Map(), PROF_TIMER::msecs(), PROF_TIMER::Stop(), traceGalCachedContainerGpu, traceGalProfile, Unmap(), KIGFX::VERTEX_CONTAINER::usedSpace(), and KIGFX::VERTEX_SIZE.
Referenced by defragmentResize().
|
overridevirtualinherited |
Remove all data stored in the container and restores its original state.
Implements KIGFX::VERTEX_CONTAINER.
Definition at line 153 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().
|
overridevirtualinherited |
Clean up after adding an item.
Reimplemented from KIGFX::VERTEX_CONTAINER.
Definition at line 79 of file cached_container.cpp.
References addFreeChunk(), m_chunkOffset, m_chunkSize, m_item, m_items, m_maxIndex, and test().
|
inlineinherited |
Return pointer to the vertices stored in the container.
Definition at line 107 of file vertex_container.h.
References m_vertices.
|
inlineoverridevirtual |
Return handle to the vertex buffer.
It might be negative if the buffer is not initialized.
Implements KIGFX::CACHED_CONTAINER.
Definition at line 44 of file cached_container_gpu.h.
References m_glBufferHandle.
|
inlineprotectedinherited |
Return the offset of a chunk.
aChunk | is the chunk. |
Definition at line 157 of file cached_container.h.
Referenced by reallocate().
|
inlineprotectedinherited |
Return the size of a chunk.
aChunk | is the chunk. |
Definition at line 147 of file cached_container.h.
Referenced by reallocate(), and test().
|
inlinevirtualinherited |
Return amount of vertices currently stored in the container.
Reimplemented in KIGFX::NONCACHED_CONTAINER.
Definition at line 125 of file vertex_container.h.
References m_currentSize.
|
inlinevirtualinherited |
Return vertices stored at the specific offset.
aOffset | is the offset. |
Definition at line 117 of file vertex_container.h.
References m_vertices.
|
inlineoverridevirtualinherited |
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 52 of file cached_container.h.
|
inlineinherited |
Return information about the container cache state.
Definition at line 135 of file vertex_container.h.
References m_dirty.
|
inlineoverridevirtual |
Prepare the container for vertices updates.
Implements KIGFX::CACHED_CONTAINER.
Definition at line 49 of file cached_container_gpu.h.
References m_isMapped.
Referenced by defragmentResize(), defragmentResizeMemcpy(), Map(), and Unmap().
|
staticinherited |
Return a pointer to a new container of an appropriate type.
Definition at line 42 of file vertex_container.cpp.
References VERTEX_CONTAINER().
Referenced by KIGFX::VERTEX_MANAGER::VERTEX_MANAGER().
|
overridevirtual |
Finish the vertices updates stage.
Implements KIGFX::CACHED_CONTAINER.
Definition at line 90 of file cached_container_gpu.cpp.
References checkGlError(), IsMapped(), m_glBufferHandle, m_isMapped, and KIGFX::VERTEX_CONTAINER::m_vertices.
Referenced by defragmentResize(), and defragmentResizeMemcpy().
|
protectedinherited |
Look for consecutive free memory chunks and merges them, decreasing fragmentation of memory.
Definition at line 338 of file cached_container.cpp.
References m_freeChunks, and test().
|
protectedinherited |
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.
aSize | is the requested chunk size. |
Definition at line 213 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().
|
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 144 of file vertex_container.h.
References m_dirty.
|
overridevirtualinherited |
Clean up after adding an item.
Implements KIGFX::VERTEX_CONTAINER.
Definition at line 66 of file cached_container.cpp.
References KIGFX::VERTEX_ITEM::GetOffset(), KIGFX::VERTEX_ITEM::GetSize(), m_chunkOffset, m_chunkSize, and m_item.
|
privateinherited |
Debug & test functions.
Definition at line 403 of file cached_container.cpp.
Referenced by Allocate().
|
privateinherited |
Definition at line 408 of file cached_container.cpp.
Referenced by Allocate().
|
privateinherited |
Definition at line 413 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().
|
overridevirtual |
Finish the vertices updates stage.
Implements KIGFX::CACHED_CONTAINER.
Definition at line 106 of file cached_container_gpu.cpp.
References checkGlError(), IsMapped(), m_isMapped, and KIGFX::VERTEX_CONTAINER::m_vertices.
Referenced by defragmentResizeMemcpy(), and ~CACHED_CONTAINER_GPU().
|
inlineprotectedinherited |
Return size of the used memory space.
Definition at line 165 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(), and KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy().
|
staticconstexprprotectedinherited |
Definition at line 187 of file vertex_container.h.
|
protectedinherited |
Maximal vertex index number stored in the container.
Definition at line 178 of file cached_container.h.
Referenced by Allocate(), CACHED_CONTAINER(), defragment(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), FinishItem(), reallocate(), and SetItem().
|
protectedinherited |
Definition at line 177 of file cached_container.h.
Referenced by Allocate(), CACHED_CONTAINER(), FinishItem(), reallocate(), SetItem(), and test().
|
protectedinherited |
Store the initial size, so it can be resized to this on Clear()
Definition at line 174 of file vertex_container.h.
Referenced by KIGFX::CACHED_CONTAINER::addFreeChunk(), KIGFX::NONCACHED_CONTAINER::Allocate(), KIGFX::CACHED_CONTAINER_GPU::CACHED_CONTAINER_GPU(), KIGFX::CACHED_CONTAINER::Clear(), KIGFX::NONCACHED_CONTAINER::Clear(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy(), KIGFX::CACHED_CONTAINER::Delete(), GetSize(), KIGFX::CACHED_CONTAINER::reallocate(), KIGFX::CACHED_CONTAINER::test(), usedSpace(), and VERTEX_CONTAINER().
|
protectedinherited |
Default initial size of a container (expressed in vertices)
Definition at line 184 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().
|
protectedinherited |
Definition at line 183 of file vertex_container.h.
Referenced by KIGFX::CACHED_CONTAINER::Allocate(), KIGFX::CACHED_CONTAINER::Clear(), and VERTEX_CONTAINER().
|
protectedinherited |
Stored VERTEX_ITEMs.
Definition at line 168 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(), mergeFreeChunks(), reallocate(), and test().
|
protectedinherited |
Current container size, expressed in vertices.
Definition at line 171 of file vertex_container.h.
Referenced by KIGFX::CACHED_CONTAINER::addFreeChunk(), KIGFX::NONCACHED_CONTAINER::Allocate(), KIGFX::CACHED_CONTAINER::Clear(), KIGFX::NONCACHED_CONTAINER::Clear(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy(), KIGFX::CACHED_CONTAINER::Delete(), KIGFX::CACHED_CONTAINER::reallocate(), KIGFX::CACHED_CONTAINER::test(), usedSpace(), and VERTEX_CONTAINER().
|
protected |
Flag saying whether it is safe to use glCopyBufferSubData.
Definition at line 80 of file cached_container_gpu.h.
Referenced by CACHED_CONTAINER_GPU(), defragmentResize(), defragmentResizeMemcpy(), GetBufferHandle(), Map(), and ~CACHED_CONTAINER_GPU().
|
protectedinherited |
Actual storage memory.
Definition at line 177 of file vertex_container.h.
Referenced by KIGFX::CACHED_CONTAINER::Delete(), and VERTEX_CONTAINER().
|
protected |
Vertex buffer handle.
Definition at line 77 of file cached_container_gpu.h.
Referenced by CACHED_CONTAINER_GPU(), defragmentResize(), IsMapped(), Map(), Unmap(), and ~CACHED_CONTAINER_GPU().
|
protectedinherited |
Properties of currently modified chunk & item.
Definition at line 174 of file cached_container.h.
Referenced by Allocate(), CACHED_CONTAINER(), defragment(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), FinishItem(), reallocate(), SetItem(), and test().
|
protectedinherited |
Currently modified item.
Definition at line 171 of file cached_container.h.
Referenced by KIGFX::CACHED_CONTAINER_GPU::AllItemsSize(), Clear(), defragment(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), Delete(), FinishItem(), and test().
|
protectedinherited |
Definition at line 181 of file cached_container.h.
Referenced by CACHED_CONTAINER(), Clear(), defragment(), FinishItem(), and KIGFX::CACHED_CONTAINER_RAM::Unmap().
|
protected |
Definition at line 83 of file cached_container_gpu.h.
Referenced by CACHED_CONTAINER_GPU(), and defragmentResize().
|
protectedinherited |
Definition at line 180 of file vertex_container.h.
Referenced by KIGFX::CACHED_CONTAINER::Allocate(), KIGFX::NONCACHED_CONTAINER::Allocate(), KIGFX::CACHED_CONTAINER_RAM::CACHED_CONTAINER_RAM(), KIGFX::CACHED_CONTAINER::defragment(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), GetAllVertices(), GetVertices(), KIGFX::CACHED_CONTAINER_GPU::Map(), KIGFX::NONCACHED_CONTAINER::NONCACHED_CONTAINER(), KIGFX::CACHED_CONTAINER::reallocate(), KIGFX::CACHED_CONTAINER_GPU::Unmap(), KIGFX::CACHED_CONTAINER_RAM::Unmap(), VERTEX_CONTAINER(), KIGFX::CACHED_CONTAINER_RAM::~CACHED_CONTAINER_RAM(), and KIGFX::NONCACHED_CONTAINER::~NONCACHED_CONTAINER().