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

Inherits AZ::DX12::MemoryView.

Public Member Functions

 BufferMemoryView (MemoryView &&memoryView, BufferMemoryType memoryType)
 
 BufferMemoryView (const BufferMemoryView &rhs)=delete
 Supports only move construction / assignment because of constraints in the base class.
 
 BufferMemoryView (BufferMemoryView &&rhs)=default
 
BufferMemoryView & operator= (const BufferMemoryView &rhs)=delete
 
BufferMemoryView & operator= (BufferMemoryView &&rhs)=default
 
BufferMemoryType GetType () const
 
- Public Member Functions inherited from AZ::DX12::MemoryView
 MemoryView (RHI::Ptr< Memory > memory, size_t offset, size_t size, size_t alignment, MemoryViewType viewType, ID3D12Heap *heap=nullptr, size_t heapOffset=0ull)
 
 MemoryView (D3D12MA::Allocation *allocation, RHI::Ptr< Memory > memory, size_t offset, size_t size, size_t alignment, MemoryViewType viewType)
 
 MemoryView (const MemoryAllocation &memAllocation, MemoryViewType viewType, ID3D12Heap *heap=nullptr, size_t heapOffset=0ull)
 
 MemoryView (const MemoryView &rhs)=delete
 
 MemoryView (MemoryView &&rhs)=default
 
MemoryView & operator= (const MemoryView &rhs)=delete
 
MemoryView & operator= (MemoryView &&rhs)=default
 
bool IsValid () const
 
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 view region in bytes.
 
size_t GetAlignment () const
 Returns the alignment of the memory view region in bytes.
 
Memory * GetMemory () const
 Returns a pointer to the memory chunk this view is sub-allocated from.
 
D3D12MA::Allocation * GetD3d12maAllocation () const
 
CpuVirtualAddress Map (RHI::HostMemoryAccess hostAccess) const
 A convenience method to map the resource region spanned by the view for CPU access.
 
void Unmap (RHI::HostMemoryAccess hostAccess) const
 A convenience method for unmapping the resource region spanned by the view.
 
GpuVirtualAddress GetGpuAddress () const
 Returns the GPU address, offset to match the view.
 
void SetName (const AZStd::string_view &name)
 Sets the name of the ID3D12Resource.
 
void SetName (const AZStd::wstring_view &name)
 Sets the name of the ID3D12Resource.
 
ID3D12Heap * GetHeap () const
 
size_t GetHeapOffset ()
 
void MarkHeapAsOwnedByMemoryView ()
 
bool IsHeapOwnedByMemoryView () const
 
The documentation for this class was generated from the following file: