Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > RHI > FDynamicRHI

Light Theme

Dark Theme

FDynamicRHI

The interface which is implemented by the dynamically bound RHI.

Windows

MacOS

Linux

Inheritance Hierarchy

FDynamicRHI

	FNullDynamicRHI
	FOpenGLDynamicRHI
	FVulkanDynamicRHI

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

		Name	Description
	TArray< uint32 ...	PixelFormatBlockBytes

Destructors

	Name	Description
	~FDynamicRHI()	Declare a virtual destructor, so the dynamic RHI can be deleted without knowing its type.

Functions

	Name	Description
FTexture2DRH...	AsyncReallocateTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture2D, int32 NewMipCount, int32 NewSizeX, int32 NewSizeY, FThreadSafeCounter* RequestSta... )
FUpdateTextu...	BeginUpdateTexture3D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture3D* Texture, uint32 MipIndex, const FUpdateTextureRegion3D& Upda... )
ETextureReal...	CancelAsyncReallocateTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture2D, bool bBlockUntilCompleted )
bool	CheckGpuHeartbeat()	Checks if the GPU is still alive.
FIndexBuffer...	CreateAndLockIndexBuffer_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 Stride, uint32 Size, uint32 InUsage, FRHIResourceCreateInfo& CreateInfo, void*& OutDataBuffer )
FVertexBuffe...	CreateAndLockVertexBuffer_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 Size, uint32 InUsage, FRHIResourceCreateInfo& CreateInfo, void*& OutDataBuffer )
FComputeShad...	CreateComputeShader_RenderThread ( FRHICommandListImmediate& RHICmdLi..., TArrayView< const uint8 > Code, const FSHAHash& Hash )
FDomainShade...	CreateDomainShader_RenderThread ( FRHICommandListImmediate& RHICmdLi..., TArrayView< const uint8 > Code, const FSHAHash& Hash )
FGeometrySha...	CreateGeometryShader_RenderThread ( FRHICommandListImmediate& RHICmdLi..., TArrayView< const uint8 > Code, const FSHAHash& Hash )
FHullShaderR...	CreateHullShader_RenderThread ( FRHICommandListImmediate& RHICmdLi..., TArrayView< const uint8 > Code, const FSHAHash& Hash )
FIndexBuffer...	CreateIndexBuffer_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 Stride, uint32 Size, uint32 InUsage, FRHIResourceCreateInfo& CreateInfo )
FPixelShader...	CreatePixelShader_RenderThread ( FRHICommandListImmediate& RHICmdLi..., TArrayView< const uint8 > Code, const FSHAHash& Hash )
FShaderResou...	CreateShaderResourceView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIVertexBuffer* VertexBuffer, uint32 Stride, uint8 Format )
FShaderResou...	CreateShaderResourceView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIIndexBuffer* Buffer )
FShaderResou...	CreateShaderResourceView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., const FShaderResourceViewInitialize... )
FStructuredB...	CreateStructuredBuffer_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 Stride, uint32 Size, uint32 InUsage, FRHIResourceCreateInfo& CreateInfo )
FVertexBuffe...	CreateVertexBuffer_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 Size, uint32 InUsage, FRHIResourceCreateInfo& CreateInfo )
FVertexShade...	CreateVertexShader_RenderThread ( FRHICommandListImmediate& RHICmdLi..., TArrayView< const uint8 > Code, const FSHAHash& Hash )
void	EnableIdealGPUCaptureOptions ( bool bEnable )	Utilities.
void	EndMultiUpdateTexture3D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., TArray< FUpdateTexture3DData >& Up... )
void	EndUpdateTexture3D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FUpdateTexture3DData& UpdateData )
ETextureReal...	FinalizeAsyncReallocateTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture2D, bool bBlockUntilCompleted )
void	FlushPendingLogs()	Some RHIs can have pending messages/logs for error tracking, or debug modes.
const TCHAR ...	GetName()
void	Init()	Initializes the RHI; separate from IDynamicRHIModule::CreateRHI so that GDynamicRHI is set when it is called.
void	InitPixelFormatInfo ( const TArray< uint32 >& PixelForma... )	Called after PostInit to initialize the pixel format info, which is needed for some commands default implementations
void *	LockIndexBuffer_BottomOfPipe ( FRHICommandListImmediate& RHICmdLi..., FRHIIndexBuffer* IndexBuffer, uint32 Offset, uint32 SizeRHI, EResourceLockMode LockMode )
void *	LockStagingBuffer_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIStagingBuffer* StagingBuff..., 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.
void *	LockStructuredBuffer_BottomOfPipe ( FRHICommandListImmediate& RHICmdLi..., FRHIStructuredBuffer* Structur..., uint32 Offset, uint32 SizeRHI, EResourceLockMode LockMode )	Buffer Lock/Unlock.
void *	LockTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture, uint32 MipIndex, EResourceLockMode LockMode, uint32& DestStride, bool bLockWithinMiptail, bool bNeedsDefaultRHIFlush )
void *	LockVertexBuffer_BottomOfPipe ( FRHICommandListImmediate& RHICmdLi..., FRHIVertexBuffer* VertexBuffer, uint32 Offset, uint32 SizeRHI, EResourceLockMode LockMode )
void	PostInit()	Called after the RHI is initialized; before the render thread is started.
void	RHIAcquireThreadOwnership()	FlushType: Flush RHI Thread.
void	RHIAcquireTransientResource_RenderThread ( FRHITexture* Texture )
void	RHIAcquireTransientResource_RenderThread ( FRHIVertexBuffer* Buffer )
void	RHIAcquireTransientResource_RenderThread ( FRHIStructuredBuffer* Buffer )
void	RHIAdvanceFrameFence()
void	RHIAdvanceFrameForGetViewportBackBuffer ( FRHIViewport* Viewport )	Only relevant with an RHI thread, this advances the backbuffer for the purpose of GetViewportBackBuffer FlushType: Thread safe
void	RHIAliasTextureResources ( FTextureRHIRef& DestTexture, FTextureRHIRef& SrcTexture )
FTexture2DRH...	RHIAsyncCreateTexture2D ( uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, uint32 Flags, void** InitialMipData, uint32 NumInitialMips )	FlushType: Thread safe.
FTexture2DRH...	RHIAsyncReallocateTexture2D ( FRHITexture2D* Texture2D, int32 NewMipCount, int32 NewSizeX, int32 NewSizeY, FThreadSafeCounter* RequestSta... )	Starts an asynchronous texture reallocation.
void	RHIBeginSuspendRendering()	Tells the RHI we're about to suspend it.
void	RHIBindDebugLabelName ( FRHITexture* Texture, const TCHAR* Name )	FlushType: Thread safe.
void	RHIBindDebugLabelName ( FRHIUnorderedAccessView* Unord..., const TCHAR* Name )
void	RHIBlockUntilGPUIdle()	Blocks the CPU until the GPU catches up and goes idle. FlushType: Flush Immediate (seems wrong)
uint64	RHICalcTexture2DPlatformSize ( uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, uint32 NumSamples, uint32 Flags, const FRHIResourceCreateInfo& Crea..., uint32& OutAlign )	FlushType: Thread safe.
uint64	RHICalcTexture3DPlatformSize ( uint32 SizeX, uint32 SizeY, uint32 SizeZ, uint8 Format, uint32 NumMips, uint32 Flags, const FRHIResourceCreateInfo& Crea..., uint32& OutAlign )	FlushType: Thread safe.
uint64	RHICalcTextureCubePlatformSize ( uint32 Size, uint8 Format, uint32 NumMips, uint32 Flags, const FRHIResourceCreateInfo& Crea..., uint32& OutAlign )	FlushType: Thread safe.
uint64	RHICalcVMTexture2DPlatformSize ( uint32 Mip0Width, uint32 Mip0Height, uint8 Format, uint32 NumMips, uint32 FirstMipIdx, uint32 NumSamples, uint32 Flags, uint32& OutAlign )	FlushType: Thread safe.
void	RHICalibrateTimers()
ETextureReal...	RHICancelAsyncReallocateTexture2D ( FRHITexture2D* Texture2D, bool bBlockUntilCompleted )	FlushType: Wait RHI Thread.
void	RHICheckViewportHDRStatus ( FRHIViewport* Viewport )	Tests the viewport to see if its HDR status has changed. This is usually tested after a window has been moved.
uint32	RHIComputeMemorySize ( FRHITexture* TextureRHI )	FlushType: Thread safe.
void	RHICopySharedMips ( FRHITexture2D* DestTexture2D, FRHITexture2D* SrcTexture2D )	FlushType: Flush RHI Thread.
void	RHICopySubTextureRegion ( FRHITexture2D* SourceTexture, FRHITexture2D* DestinationText..., FBox2D SourceBox, FBox2D DestinationBox )
void	RHICopySubTextureRegion_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* SourceTexture, FRHITexture2D* DestinationText..., FBox2D SourceBox, FBox2D DestinationBox )	Copy the source box pixels in the destination box texture, return true if implemented for the current platform
void	RHICopyVertexBuffer ( FRHIVertexBuffer* SourceBuffer, FRHIVertexBuffer* DestBuffer )	FlushType: Flush Immediate (seems dangerous)
FTextureRHIR...	RHICreateAliasedTexture ( FTextureRHIRef& SourceTexture )
FBlendStateR...	RHICreateBlendState ( const FBlendStateInitializerRHI& I... )	FlushType: Thread safe.
FBoundShader...	RHICreateBoundShaderState ( FRHIVertexDeclaration* VertexD..., FRHIVertexShader* VertexShader, FRHIHullShader* HullShader, FRHIDomainShader* DomainShader, FRHIPixelShader* PixelShader, FRHIGeometryShader* GeometrySh... )	FlushType: Thread safe, but varies depending on the RHI.
FComputeFenc...	RHICreateComputeFence ( const FName& Name )	FlushType: Thread safe, but varies depending on the RHI.
TRefCountPtr...	RHICreateComputePipelineState ( FRHIComputeShader* ComputeShad..., FRHIPipelineBinaryLibrary* Pip... )
TRefCountPtr...	RHICreateComputePipelineState ( FRHIComputeShader* ComputeShad... )
FComputeShad...	RHICreateComputeShader ( TArrayView< const uint8 > Code, const FSHAHash& Hash )	FlushType: Wait RHI Thread.
FDepthStenci...	RHICreateDepthStencilState ( const FDepthStencilStateInitializer... )	FlushType: Thread safe.
FDomainShade...	RHICreateDomainShader ( TArrayView< const uint8 > Code, const FSHAHash& Hash )	FlushType: Wait RHI Thread.
FGeometrySha...	RHICreateGeometryShader ( TArrayView< const uint8 > Code, const FSHAHash& Hash )	FlushType: Wait RHI Thread.
FGPUFenceRHI...	RHICreateGPUFence ( const FName& Name )
FGraphicsPip...	RHICreateGraphicsPipelineState ( const FGraphicsPipelineStateInitial..., FRHIPipelineBinaryLibrary* Pip... )
FGraphicsPip...	RHICreateGraphicsPipelineState ( const FGraphicsPipelineStateInitial... )	Creates a graphics pipeline state object (PSO) that represents a complete gpu pipeline for rendering.
FHullShaderR...	RHICreateHullShader ( TArrayView< const uint8 > Code, const FSHAHash& Hash )	FlushType: Wait RHI Thread.
FIndexBuffer...	RHICreateIndexBuffer ( uint32 Stride, uint32 Size, uint32 InUsage, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FPixelShader...	RHICreatePixelShader ( TArrayView< const uint8 > Code, const FSHAHash& Hash )	FlushType: Wait RHI Thread.
FRasterizerS...	RHICreateRasterizerState ( const FRasterizerStateInitializerRH... )	FlushType: Thread safe.
FRenderQuery...	RHICreateRenderQuery ( ERenderQueryType QueryType )	FlushType: Wait RHI Thread.
FRenderQuery...	RHICreateRenderQuery_RenderThread ( FRHICommandListImmediate& RHICmdLi..., ERenderQueryType QueryType )
FRenderQuery...	RHICreateRenderQueryPool ( ERenderQueryType QueryType, uint32 NumQueries )	FlushType: Must be Thread-Safe.
FSamplerStat...	RHICreateSamplerState ( const FSamplerStateInitializerRHI&... )	FlushType: Thread safe.
FRHIShaderLi...	RHICreateShaderLibrary ( EShaderPlatform Platform, FString const& FilePath, FString const& Name )	FlushType: Must be Thread-Safe.
FRHIShaderLi...	RHICreateShaderLibrary_RenderThread ( FRHICommandListImmediate& RHICmdLi..., EShaderPlatform Platform, FString FilePath, FString Name )
FShaderResou...	RHICreateShaderResourceView ( FRHIVertexBuffer* VertexBuffer, uint32 Stride, uint8 Format )	FlushType: Wait RHI Thread.
FShaderResou...	RHICreateShaderResourceView ( FRHITexture* Texture2DRHI, const FRHITextureSRVCreateInfo& Cr... )	FlushType: Wait RHI Thread.
FShaderResou...	RHICreateShaderResourceView ( FRHIIndexBuffer* Buffer )	FlushType: Wait RHI Thread.
FShaderResou...	RHICreateShaderResourceView ( const FShaderResourceViewInitialize... )	Creates a shader resource view
FShaderResou...	RHICreateShaderResourceView ( FRHIStructuredBuffer* Structur... )	FlushType: Wait RHI Thread.
FShaderResou...	RHICreateShaderResourceView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIVertexBuffer* VertexBuffer, uint32 Stride, uint8 Format )
FShaderResou...	RHICreateShaderResourceView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., const FShaderResourceViewInitialize... )
FShaderResou...	RHICreateShaderResourceView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture* Texture, const FRHITextureSRVCreateInfo& Cr... )
FShaderResou...	RHICreateShaderResourceView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIStructuredBuffer* Structur... )
FShaderResou...	RHICreateShaderResourceView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIIndexBuffer* Buffer )
FShaderResou...	RHICreateShaderResourceViewFMask ( FRHITexture2D* Texture2DRHI )	FlushType: Wait RHI Thread.
FShaderResou...	RHICreateShaderResourceViewFMask_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture2D )
FShaderResou...	RHICreateShaderResourceViewHTile ( FRHITexture2D* RenderTarget )
FShaderResou...	RHICreateShaderResourceViewWriteMask ( FRHITexture2D* Texture2DRHI )	FlushType: Wait RHI Thread.
FShaderResou...	RHICreateShaderResourceViewWriteMask_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture2D )
FStagingBuff...	RHICreateStagingBuffer()	FlushType: Thread safe.
FStructuredB...	RHICreateStructuredBuffer ( uint32 Stride, uint32 Size, uint32 InUsage, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FTexture2DRH...	RHICreateTexture2D ( uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, uint32 NumSamples, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FTexture2DRH...	RHICreateTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, uint32 NumSamples, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )
FTexture2DAr...	RHICreateTexture2DArray ( uint32 SizeX, uint32 SizeY, uint32 SizeZ, uint8 Format, uint32 NumMips, uint32 NumSamples, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FTexture2DAr...	RHICreateTexture2DArray_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 SizeX, uint32 SizeY, uint32 SizeZ, uint8 Format, uint32 NumMips, uint32 NumSamples, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )
FTexture3DRH...	RHICreateTexture3D ( uint32 SizeX, uint32 SizeY, uint32 SizeZ, uint8 Format, uint32 NumMips, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FTexture3DRH...	RHICreateTexture3D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 SizeX, uint32 SizeY, uint32 SizeZ, uint8 Format, uint32 NumMips, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )
FTextureCube...	RHICreateTextureCube ( uint32 Size, uint8 Format, uint32 NumMips, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FTextureCube...	RHICreateTextureCube_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 Size, uint8 Format, uint32 NumMips, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )
FTextureCube...	RHICreateTextureCubeArray ( uint32 Size, uint32 ArraySize, uint8 Format, uint32 NumMips, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FTextureCube...	RHICreateTextureCubeArray_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 Size, uint32 ArraySize, uint8 Format, uint32 NumMips, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )
FTexture2DRH...	RHICreateTextureExternal2D ( uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, uint32 NumSamples, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FTexture2DRH...	RHICreateTextureExternal2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, uint32 NumSamples, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )
FTextureRefe...	RHICreateTextureReference ( FLastRenderTimeContainer* Last... )	FlushType: Wait RHI Thread.
FTextureRefe...	RHICreateTextureReference_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FLastRenderTimeContainer* Last... )
FUniformBuff...	RHICreateUniformBuffer ( const void* Contents, const FRHIUniformBufferLayout& Lay..., EUniformBufferUsage Usage, EUniformBufferValidation Validation )	FlushType: Thread safe, but varies depending on the RHI.
FUnorderedAc...	RHICreateUnorderedAccessView ( FRHITexture* Texture, uint32 MipLevel, uint8 Format )	FlushType: Wait RHI Thread.
FUnorderedAc...	RHICreateUnorderedAccessView ( FRHIStructuredBuffer* Structur..., bool bUseUAVCounter, bool bAppendBuffer )	FlushType: Wait RHI Thread.
FUnorderedAc...	RHICreateUnorderedAccessView ( FRHIIndexBuffer* IndexBuffer, uint8 Format )	FlushType: Wait RHI Thread.
FUnorderedAc...	RHICreateUnorderedAccessView ( FRHIVertexBuffer* VertexBuffer, uint8 Format )	FlushType: Wait RHI Thread.
FUnorderedAc...	RHICreateUnorderedAccessView ( FRHITexture* Texture, uint32 MipLevel )	FlushType: Wait RHI Thread.
FUnorderedAc...	RHICreateUnorderedAccessView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture* Texture, uint32 MipLevel, uint8 Format )
FUnorderedAc...	RHICreateUnorderedAccessView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIStructuredBuffer* Structur..., bool bUseUAVCounter, bool bAppendBuffer )
FUnorderedAc...	RHICreateUnorderedAccessView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIIndexBuffer* IndexBuffer, uint8 Format )
FUnorderedAc...	RHICreateUnorderedAccessView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIVertexBuffer* VertexBuffer, uint8 Format )
FUnorderedAc...	RHICreateUnorderedAccessView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture* Texture, uint32 MipLevel )
FUnorderedAc...	RHICreateUnorderedAccessViewHTile ( FRHITexture2D* RenderTarget )
FUnorderedAc...	RHICreateUnorderedAccessViewStencil ( FRHITexture2D* DepthTarget, int32 MipLevel )
FVertexBuffe...	RHICreateVertexBuffer ( uint32 Size, uint32 InUsage, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FVertexDecla...	RHICreateVertexDeclaration ( const FVertexDeclarationElementList... )	FlushType: Wait RHI Thread.
FVertexShade...	RHICreateVertexShader ( TArrayView< const uint8 > Code, const FSHAHash& Hash )	FlushType: Wait RHI Thread.
FViewportRHI...	RHICreateViewport ( void* WindowHandle, uint32 SizeX, uint32 SizeY, bool bIsFullscreen, EPixelFormat PreferredPixelFormat )	Must be called from the main thread. FlushType: Thread safe
void	RHIDiscardTransientResource_RenderThread ( FRHIStructuredBuffer* Buffer )
void	RHIDiscardTransientResource_RenderThread ( FRHITexture* Texture )
void	RHIDiscardTransientResource_RenderThread ( FRHIVertexBuffer* Buffer )
bool	RHIEnqueueCompress ( uint8_t* SrcBuffer, uint8_t* DestBuffer, int UnCompressedSize, void* ErrorCodeBuffer )
bool	RHIEnqueueDecompress ( uint8_t* SrcBuffer, uint8_t* DestBuffer, int CompressedSize, void* ErrorCodeBuffer )	FlushType: Flush Immediate.
void	RHIExecuteCommandList ( FRHICommandList* CmdList )	FlushType: Wait RHI Thread.
ETextureReal...	RHIFinalizeAsyncReallocateTexture2D ( FRHITexture2D* Texture2D, bool bBlockUntilCompleted )	FlushType: Wait RHI Thread.
void	RHIFlushResources()	Flush driver resources.
bool	RHIGetAvailableResolutions ( FScreenResolutionArray& Resolution..., bool bIgnoreRefreshRate )	FlushType: Thread safe.
EColorSpaceA...	RHIGetColorSpace ( FRHIViewport* Viewport )	Return what colour space the viewport is in. Used for HDR displays.
IRHICommandC...	RHIGetCommandContextContainer ( int32 Index, int32 Num )	FlushType: Thread safe.
IRHICommandC...	RHIGetCommandContextContainer ( int32 Index, int32 Num, FRHIGPUMask GPUMask )
IRHIComputeC...	RHIGetDefaultAsyncComputeContext()	FlushType: Thread safe.
IRHICommandC...	RHIGetDefaultContext()	FlushType: Thread safe.
uint32	RHIGetGPUFrameCycles ( uint32 GPUIndex )	FlushType: Thread safe.
uint64	RHIGetMinimumAlignmentForBufferBackedSRV ( EPixelFormat Format )	FlushType: Thread safe.
void *	RHIGetNativeDevice()	FlushType: Flush RHI Thread.
void *	RHIGetNativeInstance()	FlushType: Flush RHI Thread.
uint16	RHIGetPlatformTextureMaxSampleCount()
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.
void	RHIGetResourceInfo ( FRHITexture* Ref, FRHIResourceInfo& OutInfo )	FlushType: Thread safe.
void	RHIGetSupportedResolution ( uint32& Width, uint32& Height )	FlushType: Thread safe.
void	RHIGetTextureMemoryStats ( FTextureMemoryStats& OutStats )	FlushType: Thread safe.
bool	RHIGetTextureMemoryVisualizeData ( FColor* TextureData, int32 SizeX, int32 SizeY, int32 Pitch, int32 PixelSize )	FlushType: Flush Immediate.
FTexture2DRH...	RHIGetViewportBackBuffer ( FRHIViewport* Viewport )	With RHI thread, this is the current backbuffer from the perspective of the render thread.
FUnorderedAc...	RHIGetViewportBackBufferUAV ( FRHIViewport* ViewportRHI )
uint32	RHIGetViewportNextPresentGPUIndex ( FRHIViewport* Viewport )	FlushType: Thread safe.
bool	RHIIsRenderingSuspended()	FlushType: Flush Immediate.
bool	RHIIsTypedUAVLoadSupported ( EPixelFormat PixelFormat )
void *	RHILockIndexBuffer ( FRHICommandListImmediate& RHICmdLi..., FRHIIndexBuffer* IndexBuffer, uint32 Offset, uint32 Size, EResourceLockMode LockMode )	FlushType: Flush RHI Thread.
void *	RHILockStagingBuffer ( FRHIStagingBuffer* StagingBuff..., 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.
void *	RHILockStructuredBuffer ( FRHICommandListImmediate& RHICmdLi..., FRHIStructuredBuffer* Structur..., uint32 Offset, uint32 SizeRHI, EResourceLockMode LockMode )	FlushType: Flush RHI Thread.
void *	RHILockTexture2D ( FRHITexture2D* Texture, uint32 MipIndex, EResourceLockMode LockMode, uint32& DestStride, bool bLockWithinMiptail )	FlushType: Flush RHI Thread.
void *	RHILockTexture2DArray ( FRHITexture2DArray* Texture, uint32 TextureIndex, uint32 MipIndex, EResourceLockMode LockMode, uint32& DestStride, bool bLockWithinMiptail )	FlushType: Flush RHI Thread.
void *	RHILockTextureCubeFace ( FRHITextureCube* Texture, uint32 FaceIndex, uint32 ArrayIndex, uint32 MipIndex, EResourceLockMode LockMode, uint32& DestStride, bool bLockWithinMiptail )	FlushType: Flush RHI Thread.
void *	RHILockTextureCubeFace_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITextureCube* Texture, uint32 FaceIndex, uint32 ArrayIndex, uint32 MipIndex, EResourceLockMode LockMode, uint32& DestStride, bool bLockWithinMiptail )
void *	RHILockVertexBuffer ( FRHICommandListImmediate& RHICmdLi..., FRHIVertexBuffer* VertexBuffer, uint32 Offset, uint32 SizeRHI, EResourceLockMode LockMode )	FlushType: Flush RHI Thread.
void	RHIMapStagingSurface ( FRHITexture* Texture, FRHIGPUFence* Fence, void*& OutData, int32& OutWidth, int32& OutHeight, uint32 GPUIndex )	FlushType: Flush Immediate (seems wrong)
void	RHIMapStagingSurface_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture* Texture, FRHIGPUFence* Fence, void*& OutData, int32& OutWidth, int32& OutHeight )
void	RHIPerFrameRHIFlushComplete()	FlushType: called from render thread when RHI thread is flushed.
void	RHIPollRenderQueryResults()
EPixelFormat	RHIPreferredPixelFormatHint ( EPixelFormat PreferredPixelFormat )	Return preferred pixel format if given format is unsupported.
void	RHIRead3DSurfaceFloatData ( FRHITexture* Texture, FIntRect Rect, FIntPoint ZMinMax, TArray< FFloat16Color >& OutData )	FlushType: Flush Immediate (seems wrong)
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.
void	RHIReadSurfaceData ( FRHITexture* Texture, FIntRect Rect, TArray< FColor >& OutData, FReadSurfaceDataFlags InFlags )	FlushType: Flush Immediate (seems wrong)
void	RHIReadSurfaceFloatData ( FRHITexture* Texture, FIntRect Rect, TArray< FFloat16Color >& OutData, ECubeFace CubeFace, int32 ArrayIndex, int32 MipIndex )	FlushType: Flush Immediate (seems wrong)
void	RHIReadSurfaceFloatData_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture* Texture, FIntRect Rect, TArray< FFloat16Color >& OutData, ECubeFace CubeFace, int32 ArrayIndex, int32 MipIndex )
void	RHIReleaseThreadOwnership()	FlushType: Flush RHI Thread.
bool	RHIRequiresComputeGenerateMips()
void	RHIResizeViewport ( FRHIViewport* Viewport, uint32 SizeX, uint32 SizeY, bool bIsFullscreen )	Must be called from the main thread. FlushType: Thread safe
void	RHIResizeViewport ( FRHIViewport* Viewport, uint32 SizeX, uint32 SizeY, bool bIsFullscreen, EPixelFormat PreferredPixelFormat )
void	RHIResumeRendering()	FlushType: Thread safe.
void	RHISignalFlipEvent()
void	RHISubmitCommandsAndFlushGPU()	Kicks the current frame and makes sure GPU is actively working on them FlushType: Flush Immediate (copied from RHIBlockUntilGPUIdle)
void	RHISuspendRendering()	Operations to suspend title rendering and yield control to the system FlushType: Thread safe
void	RHITick ( float DeltaTime )	Must be called from the main thread. FlushType: Thread safe
void	RHITransferIndexBufferUnderlyingResource ( FRHIIndexBuffer* DestIndexBuff..., FRHIIndexBuffer* SrcIndexBuffe... )	Transfer metadata and underlying resource from src to dest and release any resource owned by dest.
void	RHITransferTexture ( FRHITexture2D* Texture, FIntRect Rect, uint32 SrcGPUIndex, uint32 DestGPUIndex, bool PullData )	FlushType: Flush RHI Thread.
void	RHITransferVertexBufferUnderlyingResource ( FRHIVertexBuffer* DestVertexBu..., FRHIVertexBuffer* SrcVertexBuf... )	Transfer metadata and underlying resource from src to dest and release any resource owned by dest.
void	RHIUnlockIndexBuffer ( FRHICommandListImmediate& RHICmdLi..., FRHIIndexBuffer* IndexBuffer )	FlushType: Flush RHI Thread.
void	RHIUnlockStagingBuffer ( FRHIStagingBuffer* StagingBuff... )	Unlock a staging buffer previously locked with RHILockStagingBuffer.
void	RHIUnlockStructuredBuffer ( FRHICommandListImmediate& RHICmdLi..., FRHIStructuredBuffer* Structur... )	FlushType: Flush RHI Thread.
void	RHIUnlockTexture2D ( FRHITexture2D* Texture, uint32 MipIndex, bool bLockWithinMiptail )	FlushType: Flush RHI Thread.
void	RHIUnlockTexture2DArray ( FRHITexture2DArray* Texture, uint32 TextureIndex, uint32 MipIndex, bool bLockWithinMiptail )	FlushType: Flush RHI Thread.
void	RHIUnlockTextureCubeFace ( FRHITextureCube* Texture, uint32 FaceIndex, uint32 ArrayIndex, uint32 MipIndex, bool bLockWithinMiptail )	FlushType: Flush RHI Thread.
void	RHIUnlockTextureCubeFace_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITextureCube* Texture, uint32 FaceIndex, uint32 ArrayIndex, uint32 MipIndex, bool bLockWithinMiptail )
void	RHIUnlockVertexBuffer ( FRHICommandListImmediate& RHICmdLi..., FRHIVertexBuffer* VertexBuffer )	FlushType: Flush RHI Thread.
void	RHIUnmapStagingSurface ( FRHITexture* Texture, uint32 GPUIndex )	FlushType: Flush Immediate (seems wrong)
void	RHIUnmapStagingSurface_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture* Texture )
void	RHIUpdateFromBufferTexture2D ( FRHITexture2D* Texture, uint32 MipIndex, const FUpdateTextureRegion2D& Upda..., uint32 SourcePitch, FRHIStructuredBuffer* Buffer, uint32 BufferOffset )	FlushType: Flush RHI Thread.
void	RHIUpdateShaderResourceView ( FRHIShaderResourceView* SRV, FRHIIndexBuffer* IndexBuffer )
void	RHIUpdateShaderResourceView ( FRHIShaderResourceView* SRV, FRHIVertexBuffer* VertexBuffer, uint32 Stride, uint8 Format )	Must be called on RHI thread timeline Make sure to call RHIThreadFence(true) afterwards so that parallel translation doesn't refer old resources
void	RHIUpdateTexture2D ( FRHITexture2D* Texture, uint32 MipIndex, const FUpdateTextureRegion2D& Upda..., uint32 SourcePitch, const uint8* SourceData )	FlushType: Flush RHI Thread.
void	RHIUpdateTexture3D ( FRHITexture3D* Texture, uint32 MipIndex, const FUpdateTextureRegion3D& Upda..., uint32 SourceRowPitch, uint32 SourceDepthPitch, const uint8* SourceData )	FlushType: Flush RHI Thread.
void	RHIUpdateUniformBuffer ( FRHIUniformBuffer* UniformBuff..., const void* Contents )
void	RHIVirtualTextureSetFirstMipInMemory ( FRHITexture2D* Texture, uint32 FirstMip )	FlushType: Wait RHI Thread.
void	RHIVirtualTextureSetFirstMipVisible ( FRHITexture2D* Texture, uint32 FirstMip )	FlushType: Wait RHI Thread.
FRHIFlipDeta...	RHIWaitForFlip ( double TimeoutInSeconds )
void	Shutdown()	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).
void	UnlockIndexBuffer_BottomOfPipe ( FRHICommandListImmediate& RHICmdLi..., FRHIIndexBuffer* IndexBuffer )
void	UnlockStagingBuffer_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIStagingBuffer* StagingBuff... )	Unlock a staging buffer previously locked with LockStagingBuffer_RenderThread.
void	UnlockStructuredBuffer_BottomOfPipe ( FRHICommandListImmediate& RHICmdLi..., FRHIStructuredBuffer* Structur... )
void	UnlockTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture, uint32 MipIndex, bool bLockWithinMiptail, bool bNeedsDefaultRHIFlush )
void	UnlockVertexBuffer_BottomOfPipe ( FRHICommandListImmediate& RHICmdLi..., FRHIVertexBuffer* VertexBuffer )
void	UpdateFromBufferTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture, uint32 MipIndex, const FUpdateTextureRegion2D& Upda..., uint32 SourcePitch, FRHIStructuredBuffer* Buffer, uint32 BufferOffset )
void	UpdateTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture, uint32 MipIndex, const FUpdateTextureRegion2D& Upda..., uint32 SourcePitch, const uint8* SourceData )
void	UpdateTexture3D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture3D* Texture, uint32 MipIndex, const FUpdateTextureRegion3D& Upda..., uint32 SourceRowPitch, uint32 SourceDepthPitch, const uint8* SourceData )
void	VirtualTextureSetFirstMipInMemory_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture, uint32 FirstMip )
void	VirtualTextureSetFirstMipVisible_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture, uint32 FirstMip )

Deprecated Functions

	Name	Description
void	RHIAliasTextureResources ( FRHITexture* DestTexture, FRHITexture* SrcTexture )	RHIAliasTextureResources now takes references to FTextureRHIRef objects as parameters
FTextureRHIR...	RHICreateAliasedTexture ( FRHITexture* SourceTexture )	RHICreateAliasedTexture now takes a reference to an FTextureRHIRef object
FTexture2DAr...	RHICreateTexture2DArray ( uint32 SizeX, uint32 SizeY, uint32 SizeZ, uint8 Format, uint32 NumMips, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )	RHICreateTexture2DArray now takes NumSamples
FTexture2DAr...	RHICreateTexture2DArray_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 SizeX, uint32 SizeY, uint32 SizeZ, uint8 Format, uint32 NumMips, uint32 Flags, FRHIResourceCreateInfo& CreateInfo )	RHICreateTexture2DArray_RenderThread now takes NumSamples
void	RHIGenerateMips ( FRHITexture* Texture )	This function is deprecated and will be removed in future releases. Renderer version implemented.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss