1. Epic GamesDeveloper
  3. FDynamicRHI

FDynamicRHI

The interface which is implemented by the dynamically bound RHI.

API > API/Runtime > API/Runtime/RHI

Inheritance Hierarchy

References

   
Module RHI
Header /Engine/Source/Runtime/RHI/Public/DynamicRHI.h
Include #include "DynamicRHI.h"

Syntax

class FDynamicRHI

Remarks

The interface which is implemented by the dynamically bound RHI.

Variables

  Type Name Description
Protected variable TArray< uint32 > PixelFormatBlockBytes  

Destructors

  Type Name Description
Public function Virtual   Declare a virtual destructor, so the dynamic RHI can be deleted without knowing its type.

Functions

  Type Name Description
Public function Virtual FTextureRHIRef

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

  
Public function Virtual ETextureReallocationStatus

CancelAsyncReallocateTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdList,
FRHITexture* Texture2D,
bool bBlockUntilCompleted
)

  
Public function Static void

EnableIdealGPUCaptureOptions ( bool bEnable
)

 Utilities.
Public function Virtual ETextureReallocationStatus

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

  
Public function Virtual void Some RHIs can have pending messages/logs for error tracking, or debug modes.
Public function Virtual Const ERHIInterfaceType  
Public function const TCHAR *

GetName ()

  
Public function Virtual FDynamicRHI *  
Public function void

Init ()

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

InitPixelFormatInfo ( const TArray< uint32 >& PixelFormatBlockBytesIn
)

 Called after PostInit to initialize the pixel format info, which is needed for some commands default implementations
Public function Virtual void *

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

 Buffer Lock/Unlock.
Public function Virtual void *

LockStagingBuffer_RenderThread ( FRHICommandListImmediate& RHICmdList,
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 *

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

  
Public function Virtual void *

LockTexture2DArray_RenderThread ( FRHICommandListImmediate& RHICmdList,
FRHITexture* Texture,
uint32 ArrayIndex,
uint32 MipIndex,
EResourceLockMode LockMode,
uint32& DestStride,
bool bLockWithinMiptail
)

  
Public function Virtual void Called after the RHI is initialized; before the render thread is started.
Public function Virtual void Acquires or releases ownership of the platform-specific rendering context for the calling thread.
Public function void Only relevant with an RHI thread, this advances the backbuffer for the purpose of GetViewportBackBuffer FlushType: Thread safe
Public function Virtual void  
Public function FTextureRHIRef

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

  
Public function FTextureRHIRef

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

 Thread-safe function that can be used to create a texture outside of the rendering thread.
Public function FTextureRHIRef

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

 Starts an asynchronous texture reallocation.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void Tells the RHI we're about to suspend it.
Public function Virtual FUpdateTexture3DData

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

  
Public function Virtual void

RHIBindDebugLabelName ( FRHICommandListBase& RHICmdList,
FRHIBuffer* Buffer,
const TCHAR* Name
)

  
Public function Virtual void

RHIBindDebugLabelName ( FRHICommandListBase& RHICmdList,
FRHIUnorderedAccessView* UnorderedAccessViewRHI,
const TCHAR* Name
)

  
Public function void

RHIBindDebugLabelName ( FRHICommandListBase& RHICmdList,
FRHITexture* Texture,
const TCHAR* Name
)

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

RHICalcTexturePlatformSize ( FRHITextureDesc const& Desc,
uint32 FirstMipIndex
)

 FlushType: Thread safe.
Public function ETextureReallocationStatus

RHICancelAsyncReallocateTexture2D ( FRHITexture* Texture2D,
bool bBlockUntilCompleted
)

 FlushType: Wait RHI Thread.
Public function Virtual void Tests the viewport to see if its HDR status has changed. This is usually tested after a window has been moved.
Public function 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 uint64 Compute the hash of the state components of the PSO initializer for PSO Precaching (only hash data relevant for the RHI specific PSO)
Public function Virtual FTextureRHIRef  
Public function Virtual FAmplificationShaderRHIRef

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

 FlushType: Wait RHI Thread.
Public function FBlendStateRHIRef FlushType: Thread safe.
Public function FBoundShaderStateRHIRef

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

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

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

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

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

 FlushType: Wait RHI Thread.
Public function FDepthStencilStateRHIRef FlushType: Thread safe.
Public function 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  
Public function FGraphicsPipelineStateRHIRef FlushType: Thread safe.
Public function Virtual FMeshShaderRHIRef

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

 FlushType: Wait RHI Thread.
Public function FPixelShaderRHIRef

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

 FlushType: Wait RHI Thread.
Public function FRasterizerStateRHIRef FlushType: Thread safe.
Public function Virtual FRayTracingGeometryRHIRef  
Public function Virtual FRayTracingPipelineStateRHIRef  
Public function Virtual FRayTracingSceneRHIRef  
Public function Virtual FRayTracingShaderRHIRef

RHICreateRayTracingShader ( TArrayView< const uint8 > Code,
const FSHAHash& Hash,
EShaderFrequency ShaderFrequency
)

  
Public function FRenderQueryRHIRef FlushType: Wait RHI Thread.
Public function Virtual FRHIResourceCollectionRef

RHICreateResourceCollection ( FRHICommandListBase& RHICmdList,
TConstArrayView< FRHIResourceCollectionMember > InMembers
)

  
Public function FSamplerStateRHIRef FlushType: Thread safe.
Public function Virtual FShaderBindingTableRHIRef  
Public function Virtual FShaderBundleRHIRef  
Public function Virtual FRHIShaderLibraryRef

RHICreateShaderLibrary ( EShaderPlatform Platform,
FString const& FilePath,
FString const& Name
)

 FlushType: Must be Thread-Safe.
Public function Virtual FRHIShaderLibraryRef  
Public function FShaderResourceViewRHIRef SRV / UAV creation functions.
Public function Virtual FStagingBufferRHIRef FlushType: Thread safe.
Public function FTextureRHIRef

RHICreateTexture ( FRHICommandListBase& RHICmdList,
const FRHITextureCreateDesc& CreateDesc
)

 Creates an RHI texture resource.
Public function Virtual FTextureReferenceRHIRef

RHICreateTextureReference ( FRHICommandListBase& RHICmdList,
FRHITexture* InReferencedTexture
)

 Create a texture reference. InReferencedTexture can be null.
Public function Virtual IRHITransientResourceAllocator * Create a new transient resource allocator
Public function Virtual void

RHICreateTransition ( FRHITransition* Transition,
const FRHITransitionCreateInfo& CreateInfo
)

  
Public function FUniformBufferRHIRef

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

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

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

 FlushType: Wait RHI Thread.
Public function 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 FWorkGraphPipelineStateRHIRef  
Public function Virtual FWorkGraphShaderRHIRef

RHICreateWorkGraphShader ( TArrayView< const uint8 > Code,
const FSHAHash& Hash,
EShaderFrequency ShaderFrequency
)

 FlushType: Wait RHI Thread.
Public function void

RHIEndFrame ( const FRHIEndFrameArgs& Args
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function ETextureReallocationStatus

RHIFinalizeAsyncReallocateTexture2D ( FRHITexture* Texture2D,
bool bBlockUntilCompleted
)

 FlushType: Wait RHI Thread.
Public function void  
Public function void Flush driver resources.
Public function bool

RHIGetAvailableResolutions ( FScreenResolutionArray& Resolutions,
bool bIgnoreRefreshRate
)

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

RHIGetHTilePlatformConfig ( uint32 DepthWidth,
uint32 DepthHeight
)

  
Public function Virtual uint64 FlushType: Thread safe.
Public function Virtual void * FlushType: Not Thread Safe!
Public function Virtual void * FlushType: Flush RHI Thread.
Public function void * FlushType: Flush RHI Thread.
Public function Virtual void * FlushType: Flush RHI Thread.
Public function void * FlushType: Flush RHI Thread.
Public function Virtual void * FlushType: Flush RHI Thread.
Public function Virtual uint16  
Public function 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 void FlushType: Thread safe.
Public function void FlushType: Thread safe.
Public function bool

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

 FlushType: Flush Immediate.
Public function Virtual IRHIUploadContext *  
Public function FTextureRHIRef With RHI thread, this is the current backbuffer from the perspective of the render thread.
Public function Virtual FUnorderedAccessViewRHIRef  
Public function Virtual uint32 FlushType: Thread safe.
Public function Virtual void  
Public function Virtual bool FlushType: Flush Immediate.
Public function Virtual void *

RHILockBuffer ( FRHICommandListBase& RHICmdList,
FRHIBuffer* Buffer,
uint32 Offset,
uint32 Size,
EResourceLockMode LockMode
)

  
Public function Virtual void *

RHILockBufferMGPU ( FRHICommandListBase& RHICmdList,
FRHIBuffer* Buffer,
uint32 GPUIndex,
uint32 Offset,
uint32 Size,
EResourceLockMode LockMode
)

  
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 void *

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

 FlushType: Flush RHI Thread.
Public function void *

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

 FlushType: Flush RHI Thread.
Public function void *

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

 FlushType: Flush RHI Thread.
Public function Virtual void *

RHILockTextureCubeFace_RenderThread ( FRHICommandListImmediate& RHICmdList,
FRHITexture* Texture,
uint32 FaceIndex,
uint32 ArrayIndex,
uint32 MipIndex,
EResourceLockMode LockMode,
uint32& DestStride,
bool bLockWithinMiptail
)

  
Public function void

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

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

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

  
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 EPixelFormat

RHIPreferredPixelFormatHint ( EPixelFormat PreferredPixelFormat
)

 Return preferred pixel format if given format is unsupported.
Public function Virtual void Platform RHIs should implement this function to process their internal GPU resource/memory delete queues.
Public function Virtual void FlushType: Flush Immediate (seems wrong)
Public function void

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

 FlushType: Flush Immediate (seems wrong)
Public function void

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

 FlushType: Flush Immediate (seems wrong)
Public function Virtual void Default fallback; will not work for non-8-bit surfaces and it's extremely slow.
Public function Virtual void FlushType: Flush Immediate (seems wrong)
Public function void

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

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

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

  
Public function Virtual void  
Public function Virtual void  
Public function void Transfer metadata and underlying resource from src to dest and release any resource owned by dest.
Public function void

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

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

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

  
Public function Virtual void FlushType: Thread safe.
Public function Virtual void  
Public function void  
Public function Virtual void Operations to suspend title rendering and yield control to the system FlushType: Thread safe
Public function void

RHITick ( float DeltaTime
)

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

RHIUnlockBufferMGPU ( FRHICommandListBase& RHICmdList,
FRHIBuffer* Buffer,
uint32 GPUIndex
)

  
Public function Virtual void Unlock a staging buffer previously locked with RHILockStagingBuffer.
Public function void

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

 FlushType: Flush RHI Thread.
Public function void

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

 FlushType: Flush RHI Thread.
Public function void

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

 FlushType: Flush RHI Thread.
Public function Virtual void

RHIUnlockTextureCubeFace_RenderThread ( FRHICommandListImmediate& RHICmdList,
FRHITexture* Texture,
uint32 FaceIndex,
uint32 ArrayIndex,
uint32 MipIndex,
bool bLockWithinMiptail
)

  
Public function void

RHIUnmapStagingSurface ( FRHITexture* Texture,
uint32 GPUIndex
)

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

RHIUpdateFromBufferTexture2D ( FRHICommandListBase& RHICmdList,
FRHITexture* Texture,
uint32 MipIndex,
const FUpdateTextureRegion2D& UpdateRegion,
uint32 SourcePitch,
FRHIBuffer* Buffer,
uint32 BufferOffset
)

 Updates a region of a 2D texture from GPU memory provided by the given buffer (may not be implemented on every platform)
Public function void

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

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

RHIUpdateTexture3D ( FRHICommandListBase& RHICmdList,
FRHITexture* 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 void

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

  
Public function Virtual void FlushType: Wait RHI Thread.
Public function Virtual void FlushType: Wait RHI Thread.
Public function Virtual FRHIFlipDetails

RHIWaitForFlip ( double TimeoutInSeconds
)

  
Public function Virtual void Called by the thread recording an RHI command list (via RHICmdList.WriteGPUFence()).
Public function 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 Unlock a staging buffer previously locked with LockStagingBuffer_RenderThread.
Public function Virtual void

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

  
Public function Virtual void

UnlockTexture2DArray_RenderThread ( FRHICommandListImmediate& RHICmdList,
FRHITexture* Texture,
uint32 ArrayIndex,
uint32 MipIndex,
bool bLockWithinMiptail
)

  

Classes

  Type Name Description
Public struct FRHIEndFrameArgs    
Public struct FRHIFinalizeContextArgs Finalizes (i.e. closes) the specified command context, returning the completed platform command list object.  
Public struct FRHISubmitCommandListsArgs Submits a batch of previously recorded/finalized command lists to the GPU.  

Typedefs

Name Description
FRHICalcTextureSizeResult  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page