FRHICommandListBase

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

RHI

Header

/Engine/Source/Runtime/RHI/Public/RHICommandList.h

Include

#include "RHICommandList.h"

Syntax

class FRHICommandListBase : public FNoncopyable

Variables

Name Description

Protected variable

bool

 

bAsyncPSOCompileAllowed

Protected variable

bool

 

bRecursive

Public variable

FCommonData

 

Data

Public variable

TStatId

 

ExecuteStat

Protected variable

FRHIGPUMask

 

GPUMask

Protected variable

FRHIGPUMask

 

InitialGPUMask

GPUMask that was set at the time the command list was last Reset.

Protected variable

FRHICommandListBase::FPSOContext

 

PSOContext

Public variable

void *[(int32) ERenderThreadContext::Num]

 

RenderThreadContexts

Constructors

Name Description

Public function

FRHICommandListBase

(
    FRHIGPUMask InGPUMask
)

Destructors

Name Description

Public function

~FRHICommandListBase()

Functions

Name Description

Public function

void

 

AddDispatchPrerequisite

(
    const FGraphEventRef& Prereq
)

Public function

void *

 

Alloc

(
    int32 AllocSize,
    int32 Alignment
)

Public function

void *

 

Alloc()

Public function

const TArrayView< T >

 

AllocArray

(
    const TArrayView< T > InArray
)

Public function

void *

 

AllocCommand

(
    int32 AllocSize,
    int32 Alignment
)

Public function

void *

 

AllocCommand()

Public function

TCHAR *

 

AllocString

(
    const TCHAR* Name
)

Public function

bool

 

Bypass()

Protected function

void

 

CacheActiveRenderTargets

(
    const FRHIRenderPassInfo& Info
)

Protected function

void

 

CacheActiveRenderTargets

(
    uint32 NewNumSimultaneousRenderTargets,
    const FRHIRenderTargetView* NewRenderTargetsRHI,
    const FRHIDepthRenderTargetView* NewDepthStencilTargetRHI
)

Public function

void

 

CopyContext

(
    FRHICommandListBase& ParentCommandList
)

Public function

void

 

CopyRenderThreadContexts

(
    const FRHICommandListBase& ParentCommandList
)

Public function Const

bool

 

DoValidation()

Public function

void

 

ExchangeCmdList

(
    FRHICommandListBase& Other
)

Public function

void

 

Flush()

Public function

IRHIComputeContext &

 

GetComputeContext()

Public function

IRHICommandContext &

 

GetContext()

Public function Const

const FRHIGPUMask &

 

GetGPUMask()

Public function

void *

 

GetRenderThreadContext

(
    ERenderThreadContext Slot
)

Public function

uint32

 

GetUID()

Public function Const

const int32

 

GetUsedMemory()

Public function

void

 

HandleRTThreadTaskCompletion

(
    const FGraphEventRef& MyCompletionGraphEvent
)

Public function Const

bool

 

HasCommands()

Protected function

void

 

IncrementSubpass()

Public function

bool

 

IsBottomOfPipe()

Public function Const

bool

 

IsExecuting()

Public function

bool

 

IsImmediate()

Public function

bool

 

IsImmediateAsyncCompute()

Public function Const

bool

 

IsInsideComputePass()

Public function Const

bool

 

IsInsideRenderPass()

Public function Const

bool

 

IsOutsideRenderPass()

Public function

bool

 

IsTopOfPipe()

Public function

void

 

MaybeDispatchToRHIThread()

Public function

void

 

MaybeDispatchToRHIThreadInner()

Public function

void

 

QueueAsyncCommandListSubmit

(
    FGraphEventRef& AnyThreadCompletionEvent,
    FRHICommandList* CmdList
)

Public function

void

 

QueueCommandListSubmit

(
    FRHICommandList* CmdList
)

Public function

void

 

QueueParallelAsyncCommandListSubmit

(
    FGraphEventRef* AnyThreadCompletionEvents,
    bool bIsPrepass,
    FRHICommandList** CmdLists,
    int32* NumDrawsIfKnown,
    int32 Num,
    int32 MinDrawsPerTranslate,
    bool bSpewMerge
)

Public function

void

 

QueueRenderThreadCommandListSubmit

(
    FGraphEventRef& RenderThreadCompletionEvent,
    FRHICommandList* CmdList
)

Protected function

void

 

Reset()

Protected function

void

 

ResetSubpass

(
    ESubpassHint SubpassHint
)

Public function

void

 

SetComputeContext

(
    IRHIComputeContext* InContext
)

Public function

void

 

SetContext

(
    IRHICommandContext* InContext
)

Protected function

void

 

SetGPUMaskOnComputeContext()

Protected function

void

 

SetGPUMaskOnContext()

Public function

void

 

SetRenderThreadContext

(
    void* InContext,
    ERenderThreadContext Slot
)

Public function

void

 

WaitForDispatch()

Public function

void

 

WaitForRHIThreadTasks()

Public function

void

 

WaitForTasks

(
    bool bKnownToBeComplete
)

Operators

Name Description

Public function

void

 

operator delete

(
    void* RawMemory
)

Public function

void *

 

operator new

(
    size_t Size
)

Custom new/delete with recycling

Classes

Name

Description

Public struct

FCommonData

Protected struct

FPSOContext

The values of this struct must be copied when the commandlist is split

Enums

Name

Description

Public enum

ERenderThreadContext

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback