Buffer suballocation. More...

#include <BufferSuballocator.h>

Inheritance diagram for Diligent::IBufferSuballocation:

Public Member Functions
virtual Uint32	GetOffset () const =0
	Returns the start offset of the suballocation, in bytes.

virtual Uint32	GetSize () const =0
	Returns the suballocation size, in bytes.

virtual IBufferSuballocator *	GetAllocator ()=0
	Returns a pointer to the parent allocator.

virtual IBuffer *	Update (IRenderDevice pDevice, IDeviceContext pContext)=0
	Updates the internal buffer object.

virtual IBuffer *	GetBuffer () const =0
	Returns a pointer to the internal buffer object.

virtual void	SetUserData (IObject *pUserData)=0
	Stores a pointer to the user-provided data object.

virtual IObject *	GetUserData () const =0

Public Member Functions inherited from Diligent.IObject
virtual void DILIGENT_CALL_TYPE	QueryInterface (const INTERFACE_ID &IID, IObject **ppInterface)=0
	Queries the specific interface.

virtual ReferenceCounterValueType DILIGENT_CALL_TYPE	AddRef ()=0
	Increments the number of strong references by 1.

virtual ReferenceCounterValueType DILIGENT_CALL_TYPE	Release ()=0

virtual IReferenceCounters *DILIGENT_CALL_TYPE	GetReferenceCounters () const =0

Detailed Description

Buffer suballocation.

Member Function Documentation

virtual IBuffer * Diligent::IBufferSuballocation::GetBuffer ( ) const

pure virtual

Returns a pointer to the internal buffer object.

virtual IObject * Diligent::IBufferSuballocation::GetUserData ( ) const

pure virtual

Returns a pointer to the user data object previously set with SetUserData() method.

virtual void Diligent::IBufferSuballocation::SetUserData ( IObject * pUserData )

pure virtual

Stores a pointer to the user-provided data object.

The user data may later be retrieved through GetUserData().

Parameters

[in] pUserData - A pointer to the user data object to store.

Note: The method is not thread-safe and an application must externally synchronize the access.

virtual IBuffer * Diligent::IBufferSuballocation::Update	(	IRenderDevice *	pDevice,
		IDeviceContext *	pContext )

pure virtual

Updates the internal buffer object.

Remarks: This method is a shortcut for GetAllocator()->Update(pDevice, pContext).