1. Epic GamesDeveloper
  3. FRHICommandListImmediate

FRHICommandListImmediate

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 FRHICommandListImmediate : public FRHICommandList

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors are accessible with public or protected access.

Functions

  Type Name Description
Public function void  
Public function FTexture2DRHIRef

AsyncReallocateTexture2D ( FRHITexture2D* Texture2D,
int32 NewMipCount,
int32 NewSizeX,
int32 NewSizeY,
FThreadSafeCounter* RequestStatus
)

  
Public function void

BeginDrawingViewport ( FRHIViewport* Viewport,
FRHITexture* RenderTargetRHI
)

  
Public function void  
Public function void  
Public function FUpdateTexture3DData

BeginUpdateTexture3D ( FRHITexture3D* Texture,
uint32 MipIndex,
const FUpdateTextureRegion3D& UpdateRegion
)

  
Public function void  
Public function ETextureReallocationStatus

CancelAsyncReallocateTexture2D ( FRHITexture2D* Texture2D,
bool bBlockUntilCompleted
)

  
Public function Static void Global graph events must be destroyed explicitly to avoid undefined order of static destruction, as they can be destroyed after their allocator.
Public function void

CopyBuffer ( FRHIBuffer* SourceBuffer,
FRHIBuffer* DestBuffer
)

  
Public function void

EndDrawingViewport ( FRHIViewport* Viewport,
bool bPresent,
bool bLockToVsync
)

  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void

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

  
Public function void

EnqueueLambda ( LAMBDA&& Lambda
)

  
Public function ETextureReallocationStatus

FinalizeAsyncReallocateTexture2D ( FRHITexture2D* Texture2D,
bool bBlockUntilCompleted
)

  
Public function int32  
Public function void  
Public function void

GenerateMips ( FRHITexture* Texture
)

  
Public function Static FRHICommandListImmediate &

Get ( FRHICommandListBase& RHICmdList
)

  
Public function Static FRHICommandListImmediate &

Get ()

  
Public function uint32  
Public function void *  
Public function void *  
Public function void *  
Public function void *  
Public function void *  
Public function void *  
Public function Static FGraphEventArray &  
Public function bool

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

  
Public function void Dispatches work to the RHI thread and the GPU.
Public function void  
Public function bool  
Public function Static bool  
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 void *

LockStagingBuffer ( FRHIStagingBuffer* StagingBuffer,
FRHIGPUFence* Fence,
uint32 Offset,
uint32 SizeRHI
)

  
Public function void *

LockTexture2D ( FRHITexture2D* Texture,
uint32 MipIndex,
EResourceLockMode LockMode,
uint32& DestStride,
bool bLockWithinMiptail,
bool bFlushRHIThread,
uint64* OutLockedByteCount
)

  
Public function void *

LockTexture2DArray ( FRHITexture2DArray* Texture,
uint32 TextureIndex,
uint32 MipIndex,
EResourceLockMode LockMode,
uint32& DestStride,
bool bLockWithinMiptail
)

  
Public function void *

LockTextureCubeFace ( FRHITexture* Texture,
uint32 FaceIndex,
uint32 ArrayIndex,
uint32 MipIndex,
EResourceLockMode LockMode,
uint32& DestStride,
bool bLockWithinMiptail
)

  
Public function void

MapStagingSurface ( FRHITexture* Texture,
void*& OutData,
int32& OutWidth,
int32& OutHeight,
uint32 GPUIndex
)

  
Public function void

MapStagingSurface ( FRHITexture* Texture,
FRHIGPUFence* Fence,
void*& OutData,
int32& OutWidth,
int32& OutHeight,
uint32 GPUIndex
)

  
Public function void  
Public function void

QueueAsyncCommandListSubmit ( TArrayView< FQueuedCommandList > CommandLists,
ETranslatePriority ParallelTranslatePriority,
int32 MinDrawsPerTranslate
)

 Chains together one or more RHI command lists into the immediate command list, allowing in-order submission of parallel rendering work.
Public function void

QueueAsyncCommandListSubmit ( FQueuedCommandList QueuedCommandList,
ETranslatePriority ParallelTranslatePriority,
int32 MinDrawsPerTranslate
)

  
Public function void  
Public function void

ReadSurfaceData ( FRHITexture* Texture,
FIntRect Rect,
TArray< FColor >& OutData,
FReadSurfaceDataFlags InFlags
)

 ReadSurfaceFloatData reads texture data into FColor pixels in other formats are converted to FColor
Public function void ReadSurfaceFloatData reads texture data into FLinearColor pixels in other formats are converted to FLinearColor reading from float surfaces remaps the values into an interpolation of their {min,max} ; use RCM_MinMax to prevent that
Public function void

ReadSurfaceFloatData ( FRHITexture* Texture,
FIntRect Rect,
TArray< FFloat16Color >& OutData,
ECubeFace CubeFace,
int32 ArrayIndex,
int32 MipIndex
)

 ReadSurfaceFloatData reads texture data into FFloat16Color it only works if Texture is exactly PF_FloatRGBA (RGBA16F) ! no conversion is done
Public function void  
Public function void  
Public function bool  
Public function void  
Public function void  
Public function void  
Public function void

Transition ( TArrayView< const FRHITransitionInfo > Infos,
ERHIPipeline SrcPipelines,
ERHIPipeline DstPipelines
)

 Performs an immediate transition with the option of broadcasting to multiple pipelines.
Public function void

Transition ( const FRHITransitionInfo& Info
)

  
Public function void

UnlockBufferMGPU ( FRHIBuffer* Buffer,
uint32 GPUIndex
)

  
Public function void  
Public function void

UnlockTexture2D ( FRHITexture2D* Texture,
uint32 MipIndex,
bool bLockWithinMiptail,
bool bFlushRHIThread
)

  
Public function void

UnlockTexture2DArray ( FRHITexture2DArray* Texture,
uint32 TextureIndex,
uint32 MipIndex,
bool bLockWithinMiptail
)

  
Public function void

UnlockTextureCubeFace ( FRHITexture* Texture,
uint32 FaceIndex,
uint32 ArrayIndex,
uint32 MipIndex,
bool bLockWithinMiptail
)

  
Public function void

UnmapStagingSurface ( FRHITexture* Texture,
uint32 GPUIndex
)

  
Public function void  
Public function void

UpdateRHIResources ( FRHIResourceUpdateInfo* UpdateInfos,
int32 Num,
bool bNeedReleaseRefs
)

  
Public function void  
Public function void  

Classes

  Type Name Description
Public struct FQueuedCommandList    

Enums

  Type Name Description
Public enum ETranslatePriority    

Constants

Name Description
FrameDrawStats  
RHIThreadTask  
WaitOutstandingTasks  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page