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

#include <VulkanViewport.h>

+ Inheritance diagram for FVulkanBackBuffer:

Public Member Functions

 FVulkanBackBuffer (FVulkanDevice &Device, FVulkanViewport *InViewport, EPixelFormat Format, uint32 SizeX, uint32 SizeY, ETextureCreateFlags UEFlags)
 
virtual ~FVulkanBackBuffer ()
 
void OnGetBackBufferImage (FRHICommandListImmediate &RHICmdList)
 
void OnAdvanceBackBufferFrame (FRHICommandListImmediate &RHICmdList)
 
void ReleaseViewport ()
 
void ReleaseAcquiredImage ()
 
- Public Member Functions inherited from FVulkanTexture
 FVulkanTexture (FVulkanDevice &InDevice, const FRHITextureCreateDesc &InCreateDesc, const FRHITransientHeapAllocation *InTransientHeapAllocation)
 
 FVulkanTexture (FVulkanDevice &InDevice, const FRHITextureCreateDesc &InCreateDesc, VkImage InImage, const FVulkanRHIExternalImageDeleteCallbackInfo &InExternalImageDeleteCallbackInfo)
 
 FVulkanTexture (FVulkanDevice &InDevice, const FRHITextureCreateDesc &InCreateDesc, FTextureRHIRef &SrcTextureRHI)
 
virtual ~FVulkanTexture ()
 
void AliasTextureResources (FTextureRHIRef &SrcTextureRHI)
 
void UploadInitialData (FRHICommandListBase &RHICmdList, VulkanRHI::FStagingBuffer *UploadBuffer)
 
void HostUploadInitialData (FRHICommandListBase &RHICmdList, const uint8 *BulkData, uint32 BulkDataSize)
 
FVulkanViewFindOrAddInternalView (const FVulkanTextureViewDesc &ViewDesc)
 
template<typename T >
void DumpMemory (T Callback)
 
bool CanMove () const override
 
bool CanEvict () const override
 
void Evict (FVulkanDevice &Device, const FVulkanContextArray &Contexts) override
 
void Move (FVulkanDevice &Device, const FVulkanContextArray &Contexts, VulkanRHI::FVulkanAllocation &NewAllocation) override
 evict to system memory
 
FVulkanTextureGetEvictableTexture () override
 
bool GetTextureResourceInfo (FRHIResourceInfo &OutResourceInfo) const
 
voidGetNativeResource () const override final
 
voidGetTextureBaseRHI () override final
 
virtual FRHIDescriptorHandle GetDefaultBindlessHandle () const override final
 
void DestroySurface ()
 
void InvalidateMappedMemory ()
 
voidGetMappedPointer ()
 
uint32 GetMemorySize () const
 
void GetMipStride (uint32 MipIndex, uint32 &Stride)
 
void GetMipSize (uint32 MipIndex, uint64 &MipBytes)
 
VkImageViewType GetViewType () const
 
VkImageTiling GetTiling () const
 
uint32 GetNumberOfArrayLevels () const
 
VULKANRHI_API void ErrorInvalidViewType () const
 
VkImageAspectFlags GetFullAspectMask () const
 
VkImageAspectFlags GetPartialAspectMask () const
 
bool IsDepthOrStencilAspect () const
 
bool IsImageOwner () const
 
bool SupportsSampling () const
 
VkImageLayout GetDefaultLayout () const
 
void SetDefaultLayout (VkImageLayout InDefaultLayout)
 
VULKANRHI_API VkDeviceMemory GetAllocationHandle () const
 
VULKANRHI_API uint64 GetAllocationOffset () const
 
const FVulkanCpuReadbackBufferGetCpuReadbackBuffer () const
 
virtual void UpdateLinkedViews (const FVulkanContextArray &Contexts) override
 
void SetInitialImageState (FRHICommandListBase &RHICmdList, VkImageLayout InitialLayout, bool bClear, const FClearValueBinding &ClearValueBinding, bool bIsTransientResource)
 
TArray< VkSparseMemoryBindCommitReservedResource (uint64 RequiredCommitSizeInBytes)
 
- Public Member Functions inherited from FRHITexture
virtual const FRHITextureDescGetDesc () const
 
virtual class FRHITextureReferenceGetTextureReference ()
 
virtual voidGetNativeShaderResourceView () const
 
virtual void GetWriteMaskProperties (void *&OutData, uint32 &OutSize)
 
FIntVector GetSizeXYZ () const
 
FIntVector GetMipDimensions (uint8 MipIndex) const
 
bool IsMultisampled () const
 
bool HasClearValue () const
 
FLinearColor GetClearColor () const
 
void GetDepthStencilClearValue (float &OutDepth, uint32 &OutStencil) const
 
float GetDepthClearValue () const
 
uint32 GetStencilClearValue () const
 
void SetLastRenderTime (float InLastRenderTime)
 
double GetLastRenderTime () const
 
RHI_API void SetName (FName InName)
 
FRHITextureGetTexture2D ()
 
FRHITextureGetTexture2DArray ()
 
FRHITextureGetTexture3D ()
 
FRHITextureGetTextureCube ()
 
uint32 GetSizeX () const
 
uint32 GetSizeY () const
 
FIntPoint GetSizeXY () const
 
uint32 GetSizeZ () const
 
uint32 GetNumMips () const
 
EPixelFormat GetFormat () const
 
ETextureCreateFlags GetFlags () const
 
uint32 GetNumSamples () const
 
const FClearValueBinding GetClearBinding () const
 
uint32 GetSize () const
 
- Public Member Functions inherited from FRHIViewableResource
ERHIAccess GetTrackedAccess_Unsafe () const
 
FName GetName () const
 
- Public Member Functions inherited from FRHIResource
RHI_API FRHIResource (ERHIResourceType InResourceType)
 
uint32 AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 
bool IsValid () const
 
void DisableLifetimeExtension ()
 
ERHIResourceType GetType () const
 
FName GetOwnerName () const
 
void SetOwnerName (FName InOwnerName)
 
- Public Member Functions inherited from FVulkanViewableResource
virtual ~FVulkanViewableResource ()
 
bool HasLinkedViews () const
 

Additional Inherited Members

- Static Public Member Functions inherited from FVulkanTexture
static void GenerateImageCreateInfo (FImageCreateInfo &OutImageCreateInfo, FVulkanDevice &InDevice, const FRHITextureDesc &InDesc, VkFormat *OutStorageFormat=nullptr, VkFormat *OutViewFormat=nullptr, bool bForceLinearTexture=false)
 
static void InternalLockWrite (FVulkanContextCommon &Context, FVulkanTexture *Surface, const VkBufferImageCopy &Region, VulkanRHI::FStagingBuffer *StagingBuffer)
 
- Public Attributes inherited from FVulkanTexture
FVulkanViewDefaultView = nullptr
 
FVulkanViewPartialView = nullptr
 
FTextureRHIRef AliasedTexture
 
FVulkanDevice *const Device
 
VkImage Image = VK_NULL_HANDLE
 
VkImageUsageFlags ImageUsageFlags = 0
 
VkFormat StorageFormat = VK_FORMAT_UNDEFINED
 
VkFormat ViewFormat = VK_FORMAT_UNDEFINED
 
VkMemoryPropertyFlags MemProps = VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT
 
VkMemoryRequirements MemoryRequirements
 
FVulkanRHIExternalImageDeleteCallbackInfo ExternalImageDeleteCallbackInfo
 
TStaticArray< ERHIAccess, 2 > AllPlanesTrackedAccess { InPlace, ERHIAccess::Unknown }
 
- Protected Member Functions inherited from FRHITexture
 FRHITexture ()=delete
 
RHI_API FRHITexture (const FRHITextureCreateDesc &CreateDesc)
 
RHI_API FRHITexture (ERHIResourceType InResourceType)
 
- Protected Member Functions inherited from FRHIViewableResource
 FRHIViewableResource (ERHIResourceType InResourceType, ERHIAccess InAccess, const TCHAR *InName, FName InOwnerName)
 
virtual void SetTrackedAccessFromContext (FRHITrackedAccess InTrackedAccess)
 
void TakeOwnership (FRHIViewableResource &Other)
 
void ReleaseOwnership ()
 
- Protected Member Functions inherited from FRHIResource
virtual RHI_API ~FRHIResource ()
 
- Protected Attributes inherited from FVulkanTexture
EImageOwnerType ImageOwnerType
 
- Protected Attributes inherited from FRHIViewableResource
FName Name
 

Constructor & Destructor Documentation

◆ FVulkanBackBuffer()

FVulkanBackBuffer::FVulkanBackBuffer ( FVulkanDevice Device,
FVulkanViewport InViewport,
EPixelFormat  Format,
uint32  SizeX,
uint32  SizeY,
ETextureCreateFlags  UEFlags 
)

◆ ~FVulkanBackBuffer()

FVulkanBackBuffer::~FVulkanBackBuffer ( )
virtual

Member Function Documentation

◆ OnAdvanceBackBufferFrame()

void FVulkanBackBuffer::OnAdvanceBackBufferFrame ( FRHICommandListImmediate RHICmdList)

◆ OnGetBackBufferImage()

void FVulkanBackBuffer::OnGetBackBufferImage ( FRHICommandListImmediate RHICmdList)

◆ ReleaseAcquiredImage()

void FVulkanBackBuffer::ReleaseAcquiredImage ( )

◆ ReleaseViewport()

void FVulkanBackBuffer::ReleaseViewport ( )

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