Buffer Class Reference

Used to store vertex and index data data. More...

#include <Buffer.h>

Inherits Object.

Inherited by BufferImpl, BufferImpl, BufferImpl, BufferImpl, and BufferImpl.

Public Member Functions
virtual void	updateData (const void *data, size_t size)=0
	Update buffer data.
virtual void	updateSubData (const void *data, size_t offset, size_t size)=0
	Update buffer sub-region data.
virtual void	usingDefaultStoredData (bool needDefaultStoredData)=0
	By default, static buffer data will automatically stored when it comes to foreground.
size_t	getSize () const
	Get buffer size in bytes.
uint32_t	getStride () const
	Get the logical storage element stride in bytes.
Public Member Functions inherited from Object
void	retain ()
	Retains the ownership.
void	release ()
	Releases the ownership immediately.
Object *	autorelease ()
	Releases the ownership sometime soon automatically.
unsigned int	getReferenceCount () const
	Returns the Object's current reference count.
uint64_t	getObjectID () const noexcept
	Returns the process-local diagnostic identifier assigned at construction.
virtual	~Object ()
	Destructor.

Detailed Description

Used to store vertex and index data data.

Member Function Documentation

updateData()

virtual void updateData ( const void * data, size_t size )

pure virtual

Update buffer data.

Parameters

data	Specifies a pointer to data that will be copied into the data store for initialization.
size	Specifies the size in bytes of the data store region being replaced.

See also

updateSubData(void* data, unsigned int offset, unsigned int size)

Implemented in BufferImpl, BufferImpl, BufferImpl, BufferImpl, and BufferImpl.

updateSubData()

virtual void updateSubData ( const void * data, size_t offset, size_t size )

pure virtual

Update buffer sub-region data.

Parameters

data	Specifies a pointer to the new data that will be copied into the data store.
offset	Specifies the offset into the buffer object's data store where data replacement will begin, measured in bytes.
size	Specifies the size in bytes of the data store region being replaced.

See also

updateData(void* data, unsigned int size)

Implemented in BufferImpl, BufferImpl, BufferImpl, BufferImpl, and BufferImpl.

usingDefaultStoredData()

virtual void usingDefaultStoredData ( bool needDefaultStoredData )

pure virtual

By default, static buffer data will automatically stored when it comes to foreground.

This function is used to indicate whether external data needs to be used to update the buffer instead of using the default stored data.

Parameters

needDefaultStoredData

Specifies whether to use the default stored data.

Implemented in BufferImpl, BufferImpl, BufferImpl, BufferImpl, and BufferImpl.

getSize()

size_t getSize ( ) const

inline

Get buffer size in bytes.

Returns

The buffer size in bytes.

getStride()

uint32_t getStride ( ) const

inline

Get the logical storage element stride in bytes.

Backends may expose storage through raw native views.

Returns

The element stride in bytes.

---

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

• Buffer.h