1. Epic GamesDeveloper
  3. FRHICommandListBase

FRHICommandListBase

Unreal Engine C++ API Reference > Runtime > RHI

Inheritance Hierarchy

References

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

Syntax

class FRHICommandListBase : public FNoncopyable

Variables

  Type Name Description
Protected variable ERHIPipeline ActivePipeline The currently selected pipeline that RHI commands are directed to, during command list recording.
Protected variable ERHIPipeline AllowedPipelines Used to check for valid pipelines passed to SwitchPipeline().
Protected variable bool bExecuting  
Protected variable FRHICommandBase ** CommandLink  
Protected variable IRHIComputeContext * ComputeContext The active compute context into which (possibly async) compute commands are recorded.
Protected variable TRHIPipelineArray< IRHIComputeContext * > Contexts The RHI contexts available to the command list during execution.
Protected variable FGraphEventRef DispatchEvent Graph event used to gate the execution of the command list on the completion of any dependent tasks e.g. PSO async compilation and parallel RHICmdList recording tasks.
Protected variable TStatId ExecuteStat  
Protected variable IRHICommandContext * GraphicsContext The active context into which graphics commands are recorded.
Protected variable FMemStackBase MemManager  
Protected variable uint32 NumCommands  
Protected variable FRHICommandListBase::FPersistentState PersistentState  
Public variable TStaticArray< void *, 1 > QueryBatchData  
Protected variable FRHICommandBase * Root  
Protected variable FRHIBatchedShaderParameters ScratchShaderParameters  
Protected variable FRHIBatchedShaderUnbinds ScratchShaderUnbinds  
Protected variable uint32 UID  

Constructors

  Type Name Description
Public function    
Protected function  

FRHICommandListBase ( FRHIGPUMask InGPUMask,
ERecordingThread InRecordingThread
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddDispatchPrerequisite ( const FGraphEventRef& Prereq
)

 Adds a graph event as a dispatch dependency.
Public function void *

Alloc ()

  
Public function void *

Alloc ( int64 AllocSize,
int64 Alignment
)

  
Public function const TArrayView< T >

AllocArray ( const TArrayView< T > InArray
)

  
Public function const TArrayView< T >

AllocArrayUninitialized ( uint32 Num
)

  
Public function void *

AllocCommand ( int32 AllocSize,
int32 Alignment
)

  
Public function void *  
Public function void *

AllocCopy ( const void* InSourceData,
int64 AllocSize,
int64 Alignment
)

  
Public function TCHAR *

AllocString ( const TCHAR* Name
)

  
Public function Const bool  
Public function Const bool

Bypass ()

  
Protected function void  
Public function FBufferRHIRef

CreateBuffer ( uint32 Size,
EBufferUsageFlags Usage,
uint32 Stride,
ERHIAccess ResourceState,
FRHIResourceCreateInfo& CreateInfo
)

  
Public function FBufferRHIRef

CreateIndexBuffer ( uint32 Stride,
uint32 Size,
EBufferUsageFlags Usage,
FRHIResourceCreateInfo& CreateInfo
)

  
Public function FBufferRHIRef

CreateIndexBuffer ( uint32 Stride,
uint32 Size,
EBufferUsageFlags Usage,
ERHIAccess ResourceState,
FRHIResourceCreateInfo& CreateInfo
)

  
Public function FShaderResourceViewRHIRef  
Public function FShaderResourceViewRHIRef  
Public function FShaderResourceViewRHIRef  
Public function FBufferRHIRef

CreateStructuredBuffer ( uint32 Stride,
uint32 Size,
EBufferUsageFlags Usage,
ERHIAccess ResourceState,
FRHIResourceCreateInfo& CreateInfo
)

  
Public function FBufferRHIRef

CreateStructuredBuffer ( uint32 Stride,
uint32 Size,
EBufferUsageFlags Usage,
FRHIResourceCreateInfo& CreateInfo
)

  
Public function FUnorderedAccessViewRHIRef  
Public function FUnorderedAccessViewRHIRef  
Public function FBufferRHIRef

CreateVertexBuffer ( uint32 Size,
EBufferUsageFlags Usage,
ERHIAccess ResourceState,
FRHIResourceCreateInfo& CreateInfo
)

  
Public function FBufferRHIRef

CreateVertexBuffer ( uint32 Size,
EBufferUsageFlags Usage,
FRHIResourceCreateInfo& CreateInfo
)

  
Public function void

EnqueueLambda ( const TCHAR* LambdaName,
LAMBDA&& Lambda
)

  
Public function void

EnqueueLambda ( LAMBDA&& Lambda
)

  
Public function void Marks the RHI command list as completed, allowing it to be dispatched to the RHI / parallel translate threads.
Protected function FMemStackBase &  
Public function FRHICommandListImmediate &  
Public function IRHIComputeContext &  
Public function IRHICommandContext &  
Public function Const FRHIGPUMask  
Public function Const ERHIPipeline  
Public function FRHIBatchedShaderParameters &  
Public function FRHIBatchedShaderUnbinds &  
Public function Const uint32

GetUID ()

  
Public function Const const int32  
Public function Const bool  
Protected function void  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void *

LockBuffer ( FRHIBuffer* Buffer,
uint32 Offset,
uint32 SizeRHI,
EResourceLockMode LockMode
)

  
Protected function void

ResetSubpass ( ESubpassHint SubpassHint
)

  
Public function FGraphEventRef

RHIThreadFence ( bool bSetLockFence
)

  
Public function void  
Public function void  
Public function ERHIPipeline

SwitchPipeline ( ERHIPipeline Pipeline
)

  
Public function void

UnlockBuffer ( FRHIBuffer* Buffer
)

  
Public function void

UpdateFromBufferTexture2D ( FRHITexture2D* Texture,
uint32 MipIndex,
const FUpdateTextureRegion2D& UpdateRegion,
uint32 SourcePitch,
FRHIBuffer* Buffer,
uint32 BufferOffset
)

  
Public function void

UpdateTexture2D ( FRHITexture2D* Texture,
uint32 MipIndex,
const FUpdateTextureRegion2D& UpdateRegion,
uint32 SourcePitch,
const uint8* SourceData
)

  
Public function void

UpdateTexture3D ( FRHITexture3D* Texture,
uint32 MipIndex,
const FUpdateTextureRegion3D& UpdateRegion,
uint32 SourceRowPitch,
uint32 SourceDepthPitch,
const uint8* SourceData
)

  
Public function void

UpdateUniformBuffer ( FRHIUniformBuffer* UniformBufferRHI,
const void* Contents
)

  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void Blocks the calling thread until the dispatch event is completed.

Classes

  Type Name Description
Protected struct FPersistentState The values in this struct are preserved when the command list is moved or reset.  

Enums

  Type Name Description
Public enum ERecordingThread    

Deprecated Functions

  Type Name Description
Public function FShaderResourceViewRHIRef

CreateShaderResourceView ( FRHITexture* Texture,
uint8 MipLevel,
uint8 NumMipLevels,
EPixelFormat Format
)

 Use the CreateShaderResourceView function that takes an FRHIViewDesc.
Public function FShaderResourceViewRHIRef

CreateShaderResourceView ( FRHIBuffer* Buffer,
uint32 Stride,
uint8 Format
)

 Use the CreateShaderResourceView function that takes an FRHIViewDesc.
Public function FShaderResourceViewRHIRef

CreateShaderResourceView ( FRHITexture* Texture,
uint8 MipLevel
)

 Use the CreateShaderResourceView function that takes an FRHIViewDesc.
Public function FShaderResourceViewRHIRef Use the CreateShaderResourceView function that takes an FRHIViewDesc.
Public function FShaderResourceViewRHIRef Use the CreateShaderResourceView function that takes an FRHIViewDesc.
Public function FShaderResourceViewRHIRef

CreateShaderResourceViewFMask ( FRHITexture2D* Texture2DRHI
)

 Use the CreateShaderResourceView function that takes an FRHIViewDesc.
Public function FShaderResourceViewRHIRef

CreateShaderResourceViewWriteMask ( FRHITexture2D* Texture2DRHI
)

 Use the CreateShaderResourceView function that takes an FRHIViewDesc.
Public function FUnorderedAccessViewRHIRef

CreateUnorderedAccessView ( FRHIBuffer* Buffer,
uint8 Format
)

 Use the CreateUnorderedAccessView function that takes an FRHIViewDesc.
Public function FUnorderedAccessViewRHIRef

CreateUnorderedAccessView ( FRHIBuffer* Buffer,
bool bUseUAVCounter,
bool bAppendBuffer
)

 Use the CreateUnorderedAccessView function that takes an FRHIViewDesc.
Public function FUnorderedAccessViewRHIRef

CreateUnorderedAccessView ( FRHITexture* Texture,
uint32 MipLevel,
uint16 FirstArraySlice,
uint16 NumArraySlices
)

 Use the CreateUnorderedAccessView function that takes an FRHIViewDesc.
Public function FUnorderedAccessViewRHIRef

CreateUnorderedAccessView ( FRHITexture* Texture,
uint32 MipLevel,
uint8 Format,
uint16 FirstArraySlice,
uint16 NumArraySlices
)

 Use the CreateUnorderedAccessView function that takes an FRHIViewDesc.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page