#include <DeviceBuffer.h>

Inherited by AZ::DX12::Buffer, AZ::Metal::Buffer, AZ::Null::Buffer, and AZ::Vulkan::Buffer.

Public Member Functions
	AZ_RTTI (DeviceBuffer, "{3C918323-F39C-4DC6-BEE9-BC220DBA9414}", DeviceResource)

const BufferDescriptor &	GetDescriptor () const

void	ReportMemoryUsage (MemoryStatisticsBuilder &builder) const override

const BufferFrameAttachment *	GetFrameAttachment () const
	Returns the buffer frame attachment if the buffer is currently attached.

Ptr< DeviceBufferView >	GetBufferView (const BufferViewDescriptor &bufferViewDescriptor) const

const HashValue64	GetHash () const

virtual uint64_t	GetDeviceAddress () const

Public Member Functions inherited from AZ::RHI::DeviceResource
	AZ_RTTI (DeviceResource, "{9D02CDAC-80EB-4B77-8E62-849AC6E69206}", DeviceObject)

bool	IsAttachment () const
	Returns whether the resource is currently an attachment on a frame graph.

void	Shutdown () override final
	Shuts down the buffer by detaching it from its parent pool.

const DeviceResourcePool *	GetPool () const

DeviceResourcePool *	GetPool ()

uint32_t	GetVersion () const

const FrameAttachment *	GetFrameAttachment () const
	Returns the frame attachment associated with this image (if it exists).

void	InvalidateViews ()

bool	IsInResourceCache (const ImageViewDescriptor &imageViewDescriptor)
	Returns true if the DeviceResourceView is in the cache.

bool	IsInResourceCache (const BufferViewDescriptor &bufferViewDescriptor)

void	EraseResourceView (DeviceResourceView *resourceView) const
	Removes the provided DeviceResourceView from the cache.

Public Member Functions inherited from AZ::RHI::DeviceObject
	AZ_RTTI (DeviceObject, "{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object)

bool	IsInitialized () const
	Returns whether the device object is initialized.

Device &	GetDevice () const

Public Member Functions inherited from AZ::RHI::Object
	AZ_RTTI (Object, "{E43378F1-2331-4173-94B8-990ED20E6003}")

void	SetName (const Name &name)
	Sets the name of the object.

const Name &	GetName () const
	Returns the name set on the object by SetName.

uint32_t	use_count ()
	Returns the current use count of the object.

Static Public Attributes
static constexpr uint64_t	InvalidDeviceAddress = static_cast<uint64_t>(-1)

Protected Member Functions
void	SetDescriptor (const BufferDescriptor &descriptor)

Protected Member Functions inherited from AZ::RHI::DeviceResource
Ptr< DeviceImageView >	GetResourceView (const ImageViewDescriptor &imageViewDescriptor) const
	Returns view based on the descriptor.

Ptr< DeviceBufferView >	GetResourceView (const BufferViewDescriptor &bufferViewDescriptor) const

Protected Member Functions inherited from AZ::RHI::DeviceObject
void	Init (Device &device)
	The derived class should call this method to assign the device.

Protected Member Functions inherited from AZ::RHI::Object
void	add_ref () const

void	release () const

Friends
class	DeviceBufferPoolBase

Additional Inherited Members
Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int	m_useCount = 0

Detailed Description

A buffer corresponds to a region of linear memory and used for rendering operations. The user manages the lifecycle of a buffer through a DeviceBufferPool.

Member Function Documentation

◆ ReportMemoryUsage()

void AZ::RHI::DeviceBuffer::ReportMemoryUsage ( MemoryStatisticsBuilder & builder ) const

overridevirtual

This implementation estimates memory usage using the descriptor. Platforms may override to report more accurate usage metrics.

Implements AZ::RHI::DeviceResource.

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

Gems/Atom/RHI/Code/Include/Atom/RHI/DeviceBuffer.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ReportMemoryUsage()