Open 3D Engine Atom Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Vulkan::VulkanMemoryAllocation Class Reference

#include <VulkanMemoryAllocation.h>

Inherits AZ::RHI::DeviceObject.

Public Member Functions

void Init (Device &device, const VmaAllocation &alloc)
 Initialize a memmory allocation from a VMA allocation.
 
size_t GetOffset () const
 Returns the offset relative to the base memory address in bytes.
 
size_t GetSize () const
 Returns the size of the memory region in bytes.
 
CpuVirtualAddress Map (size_t offset, size_t size, RHI::HostMemoryAccess hostAccess)
 A convenience method to map the resource region spanned by the view for CPU access.
 
void Unmap (size_t offset, RHI::HostMemoryAccess hostAccess)
 A convenience method for unmapping the resource region spanned by the view.
 
VmaAllocation GetVmaAllocation () const
 Returns the VMA allocation.
 
VkDeviceMemory GetNativeDeviceMemory () const
 Returns the vulkan native memory used by the allocation.
 
- 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.
 
DeviceGetDevice () 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< VulkanMemoryAllocationCreate ()
 Creates a memory allocation object.
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::DeviceObject
void Init (Device &device)
 The derived class should call this method to assign the device.
 
void Shutdown () override
 Clears the current bound device to null.
 
- 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
 

Detailed Description

Represents a VMA memory allocation. The allocation may be part of a larger memory block (sub allocated) or be a dedicated memory block.


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