1. Epic GamesDeveloper
  3. FVulkanDynamicRHI

FVulkanDynamicRHI

The interface which is implemented by the dynamically bound RHI.

API > API/Runtime > API/Runtime/VulkanRHI

Inheritance Hierarchy

References

   
Module VulkanRHI
Header /Engine/Source/Runtime/VulkanRHI/Public/VulkanDynamicRHI.h
Include #include "VulkanDynamicRHI.h"

Syntax

class FVulkanDynamicRHI : public IVulkanDynamicRHI

Remarks

The interface which is implemented by the dynamically bound RHI.

Variables

  Type Name Description
Protected variable EActiveDebugLayerExtension ActiveDebugLayerExtension  
Protected variable uint32 ApiVersion  
Protected variable bool bIsStandaloneStereoDevice  
Protected variable FVulkanDevice * Device  
Protected variable TRefCountPtr< FVulkanViewport > DrawingViewport The viewport which is currently being drawn.
Protected variable VkInstance Instance  
Protected variable TArray< const ANSICHAR * > InstanceExtensions  
Protected variable TArray< const ANSICHAR * > InstanceLayers  
Protected variable FCriticalSection LockBufferCS  
Protected variable FOptionalVulkanInstanceExtensions OptionalInstanceExtensions  
Protected variable IConsoleObject * RebuildPipelineCacheCmd  
Protected variable IConsoleObject * SavePipelineCacheCmd  
Public variable uint32 TotalPresentCount Historical number of times we've presented any and all viewports.
Protected variable TArray< FVulkanViewport * > Viewports A list of all viewport RHIs that have been created.

Constructors

  Type Name Description
Public function   Initialization constructor.

Destructors

  Type Name Description
Public function   Destructor

Functions

  Type Name Description
Protected function void  
Public function Static void  
Public function Static FVulkanDynamicRHI &

Get ()

  
Public function Const uint32  
Public function Const FVulkanDevice *  
Public function Const VkInstance  
Public function Const const TArray< const ANSICHAR * > &  
Public function Const const TArray< const ANSICHAR * > &  
Public function Const const FOptionalVulkanInstanceExtensions &  
Public function TArray< FVulkanViewport * > &  
Protected function void

InitDevice ( FVulkanDevice* Device
)

  
Protected function void

InitGPU ( FVulkanDevice* Device
)

  
Public function void  
Protected function void

InternalUnlockTexture2D ( bool bFromRenderingThread,
FRHITexture2D* Texture,
uint32 MipIndex,
bool bLockWithinMiptail
)

  
Protected function void

InternalUpdateTexture2D ( FRHICommandListBase& RHICmdList,
FRHITexture2D* TextureRHI,
uint32 MipIndex,
const FUpdateTextureRegion2D& UpdateRegion,
uint32 SourcePitch,
const uint8* SourceData
)

  
Protected function void

InternalUpdateTexture3D ( FRHICommandListBase& RHICmdList,
FRHITexture3D* TextureRHI,
uint32 MipIndex,
const FUpdateTextureRegion3D& UpdateRegion,
uint32 SourceRowPitch,
uint32 SourceDepthPitch,
const uint8* SourceData
)

  
Protected function Static void  
Public function Static void

RecreateSwapChain ( void* NewNativeWindow
)

  
Public function Static void  
Protected function void  
Protected function TArray< const ANSICHAR * >

SetupInstanceLayers ( FVulkanInstanceExtensionArray& UEExtensions
)

 Static void WriteEndFrameTimestamp(void*);
Protected function Static void  
Public function Const bool  
Protected function void

UpdateUniformBuffer ( FRHICommandListBase& RHICmdList,
FVulkanUniformBuffer* UniformBuffer,
const void* Contents
)

  
Public function void

VulkanSetImageLayout ( VkCommandBuffer CmdBuffer,
VkImage Image,
VkImageLayout OldLayout,
VkImageLayout NewLayout,
const VkImageSubresourceRange& SubresourceRange
)

  

Overridden from IVulkanDynamicRHI

  Type Name Description
Public function Virtual FTexture2DArrayRHIRef

RHICreateTexture2DArrayFromResource ( EPixelFormat Format,
uint32 SizeX,
uint32 SizeY,
uint32 ArraySize,
uint32 NumMips,
uint32 NumSamples,
VkImage Resource,
ETextureCreateFlags Flags,
const FClearValueBinding& ClearValueBinding
)

  
Public function Virtual FTexture2DRHIRef

RHICreateTexture2DFromResource ( EPixelFormat Format,
uint32 SizeX,
uint32 SizeY,
uint32 NumMips,
uint32 NumSamples,
VkImage Resource,
ETextureCreateFlags Flags,
const FClearValueBinding& ClearValueBinding
)

  
Public function Virtual FTextureCubeRHIRef

RHICreateTextureCubeFromResource ( EPixelFormat Format,
uint32 Size,
bool bArray,
uint32 ArraySize,
uint32 NumMips,
VkImage Resource,
ETextureCreateFlags Flags,
const FClearValueBinding& ClearValueBinding
)

  
Public function Virtual Const bool

RHIDoesAdapterMatchDevice ( const void* InAdapterId
)

  
Public function Virtual void

RHIFinishExternalComputeWork ( VkCommandBuffer InCommandBuffer
)

  
Public function Virtual VkCommandBuffer  
Public function Virtual Const TArray< VkExtensionProperties >

RHIGetAllDeviceExtensions ( VkPhysicalDevice InPhysicalDevice
)

  
Public function Virtual Const TArray< VkExtensionProperties >  
Public function Virtual Const FVulkanRHIAllocationInfo  
Public function Virtual Const uint64

RHIGetGraphicsAdapterLUID ( VkPhysicalDevice InPhysicalDevice
)

  
Public function Virtual Const uint32  
Public function Virtual Const uint32  
Public function Virtual Const VkQueue  
Public function Virtual Const FVulkanRHIImageViewInfo  
Public function Virtual Const VkFormat

RHIGetSwapChainVkFormat ( EPixelFormat InFormat
)

  
Public function Virtual Const VkFormat  
Public function Virtual const VkAllocationCallbacks *  
Public function Virtual Const VkDevice  
Public function Virtual Const void *

RHIGetVkDeviceProcAddr ( const char* InName
)

  
Public function Virtual Const VkImage

RHIGetVkImage ( FRHITexture* InTexture
)

  
Public function Virtual Const VkInstance  
Public function Virtual Const VkPhysicalDevice  
Public function Virtual Const const uint8 *  
Public function Virtual Const uint32  
Public function Virtual void

RHIRegisterWork ( uint32 NumPrimitives
)

  
Public function Virtual void

RHISetImageLayout ( VkImage Image,
VkImageLayout OldLayout,
VkImageLayout NewLayout,
const VkImageSubresourceRange& SubresourceRange
)

  
Public function Virtual void

RHISetUploadImageLayout ( VkImage Image,
VkImageLayout OldLayout,
VkImageLayout NewLayout,
const VkImageSubresourceRange& SubresourceRange
)

  
Public function Virtual void  
Public function Virtual Const bool  
Public function Virtual void

RHIVerifyResult ( VkResult Result,
const ANSICHAR* VkFuntion,
const ANSICHAR* Filename,
uint32 Line
)

  

Overridden from FDynamicRHI

  Type Name Description
Public function Virtual FTexture2DRHIRef

AsyncReallocateTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdList,
FRHITexture2D* Texture2D,
int32 NewMipCount,
int32 NewSizeX,
int32 NewSizeY,
FThreadSafeCounter* RequestStatus
)

  
Public function Virtual ETextureReallocationStatus

FinalizeAsyncReallocateTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdList,
FRHITexture2D* Texture2D,
bool bBlockUntilCompleted
)

  
Public function Virtual const TCHAR *

GetName ()

  
Public function Virtual void

Init ()

 Initializes the RHI; separate from IDynamicRHIModule::CreateRHI so that GDynamicRHI is set when it is called.
Public function Virtual void *

LockBuffer_BottomOfPipe ( FRHICommandListBase& RHICmdList,
FRHIBuffer* Buffer,
uint32 Offset,
uint32 SizeRHI,
EResourceLockMode LockMode
)

 Buffer Lock/Unlock.
Public function Virtual void *

LockTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdList,
FRHITexture2D* Texture,
uint32 MipIndex,
EResourceLockMode LockMode,
uint32& DestStride,
bool bLockWithinMiptail,
bool bNeedsDefaultRHIFlush,
uint64* OutLockedByteCount
)

  
Public function Virtual void Called after the RHI is initialized; before the render thread is started.
Public function Virtual void FlushType: Flush RHI Thread.
Public function Virtual void Only relevant with an RHI thread, this advances the backbuffer for the purpose of GetViewportBackBuffer FlushType: Thread safe
Public function Virtual void

RHIAliasTextureResources ( FTextureRHIRef& DestTexture,
FTextureRHIRef& SrcTexture
)

  
Public function Virtual FTextureRHIRef

RHIAsyncCreateTexture2D ( uint32 SizeX,
uint32 SizeY,
uint8 Format,
uint32 NumMips,
ETextureCreateFlags Flags,
ERHIAccess InResourceState,
void** InitialMipData,
uint32 NumInitialMips,
FGraphEventRef& OutCompletionEvent
)

 FlushType: Thread safe.
Public function Virtual FTexture2DRHIRef

RHIAsyncReallocateTexture2D ( FRHITexture2D* Texture2D,
int32 NewMipCount,
int32 NewSizeX,
int32 NewSizeY,
FThreadSafeCounter* RequestStatus
)

 Starts an asynchronous texture reallocation.
Public function Virtual FUpdateTexture3DData

RHIBeginUpdateTexture3D ( FRHICommandListBase& RHICmdList,
FRHITexture3D* Texture,
uint32 MipIndex,
const FUpdateTextureRegion3D& UpdateRegion
)

  
Public function Virtual void

RHIBindDebugLabelName ( FRHIUnorderedAccessView* UnorderedAccessViewRHI,
const TCHAR* Name
)

  
Public function Virtual void

RHIBindDebugLabelName ( FRHITexture* Texture,
const TCHAR* Name
)

 FlushType: Thread safe.
Public function Virtual void Blocks the CPU until the GPU catches up and goes idle. FlushType: Flush Immediate (seems wrong)
Public function Virtual FRHICalcTextureSizeResult

RHICalcTexturePlatformSize ( FRHITextureDesc const& Desc,
uint32 FirstMipIndex
)

 FlushType: Thread safe.
Public function Virtual void  
Public function Virtual ETextureReallocationStatus

RHICancelAsyncReallocateTexture2D ( FRHITexture2D* Texture2D,
bool bBlockUntilCompleted
)

 FlushType: Wait RHI Thread.
Public function Virtual uint32 FlushType: Thread safe.
Public function Virtual uint64 Compute the hash of the PSO initializer for PSO Precaching (only hash data relevant for the RHI specific PSO)
Public function Virtual void

RHICopyBuffer ( FRHIBuffer* SourceBuffer,
FRHIBuffer* DestBuffer
)

 FlushType: Flush Immediate (seems dangerous)
Public function Virtual FTextureRHIRef

RHICreateAliasedTexture ( FTextureRHIRef& SourceTexture
)

  
Public function Virtual FBlendStateRHIRef FlushType: Thread safe.
Public function Virtual FBoundShaderStateRHIRef

RHICreateBoundShaderState ( FRHIVertexDeclaration* VertexDeclaration,
FRHIVertexShader* VertexShader,
FRHIPixelShader* PixelShader,
FRHIGeometryShader* GeometryShader
)

 FlushType: Thread safe, but varies depending on the RHI.
Public function Virtual FBufferRHIRef

RHICreateBuffer ( FRHICommandListBase& RHICmdList,
FRHIBufferDesc const& Desc,
ERHIAccess ResourceState,
FRHIResourceCreateInfo& CreateInfo
)

  
Public function Virtual FComputePipelineStateRHIRef FlushType: Thread safe.
Public function Virtual FComputeShaderRHIRef

RHICreateComputeShader ( TArrayView< const uint8 > Code,
const FSHAHash& Hash
)

 FlushType: Wait RHI Thread.
Public function Virtual FDepthStencilStateRHIRef FlushType: Thread safe.
Public function Virtual FGeometryShaderRHIRef

RHICreateGeometryShader ( TArrayView< const uint8 > Code,
const FSHAHash& Hash
)

 FlushType: Wait RHI Thread.
Public function Virtual FGPUFenceRHIRef

RHICreateGPUFence ( const FName& Name
)

  
Public function Virtual FGraphicsPipelineStateRHIRef FlushType: Thread safe.
Public function Virtual FPixelShaderRHIRef

RHICreatePixelShader ( TArrayView< const uint8 > Code,
const FSHAHash& Hash
)

 FlushType: Wait RHI Thread.
Public function Virtual FRasterizerStateRHIRef FlushType: Thread safe.
Public function Virtual FRenderQueryRHIRef

RHICreateRenderQuery ( ERenderQueryType QueryType
)

 FlushType: Wait RHI Thread.
Public function Virtual FSamplerStateRHIRef FlushType: Thread safe.
Public function Virtual FShaderResourceViewRHIRef SRV / UAV creation functions.
Public function Virtual FStagingBufferRHIRef FlushType: Thread safe.
Public function Virtual FTextureRHIRef

RHICreateTexture ( const FRHITextureCreateDesc& CreateDesc
)

 Creates an RHI texture resource.
Public function Virtual FTextureRHIRef  
Public function Virtual IRHITransientResourceAllocator * Transient Resource Functions and Helpers.
Public function Virtual void

RHICreateTransition ( FRHITransition* Transition,
const FRHITransitionCreateInfo& CreateInfo
)

  
Public function Virtual FUniformBufferRHIRef

RHICreateUniformBuffer ( const void* Contents,
const FRHIUniformBufferLayout* Layout,
EUniformBufferUsage Usage,
EUniformBufferValidation Validation
)

 FlushType: Thread safe, but varies depending on the RHI.
Public function Virtual FUnorderedAccessViewRHIRef  
Public function Virtual FVertexDeclarationRHIRef

RHICreateVertexDeclaration ( const FVertexDeclarationElementList& Elements
)

 FlushType: Wait RHI Thread.
Public function Virtual FVertexShaderRHIRef

RHICreateVertexShader ( TArrayView< const uint8 > Code,
const FSHAHash& Hash
)

 FlushType: Wait RHI Thread.
Public function Virtual FViewportRHIRef

RHICreateViewport ( void* WindowHandle,
uint32 SizeX,
uint32 SizeY,
bool bIsFullscreen,
EPixelFormat PreferredPixelFormat
)

 Must be called from the main thread. FlushType: Thread safe
Public function Virtual void  
Public function Virtual ETextureReallocationStatus

RHIFinalizeAsyncReallocateTexture2D ( FRHITexture2D* Texture2D,
bool bBlockUntilCompleted
)

 FlushType: Wait RHI Thread.
Public function Virtual IRHIPlatformCommandList * Finalizes (i.e. closes) the specified command context, returning the completed platform command list object.
Public function Virtual void Flush driver resources.
Public function Virtual bool

RHIGetAvailableResolutions ( FScreenResolutionArray& Resolutions,
bool bIgnoreRefreshRate
)

 FlushType: Thread safe.
Public function Virtual IRHIComputeContext *

RHIGetCommandContext ( ERHIPipeline Pipeline,
FRHIGPUMask GPUMask
)

 Retrieves a new command context to begin the recording of a new platform command list.
Public function Virtual IRHIComputeContext * FlushType: Thread safe.
Public function Virtual IRHICommandContext * FlushType: Thread safe.
Public function Virtual uint32

RHIGetGPUFrameCycles ( uint32 GPUIndex
)

 FlushType: Thread safe.
Public function Virtual uint64 FlushType: Thread safe.
Public function Virtual void * FlushType: Flush RHI Thread.
Public function Virtual void * FlushType: Flush RHI Thread.
Public function Virtual void * FlushType: Flush RHI Thread.
Public function Virtual void * FlushType: Flush RHI Thread.
Public function Virtual void * FlushType: Flush RHI Thread.
Public function Virtual bool

RHIGetRenderQueryResult ( FRHIRenderQuery* RenderQuery,
uint64& OutResult,
bool bWait,
uint32 GPUIndex
)

 CAUTION: Even though this is marked as threadsafe, it is only valid to call from the render thread.
Public function Virtual void

RHIGetSupportedResolution ( uint32& Width,
uint32& Height
)

 FlushType: Thread safe.
Public function Virtual void FlushType: Thread safe.
Public function Virtual bool

RHIGetTextureMemoryVisualizeData ( FColor* TextureData,
int32 SizeX,
int32 SizeY,
int32 Pitch,
int32 PixelSize
)

 FlushType: Flush Immediate.
Public function Virtual FTexture2DRHIRef With RHI thread, this is the current backbuffer from the perspective of the render thread.
Public function Virtual bool FlushType: Flush Immediate.
Public function Virtual void *

RHILockStagingBuffer ( FRHIStagingBuffer* StagingBuffer,
FRHIGPUFence* Fence,
uint32 Offset,
uint32 SizeRHI
)

 Lock a staging buffer to read contents on the CPU that were written by the GPU, without having to stall.
Public function Virtual void *

RHILockTexture2D ( FRHITexture2D* Texture,
uint32 MipIndex,
EResourceLockMode LockMode,
uint32& DestStride,
bool bLockWithinMiptail,
uint64* OutLockedByteCount
)

 FlushType: Flush RHI Thread.
Public function Virtual void *

RHILockTexture2DArray ( FRHITexture2DArray* Texture,
uint32 TextureIndex,
uint32 MipIndex,
EResourceLockMode LockMode,
uint32& DestStride,
bool bLockWithinMiptail
)

 FlushType: Flush RHI Thread.
Public function Virtual void *

RHILockTextureCubeFace ( FRHITextureCube* Texture,
uint32 FaceIndex,
uint32 ArrayIndex,
uint32 MipIndex,
EResourceLockMode LockMode,
uint32& DestStride,
bool bLockWithinMiptail
)

 FlushType: Flush RHI Thread.
Public function Virtual void

RHIMapStagingSurface ( FRHITexture* Texture,
FRHIGPUFence* Fence,
void*& OutData,
int32& OutWidth,
int32& OutHeight,
uint32 GPUIndex
)

 FlushType: Flush Immediate (seems wrong)
Public function Virtual bool Check if PSO Initializers are the same used during PSO Precaching (only compare data relevant for the RHI specific PSO)
Public function Virtual void

RHIRead3DSurfaceFloatData ( FRHITexture* Texture,
FIntRect Rect,
FIntPoint ZMinMax,
TArray< FFloat16Color >& OutData
)

 FlushType: Flush Immediate (seems wrong)
Public function Virtual void

RHIReadSurfaceData ( FRHITexture* Texture,
FIntRect Rect,
TArray< FColor >& OutData,
FReadSurfaceDataFlags InFlags
)

 FlushType: Flush Immediate (seems wrong)
Public function Virtual void

RHIReadSurfaceData ( FRHITexture* Texture,
FIntRect Rect,
TArray< FLinearColor >& OutData,
FReadSurfaceDataFlags InFlags
)

 Default fallback; will not work for non-8-bit surfaces and it's extremely slow.
Public function Virtual void

RHIReadSurfaceFloatData ( FRHITexture* Texture,
FIntRect Rect,
TArray< FFloat16Color >& OutData,
ECubeFace CubeFace,
int32 ArrayIndex,
int32 MipIndex
)

 FlushType: Flush Immediate (seems wrong)
Public function Virtual void FlushType: Flush RHI Thread.
Public function Virtual void  
Public function Virtual Const bool  
Public function Virtual void

RHIResizeViewport ( FRHIViewport* Viewport,
uint32 SizeX,
uint32 SizeY,
bool bIsFullscreen,
EPixelFormat PreferredPixelFormat
)

  
Public function Virtual void

RHIResizeViewport ( FRHIViewport* Viewport,
uint32 SizeX,
uint32 SizeY,
bool bIsFullscreen
)

 Must be called from the main thread. FlushType: Thread safe
Public function Virtual void FlushType: Thread safe.
Public function Virtual void

RHISubmitCommandLists ( TArrayView< IRHIPlatformCommandList* > CommandLists,
bool bFlushResources
)

 Submits a batch of previously recorded/finalized command lists to the GPU.
Public function Virtual void Kicks the current frame and makes sure GPU is actively working on them FlushType: Flush Immediate (copied from RHIBlockUntilGPUIdle)
Public function Virtual void Operations to suspend title rendering and yield control to the system FlushType: Thread safe
Public function Virtual void

RHITick ( float DeltaTime
)

 Must be called from the main thread. FlushType: Thread safe
Public function Virtual void Transfer metadata and underlying resource from src to dest and release any resource owned by dest.
Public function Virtual void FlushType: Flush RHI Thread.
Public function Virtual void Unlock a staging buffer previously locked with RHILockStagingBuffer.
Public function Virtual void

RHIUnlockTexture2D ( FRHITexture2D* Texture,
uint32 MipIndex,
bool bLockWithinMiptail
)

 FlushType: Flush RHI Thread.
Public function Virtual void

RHIUnlockTexture2DArray ( FRHITexture2DArray* Texture,
uint32 TextureIndex,
uint32 MipIndex,
bool bLockWithinMiptail
)

 FlushType: Flush RHI Thread.
Public function Virtual void

RHIUnlockTextureCubeFace ( FRHITextureCube* Texture,
uint32 FaceIndex,
uint32 ArrayIndex,
uint32 MipIndex,
bool bLockWithinMiptail
)

 FlushType: Flush RHI Thread.
Public function Virtual void

RHIUnmapStagingSurface ( FRHITexture* Texture,
uint32 GPUIndex
)

 FlushType: Flush Immediate (seems wrong)
Public function Virtual void

RHIUpdateTexture2D ( FRHICommandListBase& RHICmdList,
FRHITexture2D* Texture,
uint32 MipIndex,
const FUpdateTextureRegion2D& UpdateRegion,
uint32 SourcePitch,
const uint8* SourceData
)

 Updates a region of a 2D texture from system memory
Public function Virtual void

RHIUpdateTexture3D ( FRHICommandListBase& RHICmdList,
FRHITexture3D* Texture,
uint32 MipIndex,
const FUpdateTextureRegion3D& UpdateRegion,
uint32 SourceRowPitch,
uint32 SourceDepthPitch,
const uint8* SourceData
)

 Updates a region of a 3D texture from system memory
Public function Virtual void  
Public function Virtual void

RHIUpdateUniformBuffer ( FRHICommandListBase& RHICmdList,
FRHIUniformBuffer* UniformBufferRHI,
const void* Contents
)

  
Public function Virtual void Shutdown the RHI; handle shutdown and resource destruction before the RHI's actual destructor is called (so that all resources of the RHI are still available for shutdown).
Public function Virtual void  
Public function Virtual void

UnlockTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdList,
FRHITexture2D* Texture,
uint32 MipIndex,
bool bLockWithinMiptail,
bool bNeedsDefaultRHIFlush
)

  

Enums

  Type Name Description
Public enum EActiveDebugLayerExtension    

Constants

Name Description
HMDVulkanExtensions  

Deprecated Functions

  Type Name Description
Public function Virtual VkImageLayout &

RHIFindOrAddLayoutRW ( FRHITexture* InTexture,
VkImageLayout LayoutIfNotFound
)

 Altering image layout tracking directly is not permitted anymore.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page