1. Epic GamesDeveloper
  3. FOpenGLDynamicRHI

FOpenGLDynamicRHI

The interface which is implemented by the dynamically bound RHI.

API > API/Runtime > API/Runtime/OpenGLDrv

Inheritance Hierarchy

References

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

Syntax

class FOpenGLDynamicRHI :  
    public IOpenGLDynamicRHI,  
    public IRHICommandContextPSOFallback

Remarks

The interface which is implemented by the dynamically bound RHI.

Constructors

  Type Name Description
Public function   Initialization constructor.

Destructors

  Type Name Description
Public function   Destructor

Functions

  Type Name Description
Public function void  
Public function void

CachedBindArrayBuffer ( FOpenGLContextState& ContextState,
GLuint Buffer
)

  
Public function void

CachedBindElementArrayBuffer ( FOpenGLContextState& ContextState,
GLuint Buffer
)

  
Public function void

CachedBindPixelUnpackBuffer ( FOpenGLContextState& ContextState,
GLuint Buffer
)

  
Public function void

CachedBindStorageBuffer ( FOpenGLContextState& ContextState,
GLuint Buffer
)

  
Public function void

CachedBindUniformBuffer ( FOpenGLContextState& ContextState,
GLuint Buffer
)

  
Public function 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.
Public function void

CachedSetupTextureStageInner ( FOpenGLContextState& ContextState,
GLint TextureIndex,
GLenum Target,
GLuint Resource,
GLint BaseMip,
GLint NumMips
)

  
Public function void

CachedSetupUAVStage ( FOpenGLContextState& ContextState,
GLint UAVIndex,
GLenum Format,
GLuint Resource,
bool bLayered,
GLint Layer,
GLenum Access
)

  
Public function void

Cleanup ()

  
Public function void  
Public function Static FOpenGLDynamicRHI &

Get ()

  
Public function FOpenGLContextState &

GetContextStateForCurrentContext ( bool bAssertIfInvalid
)

  
Public function FOpenGLGPUProfiler &  
Public function FOpenGLLinkedProgram *  
Public function void *  
Public function GLuint

GetOpenGLFramebuffer ( uint32 NumSimultaneousRenderTargets,
FOpenGLTexture** RenderTargets,
const uint32* ArrayIndices,
const uint32* MipmapLevels,
FOpenGLTexture* DepthStencilTarget,
int32 NumRenderingSamples
)

  
Public function GLuint

GetOpenGLFramebuffer ( uint32 NumSimultaneousRenderTargets,
FOpenGLTexture** RenderTargets,
const uint32* ArrayIndices,
const uint32* MipmapLevels,
FOpenGLTexture* DepthStencilTarget
)

  
Public function Const FOpenGLSamplerState *  
Public function void  
Public function void

InitializeGLTexture ( FOpenGLTexture* Texture,
const void* BulkDataPtr,
uint64 BulkDataSize
)

  
Public function void

InitializeGLTextureInternal ( FOpenGLTexture* Texture,
void const* BulkDataPtr,
uint64 BulkDataSize
)

  
Public function void

InternalSetSamplerStates ( GLint TextureIndex,
FOpenGLSamplerState* SamplerState
)

  
Public function void

InternalSetShaderBufferUAV ( GLint UAVIndex,
GLuint Resource
)

  
Public function void

InternalSetShaderImageUAV ( GLint UAVIndex,
GLenum Format,
GLuint Resource,
bool bLayered,
GLint Layer,
GLenum Access
)

  
Public function void

InternalSetShaderTexture ( FOpenGLTexture* 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.
Public function void Inform all queries about the need to recreate themselves after OpenGL context they're in gets deleted.
Public function void

InvalidateTextureResourceInCache ( GLuint Resource
)

  
Public function void

InvalidateUAVResourceInCache ( GLuint Resource
)

  
Public function Const bool

IsUniformBufferBound ( FOpenGLContextState& ContextState,
GLuint Buffer
)

  
Public function bool

LinkComputeShader ( FRHIComputeShader* ComputeShaderRHI,
FOpenGLComputeShader* ComputeShader
)

  
Public function void

OnBufferDeletion ( GLuint VertexBufferResource
)

  
Public function void

OnPixelBufferDeletion ( GLuint PixelBufferResource
)

  
Public function void

OnProgramDeletion ( GLint ProgramResource
)

  
Public function void

OnUniformBufferDeletion ( GLuint UniformBufferResource,
uint32 AllocatedSize,
bool bStreamDraw
)

  
Public function void

PurgeFramebufferFromCaches ( GLuint Framebuffer
)

  
Public function void Add query to Queries list upon its creation.
Public function Static FOpenGLTexture *

ResourceCast ( FRHITexture* TextureRHI
)

  
Public function Static auto *

ResourceCast ( TRHIType* Resource
)

  
Public function FBoundShaderStateRHIRef

RHICreateBoundShaderState_OnThisThread ( FRHIVertexDeclaration* VertexDeclaration,
FRHIVertexShader* VertexShader,
FRHIPixelShader* PixelShader,
FRHIGeometryShader* GeometryShader,
bool FromPSOFileCache
)

  
Public function void

SetCustomPresent ( FRHICustomPresent* InCustomPresent
)

  
Public function void

SetRenderTargets ( uint32 NumSimultaneousRenderTargets,
const FRHIRenderTargetView* NewRenderTargets,
const FRHIDepthRenderTargetView* NewDepthStencilTarget
)

  
Public function void

SetRenderTargetsAndClear ( const FRHISetRenderTargetsInfo& RenderTargetsInfo
)

  
Public function void Remove query from Queries list upon its deletion.
Public function void  

Overridden from IOpenGLDynamicRHI

  Type Name Description
Public function Virtual FTexture2DRHIRef

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

  
Public function Virtual FTexture2DRHIRef

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

  
Public function Virtual FTextureCubeRHIRef

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

  
Public function Virtual Const int32  
Public function Virtual Const int32  
Public function Virtual Const GLuint

RHIGetResource ( FRHITexture* InTexture
)

  
Public function Virtual Const bool

RHIIsValidTexture ( GLuint InTexture
)

  
Public function Virtual void

RHISetExternalGPUTime ( uint32 InExternalGPUTime
)

  
Public function Virtual Const bool  

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

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

  
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 *

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,
FRHITexture2D* Texture,
uint32 MipIndex,
EResourceLockMode LockMode,
uint32& DestStride,
bool bLockWithinMiptail,
bool bNeedsDefaultRHIFlush,
uint64* OutLockedByteCount
)

  
Public function Virtual void *

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

  
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& DestTextureRHI,
FTextureRHIRef& SrcTextureRHI
)

  
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 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 ETextureReallocationStatus

RHICancelAsyncReallocateTexture2D ( FRHITexture2D* Texture2D,
bool bBlockUntilCompleted
)

 Cancels an async reallocation for the specified texture.
Public function Virtual uint32 Computes the size in memory required by a given texture.
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 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 FRenderQueryPoolRHIRef

RHICreateRenderQueryPool ( ERenderQueryType QueryType,
uint32 NumQueries
)

 FlushType: Must be Thread-Safe.
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 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 ETextureReallocationStatus

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.
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 void Generates mip maps for the surface.
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 IRHICommandContext * FlushType: Thread safe.
Public function Virtual uint32

RHIGetGPUFrameCycles ( uint32 GPUIndex
)

 Returns the total GPU time taken to render the last frame.
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 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 Retrieves texture memory stats. Unsupported with this allocator.
Public function Virtual bool

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

 Fills a texture with to visualize the texture pool memory.
Public function Virtual FTexture2DRHIRef With RHI thread, this is the current backbuffer from the perspective of the render thread.
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 *

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

  
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 void FlushType: called from render thread when RHI thread is flushed.
Public function Virtual EPixelFormat

RHIPreferredPixelFormatHint ( EPixelFormat PreferredPixelFormat
)

 Return preferred pixel format if given format is unsupported.
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 Const bool  
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

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

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

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

  
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

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 Unlock a staging buffer previously locked with LockStagingBuffer_RenderThread.
Public function Virtual void

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

  
Public function Virtual void

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

  

Overridden from IRHICommandContextPSOFallback

  Type Name Description
Public function Virtual void

RHIEnableDepthBoundsTest ( bool bEnable
)

  
Public function Virtual void

RHISetBlendState ( FRHIBlendState* NewState,
const FLinearColor& BlendFactor
)

  
Public function Virtual void Set bound shader state. This will set the vertex decl/shader, and pixel shader
Public function Virtual void  
Public function Virtual void

RHISetDepthStencilState ( FRHIDepthStencilState* NewState,
uint32 StencilRef
)

  
Public function Virtual void  

Overridden from IRHICommandContext

  Type Name Description
Public function Virtual 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.
Public function Virtual void 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.
Public function Virtual void

RHIBeginRenderPass ( const FRHIRenderPassInfo& InInfo,
const TCHAR* InName
)

  
Public function Virtual void  
Public function Virtual void 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.
Public function Virtual void

RHICopyBufferRegion ( FRHIBuffer* DestBuffer,
uint64 DstOffset,
FRHIBuffer* SourceBuffer,
uint64 SrcOffset,
uint64 NumBytes
)

  
Public function Virtual void

RHICopyTexture ( FRHITexture* SourceTexture,
FRHITexture* DestTexture,
const FRHICopyTextureInfo& CopyInfo
)

 FIXME: Broken on Android for cubemaps.
Public function Virtual void

RHIDiscardRenderTargets ( bool Depth,
bool Stencil,
uint32 ColorBitMask
)

 Not all RHIs need this (Mobile specific)
Public function Virtual void

RHIDrawIndexedIndirect ( FRHIBuffer* IndexBufferRHI,
FRHIBuffer* ArgumentsBufferRHI,
int32 DrawArgumentsIndex,
uint32 NumInstances
)

  
Public function Virtual void

RHIDrawIndexedPrimitive ( FRHIBuffer* IndexBuffer,
int32 BaseVertexIndex,
uint32 FirstInstance,
uint32 NumVertices,
uint32 StartIndex,
uint32 NumPrimitives,
uint32 NumInstances
)

  
Public function Virtual void

RHIDrawIndexedPrimitiveIndirect ( FRHIBuffer* IndexBuffer,
FRHIBuffer* ArgumentBuffer,
uint32 ArgumentOffset
)

  
Public function Virtual void

RHIDrawPrimitive ( uint32 BaseVertexIndex,
uint32 NumPrimitives,
uint32 NumInstances
)

  
Public function Virtual void

RHIDrawPrimitiveIndirect ( FRHIBuffer* ArgumentBuffer,
uint32 ArgumentOffset
)

  
Public function Virtual 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.
Public function Virtual void 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.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void 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.
Public function Virtual void  
Public function Virtual void 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.
Public function Virtual void

RHISetBlendFactor ( const FLinearColor& BlendFactor
)

  
Public function Virtual void

RHISetDepthBounds ( float MinDepth,
float MaxDepth
)

 Sets Depth Bounds range with the given min/max depth.
Public function Virtual void

RHISetGraphicsPipelineState ( FRHIGraphicsPipelineState* GraphicsState,
uint32 StencilRef,
bool bApplyAdditionalState
)

 This will set most relevant pipeline state.
Public function Virtual void

RHISetMultipleViewports ( uint32 Count,
const FViewportBounds* Data
)

 Useful when used with geometry shader (emit polygons to different viewports), otherwise SetViewPort() is simpler
Public function Virtual void

RHISetScissorRect ( bool bEnable,
uint32 MinX,
uint32 MinY,
uint32 MaxX,
uint32 MaxY
)

  
Public function Virtual void

RHISetShaderParameter ( FRHIGraphicsShader* Shader,
uint32 BufferIndex,
uint32 BaseIndex,
uint32 NumBytes,
const void* NewValue
)

  
Public function Virtual void

RHISetShaderParameters ( FRHIGraphicsShader* Shader,
TConstArrayView< uint8 > InParametersData,
TConstArrayView< FRHIShaderParameter > InParameters,
TConstArrayView< FRHIShaderParameterResource > InResourceParameters,
TConstArrayView< FRHIShaderParameterResource > InBindlessParameters
)

  
Public function Virtual void  
Public function Virtual void

RHISetShaderSampler ( FRHIGraphicsShader* Shader,
uint32 SamplerIndex,
FRHISamplerState* NewState
)

 Sets sampler state.
Public function Virtual void

RHISetShaderTexture ( FRHIGraphicsShader* Shader,
uint32 TextureIndex,
FRHITexture* NewTexture
)

 Set the shader resource view of a surface.
Public function Virtual void

RHISetShaderUnbinds ( FRHIGraphicsShader* Shader,
TConstArrayView< FRHIShaderParameterUnbind > InUnbinds
)

  
Public function Virtual void

RHISetShaderUniformBuffer ( FRHIGraphicsShader* Shader,
uint32 BufferIndex,
FRHIUniformBuffer* Buffer
)

  
Public function Virtual void

RHISetStencilRef ( uint32 StencilRef
)

  
Public function Virtual void

RHISetStreamSource ( uint32 StreamIndex,
FRHIBuffer* VertexBuffer,
uint32 Offset
)

  
Public function Virtual void

RHISetUAVParameter ( FRHIPixelShader* PixelShader,
uint32 UAVIndex,
FRHIUnorderedAccessView* UAV
)

 Sets a pixel shader UAV parameter.
Public function Virtual void

RHISetViewport ( float MinX,
float MinY,
float MinZ,
float MaxX,
float MaxY,
float MaxZ
)

  

Overridden from IRHIComputeContext

  Type Name Description
Public function Virtual void

RHIBeginTransitions ( TArrayView< const FRHITransition* > Transitions
)

  
Public function Virtual void

RHIClearUAVFloat ( FRHIUnorderedAccessView* UnorderedAccessViewRHI,
const FVector4f& Values
)

 Clears a UAV to the multi-channel floating point value provided.
Public function Virtual void

RHIClearUAVUint ( FRHIUnorderedAccessView* UnorderedAccessViewRHI,
const FUintVector4& Values
)

 Clears a UAV to the multi-component unsigned integer value provided.
Public function Virtual void

RHICopyToStagingBuffer ( FRHIBuffer* SourceBufferRHI,
FRHIStagingBuffer* DestinationStagingBufferRHI,
uint32 InOffset,
uint32 InNumBytes
)

 Inline copy.
Public function Virtual void

RHIDispatchComputeShader ( uint32 ThreadGroupCountX,
uint32 ThreadGroupCountY,
uint32 ThreadGroupCountZ
)

  
Public function Virtual void

RHIDispatchIndirectComputeShader ( FRHIBuffer* ArgumentBuffer,
uint32 ArgumentOffset
)

  
Public function Virtual void

RHIEndTransitions ( TArrayView< const FRHITransition* > Transitions
)

  
Public function Virtual void Some RHI implementations (OpenGL) cache render state internally Signal to RHI that cached state is no longer valid
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

RHIPushEvent ( const TCHAR* Name,
FColor Color
)

  
Public function Virtual void

RHISetShaderParameter ( FRHIComputeShader* ComputeShader,
uint32 BufferIndex,
uint32 BaseIndex,
uint32 NumBytes,
const void* NewValue
)

  
Public function Virtual void

RHISetShaderParameters ( FRHIComputeShader* Shader,
TConstArrayView< uint8 > InParametersData,
TConstArrayView< FRHIShaderParameter > InParameters,
TConstArrayView< FRHIShaderParameterResource > InResourceParameters,
TConstArrayView< FRHIShaderParameterResource > InBindlessParameters
)

  
Public function Virtual void

RHISetShaderResourceViewParameter ( FRHIComputeShader* ComputeShader,
uint32 SamplerIndex,
FRHIShaderResourceView* SRV
)

  
Public function Virtual void

RHISetShaderSampler ( FRHIComputeShader* ComputeShader,
uint32 SamplerIndex,
FRHISamplerState* NewState
)

 Sets sampler state.
Public function Virtual void

RHISetShaderTexture ( FRHIComputeShader* ComputeShader,
uint32 TextureIndex,
FRHITexture* NewTexture
)

 Set the shader resource view of a surface.
Public function Virtual void

RHISetShaderUnbinds ( FRHIComputeShader* Shader,
TConstArrayView< FRHIShaderParameterUnbind > InUnbinds
)

  
Public function Virtual void

RHISetShaderUniformBuffer ( FRHIComputeShader* ComputeShader,
uint32 BufferIndex,
FRHIUniformBuffer* Buffer
)

  
Public function Virtual void  
Public function Virtual void

RHISetUAVParameter ( FRHIComputeShader* ComputeShader,
uint32 UAVIndex,
FRHIUnorderedAccessView* UAV,
uint32 InitialCount
)

 Sets a compute shader counted UAV parameter and initial count
Public function Virtual void

RHISetUAVParameter ( FRHIComputeShader* ComputeShader,
uint32 UAVIndex,
FRHIUnorderedAccessView* UAV
)

 Sets a compute shader UAV parameter.
Public function Virtual void Submit the current command buffer to the GPU if possible.
Public function Virtual void Write the fence in the GPU timeline.

Classes

  Type Name Description
Public struct FTextureLockTracker    

Constants

Name Description
Singleton  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page