KiCad PCB EDA Suite
|
Class to store VERTEX instances with caching. More...
#include <cached_container.h>
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 |
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. | |
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 |
Finish the vertices updates stage. | |
virtual void | Unmap () override=0 |
Finish the vertices updates stage. | |
virtual unsigned int | AllItemsSize () const |
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 | 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 |
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 () |
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 46 of file cached_container.h.
|
protected |
< Maps size of free memory chunks to their offsets
Definition at line 101 of file cached_container.h.
|
protected |
Definition at line 102 of file cached_container.h.
|
protected |
List of all the stored items.
Definition at line 105 of file cached_container.h.
CACHED_CONTAINER::CACHED_CONTAINER | ( | unsigned int | aSize = DEFAULT_SIZE | ) |
Definition at line 54 of file cached_container.cpp.
References m_freeChunks.
|
inlinevirtual |
Definition at line 50 of file cached_container.h.
|
protected |
Add a chunk marked as a free space.
Store size & offset of free chunks.
Definition at line 391 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().
|
inlinevirtual |
Reimplemented in KIGFX::CACHED_CONTAINER_GPU.
Definition at line 97 of file cached_container.h.
Referenced by KIGFX::GPU_CACHED_MANAGER::EndDrawing().
|
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.
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 111 of file cached_container.cpp.
References KIGFX::VERTEX_ITEM::GetSize(), IsMapped(), m_chunkOffset, m_chunkSize, KIGFX::VERTEX_CONTAINER::m_dirty, KIGFX::VERTEX_CONTAINER::m_failed, m_item, KIGFX::VERTEX_CONTAINER::m_vertices, reallocate(), KIGFX::VERTEX_ITEM::setSize(), showFreeChunks(), showUsedChunks(), and test().
|
overridevirtual |
Remove all data stored in the container and restores its original state.
Implements KIGFX::VERTEX_CONTAINER.
Definition at line 193 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 KIGFX::VERTEX_CONTAINER::m_dirty.
Referenced by KIGFX::GPU_CACHED_MANAGER::EndDrawing().
|
protected |
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 276 of file cached_container.cpp.
References KIGFX::VERTEX_ITEM::GetOffset(), KIGFX::VERTEX_ITEM::GetSize(), m_chunkOffset, m_item, m_items, m_maxIndex, KIGFX::VERTEX_CONTAINER::m_vertices, KIGFX::VERTEX_ITEM::setOffset(), KIGFX::VERTEX_CONTAINER::usedSpace(), and KIGFX::VERTEX_SIZE.
Referenced by KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), and KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy().
|
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.
aNewSize | is the new size of container, expressed in number of vertices. |
Implemented in KIGFX::CACHED_CONTAINER_GPU, and KIGFX::CACHED_CONTAINER_RAM.
Referenced by Delete(), and reallocate().
|
overridevirtual |
Remove all data stored in the container and restores its original state.
Implements KIGFX::VERTEX_CONTAINER.
Definition at line 152 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().
|
overridevirtual |
Clean up after adding an item.
Reimplemented from KIGFX::VERTEX_CONTAINER.
Definition at line 79 of file cached_container.cpp.
References addFreeChunk(), KIGFX::VERTEX_ITEM::GetOffset(), KIGFX::VERTEX_ITEM::GetSize(), 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 KIGFX::VERTEX_CONTAINER::m_vertices.
Referenced by KIGFX::GPU_NONCACHED_MANAGER::EndDrawing().
|
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().
|
inlineprotected |
Return the offset of a chunk.
aChunk | is the chunk. |
Definition at line 157 of file cached_container.h.
Referenced by reallocate().
|
inlineprotected |
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 KIGFX::VERTEX_CONTAINER::m_currentSize.
Referenced by KIGFX::GPU_NONCACHED_MANAGER::EndDrawing().
|
inlinevirtualinherited |
Return vertices stored at the specific offset.
aOffset | is the offset. |
Definition at line 117 of file vertex_container.h.
References KIGFX::VERTEX_CONTAINER::m_vertices.
|
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 52 of file cached_container.h.
|
inlineinherited |
Return information about the container cache state.
Definition at line 135 of file vertex_container.h.
References KIGFX::VERTEX_CONTAINER::m_dirty.
|
pure virtual |
Return true if vertex buffer is currently mapped.
Prepare the container for vertices updates.
Implemented in KIGFX::CACHED_CONTAINER_GPU, and KIGFX::CACHED_CONTAINER_RAM.
Referenced by Allocate(), KIGFX::GPU_CACHED_MANAGER::EndDrawing(), and reallocate().
|
staticinherited |
Return a pointer to a new container of an appropriate type.
Definition at line 42 of file vertex_container.cpp.
Referenced by KIGFX::VERTEX_MANAGER::VERTEX_MANAGER().
|
overridepure virtual |
Finish the vertices updates stage.
Reimplemented from KIGFX::VERTEX_CONTAINER.
Implemented in KIGFX::CACHED_CONTAINER_GPU, and KIGFX::CACHED_CONTAINER_RAM.
|
protected |
Look for consecutive free memory chunks and merges them, decreasing fragmentation of memory.
Definition at line 337 of file cached_container.cpp.
References m_freeChunks, and test().
|
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.
aSize | is the requested chunk size. |
Definition at line 212 of file cached_container.cpp.
References addFreeChunk(), defragmentResize(), getChunkOffset(), getChunkSize(), KIGFX::VERTEX_ITEM::GetSize(), IsMapped(), m_chunkOffset, m_chunkSize, KIGFX::VERTEX_CONTAINER::m_currentSize, m_freeChunks, KIGFX::VERTEX_CONTAINER::m_freeSpace, m_item, KIGFX::VERTEX_CONTAINER::m_vertices, KIGFX::VERTEX_ITEM::setOffset(), 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 KIGFX::VERTEX_CONTAINER::m_dirty.
|
overridevirtual |
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.
|
private |
Debug & test functions.
Definition at line 401 of file cached_container.cpp.
Referenced by Allocate().
|
private |
Definition at line 406 of file cached_container.cpp.
Referenced by Allocate().
|
private |
Definition at line 411 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().
|
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().
|
inlineprotectedinherited |
Return size of the used memory space.
Definition at line 165 of file vertex_container.h.
References KIGFX::VERTEX_CONTAINER::m_currentSize, and KIGFX::VERTEX_CONTAINER::m_freeSpace.
Referenced by 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.
|
protected |
Maximal vertex index number stored in the container.
Definition at line 178 of file cached_container.h.
Referenced by Allocate(), defragment(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), FinishItem(), reallocate(), and SetItem().
|
protected |
Definition at line 177 of file cached_container.h.
Referenced by Allocate(), 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 addFreeChunk(), KIGFX::NONCACHED_CONTAINER::Allocate(), KIGFX::CACHED_CONTAINER_GPU::CACHED_CONTAINER_GPU(), Clear(), KIGFX::NONCACHED_CONTAINER::Clear(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy(), Delete(), KIGFX::VERTEX_CONTAINER::GetSize(), reallocate(), test(), and KIGFX::VERTEX_CONTAINER::usedSpace().
|
protectedinherited |
Default initial size of a container (expressed in vertices)
Definition at line 184 of file vertex_container.h.
Referenced by Allocate(), KIGFX::VERTEX_CONTAINER::ClearDirty(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), KIGFX::VERTEX_CONTAINER::IsDirty(), KIGFX::VERTEX_CONTAINER::SetDirty(), and KIGFX::CACHED_CONTAINER_RAM::Unmap().
|
protectedinherited |
Definition at line 183 of file vertex_container.h.
Referenced by Allocate(), and Clear().
|
protected |
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 addFreeChunk(), KIGFX::NONCACHED_CONTAINER::Allocate(), Clear(), KIGFX::NONCACHED_CONTAINER::Clear(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy(), Delete(), reallocate(), test(), and KIGFX::VERTEX_CONTAINER::usedSpace().
|
protectedinherited |
|
protected |
Properties of currently modified chunk & item.
Definition at line 174 of file cached_container.h.
Referenced by Allocate(), defragment(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), FinishItem(), reallocate(), SetItem(), and test().
|
protected |
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().
|
protected |
Definition at line 181 of file cached_container.h.
Referenced by Clear(), defragment(), FinishItem(), and KIGFX::CACHED_CONTAINER_RAM::Unmap().
|
protectedinherited |
Definition at line 180 of file vertex_container.h.
Referenced by Allocate(), KIGFX::NONCACHED_CONTAINER::Allocate(), KIGFX::CACHED_CONTAINER_RAM::CACHED_CONTAINER_RAM(), defragment(), KIGFX::CACHED_CONTAINER_RAM::defragmentResize(), KIGFX::VERTEX_CONTAINER::GetAllVertices(), KIGFX::VERTEX_CONTAINER::GetVertices(), KIGFX::CACHED_CONTAINER_GPU::Map(), KIGFX::NONCACHED_CONTAINER::NONCACHED_CONTAINER(), reallocate(), KIGFX::CACHED_CONTAINER_GPU::Unmap(), KIGFX::CACHED_CONTAINER_RAM::Unmap(), KIGFX::CACHED_CONTAINER_RAM::~CACHED_CONTAINER_RAM(), and KIGFX::NONCACHED_CONTAINER::~NONCACHED_CONTAINER().