A generic OpenGL buffer. This can be: -> a vertex buffer -> an index buffer -> a shader storage buffer (SSBO), etc.

Inheritance diagram for makVrv::DtGlBuffer:

Public Member Functions
	DtGlBuffer (const char *name, DtBufferType type, DtUsage usage, DtCpuAccess accessType, bool hasStagingBuffer)

virtual	~DtGlBuffer ()

virtual void	tearDown (void)

virtual unsigned int	releaseHandle (void)

virtual bool	updateBuffer (const int sizeToTransferInBytes, const void *data)

virtual bool	updateBuffer (const int offsetInBytes, const int sizeToTransferInBytes, const void *data)

virtual void	clearBuffer (unsigned int clearValue)

virtual bool	bufferSubData (unsigned int offset, unsigned int sizeInBytes, const void *data)

virtual void	resetStagingBuffer ()

virtual int	sizeInBytes (void) const

virtual int	sizeInBytesFromGl (void) const

virtual const unsigned int	handle (void) const

virtual void	setResizeMultiplier (float rmul)

virtual void	setUseIncrementalUpdate (bool incrementalUpdate)

virtual bool	useIncrementalUpdate ()

virtual float	resizeMultiplier ()

unsigned int	type (void) const

virtual uint64_t	gpuResidentAddress ()

virtual const void *	mapForReading (void) const

virtual void	unMap (void) const

template<class T >
void	printContents (std::ostream &outputStream, const std::string &strNumPrefix, const std::string &strValPrefix) const

virtual const DtGlBufferListener *	listener (void) const

virtual DtGlBufferListener *	listener (void)

virtual void	setListener (DtGlBufferListener *listener)

virtual const std::string &	name () const

virtual bool	gpuResidentAddressWasCalledAtleastOnce (void) const


virtual void	bind () const

virtual void	unbind () const


virtual unsigned char *	stagingBuffer (void) const

virtual unsigned char *	stagingBufferWithSize (unsigned int requestedSizeInBytes)

virtual void	syncStagingBufferToGpu (unsigned int offset, unsigned int sizeInBytes)

virtual void	syncStagingBufferToGpu ()

Protected Member Functions
virtual bool	createAndBindBuffer ()

virtual int	calculateNewSize (int requestedNewSizeInBytes)

Protected Attributes
std::string	myName

unsigned int	myHandle

unsigned int	myType

int	mySizeInBytes

float	myResizeMultiplier

unsigned char *	myStagingBuffer

bool	myHasStagingBuffer

DtUsage	myUsage

DtCpuAccess	myAccessType

bool	myUseIncrementalUpdate

int	myLastBufferTransferOffset

uint64_t	myResidentAddress

bool	myIsResident

bool	myMutableIsMapped

DtGlBufferListener *	myListener

Private Member Functions
	DtGlBuffer ()=delete

	DtGlBuffer (const DtGlBuffer &other)=delete

DtGlBuffer &	operator= (const DtGlBuffer &other)=delete

Constructor & Destructor Documentation

makVrv::DtGlBuffer::DtGlBuffer	(	const char *	name,
		DtBufferType	type,
		DtUsage	usage,
		DtCpuAccess	accessType,
		bool	hasStagingBuffer
	)

CTOR.

Parameters

name	Name of buffer for debugging and nsight.
type	Indicates the type of the buffer this will be (vertex buffer, index buffer, etc)
usage	Indicates what the intended usage of this buffer will be (dynamic, const, etc)
accessType	Indicates what level of CPU access is needed (will CPU only ever write, etc)
hasStagingBuffer	indicates whether this buffer will have an internal staging buffer

virtual makVrv::DtGlBuffer::~DtGlBuffer ( )

virtual

DTOR.

makVrv::DtGlBuffer::DtGlBuffer ( )

privatedelete

not allowed

makVrv::DtGlBuffer::DtGlBuffer ( const DtGlBuffer & other )

privatedelete

Copy Constructor not implemented – Copy Not Allowed.

Member Function Documentation

DtGlBuffer& makVrv::DtGlBuffer::operator= ( const DtGlBuffer & other )

privatedelete

Assignment Operator Not implemented � Assignment Not Allowed.

virtual void makVrv::DtGlBuffer::tearDown ( void )

virtual

releases GL objects and delete GL buffer

virtual unsigned int makVrv::DtGlBuffer::releaseHandle ( void )

virtual

releases GL handle but does not delete GL buffer

virtual bool makVrv::DtGlBuffer::updateBuffer	(	const int	sizeToTransferInBytes,
		const void *	data
	)

virtual

update the buffer, this can resize it if needed or create it from scratch

Parameters

sizeInBytes	size in bytes of the incoming data
data	is the data to copy from.

virtual bool makVrv::DtGlBuffer::updateBuffer	(	const int	offsetInBytes,
		const int	sizeToTransferInBytes,
		const void *	data
	)

virtual

update the buffer, this can resize it if needed or create it from scratch

Parameters

offsetInBytes	offset into the buffer from where to update
sizeInBytes	size in bytes of the incoming data
data	is the data to copy from.

virtual void makVrv::DtGlBuffer::clearBuffer ( unsigned int clearValue )

virtual

clear the buffer to the value specified. clears both the GPU data and the staging buffer if there is a staging buffer. requires valid graphics context

virtual void makVrv::DtGlBuffer::bind ( ) const

virtual

bind/unbind the buffer bind will not create the buffer if it is not yet created. it will also spew a warning so it is easy to know when it is used incorrectly.

virtual void makVrv::DtGlBuffer::unbind ( ) const

virtual

bind/unbind the buffer bind will not create the buffer if it is not yet created. it will also spew a warning so it is easy to know when it is used incorrectly.

virtual unsigned char* makVrv::DtGlBuffer::stagingBuffer ( void ) const

virtual

Internally GLBuffer uses a 'staging buffer' This is because map/unmap and directly uploading to the buffer is horribly slow in OpenGL. The usage therefore is to get the staging buffer, modify it and then call syncStagingBufferToGpu.

virtual unsigned char* makVrv::DtGlBuffer::stagingBufferWithSize ( unsigned int requestedSizeInBytes )

virtual

gets the staging buffer can resize the opengl data.. FIXME seperate sb size from ogl

virtual void makVrv::DtGlBuffer::syncStagingBufferToGpu	(	unsigned int	offset,
		unsigned int	sizeInBytes
	)

virtual

Use when you modified (and hence need to update) only part of the buffer [offset, offset+sizeInBytes].

virtual void makVrv::DtGlBuffer::syncStagingBufferToGpu ( )

virtual

Use when you modified (and hence need to update) the whole buffer [0, sizeInBytes()].

virtual bool makVrv::DtGlBuffer::bufferSubData	(	unsigned int	offset,
		unsigned int	sizeInBytes,
		const void *	data
	)

virtual

Optional API to upload data directly to the buffer, side stepping the staging buffer. You can use one or the other. That is to say you cannot use this API if you specified that this buffer has a staging buffer, which means you'll use that API (getStagingBuffer, syncToGPU)

virtual void makVrv::DtGlBuffer::resetStagingBuffer ( )

virtual

set the whole staging buffer to 0

virtual int makVrv::DtGlBuffer::sizeInBytes ( void ) const

virtual

The size in bytes of the buffer.

virtual int makVrv::DtGlBuffer::sizeInBytesFromGl ( void ) const

virtual

The size in bytes of the buffer from OpenGL.

virtual const unsigned int makVrv::DtGlBuffer::handle ( void ) const

virtual

The internal GL handle of the buffer.

virtual void makVrv::DtGlBuffer::setResizeMultiplier ( float rmul )

virtual

multiplier on how much extra memory should get allocated at gl buffer creation time.

virtual void makVrv::DtGlBuffer::setUseIncrementalUpdate ( bool incrementalUpdate )

virtual

enable or disable incremental update for this buffer this means that only new data is sent down instead of resending the whole buffer every time. On resize all the data is sent down again. use this if the data is static

virtual bool makVrv::DtGlBuffer::useIncrementalUpdate ( )

virtual

get the current state of incremental update for this buffer.

virtual float makVrv::DtGlBuffer::resizeMultiplier ( )

virtual

returns multiplier on how much extra memory should get allocated at gl buffer creation time.

unsigned int makVrv::DtGlBuffer::type ( void ) const

The internal OpenGL type of the buffer of the gl buffer.

virtual uint64_t makVrv::DtGlBuffer::gpuResidentAddress ( )

virtual

Get the bindless gpu address for this buffer. It makes it resident if it is not already Bindless accessed buffers are read only since only GL_READ_ONLY is supported according to the spec.

virtual const void* makVrv::DtGlBuffer::mapForReading ( void ) const

virtual

map the buffer for reading on the CPU side

Should only be used for debugging purposes. In the past we determined that mapping buffers is very slow

virtual void makVrv::DtGlBuffer::unMap ( void ) const

virtual

unmap a previously mapped buffer

Should only be used for debugging purposes. In the past we determined that mapping buffers is very slow

template<class T >

void makVrv::DtGlBuffer::printContents	(	std::ostream &	outputStream,
		const std::string &	strNumPrefix,
		const std::string &	strValPrefix
	)		const

inline

Template function to print the contents of the buffer. The contents are interpreted as items of type T. Requires that operator << will be defined for the type T. cannot be a virtual since its a template function.

virtual const DtGlBufferListener* makVrv::DtGlBuffer::listener ( void ) const

virtual

Each DtGlBuffer can have a listener set on it. When the buffer is deleted/becomes resident/non-resident, the buffer will call the 3 signals/functions here from within its internal functions. **Note* for speed reasons, a buffer can have only one listener set on it Right now, the listener class does memory tracking for all buffers get the listener.

virtual DtGlBufferListener* makVrv::DtGlBuffer::listener ( void )

virtual

get the listener (non-const)

virtual void makVrv::DtGlBuffer::setListener ( DtGlBufferListener * listener )

virtual

set the listener

virtual const std::string& makVrv::DtGlBuffer::name ( ) const

virtual

The name. This is the same as the given gl object name If the object handle gets released externally, attempt to get that name from the id does not succeed, so this can be used instead.

virtual bool makVrv::DtGlBuffer::gpuResidentAddressWasCalledAtleastOnce ( void ) const

virtual

was called atleast once (hence the buffer was tried to be made resident)

virtual bool makVrv::DtGlBuffer::createAndBindBuffer ( )

protectedvirtual

creates buffer, must be called in main render thread. returns true if the buffer was created

virtual int makVrv::DtGlBuffer::calculateNewSize ( int requestedNewSizeInBytes )

protectedvirtual

helper function to calculate the new size a buffer should be based on it's current size and the requested size.

Member Data Documentation

std::string makVrv::DtGlBuffer::myName

protected

unsigned int makVrv::DtGlBuffer::myHandle

protected

unsigned int makVrv::DtGlBuffer::myType

protected

int makVrv::DtGlBuffer::mySizeInBytes

protected

float makVrv::DtGlBuffer::myResizeMultiplier

protected

unsigned char* makVrv::DtGlBuffer::myStagingBuffer

protected

bool makVrv::DtGlBuffer::myHasStagingBuffer

protected

DtUsage makVrv::DtGlBuffer::myUsage

protected

DtCpuAccess makVrv::DtGlBuffer::myAccessType

protected

bool makVrv::DtGlBuffer::myUseIncrementalUpdate

protected

int makVrv::DtGlBuffer::myLastBufferTransferOffset

protected

uint64_t makVrv::DtGlBuffer::myResidentAddress

protected

bool makVrv::DtGlBuffer::myIsResident

protected

bool makVrv::DtGlBuffer::myMutableIsMapped

mutableprotected

DtGlBufferListener* makVrv::DtGlBuffer::myListener

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvGraphicsUtils/DtGlBuffer.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation