CeresEngine::GPUStorageBuffer Class Reference

#include <CeresEngine/RenderAPI/GPUBufferObject.hpp>

Inheritance diagram for CeresEngine::GPUStorageBuffer:

Public Member Functions
	GPUStorageBuffer ()=default
	Creates a new empty StorageBuffer.
	GPUStorageBuffer (GPUBufferPtr buffer, GPUBufferSize offset=0, GPUBufferSize length=GPUBuffer::whole)
	Creates a new StorageBuffer from an existing GPU buffer.
	GPUStorageBuffer (GPUBuffer &buffer, const GPUBufferSize offset=0, const GPUBufferSize length=GPUBuffer::whole)
	Storage buffer resource.
	GPUStorageBuffer (GPUDevice &device, GPUBufferSize size, const GPUMemoryProperties &memoryProperty=GPUMemoryProperty::DeviceLocal, String name="")
	Creates a new StorageBuffer.
	GPUStorageBuffer (const GPUUniformBuffer &uniformBuffer)
	Creates a new GPUStorageBuffer by converting from a GPUUniformBuffer.
	GPUStorageBuffer (std::nullptr_t)
	Creates a new empty StorageBuffer.
	GPUStorageBuffer (const GPUStorageBuffer &)=default
	Creates a new StorageBuffer by copying another.
GPUStorageBuffer &	operator= (const GPUStorageBuffer &)=default
	Assigns the StorageBuffer by copying another.
	GPUStorageBuffer (GPUStorageBuffer &&)=default
	Creates a new StorageBuffer by moving another.
GPUStorageBuffer &	operator= (GPUStorageBuffer &&)=default
	Assigns a StorageBuffer by moving another.
	~GPUStorageBuffer ()
	Destroys the StorageBuffer.
Public Member Functions inherited from CeresEngine::GPUBufferObject
	GPUBufferObject ()=default
	Creates a new empty BufferObject.
	GPUBufferObject (GPUBufferPtr buffer, GPUBufferSize offset=0, GPUBufferSize length=GPUBuffer::whole)
	Creates a new BufferObject from an existing GPU buffer.
	GPUBufferObject (GPUBuffer &buffer, const GPUBufferSize offset=0, const GPUBufferSize length=GPUBuffer::whole)
	GPUBufferObject (GPUDevice &device, const GPUBufferDescriptor &descriptor)
	Creates a new BufferObject.
	GPUBufferObject (std::nullptr_t)
	Creates a new empty BufferObject.
GPUBufferObject &	operator= (std::nullptr_t)
	Assigns the BufferObject an empty value.
	GPUBufferObject (const GPUBufferObject &)=default
	Creates a new BufferObject by copying another.
GPUBufferObject &	operator= (const GPUBufferObject &)=default
	Assigns the BufferObject by copying another.
	GPUBufferObject (GPUBufferObject &&)=default
	Creates a new BufferObject by moving another.
GPUBufferObject &	operator= (GPUBufferObject &&)=default
	Assigns a BufferObject by moving another.
	~GPUBufferObject ()
	Destroys the BufferObject.
void	flush (GPUBufferSize offset=0, GPUBufferSize size=GPUBuffer::whole)
	Flushes the cached memory data starting at offset with size bytes.
void	invalidate (GPUBufferSize offset=0, GPUBufferSize size=GPUBuffer::whole)
	Invalidates the cached memory data starting at offset with size bytes.
GPUBufferPtr	getBuffer () const noexcept
GPUBufferSize	getOffset () const noexcept
GPUBufferSize	getLength () const noexcept
	operator bool () const noexcept

Additional Inherited Members
Protected Attributes inherited from CeresEngine::GPUBufferObject
GPUBufferPtr	mBuffer = nullptr
	A pointer to the GPU allocated buffer.
GPUBufferSize	mOffset = 0
	The offset to the beginning of the buffer object data.
GPUBufferSize	mLength = GPUBuffer::whole
	The length of the buffer data.

Constructor & Destructor Documentation

GPUStorageBuffer() [1/8]

CeresEngine::GPUStorageBuffer::GPUStorageBuffer ( )

default

Creates a new empty StorageBuffer.

GPUStorageBuffer() [2/8]

CeresEngine::GPUStorageBuffer::GPUStorageBuffer ( GPUBufferPtr  buffer, GPUBufferSize  offset = 0, GPUBufferSize  length = GPUBuffer::whole  )

explicit

Creates a new StorageBuffer from an existing GPU buffer.

Parameters

buffer	The existing GPU buffer
offset	The offset to the beginning of the storage buffer

GPUStorageBuffer() [3/8]

CeresEngine::GPUStorageBuffer::GPUStorageBuffer ( GPUBuffer &  buffer, const GPUBufferSize  offset = 0, const GPUBufferSize  length = GPUBuffer::whole  )

inlineexplicit

Storage buffer resource.

GPUStorageBuffer() [4/8]

CeresEngine::GPUStorageBuffer::GPUStorageBuffer ( GPUDevice &  device, GPUBufferSize  size, const GPUMemoryProperties &  memoryProperty = GPUMemoryProperty::DeviceLocal, String  name = ""  )

explicit

Creates a new StorageBuffer.

Parameters

device	The device to create the buffer from
size	The buffer size in bytes
memoryProperty	The memory property flags
name	The buffer name (used for debugging only).

GPUStorageBuffer() [5/8]

CeresEngine::GPUStorageBuffer::GPUStorageBuffer ( const GPUUniformBuffer &  uniformBuffer )

explicit

Creates a new GPUStorageBuffer by converting from a GPUUniformBuffer.

GPUStorageBuffer() [6/8]

CeresEngine::GPUStorageBuffer::GPUStorageBuffer ( std::nullptr_t  )

inline

Creates a new empty StorageBuffer.

GPUStorageBuffer() [7/8]

CeresEngine::GPUStorageBuffer::GPUStorageBuffer ( const GPUStorageBuffer &  )

default

Creates a new StorageBuffer by copying another.

The contents of the buffer are not copied.

GPUStorageBuffer() [8/8]

CeresEngine::GPUStorageBuffer::GPUStorageBuffer ( GPUStorageBuffer &&  )

default

Creates a new StorageBuffer by moving another.

~GPUStorageBuffer()

CeresEngine::GPUStorageBuffer::~GPUStorageBuffer

(

)

Destroys the StorageBuffer.

Member Function Documentation

operator=() [1/2]

GPUStorageBuffer & CeresEngine::GPUStorageBuffer::operator= ( const GPUStorageBuffer &  )

default

Assigns the StorageBuffer by copying another.

The contents of the buffer are not copied.

operator=() [2/2]

GPUStorageBuffer & CeresEngine::GPUStorageBuffer::operator= ( GPUStorageBuffer &&  )

default

Assigns a StorageBuffer by moving another.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/GPUBufferObject.hpp