1. Epic GamesDeveloper
  3. IRHICommandContext

IRHICommandContext

The interface RHI command context.

API > API/Runtime > API/Runtime/RHI

Inheritance Hierarchy

References

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

Syntax

class IRHICommandContext : public IRHIComputeContext

Remarks

The interface RHI command context. Sometimes the RHI handles these. On platforms that can processes command lists in parallel, it is a separate object.

Variables

  Type Name Description
Protected variable FRHIRenderPassInfo RenderPassInfo  

Destructors

  Type Name Description
Public function Virtual    

Functions

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

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

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

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

  
Public function void

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

  
Public function Virtual void

RHIDiscardRenderTargets ( bool Depth,
bool Stencil,
uint32 ColorBitMask
)

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

RHIDispatchIndirectMeshShader ( FRHIBuffer* ArgumentBuffer,
uint32 ArgumentOffset
)

  
Public function Virtual void

RHIDispatchMeshShader ( uint32 ThreadGroupCountX,
uint32 ThreadGroupCountY,
uint32 ThreadGroupCountZ
)

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

RHIDrawPrimitive ( uint32 BaseVertexIndex,
uint32 NumPrimitives,
uint32 NumInstances
)

  
Public function void

RHIDrawPrimitiveIndirect ( FRHIBuffer* ArgumentBuffer,
uint32 ArgumentOffset
)

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

RHIMultiDrawIndexedPrimitiveIndirect ( FRHIBuffer* IndexBuffer,
FRHIBuffer* ArgumentBuffer,
uint32 ArgumentOffset,
FRHIBuffer* CountBuffer,
uint32 CountBuffeOffset,
uint32 MaxDrawArguments
)

 Similar to RHIDrawIndexedPrimitiveIndirect, but allows many draw arguments to be provided at once.
Public function Virtual void  
Public function Virtual void

RHIRayTraceDispatch ( FRHIRayTracingPipelineState* RayTracingPipelineState,
FRHIRayTracingShader* RayGenShader,
FRHIShaderBindingTable* SBT,
const FRayTracingShaderBindings& GlobalResourceBindings,
uint32 Width,
uint32 Height
)

  
Public function void

RHIRayTraceDispatch ( FRHIRayTracingPipelineState* RayTracingPipelineState,
FRHIRayTracingShader* RayGenShader,
FRHIRayTracingScene* Scene,
const FRayTracingShaderBindings& GlobalResourceBindings,
uint32 Width,
uint32 Height
)

  
Public function void

RHIRayTraceDispatchIndirect ( FRHIRayTracingPipelineState* RayTracingPipelineState,
FRHIRayTracingShader* RayGenShader,
FRHIRayTracingScene* Scene,
const FRayTracingShaderBindings& GlobalResourceBindings,
FRHIBuffer* ArgumentBuffer,
uint32 ArgumentOffset
)

  
Public function Virtual void

RHIRayTraceDispatchIndirect ( FRHIRayTracingPipelineState* RayTracingPipelineState,
FRHIRayTracingShader* RayGenShader,
FRHIShaderBindingTable* SBT,
const FRayTracingShaderBindings& GlobalResourceBindings,
FRHIBuffer* ArgumentBuffer,
uint32 ArgumentOffset
)

  
Public function Virtual void

RHIResummarizeHTile ( FRHITexture* DepthTexture
)

 Rebuilds the depth target HTILE meta data (on supported platforms).
Public function void  
Public function void  
Public function Virtual void  
Public function Virtual void

RHISetBlendFactor ( const FLinearColor& BlendFactor
)

  
Public function void

RHISetDepthBounds ( float MinDepth,
float MaxDepth
)

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

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

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

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

  
Public function void

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

  
Public function Virtual void

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

  
Public function Virtual void  
Public function Virtual void

RHISetStencilRef ( uint32 StencilRef
)

  
Public function Virtual void

RHISetStereoViewport ( float LeftMinX,
float RightMinX,
float LeftMinY,
float RightMinY,
float MinZ,
float LeftMaxX,
float RightMaxX,
float LeftMaxY,
float RightMaxY,
float MaxZ
)

  
Public function void

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

  
Public function void

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

  

Overridden from IRHIComputeContext

  Type Name Description
Public function Virtual Const ERHIPipeline  
Public function void

RHIDispatchComputeShader ( uint32 ThreadGroupCountX,
uint32 ThreadGroupCountY,
uint32 ThreadGroupCountZ
)

  
Public function void

RHIDispatchIndirectComputeShader ( FRHIBuffer* ArgumentBuffer,
uint32 ArgumentOffset
)

  
Public function Virtual void

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

 Inherit the parent context's RHISet functions that take FRHIComputeShader arguments Required to avoid warning C4263 : 'function' : member function does not override any base class virtual member function
Public function Virtual void

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

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page