FRHICommandListImmediate

Inheritance Hierarchy

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

Name Description

Public function

void

 

AcquireThreadOwnership()

Public function

void

 

AcquireTransientResource_RenderThread

(
    FStructuredBufferRHIParamRef Buffer
)

Public function

void

 

AcquireTransientResource_RenderThread

(
    FVertexBufferRHIParamRef Buffer
)

Public function

void

 

AcquireTransientResource_RenderThread

(
    FTextureRHIParamRef Texture
)

Public function

void

 

AdvanceFrameForGetViewportBackBuffer

(
    FViewportRHIParamRef Viewport
)

Public function Static

bool

 

AnyRenderThreadTasksOutstanding()

Public function

FTexture2DRH ...

 

AsyncCreateTexture2D

(
    uint32 SizeX,
    uint32 SizeY,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    void** InitialMipData,
    uint32 NumInitialMips
)

Public function

FTexture2DRH ...

 

AsyncReallocateTexture2D

(
    FTexture2DRHIParamRef Texture2D,
    int32 NewMipCount,
    int32 NewSizeX,
    int32 NewSizeY,
    FThreadSafeCounter * RequestSta...
)

Public function

FUpdateTextu ...

 

BeginUpdateTexture3D

(
    FTexture3DRHIParamRef Texture,
    uint32 MipIndex,
    const FUpdateTextureRegion3D & Upda...
)

Public function

void

 

BindDebugLabelName

(
    FTextureRHIParamRef Texture,
    const TCHAR * Name
)

Public function

void

 

BindDebugLabelName

(
    FUnorderedAccessViewRHIParamRef Uno...,
    const TCHAR * Name
)

Public function

void

 

BlockUntilGPUIdle()

Public function

uint64

 

CalcTexture2DPlatformSize

(
    uint32 SizeX,
    uint32 SizeY,
    uint8 Format,
    uint32 NumMips,
    uint32 NumSamples,
    uint32 Flags,
    uint32 & OutAlign
)

Public function

uint64

 

CalcTexture3DPlatformSize

(
    uint32 SizeX,
    uint32 SizeY,
    uint32 SizeZ,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    uint32 & OutAlign
)

Public function

uint64

 

CalcTextureCubePlatformSize

(
    uint32 Size,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    uint32 & OutAlign
)

Public function

ETextureReal ...

 

CancelAsyncReallocateTexture2D

(
    FTexture2DRHIParamRef Texture2D,
    bool bBlockUntilCompleted
)

Public function

uint32

 

ComputeMemorySize

(
    FTextureRHIParamRef TextureRHI
)

Public function

void

 

CopySharedMips

(
    FTexture2DRHIParamRef DestTexture2D,
    FTexture2DRHIParamRef SrcTexture2D
)

Public function

void

 

CopySubTextureRegion

(
    FTexture2DRHIParamRef SourceTexture,
    FTexture2DRHIParamRef DestinationTe...,
    FBox2D SourceBox,
    FBox2D DestinationBox
)

Public function

void

 

CopyVertexBuffer

(
    FVertexBufferRHIParamRef SourceBuff...,
    FVertexBufferRHIParamRef DestBuffer
)

Public function

FIndexBuffer ...

 

CreateAndLockIndexBuffer

(
    uint32 Stride,
    uint32 Size,
    uint32 InUsage,
    FRHIResourceCreateInfo & CreateInfo,
    void*& OutDataBuffer
)

Public function

FVertexBuffe ...

 

CreateAndLockVertexBuffer

(
    uint32 Size,
    uint32 InUsage,
    FRHIResourceCreateInfo & CreateInfo,
    void*& OutDataBuffer
)

Public function

FBlendStateR ...

 

CreateBlendState

(
    const FBlendStateInitializerRHI & I...
)

Public function

FBoundShader ...

 

CreateBoundShaderState

(
    FVertexDeclarationRHIParamRef Verte...,
    FVertexShaderRHIParamRef VertexShad...,
    FHullShaderRHIParamRef HullShader,
    FDomainShaderRHIParamRef DomainShad...,
    FPixelShaderRHIParamRef PixelShader,
    FGeometryShaderRHIParamRef Geometry...
)

Public function

FComputeFenc ...

 

CreateComputeFence

(
    const FName & Name
)

Public function

TRefCountPtr ...

 

CreateComputePipelineState

(
    FRHIComputeShader * ComputeShad...
)

Public function

FComputeShad ...

 

CreateComputeShader

(
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FComputeShad ...

 

CreateComputeShader

(
    const TArray < uint8 >& Code
)

Public function

FDepthStenci ...

 

CreateDepthStencilState

(
    const FDepthStencilStateInitializer ...
)

Public function

FDomainShade ...

 

CreateDomainShader

(
    const TArray < uint8 >& Code
)

Public function

FDomainShade ...

 

CreateDomainShader

(
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FGeometrySha ...

 

CreateGeometryShader

(
    const TArray < uint8 >& Code
)

Public function

FGeometrySha ...

 

CreateGeometryShader

(
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FGeometrySha ...

 

CreateGeometryShaderWithStreamOutput

(
    const FStreamOutElementList & Eleme...,
    uint32 NumStrides,
    const uint32 * Strides,
    int32 RasterizedStream,
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FGeometrySha ...

 

CreateGeometryShaderWithStreamOutput

(
    const TArray < uint8 >& Code,
    const FStreamOutElementList & Eleme...,
    uint32 NumStrides,
    const uint32 * Strides,
    int32 RasterizedStream
)

Public function

FGPUFenceRHI ...

 

CreateGPUFence

(
    const FName & Name
)

Public function

FGraphicsPip ...

 

CreateGraphicsPipelineState

(
    const FGraphicsPipelineStateInitial ...
)

Public function

FHullShaderR ...

 

CreateHullShader

(
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FHullShaderR ...

 

CreateHullShader

(
    const TArray < uint8 >& Code
)

Public function

FIndexBuffer ...

 

CreateIndexBuffer

(
    uint32 Stride,
    uint32 Size,
    uint32 InUsage,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FPixelShader ...

 

CreatePixelShader

(
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FPixelShader ...

 

CreatePixelShader

(
    const TArray < uint8 >& Code
)

Public function

FRasterizerS ...

 

CreateRasterizerState

(
    const FRasterizerStateInitializerRH ...
)

Public function

FRenderQuery ...

 

CreateRenderQuery

(
    ERenderQueryType QueryType
)

Public function

FRenderQuery ...

 

CreateRenderQuery_RenderThread

(
    ERenderQueryType QueryType
)

Public function

FStructuredB ...

 

CreateRTWriteMaskBuffer

(
    FTexture2DRHIRef RenderTarget
)

Public function

FSamplerStat ...

 

CreateSamplerState

(
    const FSamplerStateInitializerRHI &...
)

Public function

FShaderResou ...

 

CreateShaderResourceView

(
    FIndexBufferRHIParamRef Buffer
)

Public function

FShaderResou ...

 

CreateShaderResourceView

(
    FTexture2DRHIParamRef Texture2DRHI,
    uint8 MipLevel,
    uint8 NumMipLevels,
    uint8 Format
)

Public function

FShaderResou ...

 

CreateShaderResourceView

(
    FVertexBufferRHIParamRef VertexBuff...,
    uint32 Stride,
    uint8 Format
)

Public function

FShaderResou ...

 

CreateShaderResourceView

(
    FTextureCubeRHIParamRef TextureCube...,
    uint8 MipLevel
)

Public function

FShaderResou ...

 

CreateShaderResourceView

(
    FStructuredBufferRHIParamRef Struct...
)

Public function

FShaderResou ...

 

CreateShaderResourceView

(
    FTexture2DArrayRHIParamRef Texture2...,
    uint8 MipLevel
)

Public function

FShaderResou ...

 

CreateShaderResourceView

(
    FTexture2DRHIParamRef Texture2DRHI,
    uint8 MipLevel
)

Public function

FShaderResou ...

 

CreateShaderResourceView

(
    FTexture3DRHIParamRef Texture3DRHI,
    uint8 MipLevel
)

Public function

FStagingBuff ...

 

CreateStagingBuffer()

Public function

FStructuredB ...

 

CreateStructuredBuffer

(
    uint32 Stride,
    uint32 Size,
    uint32 InUsage,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FTexture2DRH ...

 

CreateTexture2D

(
    uint32 SizeX,
    uint32 SizeY,
    uint8 Format,
    uint32 NumMips,
    uint32 NumSamples,
    uint32 Flags,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FTexture2DAr ...

 

CreateTexture2DArray

(
    uint32 SizeX,
    uint32 SizeY,
    uint32 SizeZ,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FTexture3DRH ...

 

CreateTexture3D

(
    uint32 SizeX,
    uint32 SizeY,
    uint32 SizeZ,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FTextureCube ...

 

CreateTextureCube

(
    uint32 Size,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FTextureCube ...

 

CreateTextureCubeArray

(
    uint32 Size,
    uint32 ArraySize,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FTexture2DRH ...

 

CreateTextureExternal2D

(
    uint32 SizeX,
    uint32 SizeY,
    uint8 Format,
    uint32 NumMips,
    uint32 NumSamples,
    uint32 Flags,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FTextureRefe ...

 

CreateTextureReference

(
    FLastRenderTimeContainer * Last...
)

Public function

FUniformBuff ...

 

CreateUniformBuffer

(
    const void* Contents,
    const FRHIUniformBufferLayout & Lay...,
    EUniformBufferUsage Usage
)

Public function

FUnorderedAc ...

 

CreateUnorderedAccessView

(
    FTextureRHIParamRef Texture,
    uint32 MipLevel
)

Public function

FUnorderedAc ...

 

CreateUnorderedAccessView

(
    FVertexBufferRHIParamRef VertexBuff...,
    uint8 Format
)

Public function

FUnorderedAc ...

 

CreateUnorderedAccessView

(
    FIndexBufferRHIParamRef IndexBuffer,
    uint8 Format
)

Public function

FUnorderedAc ...

 

CreateUnorderedAccessView

(
    FStructuredBufferRHIParamRef Struct...,
    bool bUseUAVCounter,
    bool bAppendBuffer
)

Public function

FVertexBuffe ...

 

CreateVertexBuffer

(
    uint32 Size,
    uint32 InUsage,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FVertexShade ...

 

CreateVertexShader

(
    const TArray < uint8 >& Code
)

Public function

FVertexShade ...

 

CreateVertexShader

(
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FViewportRHI ...

 

CreateViewport

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

Public function

void

 

DiscardTransientResource_RenderThread

(
    FStructuredBufferRHIParamRef Buffer
)

Public function

void

 

DiscardTransientResource_RenderThread

(
    FVertexBufferRHIParamRef Buffer
)

Public function

void

 

DiscardTransientResource_RenderThread

(
    FTextureRHIParamRef Texture
)

Public function

void

 

EndMultiUpdateTexture3D

(
    TArray < FUpdateTexture3DData >& Up...
)

Public function

void

 

EndUpdateTexture3D

(
    FUpdateTexture3DData & UpdateData
)

Public function

bool

 

EnqueueCompress

(
    uint8_t* SrcBuffer,
    uint8_t* DestBuffer,
    int UnCompressedSize,
    void* ErrorCodeBuffer
)

Public function

bool

 

EnqueueDecompress

(
    uint8_t* SrcBuffer,
    uint8_t* DestBuffer,
    int CompressedSize,
    void* ErrorCodeBuffer
)

Public function

bool

 

EnqueueLambda

(
    bool bRunOnCurrentThread,
    LAMBDA&& Lambda
)

Public function

bool

 

EnqueueLambda

(
    LAMBDA&& Lambda
)

Public function

void

 

ExecuteCommandList

(
    FRHICommandList * CmdList
)

Public function

ETextureReal ...

 

FinalizeAsyncReallocateTexture2D

(
    FTexture2DRHIParamRef Texture2D,
    bool bBlockUntilCompleted
)

Public function

void

 

FlushResources()

Public function

void

 

GenerateMips

(
    FTextureRHIParamRef Texture
)

Public function

bool

 

GetAvailableResolutions

(
    FScreenResolutionArray & Resolution...,
    bool bIgnoreRefreshRate
)

Public function

IRHICommandC ...

 

GetCommandContextContainer

(
    int32 Index,
    int32 Num
)

Public function

IRHICommandC ...

 

GetDefaultContext()

Public function

uint32

 

GetGPUFrameCycles()

Public function

void *

 

GetNativeDevice()

Public function

bool

 

GetRenderQueryResult

(
    FRenderQueryRHIParamRef RenderQuery,
    uint64 & OutResult,
    bool bWait
)

Public function Static

FGraphEventA ...

 

GetRenderThreadTaskArray()

Public function

void

 

GetResourceInfo

(
    FTextureRHIParamRef Ref,
    FRHIResourceInfo & OutInfo
)

Public function

void

 

GetSupportedResolution

(
    uint32 & Width,
    uint32 & Height
)

Public function

void

 

GetTextureMemoryStats

(
    FTextureMemoryStats & OutStats
)

Public function

bool

 

GetTextureMemoryVisualizeData

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

Public function

FTexture2DRH ...

 

GetViewportBackBuffer

(
    FViewportRHIParamRef Viewport
)

Public function

uint32

 

GetViewportNextPresentGPUIndex

(
    FViewportRHIParamRef Viewport
)

Public function

void

 

ImmediateFlush

(
    EImmediateFlushType::Type FlushType
)

Public function

bool

 

IsRenderingSuspended()

Public function Static

bool

 

IsStalled()

Public function

void *

 

LockIndexBuffer

(
    FIndexBufferRHIParamRef IndexBuffer,
    uint32 Offset,
    uint32 SizeRHI,
    EResourceLockMode LockMode
)

Public function

void *

 

LockStagingBuffer

(
    FStagingBufferRHIParamRef StagingBu...,
    uint32 Offset,
    uint32 SizeRHI
)

Public function

void *

 

LockStructuredBuffer

(
    FStructuredBufferRHIParamRef Struct...,
    uint32 Offset,
    uint32 SizeRHI,
    EResourceLockMode LockMode
)

Public function

void *

 

LockTexture2D

(
    FTexture2DRHIParamRef Texture,
    uint32 MipIndex,
    EResourceLockMode LockMode,
    uint32 & DestStride,
    bool bLockWithinMiptail,
    bool bFlushRHIThread
)

Public function

void *

 

LockTexture2DArray

(
    FTexture2DArrayRHIParamRef Texture,
    uint32 TextureIndex,
    uint32 MipIndex,
    EResourceLockMode LockMode,
    uint32 & DestStride,
    bool bLockWithinMiptail
)

Public function

void *

 

LockTextureCubeFace

(
    FTextureCubeRHIParamRef Texture,
    uint32 FaceIndex,
    uint32 ArrayIndex,
    uint32 MipIndex,
    EResourceLockMode LockMode,
    uint32 & DestStride,
    bool bLockWithinMiptail
)

Public function

void *

 

LockVertexBuffer

(
    FVertexBufferRHIParamRef VertexBuff...,
    uint32 Offset,
    uint32 SizeRHI,
    EResourceLockMode LockMode
)

Public function

void

 

MapStagingSurface

(
    FTextureRHIParamRef Texture,
    void*& OutData,
    int32 & OutWidth,
    int32 & OutHeight
)

Public function

void

 

PollRenderQueryResults()

Public function

void

 

QueueAsyncCompute

(
    FRHIAsyncComputeCommandList & RHICo...
)

Queue the given async compute commandlists in order with the current immediate commandlist.

Public function

void

 

Read3DSurfaceFloatData

(
    FTextureRHIParamRef Texture,
    FIntRect Rect,
    FIntPoint ZMinMax,
    TArray < FFloat16Color >& OutData
)

Public function

void

 

ReadSurfaceData

(
    FTextureRHIParamRef Texture,
    FIntRect Rect,
    TArray < FLinearColor >& OutData,
    FReadSurfaceDataFlags InFlags
)

Public function

void

 

ReadSurfaceData

(
    FTextureRHIParamRef Texture,
    FIntRect Rect,
    TArray < FColor >& OutData,
    FReadSurfaceDataFlags InFlags
)

Public function

void

 

ReadSurfaceFloatData

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

Public function

void

 

ReleaseThreadOwnership()

Public function Static

FGraphEventR ...

 

RenderThreadTaskFence()

Public function

void

 

ResizeViewport

(
    FViewportRHIParamRef Viewport,
    uint32 SizeX,
    uint32 SizeY,
    bool bIsFullscreen,
    EPixelFormat PreferredPixelFormat
)

Public function

void

 

ResumeRendering()

Public function

FGraphEventR ...

 

RHIThreadFence

(
    bool bSetLockFence
)

Public function

void

 

SetCurrentStat

(
    TStatId Stat
)

Public function

void

 

SetGPUMask

(
    FRHIGPUMask InGPUMask
)

Dispatch current work and change the GPUMask.

Public function

void

 

SetResourceAliasability

(
    EResourceAliasability AliasMode,
    FTextureRHIParamRef * InTexture...,
    int32 NumTextures
)

Public function

void

 

SetStreamOutTargets

(
    uint32 NumTargets,
    const FVertexBufferRHIParamRef *...,
    const uint32 * Offsets
)

Public function

bool

 

StallRHIThread()

Public function

void

 

SubmitCommandsAndFlushGPU()

Public function

void

 

SuspendRendering()

Public function

void

 

Tick

(
    float DeltaTime
)

Public function

void

 

TransferTexture

(
    FTexture2DRHIParamRef Texture,
    FIntRect Rect,
    uint32 SrcGPUIndex,
    uint32 DestGPUIndex,
    bool PullData
)

Public function

void

 

UnlockIndexBuffer

(
    FIndexBufferRHIParamRef IndexBuffer
)

Public function

void

 

UnlockStagingBuffer

(
    FStagingBufferRHIParamRef StagingBu...
)

Public function

void

 

UnlockStructuredBuffer

(
    FStructuredBufferRHIParamRef Struct...
)

Public function

void

 

UnlockTexture2D

(
    FTexture2DRHIParamRef Texture,
    uint32 MipIndex,
    bool bLockWithinMiptail,
    bool bFlushRHIThread
)

Public function

void

 

UnlockTexture2DArray

(
    FTexture2DArrayRHIParamRef Texture,
    uint32 TextureIndex,
    uint32 MipIndex,
    bool bLockWithinMiptail
)

Public function

void

 

UnlockTextureCubeFace

(
    FTextureCubeRHIParamRef Texture,
    uint32 FaceIndex,
    uint32 ArrayIndex,
    uint32 MipIndex,
    bool bLockWithinMiptail
)

Public function

void

 

UnlockVertexBuffer

(
    FVertexBufferRHIParamRef VertexBuff...
)

Public function

void

 

UnmapStagingSurface

(
    FTextureRHIParamRef Texture
)

Public function

void

 

UnStallRHIThread()

Public function

void

 

UpdateTexture2D

(
    FTexture2DRHIParamRef Texture,
    uint32 MipIndex,
    const FUpdateTextureRegion2D & Upda...,
    uint32 SourcePitch,
    const uint8 * SourceData
)

Public function

void

 

UpdateTexture3D

(
    FTexture3DRHIParamRef Texture,
    uint32 MipIndex,
    const FUpdateTextureRegion3D & Upda...,
    uint32 SourceRowPitch,
    uint32 SourceDepthPitch,
    const uint8 * SourceData
)

Public function

void

 

UpdateTextureReference

(
    FTextureReferenceRHIParamRef Textur...,
    FTextureRHIParamRef NewTexture
)

Public function

void

 

VirtualTextureSetFirstMipInMemory

(
    FTexture2DRHIParamRef Texture,
    uint32 FirstMip
)

Public function

void

 

VirtualTextureSetFirstMipVisible

(
    FTexture2DRHIParamRef Texture,
    uint32 FirstMip
)

Public function Static

void

 

WaitOnRenderThreadTaskFence

(
    FGraphEventRef & Fence
)

Deprecated Functions

References

Module

RHI

Header

Runtime/RHI/Public/RHICommandList.h