FRHICommandList

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

RHI

Header

/Engine/Source/Runtime/RHI/Public/RHICommandList.h

Include

#include "RHICommandList.h"

Syntax

class FRHICommandList : public FRHIComputeCommandList

Constructors

Name Description

Public function

FRHICommandList

(
    FRHIGPUMask GPUMask
)

Functions

Name Description

Public function

void

 

ApplyCachedRenderTargets

(
    FGraphicsPipelineStateInitializer&...
)

Public function

void

 

BeginDrawingViewport

(
    FRHIViewport* Viewport,
    FRHITexture* RenderTargetRHI
)

Public function

void

 

BeginFrame()

Public function

void

 

BeginRenderPass

(
    const FRHIRenderPassInfo& InInfo,
    const TCHAR* Name
)

Public function

void

 

BeginRenderQuery

(
    FRHIRenderQuery* RenderQuery
)

Public function

void

 

BeginScene()

These 6 are special in that they must be called on the immediate command list and they force a flush only when we are not doing RHI thread.

Public function

void

 

BeginUpdateMultiFrameResource

(
    FRHIUnorderedAccessView* UAV
)

Public function

void

 

BeginUpdateMultiFrameResource

(
    FRHITexture* Texture
)

Public function

void

 

CalibrateTimers

(
    FRHITimestampCalibrationQuery*...
)

Public function

void

 

CopyBufferRegion

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

Public function

void

 

CopyTexture

(
    FRHITexture* SourceTextureRHI,
    FRHITexture* DestTextureRHI,
    const FRHICopyTextureInfo& CopyInf...
)

Public function

void

 

CopyToResolveTarget

(
    FRHITexture* SourceTextureRHI,
    FRHITexture* DestTextureRHI,
    const FResolveParams& ResolveParam...
)

Public function

void

 

DiscardRenderTargets

(
    bool Depth,
    bool Stencil,
    uint32 ColorBitMask
)

Public function

void

 

DispatchIndirectMeshShader

(
    FRHIBuffer* ArgumentBuffer,
    uint32 ArgumentOffset
)

Public function

void

 

DispatchMeshShader

(
    uint32 ThreadGroupCountX,
    uint32 ThreadGroupCountY,
    uint32 ThreadGroupCountZ
)

Public function

void

 

DrawIndexedIndirect

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

Public function

void

 

DrawIndexedPrimitive

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

Public function

void

 

DrawIndexedPrimitiveIndirect

(
    FRHIBuffer* IndexBuffer,
    FRHIBuffer* ArgumentsBuffer,
    uint32 ArgumentOffset
)

Public function

void

 

DrawPrimitive

(
    uint32 BaseVertexIndex,
    uint32 NumPrimitives,
    uint32 NumInstances
)

Public function

void

 

DrawPrimitiveIndirect

(
    FRHIBuffer* ArgumentBuffer,
    uint32 ArgumentOffset
)

Public function

void

 

EndDrawingViewport

(
    FRHIViewport* Viewport,
    bool bPresent,
    bool bLockToVsync
)

Public function

void

 

EndFrame()

Public function

void

 

EndRenderPass()

Public function

void

 

EndRenderQuery

(
    FRHIRenderQuery* RenderQuery
)

Public function

void

 

EndScene()

Public function

void

 

EndUpdateMultiFrameResource

(
    FRHIUnorderedAccessView* UAV
)

Public function

void

 

EndUpdateMultiFrameResource

(
    FRHITexture* Texture
)

Public function

void

 

EnqueueLambda

(
    LAMBDA&& Lambda
)

Public function Const

FRHIAmplific...

 

GetBoundAmplificationShader()

Public function Const

FRHIGeometry...

 

GetBoundGeometryShader()

Public function Const

FRHIMeshShad...

 

GetBoundMeshShader()

Public function Const

FRHIPixelSha...

 

GetBoundPixelShader()

Public function Const

FRHIVertexSh...

 

GetBoundVertexShader()

Public function

void

 

NextSubpass()

Public function

void

 

PollOcclusionQueries()

Public function

void

 

ResummarizeHTile

(
    FRHITexture2D* DepthTexture
)

Public function

void

 

RHIInvalidateCachedState()

Public function

void

 

SetBlendFactor

(
    const FLinearColor& BlendFactor
)

Public function

void

 

SetDepthBounds

(
    float MinDepth,
    float MaxDepth
)

Public function

void

 

SetGraphicsPipelineState

(
    FGraphicsPipelineState* Graphi...,
    const FBoundShaderStateInput& Shad...,
    uint32 StencilRef,
    bool bApplyAdditionalState
)

Public function

void

 

SetScissorRect

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

Public function

void

 

SetShaderParameter

(
    const TRefCountPtr< TShaderRHI >& ...,
    uint32 BufferIndex,
    uint32 BaseIndex,
    uint32 NumBytes,
    const void* NewValue
)

Public function

void

 

SetShaderParameter

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

Public function

void

 

SetShaderResourceViewParameter

(
    const TRefCountPtr< TShaderRHI >& ...,
    uint32 SamplerIndex,
    FRHIShaderResourceView* SRV
)

Public function

void

 

SetShaderResourceViewParameter

(
    FRHIGraphicsShader* Shader,
    uint32 SamplerIndex,
    FRHIShaderResourceView* SRV
)

Public function

void

 

SetShaderSampler

(
    const TRefCountPtr< TShaderRHI >& ...,
    uint32 SamplerIndex,
    FRHISamplerState* State
)

Public function

void

 

SetShaderSampler

(
    FRHIGraphicsShader* Shader,
    uint32 SamplerIndex,
    FRHISamplerState* State
)

Public function

void

 

SetShaderTexture

(
    const TRefCountPtr< TShaderRHI >& ...,
    uint32 TextureIndex,
    FRHITexture* Texture
)

Public function

void

 

SetShaderTexture

(
    FRHIGraphicsShader* Shader,
    uint32 TextureIndex,
    FRHITexture* Texture
)

Public function

void

 

SetShaderUniformBuffer

(
    FRHIGraphicsShader* Shader,
    uint32 BaseIndex,
    FRHIUniformBuffer* UniformBuff...
)

Public function

void

 

SetShaderUniformBuffer

(
    const TRefCountPtr< TShaderRHI >& ...,
    uint32 BaseIndex,
    FRHIUniformBuffer* UniformBuff...
)

Public function

void

 

SetShadingRate

(
    EVRSShadingRate ShadingRate,
    EVRSRateCombiner Combiner
)

Public function

void

 

SetStencilRef

(
    uint32 StencilRef
)

Public function

void

 

SetStereoViewport

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

Public function

void

 

SetStreamSource

(
    uint32 StreamIndex,
    FRHIBuffer* VertexBuffer,
    uint32 Offset
)

Public function

void

 

SetUAVParameter

(
    FRHIPixelShader* Shader,
    uint32 UAVIndex,
    FRHIUnorderedAccessView* UAV
)

Public function

void

 

SetUAVParameter

(
    const TRefCountPtr< FRHIPixelShader...,
    uint32 UAVIndex,
    FRHIUnorderedAccessView* UAV
)

Public function

void

 

SetViewport

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

Public function

void

 

TransitionResource

(
    FExclusiveDepthStencil DepthStencil...,
    FRHITexture* DepthTexture
)

Operators

Name Description

Public function

void

 

operator delete

(
    void* RawMemory
)

Public function

void *

 

operator new

(
    size_t Size
)

Custom new/delete with recycling

Deprecated Functions

Name Description

Public function

void

 

ClearTinyUAV

(
    FRHIUnorderedAccessView* Unord...,
    const uint32 Values
)

RHIClearTinyUAV is deprecated. Use RHIClearUAVUint or RHIClearUAVFloat instead.

Public function

void

 

SetGraphicsPipelineState

(
    FGraphicsPipelineState* Graphi...,
    const FBoundShaderStateInput& Shad...,
    bool bApplyAdditionalState
)

SetGraphicsPipelineState now requires a StencilRef argument