1. Epic GamesDeveloper
  3. FRHICommandListImmediate

FRHICommandListImmediate

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 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 ( LAMBDA&& Lambda
)

  
Public function void

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

  
Public function ETextureReallocationStatus

FinalizeAsyncReallocateTexture2D ( FRHITexture2D* Texture2D,
bool bBlockUntilCompleted
)

  
Public function int32  
Public function void  
Public function Static FRHICommandListImmediate &

Get ()

  
Public function Static FRHICommandListImmediate &

Get ( FRHICommandListBase& RHICmdList
)

  
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,
FRHIGPUFence* Fence,
void*& OutData,
int32& OutWidth,
int32& OutHeight,
uint32 GPUIndex
)

  
Public function void

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

  
Public function void  
Public function void

QueueAsyncCommandListSubmit ( FQueuedCommandList QueuedCommandList,
ETranslatePriority ParallelTranslatePriority,
int32 MinDrawsPerTranslate
)

  
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

Read3DSurfaceFloatData ( FRHITexture* Texture,
FIntRect Rect,
FIntPoint ZMinMax,
TArray< FFloat16Color >& OutData,
FReadSurfaceDataFlags Flags
)

  
Public function void

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

  
Public function void

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

  
Public function void

ReadSurfaceFloatData ( FRHITexture* Texture,
FIntRect Rect,
TArray< FFloat16Color >& OutData,
FReadSurfaceDataFlags Flags
)

  
Public function void

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

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

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

VirtualTextureSetFirstMipInMemory ( FRHITexture2D* Texture,
uint32 FirstMip
)

  
Public function void

VirtualTextureSetFirstMipVisible ( FRHITexture2D* Texture,
uint32 FirstMip
)

  

Classes

  Type Name Description
Public struct FQueuedCommandList    

Enums

  Type Name Description
Public enum ETranslatePriority    

Constants

Name Description
FrameDrawStats  
RHIThreadTask  
WaitOutstandingTasks  

Deprecated Functions

  Type Name Description
Public function void Use the global scope RHIAdvanceFrameForGetViewportBackBuffer function.
Public function void

BindDebugLabelName ( FRHIUnorderedAccessView* UnorderedAccessViewRHI,
const TCHAR* Name
)

 Use the global scope RHIBindDebugLabelName function.
Public function void

BindDebugLabelName ( FRHITexture* Texture,
const TCHAR* Name
)

 Use the global scope RHIBindDebugLabelName function.
Public function uint32

ComputeMemorySize ( FRHITexture* TextureRHI
)

 Use the global scope RHIComputeMemorySize function.
Public function void

CopySharedMips ( FRHITexture* DestTexture,
FRHITexture* SrcTexture
)

 CopySharedMips should be replaced with UE::RHI::CopySharedMips(). ** Note ** The argument ordering of the new function has changed. The new function also does not issue RHI transitions, so the caller is responsible for ensuring src/dst textures are in CopySrc/CopyDest state.
Public function FAmplificationShaderRHIRef

CreateAmplificationShader ( TArrayView< const uint8 > Code,
const FSHAHash& Hash
)

 Use the global scope RHICreateAmplificationShader function.
Public function FBlendStateRHIRef Use the global scope RHICreateBlendState function.
Public function FBoundShaderStateRHIRef

CreateBoundShaderState ( FRHIVertexDeclaration* VertexDeclaration,
FRHIVertexShader* VertexShader,
FRHIPixelShader* PixelShader,
FRHIGeometryShader* GeometryShader
)

 Use the global scope RHICreateBoundShaderState function.
Public function FComputeFenceRHIRef

CreateComputeFence ( const FName& Name
)

 Compute fences are deprecated. Use RHI transitions instead.
Public function FComputePipelineStateRHIRef Use the global scope RHICreateComputePipelineState function.
Public function FComputeShaderRHIRef

CreateComputeShader ( TArrayView< const uint8 > Code,
const FSHAHash& Hash
)

 Use the global scope RHICreateComputeShader function.
Public function FDepthStencilStateRHIRef Use the global scope RHICreateDepthStencilState function.
Public function FGeometryShaderRHIRef

CreateGeometryShader ( TArrayView< const uint8 > Code,
const FSHAHash& Hash
)

 Use the global scope RHICreateGeometryShader function.
Public function FGPUFenceRHIRef

CreateGPUFence ( const FName& Name
)

 Use the global scope RHICreateGPUFence function.
Public function FGraphicsPipelineStateRHIRef Use the global scope RHICreateGraphicsPipelineState function.
Public function FMeshShaderRHIRef

CreateMeshShader ( TArrayView< const uint8 > Code,
const FSHAHash& Hash
)

 Use the global scope RHICreateMeshShader function.
Public function FPixelShaderRHIRef

CreatePixelShader ( TArrayView< const uint8 > Code,
const FSHAHash& Hash
)

 Use the global scope RHICreatePixelShader function.
Public function FRasterizerStateRHIRef Use the global scope RHICreateRasterizerState function.
Public function FSamplerStateRHIRef Use the global scope RHICreateSamplerState function.
Public function FStagingBufferRHIRef Use the global scope RHICreateStagingBuffer function.
Public function FUniformBufferRHIRef

CreateUniformBuffer ( const void* Contents,
const FRHIUniformBufferLayout* Layout,
EUniformBufferUsage Usage
)

 Use the global scope RHICreateUniformBuffer function.
Public function FVertexShaderRHIRef

CreateVertexShader ( TArrayView< const uint8 > Code,
const FSHAHash& Hash
)

 Use the global scope RHICreateVertexShader function.
Public function FViewportRHIRef

CreateViewport ( void* WindowHandle,
uint32 SizeX,
uint32 SizeY,
bool bIsFullscreen,
EPixelFormat PreferredPixelFormat
)

 Use the global scope RHICreateViewport function.
Public function void

GenerateMips ( FRHITexture* Texture
)

 This function is deprecated and will be removed in future releases. Renderer version implemented.
Public function bool

GetAvailableResolutions ( FScreenResolutionArray& Resolutions,
bool bIgnoreRefreshRate
)

 Use the global scope RHIGetAvailableResolutions function.
Public function IRHICommandContext * Use the global scope RHIGetDefaultContext function.
Public function bool

GetRenderQueryResult ( FRHIRenderQuery* RenderQuery,
uint64& OutResult,
bool bWait,
uint32 GPUIndex
)

 Use the global scope RHIGetRenderQueryResult function.
Public function void

GetSupportedResolution ( uint32& Width,
uint32& Height
)

 Use the global scope RHIGetSupportedResolution function.
Public function void Use the global scope RHIGetTextureMemoryStats function.
Public function FTexture2DRHIRef Use the global scope RHIGetViewportBackBuffer function.
Public function uint32 Use the global scope RHIGetViewportNextPresentGPUIndex function.
Public function void

ResizeViewport ( FRHIViewport* Viewport,
uint32 SizeX,
uint32 SizeY,
bool bIsFullscreen,
EPixelFormat PreferredPixelFormat
)

 Use the global scope RHIResizeViewport function.
Public function void Use the global scope RHIResumeRendering function.
Public function void SubmitCommandsHint is deprecated. Consider calling ImmediateFlush(EImmediateFlushType::DispatchToRHIThread) instead.
Public function void Use the global scope RHISuspendRendering function.
Public function void

Tick ( float DeltaTime
)

 Use the global scope RHITick function.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page