Inheritance diagram for Cogs::BuffersVK:

Public Member Functions
void	initialize (class GraphicsDeviceVK *graphicsDevice)

VertexBufferHandle	loadVertexBuffer (const void *vertexData, const size_t count, const VertexFormat &vertexFormat) override
	Loads a new vertex buffer and populates it with the given data.

VertexBufferHandle	loadVertexBuffer (const void *vertexData, const size_t count, VertexFormatHandle vertexFormatHandle) override

void	releaseVertexBuffer (VertexBufferHandle vertexBufferHandle) override
	Release the vertex buffer with the given handle.

IndexBufferHandle	loadIndexBuffer (const void *indexData, const size_t count, const size_t indexSize) override
	Loads a new index buffer and populates it with the given indexData.

void	releaseIndexBuffer (IndexBufferHandle indexBufferHandle) override
	Releases the index buffer with the given handle.

InputLayoutHandle	loadInputLayout (const VertexFormatHandle *vertexFormats, const size_t count, EffectHandle effectHandle) override
	Loads a new input layout to map vertex flow between vertex buffers with the given vertexFormats to effects using the vertex layout of the given effectHandle.

void	releaseInputLayout (InputLayoutHandle inputLayoutHandle) override
	Releases the input layout with the given inputLayoutHandle.

BufferHandle	loadBuffer (const void *data, const size_t size, Usage::EUsage usage, uint32_t accessMode, uint32_t bindFlags, uint32_t stride=0) override
	Loads a new buffer using the given data to populate the buffer.

void	retrieveSubBuffer (void *data, BufferHandle source, const size_t offset, const size_t size) override
	Retrieves the contents of a buffer.

void	releaseBuffer (BufferHandle bufferHandle) override
	Releases the buffer with the given bufferHandle.

void *	getNativeHandle (BufferHandle bufferHandle) override
	Get the device-specific handle (D3D buffer pointer, OpenGL buffer ID etc) associated with the given buffer handle.

void	releaseResources () override
	Releases all allocated buffer resources.

Public Member Functions inherited from Cogs::BuffersCommon
virtual VertexFormatHandle	createVertexFormat (const VertexElement *elements, size_t count) override

virtual const VertexFormat *	getVertexFormat (VertexFormatHandle handle) override

virtual VertexArrayObjectHandle	loadVertexArrayObject (const EffectHandle effectHandle, const VertexBufferHandle vertexBufferHandles, const size_t vertexBufferCount, const VertexFormat const vertexFormats=nullptr, const uint32_t vertexBufferStrides=nullptr, const uint32_t *vertexBufferOffsets=nullptr, const IndexBufferHandle indexBufferHandle=IndexBufferHandle::NoHandle, uint32_t indexBufferStride=0) override

virtual void	releaseVertexArrayObject (VertexArrayObjectHandle) override

Public Member Functions inherited from Cogs::IBuffers
virtual void	annotate (BufferHandle handle, const StringView &name)
	Associate a name with an object for use in graphics debugging.

virtual void	annotate (VertexBufferHandle handle, const StringView &name)
	Associate a name with an object for use in graphics debugging.

virtual VertexBufferHandle	loadVertexBuffer (const void *vertexData, const size_t count, const VertexFormat &vertexFormat)=0
	Loads a new vertex buffer and populates it with the given data.

virtual VertexBufferHandle	loadVertexBuffer (const void *vertexData, const size_t count, VertexFormatHandle vertexFormatHandle)=0

virtual void	releaseVertexBuffer (VertexBufferHandle vertexBufferHandle)=0
	Release the vertex buffer with the given handle.

virtual IndexBufferHandle	loadIndexBuffer (const void *indexData, const size_t count, const size_t indexSize)=0
	Loads a new index buffer and populates it with the given indexData.

virtual void	releaseIndexBuffer (IndexBufferHandle indexBufferHandle)=0
	Releases the index buffer with the given handle.

virtual VertexArrayObjectHandle	loadVertexArrayObject (const EffectHandle effectHandle, const VertexBufferHandle vertexBufferHandles, const size_t vertexBufferCount, const VertexFormat const vertexFormats=nullptr, const uint32_t vertexBufferStrides=nullptr, const uint32_t *vertexBufferOffsets=nullptr, const IndexBufferHandle indexBufferHandle=IndexBufferHandle::NoHandle, uint32_t indexBufferStride=0)=0
	Create a vertex array object that encapsulates binding of a set of vertex buffers and an optional index buffer.

virtual void	releaseVertexArrayObject (VertexArrayObjectHandle vertexArrayObjectHandle)=0
	Releases the vertex array object with the given handle.

virtual InputLayoutHandle	loadInputLayout (const VertexFormatHandle *vertexFormats, const size_t count, EffectHandle effectHandle)=0
	Loads a new input layout to map vertex flow between vertex buffers with the given vertexFormats to effects using the vertex layout of the given effectHandle.

virtual void	releaseInputLayout (InputLayoutHandle inputLayoutHandle)=0
	Releases the input layout with the given inputLayoutHandle.

virtual BufferHandle	loadBuffer (const void *data, const size_t size, Usage::EUsage usage, uint32_t accessMode, uint32_t bindFlags, uint32_t stride=0)=0
	Loads a new buffer using the given data to populate the buffer.

virtual VertexFormatHandle	createVertexFormat (const VertexElement *elements, size_t count)=0

virtual const VertexFormat *	getVertexFormat (VertexFormatHandle handle)=0

virtual void	retrieveSubBuffer (void *data, BufferHandle source, const size_t offset, const size_t size)=0
	Retrieves the contents of a buffer.

virtual void	releaseBuffer (BufferHandle bufferHandle)=0
	Releases the buffer with the given bufferHandle.

virtual void *	getNativeHandle (BufferHandle bufferHandle)=0
	Get the device-specific handle (D3D buffer pointer, OpenGL buffer ID etc) associated with the given buffer handle.

virtual void	releaseResources ()=0
	Releases all allocated buffer resources.

Public Attributes
class GraphicsDeviceVK *	graphicsDevice

ResourceMap< BufferHandle, BufferVK >	buffers

ResourceMap< InputLayoutHandle, InputLayoutVK >	inputLayouts

std::unordered_map< size_t, VertexFormat >	vertexFormats

BufferPoolVK	pool256

BufferPoolVK	pool1024

Detailed Description

Definition at line 87 of file BuffersVK.h.

Member Function Documentation

◆ getNativeHandle()

void * Cogs::BuffersVK::getNativeHandle ( BufferHandle bufferHandle )

overridevirtual

Get the device-specific handle (D3D buffer pointer, OpenGL buffer ID etc) associated with the given buffer handle.

Parameters

bufferHandle Valid handle to a previously created buffer object.

Returns: Native handle

Implements Cogs::IBuffers.

Definition at line 336 of file BuffersVK.cpp.

◆ initialize()

void Cogs::BuffersVK::initialize ( class GraphicsDeviceVK * graphicsDevice )

Definition at line 74 of file BuffersVK.cpp.

◆ loadBuffer()

Cogs::BufferHandle Cogs::BuffersVK::loadBuffer	(	const void *	data,
		const size_t	size,
		Usage::EUsage	usage,
		uint32_t	accessMode,
		uint32_t	bindFlags,
		uint32_t	stride = `0`
	)

overridevirtual

Loads a new buffer using the given data to populate the buffer.

Parameters

data	Pointer to data used to populate the buffer. Must be at least size number of bytes.
size	Size of the buffer to create in bytes.
usage	Usage flags for the buffer. Specifies how the buffer is intended to be used.
accessMode	Access mode flags for the buffer. Specifies how the buffer can be accessed at a later time.
bindFlags	Binding flags specifying how the buffer can be bound to the pipeline at a later state.

Returns: Handle to a new buffer, InvalidHandle if no buffer could be created with the given parameters.

See also: Usage, AccessMode, BindFlags

Implements Cogs::IBuffers.

Definition at line 236 of file BuffersVK.cpp.

References Cogs::BindFlags::ConstantBuffer, Cogs::BindFlags::IndexBuffer, Cogs::Handle_t< BufferTag >::InvalidHandle, Cogs::AccessMode::Read, Cogs::Usage::Staging, Cogs::BindFlags::VertexBuffer, and Cogs::AccessMode::Write.

◆ loadIndexBuffer()

Cogs::IndexBufferHandle Cogs::BuffersVK::loadIndexBuffer	(	const void *	indexData,
		const size_t	count,
		const size_t	indexSize
	)

overridevirtual

Loads a new index buffer and populates it with the given indexData.

The size of the buffer (if given) must be at least indexSize * count.

Parameters

indexData	Pointer to index data in memory, or nullptr to initialize an empty index buffer.
count	Number of indexes given.
indexSize	Size of an index in bytes.

Returns: Handle to the loaded index buffer, InvalidHandle if the operation failed.

Implements Cogs::IBuffers.

Definition at line 114 of file BuffersVK.cpp.

References Cogs::Usage::Dynamic, Cogs::BindFlags::IndexBuffer, and Cogs::AccessMode::Write.

◆ loadInputLayout()

Cogs::InputLayoutHandle Cogs::BuffersVK::loadInputLayout	(	const VertexFormatHandle *	vertexFormats,
		const size_t	count,
		EffectHandle	effectHandle
	)

overridevirtual

Loads a new input layout to map vertex flow between vertex buffers with the given vertexFormats to effects using the vertex layout of the given effectHandle.

Parameters

vertexFormats	Pointer to an array of pointers to vertex formats. One for each vertex buffer that in sum describes total vertex data.
count	Number of vertex formats given.
effectHandle	Handle to a valid effect containing a valid vertex shader. The input requirements of the vertex shader is used to specify the flow of vertex data from the vertex buffer(s) specified by vertexFormats into the shader stage.

Returns: Handle to a new input layout object, InvalidHandle if no valid input layout could be created.

Implements Cogs::IBuffers.

Definition at line 145 of file BuffersVK.cpp.

References Cogs::VertexFormat::elements, Cogs::InstanceMatrix, Cogs::InstanceVector, Cogs::Handle_t< InputLayoutTag >::InvalidHandle, and Cogs::VertexData.

◆ loadVertexBuffer() [1/2]

Cogs::VertexBufferHandle Cogs::BuffersVK::loadVertexBuffer	(	const void *	vertexData,
		const size_t	count,
		const VertexFormat &	vertexFormat
	)

overridevirtual

Loads a new vertex buffer and populates it with the given data.

The size of the buffer (if given) must be at least the size of a vertex in the given vertexFormat times count.

Parameters

vertexData	Pointer to vertex data in memory, or nullptr to initialize an empty vertex buffer.
count	Number of vertexes in the vertex data.
vertexFormat	Format of the vertexes in the given memory buffer.

Returns: Handle to the loaded vertex buffer, InvalidHandle if the operation failed.

Implements Cogs::IBuffers.

Definition at line 80 of file BuffersVK.cpp.

References Cogs::Usage::Dynamic, Cogs::BindFlags::VertexBuffer, and Cogs::AccessMode::Write.

◆ loadVertexBuffer() [2/2]

Cogs::VertexBufferHandle Cogs::BuffersVK::loadVertexBuffer	(	const void *	vertexData,
		const size_t	count,
		VertexFormatHandle	vertexFormatHandle
	)

overridevirtual

Implements Cogs::IBuffers.

Definition at line 103 of file BuffersVK.cpp.

◆ releaseBuffer()

void Cogs::BuffersVK::releaseBuffer ( BufferHandle bufferHandle )

overridevirtual

Releases the buffer with the given bufferHandle.

Parameters

bufferHandle Valid handle to a previously created buffer.

Implements Cogs::IBuffers.

Definition at line 331 of file BuffersVK.cpp.

◆ releaseIndexBuffer()

void Cogs::BuffersVK::releaseIndexBuffer ( IndexBufferHandle indexBufferHandle )

overridevirtual

Releases the index buffer with the given handle.

Parameters

indexBufferHandle Valid handle to a previously created index buffer.

Implements Cogs::IBuffers.

Definition at line 126 of file BuffersVK.cpp.

◆ releaseInputLayout()

void Cogs::BuffersVK::releaseInputLayout ( InputLayoutHandle inputLayoutHandle )

overridevirtual

Releases the input layout with the given inputLayoutHandle.

Parameters

inputLayoutHandle Valid handle to a previously created index buffer.

Implements Cogs::IBuffers.

Definition at line 231 of file BuffersVK.cpp.

◆ releaseResources()

void Cogs::BuffersVK::releaseResources ( )

overridevirtual

Releases all allocated buffer resources.

Implements Cogs::IBuffers.

Definition at line 341 of file BuffersVK.cpp.

◆ releaseVertexBuffer()

void Cogs::BuffersVK::releaseVertexBuffer ( VertexBufferHandle vertexBufferHandle )

overridevirtual

Release the vertex buffer with the given handle.

The data is removed from GPU memory.

Parameters

vertexBufferHandle Valid handle to a previously created vertex buffer.

Implements Cogs::IBuffers.

Definition at line 109 of file BuffersVK.cpp.

◆ retrieveSubBuffer()

void Cogs::BuffersVK::retrieveSubBuffer	(	void *	data,
		BufferHandle	source,
		const size_t	offset,
		const size_t	size
	)

overridevirtual

Retrieves the contents of a buffer.

Parameters

data	Pointer to where the data should be stored.
offset	The offset in bytes inside the buffer from where to retrieve data.
size	The number of bytes to retrieve from the buffer.

Implements Cogs::IBuffers.

Definition at line 326 of file BuffersVK.cpp.

Member Data Documentation

◆ buffers

ResourceMap<BufferHandle, BufferVK> Cogs::BuffersVK::buffers

Definition at line 109 of file BuffersVK.h.

◆ graphicsDevice

class GraphicsDeviceVK* Cogs::BuffersVK::graphicsDevice

Definition at line 92 of file BuffersVK.h.

◆ inputLayouts

ResourceMap<InputLayoutHandle, InputLayoutVK> Cogs::BuffersVK::inputLayouts

Definition at line 110 of file BuffersVK.h.

◆ pool1024

BufferPoolVK Cogs::BuffersVK::pool1024

Definition at line 115 of file BuffersVK.h.

◆ pool256

BufferPoolVK Cogs::BuffersVK::pool256

Definition at line 114 of file BuffersVK.h.

◆ vertexFormats

std::unordered_map<size_t, VertexFormat> Cogs::BuffersVK::vertexFormats

Definition at line 112 of file BuffersVK.h.

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

D:/a/1/s/Cogs/Cogs.Rendering/Source/Vulkan/BuffersVK.h
D:/a/1/s/Cogs/Cogs.Rendering/Source/Vulkan/BuffersVK.cpp

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ getNativeHandle()

◆ initialize()

◆ loadBuffer()

◆ loadIndexBuffer()

◆ loadInputLayout()

◆ loadVertexBuffer() [1/2]

◆ loadVertexBuffer() [2/2]

◆ releaseBuffer()

◆ releaseIndexBuffer()

◆ releaseInputLayout()

◆ releaseResources()

◆ releaseVertexBuffer()

◆ retrieveSubBuffer()

Member Data Documentation

◆ buffers

◆ graphicsDevice

◆ inputLayouts

◆ pool1024

◆ pool256

◆ vertexFormats