Navigation
API > API/Runtime > API/Runtime/RHI
| Name | FRHITransientResource |
| Type | class |
| Header File | /Engine/Source/Runtime/RHI/Public/RHITransientResourceAllocator.h |
| Include Path | #include "RHITransientResourceAllocator.h" |
Syntax
class FRHITransientResource
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRHITransientResource
(
FRHIResource* InResource, |
RHITransientResourceAllocator.h | ||
FRHITransientResource
(
const FResourceTask& InResourceTask, |
RHITransientResourceAllocator.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRHITransientResource() |
RHITransientResourceAllocator.h |
Structs
| Name | Remarks |
|---|---|
| FResourceTaskResult |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FResourceTask | UE::Tasks::TTask< FResourceTaskResult > | RHITransientResourceAllocator.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| kInvalidPassIndex | const uint32 | RHITransientResourceAllocator.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AcquireCount | uint32 | Tracks the number of times Acquire has been called. | RHITransientResourceAllocator.h | |
| AcquireCycle | uint64 | Cycle count used to deduce age of the resource. | RHITransientResourceAllocator.h | |
| AcquirePasses | TInterval< uint32 > | Start -> End split pass index intervals for acquire / discard operations. | RHITransientResourceAllocator.h | |
| AcquirePipeline | ERHIPipeline | RHITransientResourceAllocator.h | ||
| AliasingOverlaps | TArray< FRHITransientAliasingOverlap > | List of aliasing resources overlapping with this one. | RHITransientResourceAllocator.h | |
| Alignment | uint32 | Alignment of the resource in bytes. | RHITransientResourceAllocator.h | |
| AllocationType | ERHITransientAllocationType | RHITransientResourceAllocator.h | ||
| bAcquired | bool | RHITransientResourceAllocator.h | ||
| bDiscardOnGraphicsWorkaround | bool | RHITransientResourceAllocator.h | ||
| DiscardPass | uint32 | RHITransientResourceAllocator.h | ||
| GpuVirtualAddress | uint64 | The Gpu virtual address of the RHI resource. | RHITransientResourceAllocator.h | |
| Hash | uint64 | The hash used to uniquely identify this resource if cached. | RHITransientResourceAllocator.h | |
| HeapAllocation | FRHITransientHeapAllocation | RHITransientResourceAllocator.h | ||
| Name | const TCHAR * | Debug name of the resource. Updated with each allocation. | RHITransientResourceAllocator.h | |
| PageAllocation | FRHITransientPageAllocation | RHITransientResourceAllocator.h | ||
| Resource | TRefCountPtr< FRHIResource > | Underlying RHI resource. | RHITransientResourceAllocator.h | |
| ResourceTask | FResourceTask | RHITransientResourceAllocator.h | ||
| ResourceType | ERHITransientResourceType | RHITransientResourceAllocator.h | ||
| Size | uint64 | Size of the resource in bytes. | RHITransientResourceAllocator.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Acquire
(
const TCHAR* InName, |
Internal Allocator API. | RHITransientResourceAllocator.h | |
void AddAliasingOverlap
(
FRHITransientResource* InBeforeResource, |
RHITransientResourceAllocator.h | ||
void Discard
(
const FRHITransientAllocationFences& Fences |
RHITransientResourceAllocator.h | ||
void Finish
(
FRHICommandListBase& RHICmdList |
RHITransientResourceAllocator.h | ||
uint32 GetAcquireCount() |
Returns the number of times Acquire has been called. | RHITransientResourceAllocator.h | |
uint64 GetAcquireCycle() |
Returns the last allocator cycle this resource was acquired. | RHITransientResourceAllocator.h | |
uint32 GetAcquirePass() |
Returns the pass index which may end acquiring this resource. | RHITransientResourceAllocator.h | |
TConstArrayView< FRHITransientAliasingOverlap > GetAliasingOverlaps() |
Returns the list of aliasing overlaps used when transitioning the resource. | RHITransientResourceAllocator.h | |
ERHITransientAllocationType GetAllocationType() |
RHITransientResourceAllocator.h | ||
uint32 GetDiscardPass() |
Returns the pass index which discarded this resource. | RHITransientResourceAllocator.h | |
uint64 GetGpuVirtualAddress() |
Returns the gpu virtual address of the transient resource. | RHITransientResourceAllocator.h | |
uint64 GetHash() |
Returns the hash used to uniquely identify this resource if cached. | RHITransientResourceAllocator.h | |
const FRHITransientHeapAllocation & GetHeapAllocation () |
RHITransientResourceAllocator.h | ||
| RHITransientResourceAllocator.h | |||
const TCHAR * GetName() |
Returns the name assigned to the transient resource at allocation time. | RHITransientResourceAllocator.h | |
const FRHITransientPageAllocation & GetPageAllocation () |
RHITransientResourceAllocator.h | ||
| RHITransientResourceAllocator.h | |||
ERHITransientResourceType GetResourceType() |
RHITransientResourceAllocator.h | ||
FRHIResource * GetRHI() |
Returns the underlying RHI resource. | RHITransientResourceAllocator.h | |
uint64 GetSize() |
Returns the required size in bytes of the resource. | RHITransientResourceAllocator.h | |
bool HasResourceTask() |
Returns whether a resource has a pending task. | RHITransientResourceAllocator.h | |
bool IsAcquired() |
Returns whether this resource is still in an acquired state. | RHITransientResourceAllocator.h | |
bool IsBuffer() |
RHITransientResourceAllocator.h | ||
bool IsDiscarded() |
RHITransientResourceAllocator.h | ||
bool IsHeapAllocated() |
RHITransientResourceAllocator.h | ||
bool IsPageAllocated() |
RHITransientResourceAllocator.h | ||
bool IsTexture() |
RHITransientResourceAllocator.h |