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 > OpenGLDrv > FOpenGLDynamicRHI

Light Theme

Dark Theme

FOpenGLDynamicRHI

The interface which is implemented by the dynamically bound RHI.

Windows

MacOS

Linux

Inheritance Hierarchy

FDynamicRHI

IRHICommandContextPSOFallback

FOpenGLDynamicRHI

References

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

Syntax

class FOpenGLDynamicRHI :
public FDynamicRHI,
public IRHICommandContextPSOFallback

Remarks

The interface which is implemented by the dynamically bound RHI.

Constructors

	Name	Description
	FOpenGLDynamicRHI()	Initialization constructor.

Destructors

	Name	Description
	~FOpenGLDynamicRHI()	Destructor

Functions

	Name	Description
void	BeginRenderQuery_OnThisThread ( FOpenGLRenderQuery* Query )
void	CachedBindArrayBuffer ( FOpenGLContextState& ContextState, GLuint Buffer )
void	CachedBindElementArrayBuffer ( FOpenGLContextState& ContextState, GLuint Buffer )
void	CachedBindPixelUnpackBuffer ( FOpenGLContextState& ContextState, GLuint Buffer )
void	CachedBindUniformBuffer ( FOpenGLContextState& ContextState, GLuint Buffer )
void	CachedSetupTextureStage ( FOpenGLContextState& ContextState, GLint TextureIndex, GLenum Target, GLuint Resource, GLint BaseMip, GLint NumMips )	Set a resource on texture target of a specific real OpenGL stage.
void	CachedSetupTextureStageInner ( FOpenGLContextState& ContextState, GLint TextureIndex, GLenum Target, GLuint Resource, GLint BaseMip, GLint NumMips )
void	CachedSetupUAVStage ( FOpenGLContextState& ContextState, GLint UAVIndex, GLenum Format, GLuint Resource, bool bLayered, GLint Layer, GLenum Access )
void	Cleanup()
FRHITexture ...	CreateOpenGLRHITextureOnly ( const uint32 SizeX, const uint32 SizeY, const bool bCubeTexture, const bool bArrayTexture, const bool bIsExternal, uint8& Format, uint32& NumMips, uint32& NumSamples, const uint32 ArraySize, ETextureCreateFlags Flags, const FClearValueBinding& InClearV..., FResourceBulkDataInterface* Bu... )
FRHITexture ...	CreateOpenGLTexture ( uint32 SizeX, uint32 SizeY, bool CubeTexture, bool ArrayTexture, bool bIsExternal, uint8 Format, uint32 NumMips, uint32 NumSamples, uint32 ArraySize, ETextureCreateFlags Flags, const FClearValueBinding& InClearV..., FResourceBulkDataInterface* Bu... )
FRHITexture ...	CreateTexture2DAliased ( FOpenGLTexture2D* SourceTextur... )
FRHITexture ...	CreateTexture2DArrayAliased ( FOpenGLTexture2DArray* SourceT... )
FRHITexture ...	CreateTextureCubeAliased ( FOpenGLTextureCube* SourceText... )
void	EndRenderQuery_OnThisThread ( FOpenGLRenderQuery* Query )
FOpenGLConte...	GetContextStateForCurrentContext ( bool bAssertIfInvalid )
FOpenGLGPUPr...	GetGPUProfilingData()
FOpenGLLinke...	GetLinkedComputeProgram ( FRHIComputeShader* ComputeShad... )
void *	GetOpenGLCurrentContextHandle()
FOpenGLSampl...	GetPointSamplerState()
void	GetRenderQueryResult_OnThisThread ( FOpenGLRenderQuery* Query, bool bWait )
void	InitializeGLTexture ( FRHITexture* Texture, uint32 SizeX, const uint32 SizeY, const bool bCubeTexture, const bool bArrayTexture, const bool bIsExternal, const uint8 Format, const uint32 NumMips, const uint32 NumSamples, const uint32 ArraySize, const ETextureCreateFlags Flags, const FClearValueBinding& InClearV..., FResourceBulkDataInterface* Bu... )
void	InitializeGLTextureInternal ( GLuint TextureID, FRHITexture* Texture, uint32 SizeX, const uint32 SizeY, const bool bCubeTexture, const bool bArrayTexture, const bool bIsExternal, const uint8 Format, const uint32 NumMips, const uint32 NumSamples, const uint32 ArraySize, const ETextureCreateFlags Flags, const FClearValueBinding& InClearV..., FResourceBulkDataInterface* Bu... )
void	InternalSetSamplerStates ( GLint TextureIndex, FOpenGLSamplerState* SamplerSt... )
void	InternalSetShaderTexture ( FOpenGLTextureBase* Texture, FOpenGLShaderResourceView* SRV, GLint TextureIndex, GLenum Target, GLuint Resource, int NumMips, int LimitMip )	Remember what RHI user wants set on a specific OpenGL texture stage, translating from Stage and TextureIndex for stage pair.
void	InternalSetShaderUAV ( GLint UAVIndex, GLenum Format, GLuint Resource, bool bLayered, GLint Layer, GLenum Access )
void	InvalidateQueries()	Inform all queries about the need to recreate themselves after OpenGL context they're in gets deleted.
void	InvalidateTextureResourceInCache ( GLuint Resource )
void	InvalidateUAVResourceInCache ( GLuint Resource )
bool	IsUniformBufferBound ( FOpenGLContextState& ContextState, GLuint Buffer )
void	OnIndexBufferDeletion ( GLuint IndexBufferResource )
void	OnPixelBufferDeletion ( GLuint PixelBufferResource )
void	OnProgramDeletion ( GLint ProgramResource )
void	OnUniformBufferDeletion ( GLuint UniformBufferResource, uint32 AllocatedSize, bool bStreamDraw )
void	OnVertexBufferDeletion ( GLuint VertexBufferResource )
void	PurgeFramebufferFromCaches ( GLuint Framebuffer )
void	RegisterQuery ( FOpenGLRenderQuery* Query )	Add query to Queries list upon its creation.
TEnableIf<&#...	ResourceCast ( TRHIType* Resource )
TEnableIf< T...	ResourceCast ( TRHIType* Resource )	If using a Proxy object return the contained GL object rather than the proxy itself.
TEnableIf<&#...	ResourceCast_Unfenced ( TRHIType* Resource )
FBoundShader...	RHICreateBoundShaderState_internal ( FRHIVertexDeclaration* VertexD..., FRHIVertexShader* VertexShader..., FRHIHullShader* HullShaderRHI, FRHIDomainShader* DomainShader..., FRHIPixelShader* PixelShaderRH..., FRHIGeometryShader* GeometrySh..., bool FromPSOFileCache )
FBoundShader...	RHICreateBoundShaderState_OnThisThread ( FRHIVertexDeclaration* VertexD..., FRHIVertexShader* VertexShader, FRHIHullShader* HullShader, FRHIDomainShader* DomainShader, FRHIPixelShader* PixelShader, FRHIGeometryShader* GeometrySh..., bool FromPSOFileCache )
FTexture2DRH...	RHICreateTexture2DArrayFromResource ( EPixelFormat Format, uint32 SizeX, uint32 SizeY, uint32 ArraySize, uint32 NumMips, uint32 NumSamples, uint32 NumSamplesTileMem, const FClearValueBinding& ClearVal..., GLuint Resource, ETextureCreateFlags Flags )
FTexture2DRH...	RHICreateTexture2DFromResource ( EPixelFormat Format, uint32 SizeX, uint32 SizeY, uint32 NumMips, uint32 NumSamples, uint32 NumSamplesTileMem, const FClearValueBinding& ClearVal..., GLuint Resource, ETextureCreateFlags Flags )
FTextureCube...	RHICreateTextureCubeFromResource ( EPixelFormat Format, uint32 Size, bool bArray, uint32 ArraySize, uint32 NumMips, uint32 NumSamples, uint32 NumSamplesTileMem, const FClearValueBinding& ClearVal..., GLuint Resource, ETextureCreateFlags Flags )
void	SetCustomPresent ( FRHICustomPresent* InCustomPre... )
void	SetRenderTargets ( uint32 NumSimultaneousRenderTargets, const FRHIRenderTargetView* Ne..., const FRHIDepthRenderTargetView... )
void	SetRenderTargetsAndClear ( const FRHISetRenderTargetsInfo& Re... )
void	SetResourcesFromTables ( const ShaderType*__restrict Sh... )
void	UnregisterQuery ( FOpenGLRenderQuery* Query )	Remove query from Queries list upon its deletion.
void	UpdateSRV ( FOpenGLShaderResourceView* SRV )

Overridden from FDynamicRHI

	Name	Description
FTexture2DRH...	AsyncReallocateTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture2D, int32 NewMipCount, int32 NewSizeX, int32 NewSizeY, FThreadSafeCounter* RequestSta... )
ETextureReal...	CancelAsyncReallocateTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture2D, bool bBlockUntilCompleted )
FComputeShad...	CreateComputeShader_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, ERHIAccess InResourceState, 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, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )
FVertexBuffe...	CreateVertexBuffer_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 Size, uint32 InUsage, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )
FVertexShade...	CreateVertexShader_RenderThread ( FRHICommandListImmediate& RHICmdLi..., TArrayView< const uint8 > Code, const FSHAHash& Hash )
ETextureReal...	FinalizeAsyncReallocateTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* Texture2D, bool bBlockUntilCompleted )
const TCHAR ...	GetName()
void	Init()	Initializes the RHI; separate from IDynamicRHIModule::CreateRHI so that GDynamicRHI is set when it is called.
void *	LockIndexBuffer_BottomOfPipe ( FRHICommandListImmediate& RHICmdLi..., FRHIIndexBuffer* IndexBuffer, uint32 Offset, uint32 Size, 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 *	LockTexture2DArray_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2DArray* Texture, uint32 ArrayIndex, uint32 MipIndex, EResourceLockMode LockMode, uint32& DestStride, bool bLockWithinMiptail )
void *	LockVertexBuffer_BottomOfPipe ( FRHICommandListImmediate& RHICmdLi..., FRHIVertexBuffer* VertexBuffer, uint32 Offset, uint32 SizeRHI, EResourceLockMode LockMode )
void	PostInit()	Initializes the RHI; separate from IDynamicRHIModule::CreateRHI so that GDynamicRHI is set when it is called.
void	RHIAcquireThreadOwnership()	FlushType: Flush RHI Thread.
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& DestTextureRHI, FTextureRHIRef& SrcTextureRHI )
FTexture2DRH...	RHIAsyncCreateTexture2D ( uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, ERHIAccess InResourceState, 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	RHIBindDebugLabelName ( FRHITexture* Texture, const TCHAR* Name )	FlushType: Thread safe.
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, ETextureCreateFlags Flags, const FRHIResourceCreateInfo& Crea..., uint32& OutAlign )	FlushType: Thread safe.
uint64	RHICalcTexture3DPlatformSize ( uint32 SizeX, uint32 SizeY, uint32 SizeZ, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, const FRHIResourceCreateInfo& Crea..., uint32& OutAlign )	FlushType: Thread safe.
uint64	RHICalcTextureCubePlatformSize ( uint32 Size, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, const FRHIResourceCreateInfo& Crea..., uint32& OutAlign )	FlushType: Thread safe.
ETextureReal...	RHICancelAsyncReallocateTexture2D ( FRHITexture2D* Texture2D, bool bBlockUntilCompleted )	Cancels an async reallocation for the specified texture.
uint32	RHIComputeMemorySize ( FRHITexture* TextureRHI )	Computes the size in memory required by a given texture.
void	RHICopySharedMips ( FRHITexture2D* DestTexture2D, FRHITexture2D* SrcTexture2D )	FlushType: Flush RHI Thread.
void	RHICopySubTextureRegion ( FRHITexture2D* SourceTexture, FRHITexture2D* DestinationText..., FBox2D SourceBox, FBox2D DestinationBox )
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.
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 )
FHullShaderR...	RHICreateHullShader ( TArrayView< const uint8 > Code, const FSHAHash& Hash )	FlushType: Wait RHI Thread.
FIndexBuffer...	RHICreateIndexBuffer ( uint32 Stride, uint32 Size, uint32 InUsage, ERHIAccess InResourceState, 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.
FShaderResou...	RHICreateShaderResourceView ( FRHIStructuredBuffer* Structur... )	FlushType: Wait RHI Thread.
FShaderResou...	RHICreateShaderResourceView ( FRHITexture* Texture2DRHI, const FRHITextureSRVCreateInfo& Cr... )	FlushType: Wait RHI Thread.
FShaderResou...	RHICreateShaderResourceView ( FRHIVertexBuffer* VertexBuffer, uint32 Stride, uint8 Format )	FlushType: Wait RHI Thread.
FShaderResou...	RHICreateShaderResourceView ( FRHIIndexBuffer* Buffer )	FlushType: Wait RHI Thread.
FShaderResou...	RHICreateShaderResourceView ( const FShaderResourceViewInitialize... )	Creates a shader resource view
FShaderResou...	RHICreateShaderResourceView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIIndexBuffer* Buffer )
FShaderResou...	RHICreateShaderResourceView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIStructuredBuffer* Structur... )
FShaderResou...	RHICreateShaderResourceView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIVertexBuffer* VertexBuffer, uint32 Stride, uint8 Format )
FShaderResou...	RHICreateShaderResourceView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture* Texture, const FRHITextureSRVCreateInfo& Cr... )
FStagingBuff...	RHICreateStagingBuffer()	FlushType: Thread safe.
FStructuredB...	RHICreateStructuredBuffer ( uint32 Stride, uint32 Size, uint32 InUsage, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FTexture2DRH...	RHICreateTexture2D ( uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, uint32 NumSamples, ETextureCreateFlags Flags, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )	Creates a 2D RHI texture resource
FTexture2DRH...	RHICreateTexture2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, uint32 NumSamples, ETextureCreateFlags Flags, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )
FTexture2DAr...	RHICreateTexture2DArray ( uint32 SizeX, uint32 SizeY, uint32 SizeZ, uint8 Format, uint32 NumMips, uint32 NumSamples, ETextureCreateFlags Flags, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FTexture2DAr...	RHICreateTexture2DArray_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 SizeX, uint32 SizeY, uint32 SizeZ, uint8 Format, uint32 NumMips, uint32 NumSamples, ETextureCreateFlags Flags, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )
FTexture3DRH...	RHICreateTexture3D ( uint32 SizeX, uint32 SizeY, uint32 SizeZ, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FTexture3DRH...	RHICreateTexture3D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 SizeX, uint32 SizeY, uint32 SizeZ, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )
FTextureCube...	RHICreateTextureCube ( uint32 Size, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FTextureCube...	RHICreateTextureCube_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 Size, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )
FTextureCube...	RHICreateTextureCubeArray ( uint32 Size, uint32 ArraySize, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )	FlushType: Wait RHI Thread.
FTextureCube...	RHICreateTextureCubeArray_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 Size, uint32 ArraySize, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )
FTexture2DRH...	RHICreateTextureExternal2D ( uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, uint32 NumSamples, ETextureCreateFlags Flags, ERHIAccess InResourceState, FRHIResourceCreateInfo& CreateInfo )	Creates a 2D RHI texture external resource
FTexture2DRH...	RHICreateTextureExternal2D_RenderThread ( FRHICommandListImmediate& RHICmdLi..., uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, uint32 NumSamples, ETextureCreateFlags Flags, ERHIAccess InResourceState, 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 ( FRHIVertexBuffer* VertexBuffer, uint8 Format )	FlushType: Wait RHI Thread.
FUnorderedAc...	RHICreateUnorderedAccessView ( FRHIIndexBuffer* IndexBuffer, uint8 Format )	FlushType: Wait RHI Thread.
FUnorderedAc...	RHICreateUnorderedAccessView ( FRHIStructuredBuffer* Structur..., bool bUseUAVCounter, bool bAppendBuffer )	FlushType: Wait RHI Thread.
FUnorderedAc...	RHICreateUnorderedAccessView ( FRHITexture* Texture, uint32 MipLevel )	FlushType: Wait RHI Thread.
FUnorderedAc...	RHICreateUnorderedAccessView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture* Texture, uint32 MipLevel )
FUnorderedAc...	RHICreateUnorderedAccessView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIVertexBuffer* VertexBuffer, uint8 Format )
FUnorderedAc...	RHICreateUnorderedAccessView_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHIStructuredBuffer* Structur..., bool bUseUAVCounter, bool bAppendBuffer )
FVertexBuffe...	RHICreateVertexBuffer ( uint32 Size, uint32 InUsage, ERHIAccess InResourceState, 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	RHIExecuteCommandList ( FRHICommandList* CmdList )	FlushType: Wait RHI Thread.
ETextureReal...	RHIFinalizeAsyncReallocateTexture2D ( FRHITexture2D* Texture2D, bool bBlockUntilCompleted )	Returns the status of an ongoing or completed texture reallocation: TexRealloc_Succeeded - The texture is ok, reallocation is not in progress.
void	RHIFlushResources()	Flush driver resources.
void	RHIGenerateMips ( FRHITexture* Texture )	Generates mip maps for the surface.
bool	RHIGetAvailableResolutions ( FScreenResolutionArray& Resolution..., bool bIgnoreRefreshRate )	FlushType: Thread safe.
IRHICommandC...	RHIGetCommandContextContainer ( int32 Index, int32 Num )	FlushType: Thread safe.
IRHICommandC...	RHIGetDefaultContext()	FlushType: Thread safe.
uint32	RHIGetGPUFrameCycles ( uint32 GPUIndex )	Returns the total GPU time taken to render the last frame.
uint64	RHIGetMinimumAlignmentForBufferBackedSRV ( EPixelFormat Format )	FlushType: Thread safe.
void *	RHIGetNativeDevice()	FlushType: Flush RHI Thread.
void *	RHIGetNativeInstance()	FlushType: Flush RHI Thread.
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 )	Retrieves texture memory stats. Unsupported with this allocator.
bool	RHIGetTextureMemoryVisualizeData ( FColor* TextureData, int32 SizeX, int32 SizeY, int32 Pitch, int32 PixelSize )	Fills a texture with to visualize the texture pool memory.
FTexture2DRH...	RHIGetViewportBackBuffer ( FRHIViewport* Viewport )	With RHI thread, this is the current backbuffer from the perspective of the render 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 *	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	RHIMapStagingSurface ( FRHITexture* Texture, FRHIGPUFence* Fence, void*& OutData, int32& OutWidth, int32& OutHeight, uint32 GPUIndex )	FlushType: Flush Immediate (seems wrong)
void	RHIPerFrameRHIFlushComplete()	FlushType: called from render thread when RHI thread is flushed.
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< FColor >& OutData, FReadSurfaceDataFlags InFlags )	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	RHIReadSurfaceFloatData ( FRHITexture* Texture, FIntRect Rect, TArray< FFloat16Color >& OutData, ECubeFace CubeFace, int32 ArrayIndex, int32 MipIndex )	FlushType: Flush Immediate (seems wrong)
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	RHISubmitCommandsAndFlushGPU()	Kicks the current frame and makes sure GPU is actively working on them FlushType: Flush Immediate (copied from RHIBlockUntilGPUIdle)
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	RHITransferVertexBufferUnderlyingResource ( FRHIVertexBuffer* DestVertexBu..., FRHIVertexBuffer* SrcVertexBuf... )	Transfer metadata and underlying resource from src to dest and release any resource owned by dest.
void	RHIUnlockStagingBuffer ( FRHIStagingBuffer* StagingBuff... )	Unlock a staging buffer previously locked with RHILockStagingBuffer.
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	RHIUnmapStagingSurface ( FRHITexture* Texture, uint32 GPUIndex )	FlushType: Flush Immediate (seems wrong)
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.
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	UnlockTexture2DArray_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2DArray* Texture, uint32 ArrayIndex, uint32 MipIndex, bool bLockWithinMiptail )
void	UnlockVertexBuffer_BottomOfPipe ( FRHICommandListImmediate& RHICmdLi..., FRHIVertexBuffer* VertexBuffer )
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 )

Overridden from IRHICommandContextPSOFallback

	Name	Description
void	RHIEnableDepthBoundsTest ( bool bEnable )
void	RHISetBlendState ( FRHIBlendState* NewState, const FLinearColor& BlendFactor )
void	RHISetBoundShaderState ( FRHIBoundShaderState* BoundSha... )	Set bound shader state. This will set the vertex decl/shader, and pixel shader
void	RHISetDepthStencilState ( FRHIDepthStencilState* NewStat..., uint32 StencilRef )
void	RHISetRasterizerState ( FRHIRasterizerState* NewState )

Overridden from IRHICommandContext

	Name	Description
void	RHIBeginDrawingViewport ( FRHIViewport* Viewport, FRHITexture* RenderTargetRHI )	This method is queued with an RHIThread, otherwise it will flush after it is queued; without an RHI thread there is no benefit to queuing this frame advance commands.
void	RHIBeginFrame()	This method is queued with an RHIThread, otherwise it will flush after it is queued; without an RHI thread there is no benefit to queuing this frame advance commands.
void	RHIBeginRenderPass ( const FRHIRenderPassInfo& InInfo, const TCHAR* InName )
void	RHIBeginRenderQuery ( FRHIRenderQuery* RenderQuery )
void	RHIBeginScene()	This method is queued with an RHIThread, otherwise it will flush after it is queued; without an RHI thread there is no benefit to queuing this frame advance commands.
void	RHICopyBufferRegion ( FRHIVertexBuffer* DestBuffer, uint64 DstOffset, FRHIVertexBuffer* SourceBuffer, uint64 SrcOffset, uint64 NumBytes )
void	RHICopyTexture ( FRHITexture* SourceTexture, FRHITexture* DestTexture, const FRHICopyTextureInfo& CopyInf... )	FIXME: Broken on Android for cubemaps.
void	RHICopyToResolveTarget ( FRHITexture* SourceTexture, FRHITexture* DestTexture, const FResolveParams& ResolveParam... )	Resolves from one texture to another.
void	RHIDiscardRenderTargets ( bool Depth, bool Stencil, uint32 ColorBitMask )	Not all RHIs need this (Mobile specific)
void	RHIDrawIndexedIndirect ( FRHIIndexBuffer* IndexBufferRH..., FRHIStructuredBuffer* Argument..., int32 DrawArgumentsIndex, uint32 NumInstances )
void	RHIDrawIndexedPrimitive ( FRHIIndexBuffer* IndexBuffer, int32 BaseVertexIndex, uint32 FirstInstance, uint32 NumVertices, uint32 StartIndex, uint32 NumPrimitives, uint32 NumInstances )
void	RHIDrawIndexedPrimitiveIndirect ( FRHIIndexBuffer* IndexBuffer, FRHIVertexBuffer* ArgumentBuff..., uint32 ArgumentOffset )
void	RHIDrawPrimitive ( uint32 BaseVertexIndex, uint32 NumPrimitives, uint32 NumInstances )
void	RHIDrawPrimitiveIndirect ( FRHIVertexBuffer* ArgumentBuff..., uint32 ArgumentOffset )
void	RHIEndDrawingViewport ( FRHIViewport* Viewport, bool bPresent, bool bLockToVsync )	This method is queued with an RHIThread, otherwise it will flush after it is queued; without an RHI thread there is no benefit to queuing this frame advance commands.
void	RHIEndFrame()	This method is queued with an RHIThread, otherwise it will flush after it is queued; without an RHI thread there is no benefit to queuing this frame advance commands.
void	RHIEndRenderPass()
void	RHIEndRenderQuery ( FRHIRenderQuery* RenderQuery )
void	RHIEndScene()	This method is queued with an RHIThread, otherwise it will flush after it is queued; without an RHI thread there is no benefit to queuing this frame advance commands.
void	RHINextSubpass()
void	RHIPollOcclusionQueries()	Used for OpenGL to check and see if any occlusion queries can be read back on the RHI thread. If they aren't ready when we need them, then we end up stalling.
void	RHISetBlendFactor ( const FLinearColor& BlendFactor )
void	RHISetDepthBounds ( float MinDepth, float MaxDepth )	Sets Depth Bounds range with the given min/max depth.
void	RHISetGraphicsPipelineState ( FRHIGraphicsPipelineState* Gra..., bool bApplyAdditionalState )	This will set most relevant pipeline state.
void	RHISetMultipleViewports ( uint32 Count, const FViewportBounds* Data )	Useful when used with geometry shader (emit polygons to different viewports), otherwise SetViewPort() is simpler
void	RHISetScissorRect ( bool bEnable, uint32 MinX, uint32 MinY, uint32 MaxX, uint32 MaxY )
void	RHISetShaderParameter ( FRHIGraphicsShader* Shader, uint32 BufferIndex, uint32 BaseIndex, uint32 NumBytes, const void* NewValue )
void	RHISetShaderResourceViewParameter ( FRHIGraphicsShader* Shader, uint32 SamplerIndex, FRHIShaderResourceView* SRV )
void	RHISetShaderSampler ( FRHIGraphicsShader* Shader, uint32 SamplerIndex, FRHISamplerState* NewState )	Sets sampler state.
void	RHISetShaderTexture ( FRHIGraphicsShader* Shader, uint32 TextureIndex, FRHITexture* NewTexture )	Set the shader resource view of a surface.
void	RHISetShaderUniformBuffer ( FRHIGraphicsShader* Shader, uint32 BufferIndex, FRHIUniformBuffer* Buffer )
void	RHISetStencilRef ( uint32 StencilRef )
void	RHISetStreamSource ( uint32 StreamIndex, FRHIVertexBuffer* VertexBuffer, uint32 Offset )
void	RHISetUAVParameter ( FRHIPixelShader* PixelShader, uint32 UAVIndex, FRHIUnorderedAccessView* UAV )	Sets a pixel shader UAV parameter.
void	RHISetViewport ( float MinX, float MinY, float MinZ, float MaxX, float MaxY, float MaxZ )
void	RHIUpdateTextureReference ( FRHITextureReference* TextureR..., FRHITexture* NewTexture )

Overridden from IRHIComputeContext

	Name	Description
void	RHIBeginTransitions ( TArrayView< const FRHITransition&#... )
void	RHIClearUAVFloat ( FRHIUnorderedAccessView* Unord..., const FVector4& Values )	Clears a UAV to the multi-channel floating point value provided.
void	RHIClearUAVUint ( FRHIUnorderedAccessView* Unord..., const FUintVector4& Values )	Clears a UAV to the multi-component unsigned integer value provided.
void	RHICopyToStagingBuffer ( FRHIVertexBuffer* SourceBuffer..., FRHIStagingBuffer* Destination..., uint32 InOffset, uint32 InNumBytes )	Inline copy.
void	RHIDispatchComputeShader ( uint32 ThreadGroupCountX, uint32 ThreadGroupCountY, uint32 ThreadGroupCountZ )
void	RHIDispatchIndirectComputeShader ( FRHIVertexBuffer* ArgumentBuff..., uint32 ArgumentOffset )
void	RHIEndTransitions ( TArrayView< const FRHITransition&#... )
void	RHIInvalidateCachedState()	Some RHI implementations (OpenGL) cache render state internally Signal to RHI that cached state is no longer valid
void	RHIPopEvent()
void	RHIPostExternalCommandsReset()
void	RHIPushEvent ( const TCHAR* Name, FColor Color )
void	RHISetComputeShader ( FRHIComputeShader* ComputeShad... )	Sets the current compute shader.
void	RHISetGlobalUniformBuffers ( const FUniformBufferStaticBindings ... )
void	RHISetShaderParameter ( FRHIComputeShader* ComputeShad..., uint32 BufferIndex, uint32 BaseIndex, uint32 NumBytes, const void* NewValue )
void	RHISetShaderResourceViewParameter ( FRHIComputeShader* ComputeShad..., uint32 SamplerIndex, FRHIShaderResourceView* SRV )
void	RHISetShaderSampler ( FRHIComputeShader* ComputeShad..., uint32 SamplerIndex, FRHISamplerState* NewState )	Sets sampler state.
void	RHISetShaderTexture ( FRHIComputeShader* PixelShader, uint32 TextureIndex, FRHITexture* NewTexture )	Set the shader resource view of a surface.
void	RHISetShaderUniformBuffer ( FRHIComputeShader* ComputeShad..., uint32 BufferIndex, FRHIUniformBuffer* Buffer )
void	RHISetUAVParameter ( FRHIComputeShader* ComputeShad..., uint32 UAVIndex, FRHIUnorderedAccessView* UAV )	Sets a compute shader UAV parameter.
void	RHISetUAVParameter ( FRHIComputeShader* ComputeShad..., uint32 UAVIndex, FRHIUnorderedAccessView* UAV, uint32 InitialCount )	Sets a compute shader counted UAV parameter and initial count
void	RHISubmitCommandsHint()	Submit the current command buffer to the GPU if possible.
void	RHIWriteGPUFence ( FRHIGPUFence* FenceRHI )	Write the fence in the GPU timeline.

Classes

	Name	Description
	FTextureLockTracker

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

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

Take our survey

Dismiss