Open 3D Engine Atom Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
AZ::Vulkan::Buffer Class Referencefinal

Inherits AZ::RHI::Buffer.

Public Types

using BufferOwnerProperty = RHI::BufferProperty< QueueId >
 
using SubresourceRangeOwner = BufferOwnerProperty::PropertyRange
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (Buffer, AZ::SystemAllocator)
 
 AZ_RTTI (Buffer, "D3416E5D-D058-4EB1-95D9-06C9B3B1C52A", Base)
 
const BufferMemoryView * GetBufferMemoryView () const
 
BufferMemoryView * GetBufferMemoryView ()
 
AZStd::vector< SubresourceRangeOwner > GetOwnerQueue (const RHI::BufferView &bufferView) const
 
AZStd::vector< SubresourceRangeOwner > GetOwnerQueue (const RHI::BufferSubresourceRange *range=nullptr) const
 
void SetOwnerQueue (const QueueId &queueId, const RHI::BufferSubresourceRange *range=nullptr)
 
void SetOwnerQueue (const QueueId &queueId, const RHI::BufferView &bufferView)
 
void SetUploadHandle (const RHI::AsyncWorkHandle &handle)
 
const RHI::AsyncWorkHandle & GetUploadHandle () const
 
VkAccelerationStructureKHR GetNativeAccelerationStructure () const
 Only valid for buffers with the RayTracingAccelerationStructure bind flag.
 
void SetNativeAccelerationStructure (const VkAccelerationStructureKHR &accelerationStructure)
 
- Public Member Functions inherited from AZ::RHI::Buffer
 AZ_RTTI (Buffer, "{3C918323-F39C-4DC6-BEE9-BC220DBA9414}", Resource)
 
const BufferDescriptor & GetDescriptor () const
 
const BufferFrameAttachment * GetFrameAttachment () const
 Returns the buffer frame attachment if the buffer is currently attached.
 
Ptr< BufferView > GetBufferView (const BufferViewDescriptor &bufferViewDescriptor)
 
const HashValue64 GetHash () const
 
- Public Member Functions inherited from AZ::RHI::Resource
 AZ_RTTI (Resource, "{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 ResourcePool * GetPool () const
 
ResourcePool * 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 ResourceView is in the cache.
 
bool IsInResourceCache (const BufferViewDescriptor &bufferViewDescriptor)
 
void EraseResourceView (ResourceView *resourceView) const
 Removes the provided ResourceView 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 Member Functions

static RHI::Ptr< Buffer > Create ()
 

Friends

class BufferPool
 
class AliasedHeap
 
class Device
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::Buffer
void SetDescriptor (const BufferDescriptor &descriptor)
 
- Protected Member Functions inherited from AZ::RHI::Resource
Ptr< ImageView > GetResourceView (const ImageViewDescriptor &imageViewDescriptor) const
 Returns view based on the descriptor.
 
Ptr< BufferView > 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
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 
The documentation for this class was generated from the following file: