UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FD3D12Resource Class Reference

#include <D3D12Resources.h>

+ Inheritance diagram for FD3D12Resource:

Classes

struct  FD3D12ResourceTypeHelper
 

Public Member Functions

 FD3D12Resource ()=delete
 
 FD3D12Resource (FD3D12Device *ParentDevice, FRHIGPUMask VisibleNodes, ID3D12Resource *InResource, ED3D12Access InInitialD3D12Access, FD3D12ResourceDesc const &InDesc, FD3D12Heap *InHeap=nullptr, D3D12_HEAP_TYPE InHeapType=D3D12_HEAP_TYPE_DEFAULT)
 
 FD3D12Resource (FD3D12Device *ParentDevice, FRHIGPUMask VisibleNodes, ID3D12Resource *InResource, ED3D12Access InInitialD3D12Access, ED3D12ResourceStateMode InResourceStateMode, ED3D12Access InDefaultD3D12Access, FD3D12ResourceDesc const &InDesc, FD3D12Heap *InHeap, D3D12_HEAP_TYPE InHeapType)
 
virtual ~FD3D12Resource ()
 
 operator ID3D12Resource & ()
 
ID3D12ResourceGetResource () const
 
const D3D12_RESOURCE_DESC * GetUAVAccessResourceDesc () const
 
void SetUAVAccessResourceDesc (const D3D12_RESOURCE_DESC &InUAVAccessResourceDesc)
 
voidMap (const D3D12_RANGE *ReadRange=nullptr)
 
void Unmap ()
 
ID3D12PageableGetPageable ()
 
const FD3D12ResourceDescGetDesc () const
 
D3D12_HEAP_TYPE GetHeapType () const
 
D3D12_GPU_VIRTUAL_ADDRESS GetGPUVirtualAddress () const
 
void SetGPUVirtualAddress (D3D12_GPU_VIRTUAL_ADDRESS Value)
 
voidGetResourceBaseAddress () const
 
uint16 GetMipLevels () const
 
uint16 GetArraySize () const
 
uint8 GetPlaneCount () const
 
uint16 GetSubresourceCount () const
 
ED3D12Access GetInitialAccess () const
 
ED3D12Access GetDefaultAccess () const
 
bool RequiresResourceStateTracking () const
 
bool IsBackBuffer () const
 
void SetName (const TCHAR *Name)
 
FName GetName () const
 
void DoNotDeferDelete ()
 
bool ShouldDeferDelete () const
 
void DeferDelete ()
 
bool IsReservedResource () const
 
bool IsPlacedResource () const
 
FD3D12HeapGetHeap () const
 
bool IsDepthStencilResource () const
 
uint64 GetCommittedReservedResourceSize () const
 
bool NeedsDeferredResidencyUpdate () const
 
void StartTrackingForResidency ()
 
bool IsResident () const
 
TConstArrayView< FD3D12ResidencyHandle * > GetResidencyHandles () const
 
template<typename TLambda >
FORCEINLINE_DEBUGGABLE void GetBackingHeapsGpuAddresses (TLambda &&Lambda) const
 
void CommitReservedResource (ID3D12CommandQueue *D3DCommandQueue, uint64 RequiredCommitSizeInBytes)
 
- Public Member Functions inherited from FThreadSafeRefCountedObject
 FThreadSafeRefCountedObject ()=default
 
 FThreadSafeRefCountedObject (const FThreadSafeRefCountedObject &Rhs)=delete
 
FThreadSafeRefCountedObjectoperator= (const FThreadSafeRefCountedObject &Rhs)=delete
 
virtual ~FThreadSafeRefCountedObject ()
 
FReturnedRefCountValue AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 
- Public Member Functions inherited from FD3D12DeviceChild
 FD3D12DeviceChild (FD3D12Device *InParent=nullptr)
 
FORCEINLINE FD3D12DeviceGetParentDevice () const
 
FD3D12DeviceGetParentDevice_Unsafe () const
 
- Public Member Functions inherited from FD3D12MultiNodeGPUObject
 FD3D12MultiNodeGPUObject (FRHIGPUMask NodeMask, FRHIGPUMask VisibiltyMask)
 
- Public Member Functions inherited from FD3D12GPUObject
 FD3D12GPUObject (FRHIGPUMask InGPUMask, FRHIGPUMask InVisibiltyMask)
 
SGPU_CONSTEXPR FRHIGPUMask GetGPUMask () const
 
SGPU_CONSTEXPR FRHIGPUMask GetVisibilityMask () const
 

Friends

class FD3D12Buffer
 

Additional Inherited Members

- Protected Attributes inherited from FD3D12DeviceChild
FD3D12DeviceParent
 

Constructor & Destructor Documentation

◆ FD3D12Resource() [1/3]

FD3D12Resource::FD3D12Resource ( )
delete

◆ FD3D12Resource() [2/3]

FD3D12Resource::FD3D12Resource ( FD3D12Device ParentDevice,
FRHIGPUMask  VisibleNodes,
ID3D12Resource InResource,
ED3D12Access  InInitialD3D12Access,
FD3D12ResourceDesc const &  InDesc,
FD3D12Heap InHeap = nullptr,
D3D12_HEAP_TYPE  InHeapType = D3D12_HEAP_TYPE_DEFAULT 
)
explicit

◆ FD3D12Resource() [3/3]

FD3D12Resource::FD3D12Resource ( FD3D12Device ParentDevice,
FRHIGPUMask  VisibleNodes,
ID3D12Resource InResource,
ED3D12Access  InInitialD3D12Access,
ED3D12ResourceStateMode  InResourceStateMode,
ED3D12Access  InDefaultD3D12Access,
FD3D12ResourceDesc const &  InDesc,
FD3D12Heap InHeap,
D3D12_HEAP_TYPE  InHeapType 
)
explicit

◆ ~FD3D12Resource()

FD3D12Resource::~FD3D12Resource ( )
virtual

Member Function Documentation

◆ CommitReservedResource()

void FD3D12Resource::CommitReservedResource ( ID3D12CommandQueue D3DCommandQueue,
uint64  RequiredCommitSizeInBytes 
)

◆ DeferDelete()

void FD3D12Resource::DeferDelete ( )

◆ DoNotDeferDelete()

void FD3D12Resource::DoNotDeferDelete ( )
inline

◆ GetArraySize()

uint16 FD3D12Resource::GetArraySize ( ) const
inline

◆ GetBackingHeapsGpuAddresses()

template<typename TLambda >
FORCEINLINE_DEBUGGABLE void FD3D12Resource::GetBackingHeapsGpuAddresses ( TLambda &&  Lambda) const
inline

◆ GetCommittedReservedResourceSize()

uint64 FD3D12Resource::GetCommittedReservedResourceSize ( ) const
inline

◆ GetDefaultAccess()

ED3D12Access FD3D12Resource::GetDefaultAccess ( ) const
inline

◆ GetDesc()

const FD3D12ResourceDesc & FD3D12Resource::GetDesc ( ) const
inline

◆ GetGPUVirtualAddress()

D3D12_GPU_VIRTUAL_ADDRESS FD3D12Resource::GetGPUVirtualAddress ( ) const
inline

◆ GetHeap()

FD3D12Heap * FD3D12Resource::GetHeap ( ) const
inline

◆ GetHeapType()

D3D12_HEAP_TYPE FD3D12Resource::GetHeapType ( ) const
inline

◆ GetInitialAccess()

ED3D12Access FD3D12Resource::GetInitialAccess ( ) const
inline

◆ GetMipLevels()

uint16 FD3D12Resource::GetMipLevels ( ) const
inline

◆ GetName()

FName FD3D12Resource::GetName ( ) const
inline

◆ GetPageable()

ID3D12Pageable * FD3D12Resource::GetPageable ( )

◆ GetPlaneCount()

uint8 FD3D12Resource::GetPlaneCount ( ) const
inline

◆ GetResidencyHandles()

TConstArrayView< FD3D12ResidencyHandle * > FD3D12Resource::GetResidencyHandles ( ) const
inline

◆ GetResource()

ID3D12Resource * FD3D12Resource::GetResource ( ) const
inline

◆ GetResourceBaseAddress()

void * FD3D12Resource::GetResourceBaseAddress ( ) const
inline

◆ GetSubresourceCount()

uint16 FD3D12Resource::GetSubresourceCount ( ) const
inline

◆ GetUAVAccessResourceDesc()

const D3D12_RESOURCE_DESC * FD3D12Resource::GetUAVAccessResourceDesc ( ) const
inline

◆ IsBackBuffer()

bool FD3D12Resource::IsBackBuffer ( ) const
inline

◆ IsDepthStencilResource()

bool FD3D12Resource::IsDepthStencilResource ( ) const
inline

◆ IsPlacedResource()

bool FD3D12Resource::IsPlacedResource ( ) const
inline

◆ IsReservedResource()

bool FD3D12Resource::IsReservedResource ( ) const
inline

◆ IsResident()

bool FD3D12Resource::IsResident ( ) const
inline

◆ Map()

void * FD3D12Resource::Map ( const D3D12_RANGE ReadRange = nullptr)
inline

◆ NeedsDeferredResidencyUpdate()

bool FD3D12Resource::NeedsDeferredResidencyUpdate ( ) const
inline

◆ operator ID3D12Resource &()

FD3D12Resource::operator ID3D12Resource & ( )
inline

◆ RequiresResourceStateTracking()

bool FD3D12Resource::RequiresResourceStateTracking ( ) const
inline

◆ SetGPUVirtualAddress()

void FD3D12Resource::SetGPUVirtualAddress ( D3D12_GPU_VIRTUAL_ADDRESS  Value)
inline

◆ SetName()

void FD3D12Resource::SetName ( const TCHAR Name)
inline

◆ SetUAVAccessResourceDesc()

void FD3D12Resource::SetUAVAccessResourceDesc ( const D3D12_RESOURCE_DESC &  InUAVAccessResourceDesc)
inline

◆ ShouldDeferDelete()

bool FD3D12Resource::ShouldDeferDelete ( ) const
inline

◆ StartTrackingForResidency()

void FD3D12Resource::StartTrackingForResidency ( )

◆ Unmap()

void FD3D12Resource::Unmap ( )
inline

Friends And Related Symbol Documentation

◆ FD3D12Buffer

friend class FD3D12Buffer
friend

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