UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FVulkanCommandBuffer Class Reference

#include <VulkanCommandBuffer.h>

Public Types

enum class  EState : uint8 {
  ReadyForBegin , IsInsideBegin , IsInsideRenderPass , HasEnded ,
  Submitted , NotAllocated , NeedReset
}
 

Public Member Functions

bool IsInsideRenderPass () const
 
bool IsOutsideRenderPass () const
 
bool HasBegun () const
 
bool HasEnded () const
 
bool IsSubmitted () const
 
bool IsAllocated () const
 
VkCommandBuffer GetHandle () const
 
EVulkanCommandBufferType GetCommandBufferType () const
 
void SetSubmitted ()
 
void Begin (FVulkanQueryPool *OptionalQueryPool, VkRenderPass RenderPassHandle)
 
void End (FVulkanQueryPool *OptionalQueryPool)
 
void BeginRenderPass (const FVulkanBeginRenderPassInfo &BeginRenderPassInfo, const VkClearValue *AttachmentClearValues)
 
void EndRenderPass ()
 
void BeginDynamicRendering (const VkRenderingInfo &RenderingInfo)
 
void EndDynamicRendering ()
 
void BeginSplitBarrier (VkEvent BarrierEvent, const VkDependencyInfo &DependencyInfo)
 
void EndSplitBarrier (VkEvent BarrierEvent, const VkDependencyInfo &DependencyInfo)
 
uint64 GetBusyCycles () const
 

Public Attributes

TArray< VkViewport, TInlineAllocator< 2 > > CurrentViewports
 
TArray< VkRect2D, TInlineAllocator< 2 > > CurrentScissors
 
uint32 CurrentStencilRef = 0
 
EState State = EState::NotAllocated
 
FGfxPipelineDescLastDynamicStateUpdate = nullptr
 
uint8 bNeedsFullDynamicStateUpdate: 1 = 1
 
uint8 bHasPipeline: 1 = 0
 
uint8 bHasViewport: 1 = 0
 
uint8 bHasScissor: 1 = 0
 
uint8 bHasStencilRef: 1 = 0
 
uint8 CurrentMultiViewCount = 0
 
TArray< FVulkanCommandBuffer * > ExecutedSecondaryCommandBuffers
 
VkRenderingFlags LastDynamicRenderingFlags = 0
 
FVulkanDeviceDevice
 

Protected Member Functions

 FVulkanCommandBuffer (FVulkanDevice &InDevice, FVulkanCommandBufferPool &InCommandBufferPool)
 
 ~FVulkanCommandBuffer ()
 

Friends

class FVulkanCommandBufferPool
 
class FVulkanQueue
 
class FVulkanDynamicRHI
 

Member Enumeration Documentation

◆ EState

Enumerator
ReadyForBegin 
IsInsideBegin 
IsInsideRenderPass 
HasEnded 
Submitted 
NotAllocated 
NeedReset 

Constructor & Destructor Documentation

◆ FVulkanCommandBuffer()

FVulkanCommandBuffer::FVulkanCommandBuffer ( FVulkanDevice InDevice,
FVulkanCommandBufferPool InCommandBufferPool 
)
protected

◆ ~FVulkanCommandBuffer()

FVulkanCommandBuffer::~FVulkanCommandBuffer ( )
protected

Member Function Documentation

◆ Begin()

void FVulkanCommandBuffer::Begin ( FVulkanQueryPool OptionalQueryPool,
VkRenderPass  RenderPassHandle 
)

◆ BeginDynamicRendering()

void FVulkanCommandBuffer::BeginDynamicRendering ( const VkRenderingInfo RenderingInfo)

◆ BeginRenderPass()

void FVulkanCommandBuffer::BeginRenderPass ( const FVulkanBeginRenderPassInfo BeginRenderPassInfo,
const VkClearValue AttachmentClearValues 
)

◆ BeginSplitBarrier()

void FVulkanCommandBuffer::BeginSplitBarrier ( VkEvent  BarrierEvent,
const VkDependencyInfo DependencyInfo 
)

◆ End()

void FVulkanCommandBuffer::End ( FVulkanQueryPool OptionalQueryPool)

◆ EndDynamicRendering()

void FVulkanCommandBuffer::EndDynamicRendering ( )

◆ EndRenderPass()

void FVulkanCommandBuffer::EndRenderPass ( )

◆ EndSplitBarrier()

void FVulkanCommandBuffer::EndSplitBarrier ( VkEvent  BarrierEvent,
const VkDependencyInfo DependencyInfo 
)

◆ GetBusyCycles()

uint64 FVulkanCommandBuffer::GetBusyCycles ( ) const
inline

◆ GetCommandBufferType()

EVulkanCommandBufferType FVulkanCommandBuffer::GetCommandBufferType ( ) const
inline

◆ GetHandle()

VkCommandBuffer FVulkanCommandBuffer::GetHandle ( ) const
inline

◆ HasBegun()

bool FVulkanCommandBuffer::HasBegun ( ) const
inline

◆ HasEnded()

bool FVulkanCommandBuffer::HasEnded ( ) const
inline

◆ IsAllocated()

bool FVulkanCommandBuffer::IsAllocated ( ) const
inline

◆ IsInsideRenderPass()

bool FVulkanCommandBuffer::IsInsideRenderPass ( ) const
inline

◆ IsOutsideRenderPass()

bool FVulkanCommandBuffer::IsOutsideRenderPass ( ) const
inline

◆ IsSubmitted()

bool FVulkanCommandBuffer::IsSubmitted ( ) const
inline

◆ SetSubmitted()

void FVulkanCommandBuffer::SetSubmitted ( )

Friends And Related Symbol Documentation

◆ FVulkanCommandBufferPool

◆ FVulkanDynamicRHI

friend class FVulkanDynamicRHI
friend

◆ FVulkanQueue

friend class FVulkanQueue
friend

Member Data Documentation

◆ bHasPipeline

uint8 FVulkanCommandBuffer::bHasPipeline

◆ bHasScissor

uint8 FVulkanCommandBuffer::bHasScissor

◆ bHasStencilRef

uint8 FVulkanCommandBuffer::bHasStencilRef

◆ bHasViewport

uint8 FVulkanCommandBuffer::bHasViewport

◆ bNeedsFullDynamicStateUpdate

uint8 FVulkanCommandBuffer::bNeedsFullDynamicStateUpdate

◆ CurrentMultiViewCount

uint8 FVulkanCommandBuffer::CurrentMultiViewCount = 0

◆ CurrentScissors

TArray<VkRect2D, TInlineAllocator<2> > FVulkanCommandBuffer::CurrentScissors

◆ CurrentStencilRef

uint32 FVulkanCommandBuffer::CurrentStencilRef = 0

◆ CurrentViewports

TArray<VkViewport, TInlineAllocator<2> > FVulkanCommandBuffer::CurrentViewports

◆ Device

FVulkanDevice& FVulkanCommandBuffer::Device

◆ ExecutedSecondaryCommandBuffers

TArray<FVulkanCommandBuffer*> FVulkanCommandBuffer::ExecutedSecondaryCommandBuffers

◆ LastDynamicRenderingFlags

VkRenderingFlags FVulkanCommandBuffer::LastDynamicRenderingFlags = 0

◆ LastDynamicStateUpdate

FGfxPipelineDesc* FVulkanCommandBuffer::LastDynamicStateUpdate = nullptr

◆ State

EState FVulkanCommandBuffer::State = EState::NotAllocated

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