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::MemoryTypeView< T > Class Template Reference

Represents a view into GPU memory object. It contains a smart pointer to the allocation that it's "viewing". More...

#include <MemoryTypeView.h>

Public Member Functions

 MemoryTypeView (RHI::Ptr< T > alloc)
 
 MemoryTypeView (RHI::Ptr< T > alloc, size_t offset, size_t size)
 
bool IsValid () const
 Returns if the MemoryView has a valid value.
 
size_t GetOffset () const
 Returns the offset relative to the memory allocation in bytes.
 
size_t GetSize () const
 Returns the size of the memory view region in bytes.
 
CpuVirtualAddress Map (RHI::HostMemoryAccess hostAccess)
 A convenience method to map the resource region spanned by the view for CPU access.
 
void Unmap (RHI::HostMemoryAccess hostAccess)
 A convenience method for unmapping the resource region spanned by the view.
 
MemoryAllocationType GetAllocationType () const
 Returns the allocation type.
 
void SetName (const AZStd::string_view &name) const
 Sets the name of the underlying memory object. It only applies the name if the allocation is Unique.
 
RHI::Ptr< T > GetAllocation () const
 Returns the allocation that the View represents.
 

Detailed Description

template<typename T>
class AZ::Vulkan::MemoryTypeView< T >

Represents a view into GPU memory object. It contains a smart pointer to the allocation that it's "viewing".


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