#include <vertex_container.h>

Inheritance diagram for KIGFX::VERTEX_CONTAINER:

Public Member Functions
virtual	~VERTEX_CONTAINER ()

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

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

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

virtual void	Unmap ()
	Finish the vertices updates stage.

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

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

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

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

virtual void	Clear ()=0
	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 Member Functions
	VERTEX_CONTAINER (unsigned int aSize=DEFAULT_SIZE)

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

Protected Attributes
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)

Detailed Description

Definition at line 38 of file vertex_container.h.

Constructor & Destructor Documentation

◆ ~VERTEX_CONTAINER()

VERTEX_CONTAINER::~VERTEX_CONTAINER ( )

virtual

Definition at line 67 of file vertex_container.cpp.

◆ VERTEX_CONTAINER()

VERTEX_CONTAINER::VERTEX_CONTAINER ( unsigned int aSize = DEFAULT_SIZE )

protected

Definition at line 56 of file vertex_container.cpp.

References m_currentSize, m_dirty, m_failed, m_freeSpace, m_initialSize, and m_vertices.

Referenced by KIGFX::CACHED_CONTAINER::CACHED_CONTAINER(), MakeContainer(), and KIGFX::NONCACHED_CONTAINER::NONCACHED_CONTAINER().

Member Function Documentation

◆ Abandon()

virtual void KIGFX::VERTEX_CONTAINER::Abandon ( )

inlinevirtual

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.

◆ Allocate()

virtual VERTEX * KIGFX::VERTEX_CONTAINER::Allocate ( unsigned int aSize )

pure virtual

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 or NULL in case of failure.

Implemented in KIGFX::CACHED_CONTAINER, and KIGFX::NONCACHED_CONTAINER.

◆ Clear()

virtual void KIGFX::VERTEX_CONTAINER::Clear ( )

pure virtual

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

Implemented in KIGFX::CACHED_CONTAINER, and KIGFX::NONCACHED_CONTAINER.

◆ ClearDirty()

void KIGFX::VERTEX_CONTAINER::ClearDirty ( )

inline

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().

◆ Delete()

virtual void KIGFX::VERTEX_CONTAINER::Delete ( VERTEX_ITEM * aItem )

pure virtual

Erase the data related to an item.

Parameters

aItem is the item to be erased.

Implemented in KIGFX::CACHED_CONTAINER, and KIGFX::NONCACHED_CONTAINER.

◆ FinishItem()

virtual void KIGFX::VERTEX_CONTAINER::FinishItem ( )

inlinevirtual

Clean up after adding an item.

Reimplemented in KIGFX::CACHED_CONTAINER.

Definition at line 83 of file vertex_container.h.

◆ GetAllVertices()

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

inline

Return pointer to the vertices stored in the container.

Definition at line 112 of file vertex_container.h.

References m_vertices.

◆ GetSize()

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

inlinevirtual

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

inlinevirtual

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()

virtual bool KIGFX::VERTEX_CONTAINER::IsCached ( ) const

pure virtual

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

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

Implemented in KIGFX::CACHED_CONTAINER, and KIGFX::NONCACHED_CONTAINER.

Referenced by KIGFX::GPU_MANAGER::MakeManager().

◆ IsDirty()

bool KIGFX::VERTEX_CONTAINER::IsDirty ( ) const

inline

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.

◆ MakeContainer()

VERTEX_CONTAINER * VERTEX_CONTAINER::MakeContainer ( bool aCached )

static

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::VERTEX_CONTAINER::Map ( )

inlinevirtual

Prepare the container for vertices updates.

Reimplemented in KIGFX::CACHED_CONTAINER, KIGFX::CACHED_CONTAINER_GPU, and KIGFX::CACHED_CONTAINER_RAM.

Definition at line 66 of file vertex_container.h.

◆ SetDirty()

void KIGFX::VERTEX_CONTAINER::SetDirty ( )

inline

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()

virtual void KIGFX::VERTEX_CONTAINER::SetItem ( VERTEX_ITEM * aItem )

pure virtual

Set the item for the further actions.

Parameters

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

Implemented in KIGFX::CACHED_CONTAINER, and KIGFX::NONCACHED_CONTAINER.

◆ Unmap()

virtual void KIGFX::VERTEX_CONTAINER::Unmap ( )

inlinevirtual

Finish the vertices updates stage.

Reimplemented in KIGFX::CACHED_CONTAINER, KIGFX::CACHED_CONTAINER_GPU, and KIGFX::CACHED_CONTAINER_RAM.

Definition at line 71 of file vertex_container.h.

◆ usedSpace()

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

inlineprotected

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

staticconstexprprotected

Default initial size of a container (expressed in vertices)

Definition at line 192 of file vertex_container.h.

◆ m_currentSize

unsigned int KIGFX::VERTEX_CONTAINER::m_currentSize

protected

Current container size, expressed in vertices.

Definition at line 179 of file vertex_container.h.

◆ m_dirty

bool KIGFX::VERTEX_CONTAINER::m_dirty

protected

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

protected

Definition at line 188 of file vertex_container.h.

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

◆ m_freeSpace

unsigned int KIGFX::VERTEX_CONTAINER::m_freeSpace

protected

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

protected

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_vertices

VERTEX* KIGFX::VERTEX_CONTAINER::m_vertices

protected

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 Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~VERTEX_CONTAINER()

◆ VERTEX_CONTAINER()

Member Function Documentation

◆ Abandon()

◆ Allocate()

◆ Clear()

◆ ClearDirty()

◆ Delete()

◆ FinishItem()

◆ GetAllVertices()

◆ GetSize()

◆ GetVertices()

◆ IsCached()

◆ IsDirty()

◆ MakeContainer()

◆ Map()

◆ SetDirty()

◆ SetItem()

◆ Unmap()

◆ usedSpace()

Member Data Documentation

◆ DEFAULT_SIZE

◆ m_currentSize

◆ m_dirty

◆ m_failed

◆ m_freeSpace

◆ m_initialSize

◆ m_vertices