1. Epic GamesDeveloper
  3. FRHICommandListBase

FRHICommandListBase

API > API/Runtime > API/Runtime/RHI

Inheritance Hierarchy

References

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

Syntax

class FRHICommandListBase

Variables

  Type Name Description
Protected variable FRHICommandListBase ActivatePipelineCommands  
Protected variable ERHIPipeline ActivePipelines The currently selected pipelines that RHI commands are directed to, during command list recording.
Protected variable ERHIPipeline AllowedPipelines Used to check for valid pipelines passed to ActivatePipeline().
Protected variable bool bAllowParallelTranslate  
Public variable bool bEmitBreadcrumbs  
Protected variable bool bExecuting  
Protected variable TSharedPtr< FRHIBreadcrumbAllocator > BreadcrumbAllocator  
Protected variable FRHIBreadcrumbAllocatorArray BreadcrumbAllocatorRefs  
Protected variable bool bUsesLockFence  
Protected variable bool bUsesSetTrackedAccess  
Protected variable bool bUsesShaderBundles  
Protected variable FRHICommandBase ** CommandLink  
Protected variable IRHIComputeContext * ComputeContext The active compute context into which (possibly async) compute commands are recorded.
Protected variable FRHIContextArray Contexts The RHI contexts available to the command list during execution.
Protected variable FRHICommandListBase CPUBreadcrumbState  
Public variable FRHIBreadcrumbNode * Current  
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 FRHIDrawStats DrawStats  
Public variable FActivatePipelineCommand * First  
Public variable friend FRHIBreadcrumbEventManual  
Public variable friend FRHIBreadcrumbEventScope  
Protected variable TRHIPipelineArray< FBreadcrumbState > GPUBreadcrumbState  
Protected variable IRHICommandContext * GraphicsContext The active context into which graphics commands are recorded.
Protected variable FRHICommandRHIThreadFence * LastLockFenceCommand  
Protected variable FMemStackBase MemManager  
Protected variable uint32 NumCommands  
Protected variable FRHICommandListBase::FPersistentState PersistentState  
Public variable FActivatePipelineCommand * Prev  
Protected variable FRHICommandBase * Root  
Protected variable FRHIBatchedShaderUnbinds ScratchShaderUnbinds  
Protected variable FShaderParameterState ShaderParameterState  
Public variable FRHIBreadcrumbList UnknownParentList  
Protected variable IRHIUploadContext * UploadContext The active upload context into which RHI specific commands are recorded.

Constructors

  Type Name Description
Public function   Move only.
Public function    
Protected function  

FRHICommandListBase ( FRHIGPUMask InGPUMask,
bool bInImmediate
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Adds a graph event as a dispatch dependency.
Public function T *

Alloc ()

  
Public function void *

Alloc ( int64 AllocSize,
int64 Alignment
)

  
Public function const TArrayView< T >

AllocArray ( TConstArrayView< T > InArray
)

  
Public function const TArrayView< T >  
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 void  
Public function void

BindDebugLabelName ( FRHIUnorderedAccessView* UnorderedAccessViewRHI,
const TCHAR* Name
)

  
Public function void

BindDebugLabelName ( FRHIBuffer* Buffer,
const TCHAR* Name
)

  
Public function void

BindDebugLabelName ( FRHITexture* Texture,
const TCHAR* Name
)

  
Public function Const bool

Bypass ()

  
Protected function void  
Public function FRayTracingAccelerationStructureSize  
Public function FRHIBatchedShaderParametersAllocator *  
Public function FBufferRHIRef

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

  
Public function FBufferRHIRef  
Public function FBufferRHIRef

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

  
Public function FRayTracingGeometryRHIRef  
Public function FShaderBindingTableRHIRef  
Public function FRHIResourceCollectionRef

CreateResourceCollection ( TConstArrayView< FRHIResourceCollectionMember > InMembers
)

  
Public function FShaderResourceViewRHIRef

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

  
Public function FShaderResourceViewRHIRef  
Public function FShaderResourceViewRHIRef  
Public function FShaderResourceViewRHIRef  
Public function FShaderResourceViewRHIRef  
Public function FShaderResourceViewRHIRef

CreateShaderResourceView ( FRHITexture* Texture,
uint8 MipLevel
)

  
Public function FShaderResourceViewRHIRef

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

  
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  
Public function FTextureRHIRef

CreateTexture ( const FRHITextureCreateDesc& CreateDesc
)

  
Public function FTextureReferenceRHIRef

CreateTextureReference ( FRHITexture* InReferencedTexture
)

  
Public function FUnorderedAccessViewRHIRef

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

  
Public function FUnorderedAccessViewRHIRef  
Public function FUnorderedAccessViewRHIRef  
Public function FUnorderedAccessViewRHIRef  
Public function FUnorderedAccessViewRHIRef

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

  
Public function FUnorderedAccessViewRHIRef

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

  
Public function FBufferRHIRef  
Public function FBufferRHIRef

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

  
Public function void

EnqueueLambda ( LAMBDA&& Lambda
)

  
Public function void

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

  
Public function void

EnqueueLambdaMultiPipe ( ERHIPipeline Pipelines,
EThreadFence ThreadFence,
const TCHAR* LambdaName,
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 FRHIBreadcrumbNode *&  
Public function Const FRHIGPUMask  
Public function Const ERHIPipeline  
Public function TStaticArray< void *, 1 > &  
Public function FRHIBatchedShaderParameters &  
Public function FRHIBatchedShaderUnbinds &  
Public function IRHIUploadContext &  
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 Const bool  
Public function void *

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

  
Public function void *

LockBufferMGPU ( FRHIBuffer* Buffer,
uint32 GPUIndex,
uint32 Offset,
uint32 SizeRHI,
EResourceLockMode LockMode
)

 LockBufferMGPU / UnlockBufferMGPU may ONLY be called for buffers with the EBufferUsageFlags::MultiGPUAllocate flag set! And buffers with that flag set may not call the regular (single GPU) LockBuffer / UnlockBuffer.
Public function Const bool Returns true if the RHI needs unbind commands.
Public function void  
Protected function void

ResetSubpass ( ESubpassHint SubpassHint
)

  
Public function FGraphEventRef

RHIThreadFence ( bool bSetLockFence
)

  
Public function void  
Public function void  
Public function void

Stats_AddDrawAndPrimitives ( EPrimitiveType PrimitiveType,
uint32 NumPrimitives
)

  
Public function ERHIPipeline  
Public function void

UnlockBuffer ( FRHIBuffer* Buffer
)

  
Public function void

UnlockBufferMGPU ( FRHIBuffer* Buffer,
uint32 GPUIndex
)

  
Public function void

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

  
Public function void

UpdateStreamSourceSlot ( FRHIStreamSourceSlot* StreamSourceSlotRHI,
FRHIBuffer* BufferRHI
)

  
Public function void

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

  
Public function void

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

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

Classes

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

Enums

  Type Name Description
Public enum EThreadFence    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page