FMetalCommandList Class Reference

#include <MetalCommandList.h>

Public Member Functions
	FMetalCommandList (FMetalCommandQueue &InCommandQueue)
	~FMetalCommandList (void)
void	FinalizeCommandBuffer (FMetalCommandBuffer *Buffer)
uint32	GetParallelIndex (void) const
FMetalCommandQueue &	GetCommandQueue (void) const

Static Public Member Functions
static void	HandleMetalCommandBufferFailure (MTL::CommandBuffer *CompletedBuffer)

Detailed Description

FMetalCommandList: Encapsulates multiple command-buffers into an ordered list for submission. For the immediate context this is irrelevant and is merely a pass-through into the CommandQueue, but for deferred/parallel contexts it is required as they must queue their command buffers until they can be committed to the command-queue in the proper order which is only known at the end of parallel encoding.

Constructor & Destructor Documentation

FMetalCommandList()

FMetalCommandList::FMetalCommandList

(

FMetalCommandQueue &

InCommandQueue

)

Constructor

Parameters

InCommandQueue

The command-queue to which the command-list's buffers will be submitted.

~FMetalCommandList()

FMetalCommandList::~FMetalCommandList

(

void

)

Destructor

Member Function Documentation

FinalizeCommandBuffer()

void FMetalCommandList::FinalizeCommandBuffer

(

FMetalCommandBuffer *

Buffer

)

Finalizes the command buffer ready for submission

Parameters

Buffer

The buffer to submit to the command-list.

GetCommandQueue()

FMetalCommandQueue & FMetalCommandList::GetCommandQueue ( void  ) const

inline

Returns

The command queue to which this command-list submits command-buffers.

GetParallelIndex()

uint32 FMetalCommandList::GetParallelIndex ( void  ) const

inline

The index of this command-list within the parallel pass.

Returns

The index of this command-list within the parallel pass, 0 when IsImmediate() is true.

HandleMetalCommandBufferFailure()

void FMetalCommandList::HandleMetalCommandBufferFailure ( MTL::CommandBuffer *  CompletedBuffer )

static

Command buffer failure reporting function.

Parameters

CompletedBuffer

The buffer to check for failure.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Apple/MetalRHI/Private/MetalCommandList.h
• Engine/Source/Runtime/Apple/MetalRHI/Private/MetalCommandList.cpp